X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=ba5d40e51879ffe7f5b7709c51cbfed96579ed41;hb=c423fa1e62d3060b592ea9e56c841649b8504d8b;hp=c582357f728e82402719e5681b845e01fbe6af5e;hpb=b9fc4bb5b3ce7d75e7e5284352eeaa04bbe78e14;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index c582357f72..ba5d40e518 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,411 +1,69 @@ -/* +/* spacing-spanner.cc -- implement Spacing_spanner - + source file of the GNU LilyPond music typesetter - - (c) 1999--2003 Han-Wen Nienhuys - - */ + + (c) 1999--2007 Han-Wen Nienhuys +*/ + +#include "spacing-spanner.hh" #include -#include +#include +#include "spacing-options.hh" +#include "international.hh" #include "main.hh" -#include "system.hh" -#include "warn.hh" -#include "paper-def.hh" -#include "paper-score.hh" -#include "paper-column.hh" -#include "item.hh" #include "moment.hh" #include "note-spacing.hh" -#include "misc.hh" -#include "warn.hh" -#include "staff-spacing.hh" -#include "spring.hh" +#include "output-def.hh" #include "paper-column.hh" +#include "paper-score.hh" +#include "pointer-group-interface.hh" +#include "separation-item.hh" +#include "skyline-pair.hh" #include "spaceable-grob.hh" -#include "break-align-interface.hh" #include "spacing-interface.hh" +#include "staff-spacing.hh" +#include "system.hh" +#include "warn.hh" - -/* - TODO: this file/class is too complex. Should figure out how to chop - this up even more. - - */ - -class Spacing_spanner -{ -public: - static void standard_breakable_column_spacing (Grob * me, Item*l, Item*r, - Real * fixed, Real * space, Moment); - - - static Real default_bar_spacing (Grob*,Grob*,Grob*,Moment); - static Real note_spacing (Grob*,Grob*,Grob*,Moment, bool*); - static Real get_duration_space (Grob*,Moment dur, Rational shortest, bool*); - static Rational find_shortest (Grob *, Link_array const &); - static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment); - static void find_loose_columns () {} - static void prune_loose_columns (Grob*,Link_array *cols, Rational); - static void find_loose_columns (Link_array cols); - static void set_explicit_neighbor_columns (Link_array cols); - static void set_implicit_neighbor_columns (Link_array cols); - static void do_measure (Rational, Grob*me,Link_array *cols); - static void musical_column_spacing (Grob*,Item*,Item*, Real, Rational); - DECLARE_SCHEME_CALLBACK (set_springs, (SCM )); - static bool has_interface (Grob*); -}; - -/* - Return whether COL is fixed to its neighbors by some kind of spacing - constraint. - - - If in doubt, then we're not loose; the spacing engine should space - for it, risking suboptimal spacing. - - (Otherwise, we might risk core dumps, and other weird stuff.) - -*/ -static bool -loose_column (Grob *l, Grob *c, Grob *r) +vector +Spacing_spanner::get_columns (Grob *me_grob) { - SCM rns = c->get_grob_property ("right-neighbors"); - SCM lns = c->get_grob_property ("left-neighbors"); - - /* - If this column doesn't have a proper neighbor, we should really - make it loose, but spacing it correctly is more than we can - currently can handle. - - (this happens in the following situation: - - | - | clef G - * - - | | || - | | || - O O || - - - the column containing the clef is really loose, and should be - attached right to the first column, but that is a lot of work for - such a borderline case.) - - */ - if (!gh_pair_p (lns) || !gh_pair_p (rns)) - return false; - - Item * l_neighbor = dynamic_cast (unsmob_grob (gh_car (lns))); - Item * r_neighbor = dynamic_cast (unsmob_grob (gh_car (rns))); - - if (!l_neighbor || !r_neighbor) - return false; - - l_neighbor = l_neighbor->get_column (); - r_neighbor = dynamic_cast (Note_spacing::right_column (r_neighbor)); - - if (l == l_neighbor && r == r_neighbor) - return false; - - if (!l_neighbor || !r_neighbor) - return false; - - - - /* - Only declare loose if the bounds make a little sense. This means - some cases (two isolated, consecutive clef changes) won't be - nicely folded, but hey, then don't do that. - */ - if(! ((Paper_column::musical_b (l_neighbor) || Item::breakable_b (l_neighbor)) - && (Paper_column::musical_b (r_neighbor) || Item::breakable_b (r_neighbor))) ) - { - return false; - } - - - /* - A rather hairy check, but we really only want to move around clefs. (anything else?) - - in any case, we don't want to move bar lines. - */ - for (SCM e = c->get_grob_property ("elements"); gh_pair_p (e); e = gh_cdr (e)) - { - Grob * g = unsmob_grob (gh_car (e)); - if (g && Break_align_interface::has_interface (g)) - { - for (SCM s = g->get_grob_property ("elements"); gh_pair_p (s); - s = gh_cdr (s)) - { - Grob *h = unsmob_grob (gh_car (s)); - - /* - ugh. -- fix staff-bar name? - */ - if (h && h->get_grob_property ("break-align-symbol") == ly_symbol2scm ("staff-bar")) - return false; - } - } - } + Spanner *me = dynamic_cast (me_grob); + vector all (get_root_system (me)->used_columns ()); + vsize start = binary_search (all, (Grob*)me->get_bound (LEFT), + &Paper_column::less_than); + vsize end = binary_search (all, (Grob*) me->get_bound (RIGHT), + &Paper_column::less_than); - return true; + all = vector::vector (all.begin () + start, + all.begin () + end + 1); + return all; } -/* - Remove columns that are not tightly fitting from COLS. In the - removed columns, set 'between-cols to the columns where it is in - between. -*/ -void -Spacing_spanner::prune_loose_columns (Grob*me,Link_array *cols, Rational shortest) -{ - Link_array newcols; - Real increment = gh_scm2double (me->get_grob_property ("spacing-increment")); - for (int i=0; i < cols->size (); i++) - { - if (Item::breakable_b (cols->elem(i)) || Paper_column::musical_b (cols->elem (i))) - { - newcols.push (cols->elem(i)); - continue; - } - - Grob *c = cols->elem(i); - if (loose_column (cols->elem (i-1), c, cols->elem (i+1))) - { - SCM lns = c->get_grob_property ("left-neighbors"); - lns = gh_pair_p (lns) ? gh_car (lns) : SCM_BOOL_F; - - SCM rns = c->get_grob_property ("right-neighbors"); - rns = gh_pair_p (rns) ? gh_car (rns) : SCM_BOOL_F; - - /* - Either object can be non existent, if the score ends - prematurely. - */ - rns = gh_car (unsmob_grob (rns)->get_grob_property ("right-items")); - c->set_grob_property ("between-cols", gh_cons (lns, - rns)); - - /* - Set distance constraints for loose columns - */ - Drul_array next_door; - next_door[LEFT] =cols->elem (i - 1); - next_door[RIGHT] =cols->elem (i + 1); - Direction d = LEFT; - Drul_array dists(0,0); - - do - { - dists[d] = 0.0; - Item *lc = dynamic_cast ((d == LEFT) ? next_door[LEFT] : c); - Item *rc = dynamic_cast (d == LEFT ? c : next_door[RIGHT]); - - for (SCM s = lc->get_grob_property ("spacing-wishes"); - gh_pair_p (s); s = gh_cdr (s)) - { - Grob *sp = unsmob_grob (gh_car (s)); - if (Note_spacing::left_column (sp) != lc - || Note_spacing::right_column (sp) != rc) - continue; - - Real space, fixed; - fixed = 0.0; - bool dummy; - - if (d == LEFT) - { - /* - The note spacing should be taken from the musical - columns. - - */ - Real base = note_spacing (me, lc, rc, shortest, &dummy); - Note_spacing::get_spacing (sp, rc, base, increment, &space, &fixed); - - space -= increment; - - dists[d] = dists[d] >? space; - } - else - { - Real space, fixed_space; - Staff_spacing::get_spacing_params (sp, - &space, &fixed_space); - - dists[d] = dists[d] >? fixed_space; - } - - } - } - while (flip (&d) != LEFT); - - Rod r; - r.distance_ = dists[LEFT] + dists[RIGHT]; - r.item_l_drul_[LEFT] = dynamic_cast (cols->elem(i-1)); - r.item_l_drul_[RIGHT] = dynamic_cast (cols->elem (i+1)); - - r.add_to_cols (); - } - else - { - newcols.push (c); - } - } - - *cols = newcols; -} - -/* - Set neighboring columns determined by the spacing-wishes grob property. -*/ -void -Spacing_spanner::set_explicit_neighbor_columns (Link_array cols) -{ - for (int i=0; i < cols.size(); i++) - { - SCM right_neighbors = SCM_EOL; - int min_rank = 100000; // inf. - - - SCM wishes= cols[i]->get_grob_property ("spacing-wishes"); - for (SCM s =wishes; gh_pair_p (s); s = gh_cdr (s)) - { - Item * wish = dynamic_cast (unsmob_grob (gh_car (s))); - - Item * lc = wish->get_column (); - Grob * right = Note_spacing::right_column (wish); - - if (!right) - continue; - - Item * rc = dynamic_cast (right); - - int right_rank = Paper_column::get_rank (rc); - int left_rank = Paper_column::get_rank (lc); - - /* - update the left column. - */ - if (right_rank <= min_rank) - { - if (right_rank < min_rank) - right_neighbors =SCM_EOL; - - min_rank = right_rank; - right_neighbors = gh_cons (wish->self_scm (), right_neighbors); - } - - /* - update the right column of the wish. - */ - int maxrank = 0; - SCM left_neighs = rc->get_grob_property ("left-neighbors"); - if (gh_pair_p (left_neighs) - && unsmob_grob (gh_car (left_neighs))) - { - Item * it = dynamic_cast (unsmob_grob (gh_car (left_neighs))); - maxrank = Paper_column::get_rank (it->get_column ()); - } - - if (left_rank >= maxrank) - { - if (left_rank > maxrank) - left_neighs = SCM_EOL; - - left_neighs = gh_cons (wish->self_scm (), left_neighs); - rc->set_grob_property ("left-neighbors", right_neighbors); - } - } - - if (gh_pair_p (right_neighbors)) - { - cols[i]->set_grob_property ("right-neighbors", right_neighbors); - } - } -} - -/* - Set neighboring columns that have no left/right-neighbor set - yet. Only do breakable non-musical columns, and musical columns. -*/ -void -Spacing_spanner::set_implicit_neighbor_columns (Link_array cols) -{ - for (int i = 0; i < cols.size (); i++) - { - Item * it = dynamic_cast(cols[i]); - if (!Item::breakable_b (it) && !Paper_column::musical_b (it)) - continue; - - // it->breakable || it->musical - - /* - sloppy with typnig left/right-neighbors should take list, but paper-column found instead. - */ - SCM ln = cols[i] ->get_grob_property ("left-neighbors"); - if (!gh_pair_p (ln) && i ) - { - cols[i]->set_grob_property ("left-neighbors", gh_cons (cols[i-1]->self_scm(), SCM_EOL)); - } - - SCM rn = cols[i] ->get_grob_property ("right-neighbors"); - if (!gh_pair_p (rn) && i < cols.size () - 1) - { - cols[i]->set_grob_property ("right-neighbors", gh_cons (cols[i + 1]->self_scm(), SCM_EOL)); - } - } -} - - -MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1); +MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1); SCM Spacing_spanner::set_springs (SCM smob) { - Grob *me = unsmob_grob (smob); - - Link_array all (me->pscore_->system_->columns ()); + Spanner *me = unsmob_spanner (smob); - set_explicit_neighbor_columns (all); - - SCM preset_shortest = me->get_grob_property ("common-shortest-duration"); - Rational global_shortest; - if (unsmob_moment (preset_shortest)) - { - global_shortest = unsmob_moment (preset_shortest)->main_part_; - } - else - { - global_shortest = find_shortest (me, all); - if (verbose_global_b) - { - progress_indication (_f("Global shortest duration is %s\n", global_shortest.to_string ())); - } - } - prune_loose_columns (me, &all, global_shortest); - set_implicit_neighbor_columns (all); + /* + can't use get_system () ? --hwn. + */ + Spacing_options options; + options.init_from_grob (me); + vector cols = Spacing_spanner::get_columns (me); + set_explicit_neighbor_columns (cols); - - int j = 0; - for (int i = 1; i < all.size (); i++) - { - Grob *sc = all[i]; - if (Item::breakable_b (sc)) - { - Link_array measure (all.slice (j, i+1)); - do_measure (global_shortest, me, &measure); - j = i; - } - } + prune_loose_columns (me, &cols, &options); + set_implicit_neighbor_columns (cols); + generate_springs (me, cols, &options); return SCM_UNSPECIFIED; } - /* We want the shortest note that is also "common" in the piece, so we find the shortest in each measure, and take the most frequently @@ -414,47 +72,52 @@ Spacing_spanner::set_springs (SCM smob) This probably gives weird effects with modern music, where every note has a different duration, but hey, don't write that kind of stuff, then. - */ -Rational -Spacing_spanner::find_shortest (Grob *me, Link_array const &cols) + +MAKE_SCHEME_CALLBACK (Spacing_spanner, calc_common_shortest_duration, 1); +SCM +Spacing_spanner::calc_common_shortest_duration (SCM grob) { + Spanner *me = unsmob_spanner (grob); + + vector cols (get_columns (me)); + /* ascending in duration - */ - Array durations; - Array counts; - + */ + vector durations; + vector counts; + Rational shortest_in_measure; shortest_in_measure.set_infinite (1); - - for (int i =0 ; i < cols.size (); i++) + + for (vsize i = 0; i < cols.size (); i++) { - if (Paper_column::musical_b (cols[i])) + if (Paper_column::is_musical (cols[i])) { - Moment *when = unsmob_moment (cols[i]->get_grob_property ("when")); + Moment *when = unsmob_moment (cols[i]->get_property ("when")); /* ignore grace notes for shortest notes. */ if (when && when->grace_part_) continue; - - SCM st = cols[i]->get_grob_property ("shortest-starter-duration"); + + SCM st = cols[i]->get_property ("shortest-starter-duration"); Moment this_shortest = *unsmob_moment (st); - assert (this_shortest.to_bool()); - shortest_in_measure = shortest_in_measure shortest_in_measure) { - counts.insert (1, j); - durations.insert (shortest_in_measure, j); + counts.insert (counts.begin () + j, 1); + durations.insert (durations.begin () + j, shortest_in_measure); break; } else if (durations[j] == shortest_in_measure) @@ -464,500 +127,416 @@ Spacing_spanner::find_shortest (Grob *me, Link_array const &cols) } } - if (durations.size() == j) + if (durations.size () == j) { - durations.push (shortest_in_measure); - counts.push (1); + durations.push_back (shortest_in_measure); + counts.push_back (1); } - shortest_in_measure.set_infinite(1); + shortest_in_measure.set_infinite (1); } } - int max_idx = -1; + vsize max_idx = VPOS; int max_count = 0; - for (int i =durations.size(); i--;) + for (vsize i = durations.size (); i--;) { if (counts[i] >= max_count) { max_idx = i; max_count = counts[i]; } - - // printf ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]); } - SCM bsd = me->get_grob_property ("base-shortest-duration"); - Rational d = Rational (1,8); + SCM bsd = me->get_property ("base-shortest-duration"); + Rational d = Rational (1, 8); if (Moment *m = unsmob_moment (bsd)) d = m->main_part_; - - if (max_idx >= 0) - d = d *cols) +Spacing_spanner::generate_pair_spacing (Grob *me, + Paper_column *left_col, Paper_column *right_col, + Paper_column *after_right_col, + Spacing_options const *options) { - - Real headwid = gh_scm2double (me->get_grob_property ("spacing-increment")); - for (int i= 0; i < cols->size () - 1; i++) + if (Paper_column::is_musical (left_col)) { - Item * l = dynamic_cast (cols->elem (i)); - Item * r = dynamic_cast (cols->elem (i+1)); - - Paper_column * lc = dynamic_cast (l); - Paper_column * rc = dynamic_cast (r); - - if (!Paper_column::musical_b (l)) + if (!Paper_column::is_musical (right_col) + && options->float_nonmusical_columns_ + && after_right_col + && Paper_column::is_musical (after_right_col)) { - breakable_column_spacing (me, l, r, shortest); - /* - - The case that the right part is broken as well is rather - rare, but it is possible, eg. with a single empty measure, - or if one staff finishes a tad earlier than the rest. - - */ - Item *lb = l->find_prebroken_piece (RIGHT); - Item *rb = r->find_prebroken_piece (LEFT); - - if (lb) - breakable_column_spacing (me, lb,r, shortest); - - if (rb) - breakable_column_spacing (me, l, rb, shortest); - if (lb && rb) - breakable_column_spacing (me, lb, rb, shortest); - - continue ; + TODO: should generate rods to prevent collisions. + */ + musical_column_spacing (me, left_col, after_right_col, options); + right_col->set_object ("between-cols", scm_cons (left_col->self_scm (), + after_right_col->self_scm ())); } + else + musical_column_spacing (me, left_col, right_col, options); + if (Item *rb = right_col->find_prebroken_piece (LEFT)) + musical_column_spacing (me, left_col, rb, options); + } + else + { + /* + The case that the right part is broken as well is rather + rare, but it is possible, eg. with a single empty measure, + or if one staff finishes a tad earlier than the rest. + */ + Item *lb = left_col->find_prebroken_piece (RIGHT); + Item *rb = right_col->find_prebroken_piece (LEFT); - musical_column_spacing (me, lc, rc, headwid, shortest); - if (Item *rb = r->find_prebroken_piece (LEFT)) - musical_column_spacing (me, lc, rb, headwid, shortest); - } -} + if (left_col && right_col) + breakable_column_spacing (me, left_col, right_col, options); + if (lb && right_col) + breakable_column_spacing (me, lb, right_col, options); -/* - Generate the space between two musical columns LC and RC, given - spacing parameters INCR and SHORTEST. - */ -void -Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real increment, Rational shortest) -{ - bool expand_only = false; - Real base_note_space = note_spacing (me, lc, rc, shortest, &expand_only); + if (left_col && rb) + breakable_column_spacing (me, left_col, rb, options); - Real compound_note_space = 0.0; - Real compound_fixed_note_space = 0.0; - int wish_count = 0; - - SCM seq = lc->get_grob_property ("right-neighbors"); + if (lb && rb) + breakable_column_spacing (me, lb, rb, options); + } +} - /* - We adjust the space following a note only if the next note - happens after the current note (this is set in the grob - property SPACING-SEQUENCE. - */ - for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s)) +static void +set_column_rods (vector const &cols, Real padding) +{ + /* distances[i] will be the minimum distance between column i and column i+1 */ + vector distances; + + for (vsize i = 1; i < cols.size (); i++) { - Grob * wish = unsmob_grob (gh_car (s)); + assert (distances.size () == i-1); - Item *wish_rcol = Note_spacing::right_column (wish); - if (Note_spacing::left_column (wish) != lc - || (wish_rcol != rc && wish_rcol != rc->original_)) - continue; + Item *r = dynamic_cast (cols[i]); + Item *rb = r->find_prebroken_piece (LEFT); - /* - This is probably a waste of time in the case of polyphonic - music. */ - if (Note_spacing::has_interface (wish)) + if (Separation_item::is_empty (r) && (!rb || Separation_item::is_empty (rb))) { - Real space =0.0; - Real fixed =0.0; - - Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed); - - - compound_note_space = compound_note_space + space; - compound_fixed_note_space = compound_fixed_note_space + fixed; - wish_count ++; - + distances.push_back (0); + continue; } - } - if (Paper_column::when_mom (rc).grace_part_ && - !Paper_column::when_mom (lc).grace_part_) - { - /* - Ugh. 0.8 is arbitrary. - */ - compound_note_space *= 0.8; - } - - if (compound_note_space < 0 || wish_count == 0) - { - compound_note_space = base_note_space; - compound_fixed_note_space = increment; - } - else - { - compound_note_space /= wish_count; - compound_fixed_note_space /= wish_count; - } + Skyline_pair *skys = Skyline_pair::unsmob (r->get_property ("horizontal-skylines")); + Real right_stickout = skys ? (*skys)[LEFT].max_height () : 0.0; - /* - Whatever we do, the fixed space is smaller than the real - space. + /* min rather than max because right-stickout will be negative if the right-hand column + sticks out a lot to the left */ + right_stickout = min (right_stickout, + Separation_item::conditional_skyline (r, cols[i-1]).max_height ()); - TODO: this criterion is discontinuous in the derivative. - Maybe it should be continuous? - */ - compound_fixed_note_space = compound_fixed_note_space r_cols (r, rb); + Drul_array cur_dist (0.0, 0.0); - bool packed = to_boolean (me->get_paper ()->get_scmvar ("packed")); - Real strength, distance; + /* This is an inner loop and hence it is potentially quadratic. However, we only continue + as long as there is a rod to insert. Therefore, this loop will usually only execute + a constant number of times per iteration of the outer loop. */ + for (vsize j = i; j--;) + { + Item *l = dynamic_cast (cols[j]); + Item *lb = l->find_prebroken_piece (RIGHT); + Skyline_pair *skys = Skyline_pair::unsmob (l->get_property ("horizontal-skylines")); + Real left_stickout = skys ? (*skys)[RIGHT].max_height () : 0.0; + bool done = true; - /* - TODO: make sure that the space doesn't exceed the right margin. - */ - if (packed) - { - /* - In packed mode, pack notes as tight as possible. This makes - sense mostly in combination with raggedright mode: the notes - are then printed at minimum distance. This is mostly useful - for ancient notation, but may also be useful for some flavours - of contemporary music. If not in raggedright mode, lily will - pack as much bars of music as possible into a line, but the - line will then be stretched to fill the whole linewidth. - */ - strength = 1.0; - distance = compound_fixed_note_space; - } - else - { - strength = 1 / (compound_note_space - compound_fixed_note_space); - distance = compound_note_space; - } + Direction d = LEFT; + do + { + if (j < i-1) + cur_dist[d] += distances[j]; - // Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only); + Item *r_col = r_cols[d]; + bool touches = right_stickout - left_stickout + cur_dist[d] < 0.0; + Real dist = 0.0; - Spaceable_grob::add_spring (lc, rc, distance, strength, false); -} + /* we set a distance for the line-starter column even if it's non-broken counterpart + doesn't touch the right column. */ + if (lb) + Separation_item::set_distance (lb, r_col, padding); + if (touches || j == i-1) + dist = Separation_item::set_distance (l, r_col, padding); -/* - The one-size-fits all spacing. It doesn't take into account - different spacing wishes from one to the next column. - */ -void -Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r, - Real * fixed, Real * space, - Moment shortest) -{ - *fixed = 0.0; - Direction d = LEFT; - Drul_array cols(l,r); - - do - { - if (!Paper_column::musical_b (cols[d])) - { - /* - Tied accidentals over barlines cause problems, so lets see - what happens if we do this for non musical columns only. - */ - Interval lext = cols[d]->extent (cols [d], X_AXIS); - if (!lext.is_empty ()) - *fixed += -d * lext[-d]; + if (j == i-1 && d == LEFT) + distances.push_back (dist); + + if (j == i-1) + cur_dist[d] = distances[j]; + + done = done && !touches; + } + while (flip (&d) != LEFT && rb); + + /* we need the empty check for gregorian notation, where there are a lot of + extraneous paper-columns that we need to skip over */ + if (done && !Separation_item::is_empty (l)) + break; } } - while (flip (&d) != LEFT); - +} + - if (l->breakable_b (l) && r->breakable_b(r)) +void +Spacing_spanner::generate_springs (Grob *me, + vector const &cols, + Spacing_options const *options) +{ + Paper_column *prev = dynamic_cast (cols[0]); + for (vsize i = 1; i < cols.size (); i++) { - Moment *dt = unsmob_moment (l->get_grob_property ("measure-length")); - Moment mlen (1); - if (dt) - mlen = *dt; + Paper_column *col = dynamic_cast (cols[i]); + Paper_column *next = (i + 1 < cols.size ()) ? dynamic_cast (cols[i+1]) : 0; - Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); + generate_pair_spacing (me, prev, col, next, options); - *space = *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8; + prev = col; } - else - { - Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - if (dt == Moment (0,0)) - { - /* - In this case, Staff_spacing should handle the job, - using dt when it is 0 is silly. - */ - *space = *fixed + 0.5; - } - else - { - bool dummy; - *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy); - } - } + set_column_rods (cols, 0.1); // FIXME: padding } - /* - Read hints from L and generate springs. + Generate the space between two musical columns LEFT_COL and RIGHT_COL. */ void -Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest) +Spacing_spanner::musical_column_spacing (Grob *me, + Item *left_col, + Item *right_col, + Spacing_options const *options) { - Real compound_fixed = 0.0; - Real compound_space = 0.0; - int wish_count = 0; - - Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); + Real base_note_space = note_spacing (me, left_col, right_col, options); + Spring spring; - if (dt == Moment (0,0)) + if (options->stretch_uniformly_) + spring = Spring (base_note_space, 0.0); + else { - for (SCM s = l->get_grob_property ("spacing-wishes"); - gh_pair_p (s); s = gh_cdr (s)) + vector springs; + extract_grob_set (left_col, "right-neighbors", neighbors); + + for (vsize i = 0; i < neighbors.size (); i++) { - Item * spacing_grob = dynamic_cast (unsmob_grob (gh_car (s))); + Grob *wish = neighbors[i]; - if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + Item *wish_rcol = Spacing_interface::right_column (wish); + if (Spacing_interface::left_column (wish) != left_col + || (wish_rcol != right_col && wish_rcol != right_col->original ())) continue; - Real space; - Real fixed_space; - /* - column for the left one settings should be ok due automatic - pointer munging. - - */ - assert (spacing_grob-> get_column () == l); + This is probably a waste of time in the case of polyphonic + music. */ + if (Note_spacing::has_interface (wish)) + { + Real inc = options->increment_; + Grob *gsp = unsmob_grob (left_col->get_object ("grace-spacing")); + if (gsp && Paper_column::when_mom (left_col).grace_part_) + { + Spacing_options grace_opts; + grace_opts.init_from_grob (gsp); + inc = grace_opts.increment_; + } + springs.push_back (Note_spacing::get_spacing (wish, right_col, base_note_space, inc)); + } + } - Staff_spacing::get_spacing_params (spacing_grob, - &space, &fixed_space); + if (springs.empty ()) + { - if (Paper_column::when_mom (r).grace_part_) + if (!Paper_column::is_musical (right_col)) { /* - Correct for grace notes. - - Ugh. The 0.8 is arbitrary. + There used to be code that examined left_col->extent + (X_AXIS), but this is resulted in unexpected wide + spacing, because the width of s^"text" output is also + taken into account here. + */ + spring = Spring (max (base_note_space, options->increment_), + options->increment_); + } + else + { + /* + Min distance should be 0.0. If there are no spacing + wishes, we're probably dealing with polyphonic spacing + of hemiolas. */ - space *= 0.8; + spring = Spring (base_note_space, 0.0); } - - - compound_space += space; - compound_fixed += fixed_space; - wish_count ++ ; } + else + spring = merge_springs (springs); } - if (compound_space <= 0.0 || !wish_count) + if (Paper_column::when_mom (right_col).grace_part_ + && !Paper_column::when_mom (left_col).grace_part_) { - standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space , - shortest); - wish_count = 1; + /* + Ugh. 0.8 is arbitrary. + */ + spring *= 0.8; } - else + + /* + TODO: make sure that the space doesn't exceed the right margin. + */ + if (options->packed_) { - compound_space /= wish_count; - compound_fixed /= wish_count; + /* + In packed mode, pack notes as tight as possible. This makes + sense mostly in combination with ragged-right mode: the notes + are then printed at minimum distance. This is mostly useful + for ancient notation, but may also be useful for some flavours + of contemporary music. If not in ragged-right mode, lily will + pack as many bars of music as possible into a line, but the + line will then be stretched to fill the whole linewidth. + + Note that we don't actually pack things as tightly as possible: + we don't allow the next column to begin before this one ends. + */ + spring.set_distance (max (left_col->extent (left_col, X_AXIS)[RIGHT], + spring.min_distance ())); + spring.set_inverse_stretch_strength (1.0); } - assert (!isinf (compound_space)); - compound_space = compound_space >? compound_fixed; + Spaceable_grob::add_spring (left_col, right_col, spring); +} + +/* + Check if COL fills the whole measure. + */ +bool +Spacing_spanner::fills_measure (Grob *me, Item *left, Item *col) +{ + System *sys = get_root_system (me); + Item *next = sys->column (col->get_column ()->get_rank () + 1); + if (!next) + return false; + if (Paper_column::is_musical (next) + || Paper_column::is_musical (left) + || !Paper_column::is_musical (col) + || !Paper_column::is_used (next)) + return false; + + Moment dt = + Paper_column::when_mom (next) - Paper_column::when_mom (col); + + Moment *len = unsmob_moment (left->get_property ("measure-length")); + if (!len) + return false; /* - Hmm. we do 1/0 in the next thing. Perhaps we should check if this - works on all architectures. + Don't check for exact measure length, since ending measures are + often shortened due to pickups. */ + if (dt.main_part_ > len->main_part_ / Rational (2) + && (next->is_broken () + || next->break_status_dir ())) + return true; - /* - There used to be code that changed spacing depending on - raggedright setting. Ugh. - - Do it more cleanly, or rename the property. - - */ - Real strength = 1 / (compound_space - compound_fixed); - Real distance = compound_space; - Spaceable_grob::add_spring (l, r, distance, strength, false); + return false; } - -/** - Get the measure wide ant for arithmetic spacing. - */ -Real -Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only) +/* + Read hints from L and generate springs. +*/ +void +Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, + Spacing_options const *options) { - Real k = gh_scm2double (me->get_grob_property ("shortest-duration-space")); - Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); - - if (d < shortest) - { - /* - We don't space really short notes using the log of the - duration, since it would disproportionally stretches the long - notes in a piece. In stead, we use geometric spacing with constant 0.5 - (i.e. linear.) - - This should probably be tunable, to use other base numbers. + vector springs; + Spring spring; - In Mozart hrn3 by EB., we have 8th note = 3.9 mm (total), 16th note = - 3.6 mm (total). head-width = 2.4, so we 1.2mm for 16th, 1.5 - mm for 8th. (white space), suggesting that we use + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - (1.2 / 1.5)^{-log2(duration ratio)} - + if (dt == Moment (0, 0)) + { + extract_grob_set (l, "spacing-wishes", wishes); - */ - Rational ratio = d.main_part_ / shortest; + for (vsize i = 0; i < wishes.size (); i++) + { + Item *spacing_grob = dynamic_cast (wishes[i]); - return ((k-1) + double (ratio)) * incr; - } - else - { - /* - John S. Gourlay. ``Spacing a Line of Music,'' Technical - Report OSU-CISRC-10/87-TR35, Department of Computer and - Information Science, The Ohio State University, 1987. - */ - Real log = log_2 (shortest); - k -= log; - Rational compdur = d.main_part_ + d.grace_part_ /Rational (3); - *expand_only = false; - - return (log_2 (compdur) + k) * incr; - } -} + if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + continue; -Real -Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc, - Moment shortest, bool * expand_only) -{ - Moment shortest_playing_len = 0; - SCM s = lc->get_grob_property ("shortest-playing-duration"); + /* + column for the left one settings should be ok due automatic + pointer munging. + */ + assert (spacing_grob->get_column () == l); - if (unsmob_moment (s)) - shortest_playing_len = *unsmob_moment (s); - - if (! shortest_playing_len.to_bool ()) - { - programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).to_string ()); - shortest_playing_len = 1; + springs.push_back (Staff_spacing::get_spacing (spacing_grob, r)); + } } - Moment lwhen = Paper_column::when_mom (lc); - Moment rwhen = Paper_column::when_mom (rc); + if (springs.empty ()) + spring = standard_breakable_column_spacing (me, l, r, options); + else + spring = merge_springs (springs); - Moment delta_t = rwhen - lwhen; - if (!Paper_column::musical_b (rc )) + if (Paper_column::when_mom (r).grace_part_) { /* - when toying with mmrests, it is possible to have musical - column on the left and non-musical on the right, spanning - several measures. - - In 2.0.1, this still fucks up in an interesting way: - - -\score { -{ \property Score.skipBars = ##t - \context Staff = clarinet - { - \notes { - \time 3/4 \mark "72" -<< s1*0^"all" R4*3*11 >> - \mark "73" - R4*3*11 \mark "74" - d2 r4 - - - }}} - \paper { raggedright = ##t } -} - + Correct for grace notes. - */ - - Moment *dt = unsmob_moment (rc->get_grob_property ("measure-length")); - if (dt) - delta_t = delta_t ? delta_t; - if (delta_t.main_part_ && !lwhen.grace_part_) + if (Paper_column::is_musical (r) + && l->break_status_dir () == CENTER + && fills_measure (me, l, r)) { - dist = get_duration_space (me, shortest_playing_len, shortest.main_part_, expand_only); - dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_); + spring.set_distance (spring.distance () + 1.0); + spring.set_default_strength (); } - else if (delta_t.grace_part_) + + if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT) { - /* - TODO: figure out how to space grace notes. - */ - dist = get_duration_space (me, shortest, shortest.main_part_, expand_only); - - Real grace_fact = 1.0; - SCM gf = me->get_grob_property ("grace-space-factor"); - if (gh_number_p (gf)) - grace_fact = gh_scm2double (gf); - - dist *= grace_fact; + spring.set_min_distance (0.0); + spring.set_default_strength (); } - - return dist; + Spaceable_grob::add_spring (l, r, spring); } - - -ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface", -"The space taken by a note is dependent on its duration. Doubling a\n" -"duration adds spacing-increment to the space. The most common shortest\n" -"note gets shortest-duration-space. Notes that are even shorter are\n" -"spaced proportonial to their duration.\n" -"\n" -"Typically, the increment is the width of a black note head. In a\n" -"piece with lots of 8th notes, and some 16th notes, the eighth note\n" -"gets 2 note heads width (i.e. the space following a note is 1 note\n" -"head width) A 16th note is followed by 0.5 note head width. The\n" -"quarter note is followed by 3 NHW, the half by 4 NHW, etc.\n", - "grace-space-factor spacing-increment base-shortest-duration shortest-duration-space common-shortest-duration"); - - - -ADD_INTERFACE (Spacing_interface,"spacing-interface", - "Something to do with line breaking and spacing. Kill this one after determining line breaks.", - ""); +ADD_INTERFACE (Spacing_spanner, + "The space taken by a note is dependent on its duration." + " Doubling a duration adds @code{spacing-increment} to the" + " space. The most common shortest note gets" + " @code{shortest-duration-space}. Notes that are even shorter" + " are spaced proportonial to their duration.\n" + "\n" + "Typically, the increment is the width of a black note head." + " In a piece with lots of 8th notes, and some 16th notes, the" + " eighth note gets a 2@tie{}note heads width (i.e., the space" + " following a note is a 1@tie{}note head width). A 16th note" + " is followed by 0.5 note head width. The quarter note is" + " followed by 3@tie{}NHW, the half by 4@tie{}NHW, etc.", + + /* properties */ + "average-spacing-wishes " + "base-shortest-duration " + "common-shortest-duration " + "packed-spacing " + "shortest-duration-space " + "spacing-increment " + "strict-grace-spacing " + "strict-note-spacing " + "uniform-stretching " + );