X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpaper-column.cc;h=3308cf251cc65a55aaf2302780a4b5abb8b323c3;hb=e19a4a25b9dcc34ffef13a583d45dc2a529998a5;hp=2f225d0718d55fb6eba1b11183ec34a274666702;hpb=ee513a2f7d18fc8d43e1c291350ed81856b0192d;p=lilypond.git diff --git a/lily/paper-column.cc b/lily/paper-column.cc index 2f225d0718..3308cf251c 100644 --- a/lily/paper-column.cc +++ b/lily/paper-column.cc @@ -3,152 +3,378 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2000 Han-Wen Nienhuys + (c) 1997--2009 Han-Wen Nienhuys */ -#include "moment.hh" + #include "paper-column.hh" -#include "paper-score.hh" -#include "debug.hh" + #include "axis-group-interface.hh" +#include "break-align-interface.hh" +#include "font-interface.hh" +#include "grob-array.hh" +#include "lookup.hh" +#include "lookup.hh" +#include "moment.hh" +#include "output-def.hh" +#include "paper-score.hh" +#include "pointer-group-interface.hh" +#include "rhythmic-head.hh" +#include "separation-item.hh" +#include "skyline-pair.hh" +#include "spaceable-grob.hh" +#include "spring.hh" +#include "string-convert.hh" +#include "system.hh" +#include "text-interface.hh" +#include "warn.hh" + +Grob * +Paper_column::clone () const +{ + return new Paper_column (*this); +} void -Paper_column::add_rod (Paper_column * p, Real d) +Paper_column::do_break_processing () { - Direction dir = Direction (sign (p->rank_i () - rank_i ())); - - if (!dir) - { - programming_error ("Must set minimum distance between differing columns."); - return; - } - - for (int i=0; i < minimal_dists_arr_drul_[dir].size (); i++) - { - Column_rod &rod = minimal_dists_arr_drul_[dir][i]; - if (rod.other_l_ == p) - { - rod.distance_f_ = rod.distance_f_ >? d; - return ; - } - } + Item::do_break_processing (); +} - Column_rod cr; - cr.distance_f_ = d; - cr.other_l_ = p; +int +Paper_column::get_rank (Grob const *me) +{ + return dynamic_cast (me)->rank_; +} - minimal_dists_arr_drul_[dir].push (cr); +System * +Paper_column::get_system () const +{ + return system_; } void -Paper_column::add_spring (Paper_column * p, Real d, Real s) +Paper_column::set_system (System *s) { - Direction dir = Direction (sign (p->rank_i () - rank_i ())); - - if (!dir) - { - warning (_ ("Must set spring between differing columns")); - return; - } - - for (int i=0; i < spring_arr_drul_[dir].size (); i++) - { - Column_spring &spring = spring_arr_drul_[dir][i]; - if (spring.other_l_ == p) - { - spring.distance_f_ = spring.distance_f_ >? d; - return ; - } - } + system_ = s; +} + +Paper_column * +Paper_column::get_column () const +{ + return (Paper_column *) (this); +} - Column_spring cr; - cr.distance_f_ = d; - cr.strength_f_ = s; - cr.other_l_ = p; +Paper_column::Paper_column (SCM l) + : Item (l) +{ + system_ = 0; + rank_ = -1; +} - spring_arr_drul_[dir].push (cr); +Paper_column::Paper_column (Paper_column const &src) + : Item (src) +{ + system_ = 0; + rank_ = src.rank_; } int -Paper_column::rank_i() const +Paper_column::compare (Grob * const &a, + Grob * const &b) { - return rank_i_; + return sign (dynamic_cast (a)->rank_ + - dynamic_cast (b)->rank_); } -void -Paper_column::set_rank (int i) +bool +Paper_column::less_than (Grob *const &a, + Grob *const &b) { - rank_i_ = i; + Paper_column *pa = dynamic_cast (a); + Paper_column *pb = dynamic_cast (b); + + return pa->rank_ < pb->rank_; } -void -Paper_column::do_print() const +Moment +Paper_column::when_mom (Grob *me) +{ + SCM m = me->get_property ("when"); + if (Moment *when = unsmob_moment (m)) + return *when; + return Moment (0); +} + +bool +Paper_column::is_musical (Grob *me) +{ + SCM m = me->get_property ("shortest-starter-duration"); + Moment s (0); + if (unsmob_moment (m)) + s = *unsmob_moment (m); + return s != Moment (0); +} + +bool +Paper_column::is_used (Grob *me) +{ + extract_grob_set (me, "elements", elts); + if (elts.size ()) + return true; + + extract_grob_set (me, "bounded-by-me", bbm); + if (bbm.size ()) + return true; + + if (Paper_column::is_breakable (me)) + return true; + + if (to_boolean (me->get_property ("used"))) + return true; + return false; +} + +bool +Paper_column::is_breakable (Grob *me) { -#ifndef NPRINT - DEBUG_OUT << "rank: " << rank_i_ << '\n'; + return scm_is_symbol (me->get_property ("line-break-permission")); +} + +Real +Paper_column::minimum_distance (Grob *left, Grob *right) +{ + Drul_array cols (left, right); + Drul_array skys = Drul_array (Skyline (RIGHT), Skyline (LEFT)); + Direction d = LEFT; do { - for (int i=0; i < minimal_dists_arr_drul_[d].size (); i++) - { - minimal_dists_arr_drul_[d][i].print (); - } - for (int i=0; i < spring_arr_drul_[d].size (); i++) - { - spring_arr_drul_[d][i].print (); - } - + Skyline_pair *sp = Skyline_pair::unsmob (cols[d]->get_property ("horizontal-skylines")); + if (sp) + skys[d] = (*sp)[-d]; } - while ((flip (&d))!=LEFT); - Item::do_print (); -#endif -} + while (flip (&d) != LEFT); -Line_of_score* -Paper_column::line_l() const -{ - return line_l_; + skys[RIGHT].merge (Separation_item::conditional_skyline (right, left)); + + return max (0.0, skys[LEFT].distance (skys[RIGHT])); } -Paper_column* -Paper_column::column_l () const +Interval +Paper_column::break_align_width (Grob *me) { - return (Paper_column*)(this); + Grob *p = me->get_parent (X_AXIS); + + if (is_musical (me)) + { + me->programming_error ("tried to get break-align-width of a non-musical column"); + return Interval (0, 0) + me->relative_coordinate (p, X_AXIS); + } + + Grob *align = Pointer_group_interface::find_grob (me, ly_symbol2scm ("elements"), + Break_alignment_interface::has_interface); + if (!align) + return Interval (0, 0) + me->relative_coordinate (p, X_AXIS); + + return align->extent (p, X_AXIS); } -Paper_column::Paper_column (Moment w) +/* + Print a vertical line and the rank number, to aid debugging. +*/ +MAKE_SCHEME_CALLBACK (Paper_column, print, 1); +SCM +Paper_column::print (SCM p) { - SCM when = (new Moment (w))->smobify_self (); - scm_unprotect_object (when); - set_elt_property ("when", when); + Paper_column *me = dynamic_cast (unsmob_grob (p)); + + string r = to_string (Paper_column::get_rank (me)); + + Moment *mom = unsmob_moment (me->get_property ("when")); + string when = mom ? mom->to_string () : "?/?"; + + Font_metric *musfont = Font_interface::get_default_font (me); + SCM properties = Font_interface::text_font_alist_chain (me); + + SCM scm_mol = Text_interface::interpret_markup (me->layout ()->self_scm (), + properties, + ly_string2scm (r)); + SCM when_mol = Text_interface::interpret_markup (me->layout ()->self_scm (), + properties, + ly_string2scm (when)); + Stencil t = *unsmob_stencil (scm_mol); + t.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (when_mol), 0.1); + t.align_to (X_AXIS, CENTER); + t.align_to (Y_AXIS, DOWN); + + Stencil l = Lookup::filled_box (Box (Interval (-0.01, 0.01), + Interval (-2, -1))); + + SCM small_letters = scm_cons (scm_acons (ly_symbol2scm ("font-size"), + scm_from_int (-6), SCM_EOL), + properties); + + int j = 0; + for (SCM s = me->get_object ("ideal-distances"); + scm_is_pair (s); s = scm_cdr (s)) + { + Spring *sp = unsmob_spring (scm_caar (s)); + if (!unsmob_grob (scm_cdar (s)) + || !unsmob_grob (scm_cdar (s))->get_system ()) + continue; + + j++; + Real y = -j * 1 -3; + vector pts; + pts.push_back (Offset (0, y)); + + Offset p2 (sp->distance (), y); + pts.push_back (p2); + + Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts); + Stencil head (musfont->find_by_name ("arrowheads.open.01")); + + SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (), + small_letters, + ly_string2scm (String_convert::form_string ("%5.2lf", sp->distance ()))); + + id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (sp->distance ()/3, y+1))); + id_stencil.add_stencil (head.translated (p2)); + id_stencil = id_stencil.in_color (0,0,1); + l.add_stencil (id_stencil); + } + + for (SCM s = me->get_object ("minimum-distances"); + scm_is_pair (s); s = scm_cdr (s)) + { + Real dist = scm_to_double (scm_cdar (s)); + Grob *other = unsmob_grob (scm_caar (s)); + if (!other || other->get_system () != me->get_system ()) + continue; + + j++; + + Real y = -j * 1.0 -3.5; + vector pts; + pts.push_back (Offset (0, y)); + + Offset p2 (dist, y); + pts.push_back (p2); - Axis_group_interface (this).set_interface (); - Axis_group_interface (this).set_axes (X_AXIS, X_AXIS); + Stencil id_stencil = Lookup::points_to_line_stencil (0.1, pts); + Stencil head (musfont->find_by_name ("arrowheads.open.0M1")); + head.translate_axis (y, Y_AXIS); + id_stencil.add_stencil (head); - line_l_=0; - rank_i_ = -1; + SCM distance_stc = Text_interface::interpret_markup (me->layout ()->self_scm (), + small_letters, + ly_string2scm (String_convert::form_string ("%5.2lf", + dist))); + + id_stencil.add_stencil (unsmob_stencil (distance_stc)->translated (Offset (dist/3, y-1))); + + + id_stencil = id_stencil.in_color (1,0,0); + l.add_stencil (id_stencil); + } + t.add_stencil (l); + return t.smobbed_copy (); } -Moment -Paper_column::when_mom () const +/* + This is all too hairy. We use bounded-by-me to make sure that some + columns are kept "alive". Unfortunately, when spanners are suicided, + this falls apart again, because suicided spanners are still in + bounded-by-me + + THIS IS BROKEN KLUDGE. WE SHOULD INVENT SOMETHING BETTER. +*/ +MAKE_SCHEME_CALLBACK (Paper_column, before_line_breaking, 1); +SCM +Paper_column::before_line_breaking (SCM grob) { - SCM m = get_elt_property ("when"); - Moment s (0); - if (SMOB_IS_TYPE_B(Moment, m)) + Grob *me = unsmob_grob (grob); + + SCM bbm = me->get_object ("bounded-by-me"); + Grob_array *ga = unsmob_grob_array (bbm); + if (!ga) + return SCM_UNSPECIFIED; + + vector &array (ga->array_reference ()); + + for (vsize i = array.size (); i--;) { - s = *SMOB_TO_TYPE (Moment,m); + Grob *g = array[i]; + + if (!g || !g->is_live ()) + /* UGH . potentially quadratic. */ + array.erase (array.begin () + i); } - return s; + + return SCM_UNSPECIFIED; } - + +/* FIXME: This is a hack that we use to identify columns that used to + contain note-heads but whose note-heads were moved by one of the ligature + engravers. Once the ligature engravers are fixed to behave nicely, this + function can be removed. +*/ bool -Paper_column::musical_b () const +Paper_column::is_extraneous_column_from_ligature (Grob *me) { - SCM m = get_elt_property ("shortest-starter-duration"); - Moment s (0); - if (SMOB_IS_TYPE_B(Moment, m)) + if (!is_musical (me)) + return false; + + // If all the note-heads that I think are my children actually belong + // to another column, then I am extraneous. + extract_grob_set (me, "elements", elts); + bool has_notehead = false; + for (vsize i = 0; i < elts.size (); i++) { - s = *SMOB_TO_TYPE (Moment,m); + if (Rhythmic_head::has_interface (elts[i])) + { + has_notehead = true; + if (dynamic_cast (elts[i])->get_column () == me) + return false; + } } - return s != Moment(0); + return has_notehead; } + +ADD_INTERFACE (Paper_column, + "@code{Paper_column} objects form the top-most X@tie{}parents" + " for items. There are two types of columns: musical and" + " non-musical, to which musical and non-musical objects are" + " attached respectively. The spacing engine determines the" + " X@tie{}positions of these objects.\n" + "\n" + "They are numbered, the first (leftmost) is column@tie{}0." + " Numbering happens before line breaking, and columns are not" + " renumbered after line breaking. Since many columns go" + " unused, you should only use the rank field to get ordering" + " information. Two adjacent columns may have non-adjacent" + " numbers.", + + /* properties */ + "between-cols " + "bounded-by-me " + "full-measure-extra-space " + "grace-spacing " + "labels " + "line-break-system-details " + "line-break-penalty " + "line-break-permission " + "maybe-loose " + "page-break-penalty " + "page-break-permission " + "page-turn-penalty " + "page-turn-permission " + "rhythmic-location " + "shortest-playing-duration " + "shortest-starter-duration " + "spacing " + "used " + "when " + ); +