X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fitem.cc;h=f90b29d30a78445c0789de622aadd1275d916ca3;hb=5d84bfad4626892bcffd05adcced53c8a2329047;hp=abae1689a6ad828a82430caa84b59435ad395cff;hpb=667d9bdb6227dd10819599c6d069a5eeb67eedd7;p=lilypond.git diff --git a/lily/item.cc b/lily/item.cc index abae1689a6..f90b29d30a 100644 --- a/lily/item.cc +++ b/lily/item.cc @@ -1,138 +1,143 @@ /* - item.cc -- implement Item + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2015 Han-Wen Nienhuys - (c) 1997--2002 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ +#include "item.hh" +#include "axis-group-interface.hh" #include "paper-score.hh" -#include "debug.hh" -#include "item.hh" +#include "warn.hh" #include "paper-column.hh" -#include "spanner.hh" #include "lily-guile.hh" #include "system.hh" -#include "group-interface.hh" +#include "pointer-group-interface.hh" + +#include "moment.hh" + +Grob * +Item::clone () const +{ + return new Item (*this); +} Item::Item (SCM s) : Grob (s) { - broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0; - Group_interface::add_thing (this, ly_symbol2scm ("interfaces"), ly_symbol2scm ("item-interface")); - + broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0; + cached_pure_height_valid_ = false; } /** - Item copy ctor. Copy nothing: everything should be a elt property + Item copy ctor. Copy nothing: everything should be an elt property or a special purpose pointer (such as broken_to_drul_[]) */ Item::Item (Item const &s) : Grob (s) { - broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0; + broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] = 0; + cached_pure_height_valid_ = false; } - bool -Item::breakable_b (Grob*me) +Item::is_non_musical (Grob *me) { - if (me->original_l_) - return false; - - if (!dynamic_cast (me)) - programming_error ("only items can be breakable."); - - Item * i =dynamic_cast (me->get_parent (X_AXIS)); - return (i) ? Item::breakable_b (i) : to_boolean (me->get_grob_property ("breakable")); + Item *i = dynamic_cast (me->get_parent (X_AXIS)); + return i ? Item::is_non_musical (i) : to_boolean (me->get_property ("non-musical")); } Paper_column * -Item::column_l () const +Item::get_column () const { - Item *parent = dynamic_cast (get_parent (X_AXIS)); - return parent ? parent->column_l () : 0; + Item *parent = dynamic_cast (get_parent (X_AXIS)); + return parent ? parent->get_column () : 0; } System * -Item::line_l () const +Item::get_system () const { Grob *g = get_parent (X_AXIS); - return g ? g->line_l () : 0; + return g ? g->get_system () : 0; } - void Item::copy_breakable_items () { Drul_array new_copies; - Direction i=LEFT; - do + for (LEFT_and_RIGHT (d)) { - Grob * dolly = clone (); - Item * item_p = dynamic_cast (dolly); - pscore_l_->line_l_->typeset_grob (item_p); - new_copies[i] =item_p; + Grob *dolly = clone (); + Item *item = dynamic_cast (dolly); + get_root_system (this)->typeset_grob (item); + new_copies[d] = item; } - while (flip (&i) != LEFT); - broken_to_drul_= new_copies; -} + broken_to_drul_ = new_copies; +} bool -Item::broken_b () const +Item::is_broken () const { return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]; } - /* Generate items for begin and end-of line. - */ +*/ void Item::discretionary_processing () { - if (broken_b ()) + if (is_broken () || original ()) return; - if (Item::breakable_b (this)) + if (Item::is_non_musical (this)) copy_breakable_items (); } -Grob* -Item::find_broken_piece (System*l) const +Grob * +Item::find_broken_piece (System *l) const { - if (line_l () == l) - return (Item*) (this); + if (get_system () == l) + return (Item *) (this); - Direction d = LEFT; - do { - Grob *s = broken_to_drul_[d]; - if (s && s->line_l () == l) - return s; - } - while (flip (&d) != LEFT); + for (LEFT_and_RIGHT (d)) + { + Grob *s = broken_to_drul_[d]; + if (s && s->get_system () == l) + return s; + } return 0; } - -Item* +Item * Item::find_prebroken_piece (Direction d) const { - Item * me = (Item *) (this); + Item *me = (Item *) (this); if (!d) return me; - return dynamic_cast (broken_to_drul_[d]); + return dynamic_cast (broken_to_drul_[d]); } - Direction Item::break_status_dir () const { - if (original_l_) + if (original ()) { - Item * i = dynamic_cast (original_l_); + Item *i = dynamic_cast (original ()); return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT; } @@ -143,62 +148,142 @@ Item::break_status_dir () const void Item::handle_prebroken_dependencies () { - if (original_l_) - { - mutable_property_alist_ - = handle_broken_grobs(original_l_->mutable_property_alist_, - gh_int2scm (break_status_dir ())); - } - + Grob::handle_prebroken_dependencies (); + /* Can't do this earlier, because try_visibility_lambda () might set the elt property transparent, which would then be copied. + */ + if (!Item::break_visible (this)) + suicide (); +} + +bool +Item::break_visible (Grob *g) +{ + Item *it = dynamic_cast (g); + SCM vis = g->get_property ("break-visibility"); + if (scm_is_vector (vis)) + return to_boolean (scm_c_vector_ref (vis, it->break_status_dir () + 1)); + return true; +} - TODO: +bool +Item::pure_is_visible (int start, int end) const +{ + SCM vis = get_property ("break-visibility"); + if (scm_is_vector (vis)) + { + int pos = 1; + int pc_rank = Paper_column::get_rank (get_column ()); + if (pc_rank == start) + pos = 2; + else if (pc_rank == end) + pos = 0; + return to_boolean (scm_vector_ref (vis, scm_from_int (pos))); + } + return true; +} - handle visibility-lambda the item itself iso. breakstatusdir, so - the function can do more complicated things. - - */ - SCM vis = get_grob_property ("visibility-lambda"); - if (gh_procedure_p (vis)) +Interval_t +Item::spanned_rank_interval () const +{ + int c = get_column ()->get_rank (); + return Interval_t (c, c); +} + +Interval_t +spanned_time_interval (Item *l, Item *r) +{ + Drul_array bounds (l, r); + Interval_t iv; + + for (LEFT_and_RIGHT (d)) + { + if (bounds[d] && bounds[d]->get_column ()) + iv[d] = robust_scm2moment (bounds[d]->get_column ()->get_property ("when"), + iv[d]); + } + + for (LEFT_and_RIGHT (d)) { - SCM args = scm_list_n (gh_int2scm (break_status_dir ()), SCM_UNDEFINED); - SCM result = gh_apply (vis, args); - bool trans = gh_scm2bool (ly_car (result)); - bool empty = gh_scm2bool (ly_cdr (result)); - - if (empty && trans) - suicide (); - else if (empty) - { - set_extent (SCM_EOL, X_AXIS); - set_extent (SCM_EOL, Y_AXIS); - } - else if (trans) - set_grob_property ("molecule-callback", SCM_EOL); + if (!bounds[d] || !bounds[d]->get_column ()) + iv[d] = iv[-d]; } + + return iv; } -SCM -Item::do_derived_mark () +void +Item::derived_mark () const { if (broken_to_drul_[LEFT]) scm_gc_mark (broken_to_drul_[LEFT]->self_scm ()); if (broken_to_drul_[RIGHT]) scm_gc_mark (broken_to_drul_[RIGHT]->self_scm ()); - return SCM_EOL; } -Item* -unsmob_item (SCM s ) +Interval +Item::pure_y_extent (Grob *g, int start, int end) { - return dynamic_cast (unsmob_grob (s)); -} + if (cached_pure_height_valid_) + return cached_pure_height_ + pure_relative_y_coordinate (g, start, end); + /* Note: cached_pure_height_ does not notice if start changes, implicitly + assuming that Items' pure_heights do not depend on 'start' or 'end'. + */ + cache_pure_height (Grob::pure_y_extent (this, start, end)); + return cached_pure_height_ + pure_relative_y_coordinate (g, start, end); +} +void +Item::cache_pure_height (Interval height) +{ + cached_pure_height_ = height; + cached_pure_height_valid_ = true; +} -ADD_INTERFACE(Item, - "item-interface", - "", - "no-spacing-rods visibility-lambda breakable") +ADD_INTERFACE (Item, + "Grobs can be distinguished in their role in the horizontal" + " spacing. Many grobs define constraints on the spacing by" + " their sizes, for example, note heads, clefs, stems, and all" + " other symbols with a fixed shape. These grobs form a" + " subtype called @code{Item}.\n" + "\n" + "Some items need special treatment for line breaking. For" + " example, a clef is normally only printed at the start of a" + " line (i.e., after a line break). To model this," + " @q{breakable} items (clef, key signature, bar lines, etc.)" + " are copied twice. Then we have three versions of each" + " breakable item: one version if there is no line break, one" + " version that is printed before the line break (at the end of" + " a system), and one version that is printed after the line" + " break.\n" + "\n" + "Whether these versions are visible and take up space is" + " determined by the outcome of the @code{break-visibility}" + " grob property, which is a function taking a direction" + " (@w{@code{-1}}, @code{0} or@tie{}@code{1}) as an argument. It" + " returns a cons of booleans, signifying whether this grob" + " should be transparent and have no extent.\n" + "\n" + "The following variables for @code{break-visibility} are" + " predefined:\n" + "@example\n" + " grob will show: before no after\n" + " break break break\n" + " all-invisible no no no\n" + " begin-of-line-visible no no yes\n" + " end-of-line-visible yes no no\n" + " all-visible yes yes yes\n" + " begin-of-line-invisible yes yes no\n" + " end-of-line-invisible no yes yes\n" + " center-invisible yes no yes\n" + "@end example", + + /* properties */ + "break-visibility " + "extra-spacing-height " + "extra-spacing-width " + "non-musical " + );