X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fitem.cc;h=e47143e6828ce66b0a94a09847c5a91919efbd4e;hb=f5174651f3b2ded5845a37537aac766ef1b35ab5;hp=78db9884e97fadeb4f5fb11877a222066c5cda81;hpb=55fa3168d0fb5326341ff56d7a1638c89eb2ebaf;p=lilypond.git diff --git a/lily/item.cc b/lily/item.cc index 78db9884e9..e47143e682 100644 --- a/lily/item.cc +++ b/lily/item.cc @@ -3,195 +3,292 @@ source file of the GNU LilyPond music typesetter - (c) 1997--1998 Han-Wen Nienhuys + (c) 1997--2007 Han-Wen Nienhuys */ -#include "p-score.hh" -#include "debug.hh" #include "item.hh" -#include "p-col.hh" -// #include "elem-group.hh" -#include "spanner.hh" -Item::Item () +#include "axis-group-interface.hh" +#include "paper-score.hh" +#include "warn.hh" +#include "paper-column.hh" +#include "lily-guile.hh" +#include "system.hh" +#include "pointer-group-interface.hh" + +#include "moment.hh" + + +Grob * +Item::clone () const { - unbroken_original_l_ =0; - break_priority_i_ = 0; - breakable_b_ = false; - break_status_dir_ = CENTER; - broken_to_drul_[LEFT] = broken_to_drul_[RIGHT]=0; + return new Item (*this); } -IMPLEMENT_IS_TYPE_B1(Item, Score_element); - -void -Item::do_print() const +Item::Item (SCM s) + : Grob (s) { -#ifndef NPRINT - DOUT << "breakable_b_: " << breakable_b_ << - " break_status_dir_: " << break_status_dir_; -#endif + 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 + 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; + cached_pure_height_valid_ = false; +} -Real -Item::hpos_f() const +bool +Item::is_non_musical (Grob *me) { - return absolute_coordinate (X_AXIS); + if (me->original ()) + return false; + + Item *i = dynamic_cast (me->get_parent (X_AXIS)); + return i ? Item::is_non_musical (i) : to_boolean (me->get_property ("non-musical")); } -Line_of_score * -Item::line_l() const +Paper_column * +Item::get_column () const { - Graphical_axis_group *ga = axis_group_l_a_[X_AXIS]; - - if (!ga) - return 0; - - assert (ga->access_Score_element()); - return ga->access_Score_element ()-> line_l (); + Item *parent = dynamic_cast (get_parent (X_AXIS)); + return parent ? parent->get_column () : 0; } -Direction -Item::break_status_dir() const +System * +Item::get_system () const { - return break_status_dir_; + Grob *g = get_parent (X_AXIS); + return g ? g->get_system () : 0; } void -Item::copy_breakable_items() +Item::copy_breakable_items () { - if (broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]) - return; Drul_array new_copies; - Direction i=LEFT; - do + Direction i = LEFT; + do { - Item * item_p = clone()->access_Item (); - - item_p->break_status_dir_ = i; - pscore_l_->typeset_element (item_p); - item_p->handle_prebroken_dependencies(); - new_copies[i] =item_p; + Grob *dolly = clone (); + Item *item = dynamic_cast (dolly); + get_root_system (this)->typeset_grob (item); + new_copies[i] = item; } - while (flip(&i) != LEFT); - broken_to_drul_= new_copies; + while (flip (&i) != LEFT); + + broken_to_drul_ = new_copies; } -void -Item::do_breakable_col_processing() +bool +Item::is_broken () const { - if (!breakable_b_) - return; + return broken_to_drul_[LEFT] || broken_to_drul_[RIGHT]; +} - if (!column_l ()->breakable_b_) +/* + Generate items for begin and end-of line. +*/ +void +Item::discretionary_processing () +{ + if (is_broken ()) return; - copy_breakable_items(); - handle_prebroken_dependencies(); - - /* - Otherwise the broken items won't be pre_process()'ed. - */ - add_dependency (broken_to_drul_[LEFT]); - add_dependency (broken_to_drul_[RIGHT]); + if (Item::is_non_musical (this)) + copy_breakable_items (); } -Item* -Item::find_prebroken_piece (Line_of_score*l) const +Grob * +Item::find_broken_piece (System *l) const { - if (line_l() == l) - return (Item*)this; - else if (broken_to_drul_[LEFT] && broken_to_drul_[LEFT]->line_l() == l) - return broken_to_drul_[LEFT]; - else if (broken_to_drul_[RIGHT] && broken_to_drul_[RIGHT]->line_l() == l) - return broken_to_drul_[RIGHT]; + if (get_system () == l) + return (Item *) (this); + + Direction d = LEFT; + do + { + Grob *s = broken_to_drul_[d]; + if (s && s->get_system () == l) + return s; + } + while (flip (&d) != LEFT); return 0; } -Item* -Item::find_prebroken_piece (Direction breakstatus) const +Item * +Item::find_prebroken_piece (Direction d) const { - if (!breakstatus) - return (Item *) this; // ugh - else - return (Item*) broken_to_drul_[breakstatus]; + Item *me = (Item *) (this); + if (!d) + return me; + return dynamic_cast (broken_to_drul_[d]); } -void -Item::handle_prebroken_dependencies() +Direction +Item::break_status_dir () const { - if (breakable_b_) - Score_element::handle_prebroken_dependencies(); + if (original ()) + { + Item *i = dynamic_cast (original ()); + + return (i->broken_to_drul_[LEFT] == this) ? LEFT : RIGHT; + } + else + return CENTER; } -int -Item::left_right_compare(Item const *l, Item const *r) +void +Item::handle_prebroken_dependencies () { - while (!l->is_type_b (Paper_column::static_name ())) - l = l->axis_group_l_a_[X_AXIS]->access_Score_element ()->access_Item (); - while (!r->is_type_b (Paper_column::static_name ())) - r = r->axis_group_l_a_[X_AXIS]->access_Score_element ()->access_Item (); + Grob::handle_prebroken_dependencies (); - Paper_column *p1 = (Paper_column*)l; - Paper_column* p2 = (Paper_column*)r; - return p1->rank_i () - p2->rank_i (); + /* + 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; +} bool -Item::linked_b() const +Item::pure_is_visible (int start, int end) const { - return Score_element::linked_b() || attached_span_l_arr_.size(); + 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; } -void -Item::do_junk_links() +Interval_t +Item::spanned_rank_interval () const { - attached_span_l_arr_.set_size(0); + int c = get_column ()->get_rank (); + return Interval_t (c, c); } -void -Item::do_unlink() +Interval_t +spanned_time_interval (Item *l, Item *r) { - Link_array attached=attached_span_l_arr_; - for (int i=0; i < attached.size (); i++) + Drul_array bounds (l, r); + Interval_t iv; + + Direction d = LEFT; + do + { + if (bounds[d] && bounds[d]->get_column ()) + iv[d] = robust_scm2moment (bounds[d]->get_column ()->get_property ("when"), + iv[d]); + } + while (flip (&d) != LEFT); + + do { - Spanner *s= attached[i]; - - Direction d= LEFT; - do { - if (s->spanned_drul_[d] == this) - s->set_bounds (d, 0); - if (unbroken_original_l_ - && unbroken_original_l_-> broken_to_drul_[d] == this) - unbroken_original_l_->broken_to_drul_[d] = 0; - } while (flip (&d) != LEFT); + if (!bounds[d] || !bounds[d]->get_column ()) + iv[d] = iv[-d]; } - assert (!attached_span_l_arr_.size ()); - unbroken_original_l_ =0; + while (flip (&d) != LEFT); + + + return iv; } -Paper_column * -Item::column_l () const + +void +Item::derived_mark () const { - return axis_group_l_a_[X_AXIS]->access_Score_element ()->access_Item ()->column_l (); + 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 ()); } -Item::Item (Item const &s) - : Score_element (s) +Item * +unsmob_item (SCM s) { - unbroken_original_l_ = &s; - /* do not copy attached_span_l_arr_ */ - breakable_b_ = s.breakable_b_; - broken_to_drul_[LEFT] = broken_to_drul_[RIGHT] =0; - break_status_dir_ = s.break_status_dir_; - break_priority_i_ = s.break_priority_i_; + return dynamic_cast (unsmob_grob (s)); } -Item * -Item::access_Item () +Interval +Item::pure_height (Grob *g, int start, int end) +{ + if (cached_pure_height_valid_) + return cached_pure_height_ + pure_relative_y_coordinate (g, start, end); + + cached_pure_height_ = Grob::pure_height (this, start, end); + cached_pure_height_valid_ = true; + return cached_pure_height_ + pure_relative_y_coordinate (g, start, end); +} + +bool +Item::less (Grob * const &g1, Grob * const &g2) { - return this; + return dynamic_cast (g1)->get_column ()->get_rank () < dynamic_cast (g2)->get_column ()->get_rank (); } + +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" + " (@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 " + );