X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=f56af93598cc577404b9690d27527a2a87922cb2;hb=545092a25d8ca41dc90b87482474b3719f7130a9;hp=b087ffde981c597e6adb7ca6f7d4e0fb4bdb4b6c;hpb=62cfd82cd3794a9d0dd4329c6a8d070e52f5857d;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index b087ffde98..f56af93598 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,368 +1,73 @@ -/* +/* spacing-spanner.cc -- implement Spacing_spanner - + source file of the GNU LilyPond music typesetter - - (c) 1999--2002 Han-Wen Nienhuys - - */ + + (c) 1999--2005 Han-Wen Nienhuys +*/ #include -#include -#include "line-of-score.hh" -#include "paper-def.hh" -#include "paper-score.hh" +#include +using namespace std; + +#include "spacing-spanner.hh" #include "paper-column.hh" -#include "item.hh" +#include "output-def.hh" +#include "paper-score.hh" +#include "system.hh" #include "moment.hh" #include "note-spacing.hh" -#include "misc.hh" +#include "main.hh" #include "warn.hh" -#include "staff-spacing.hh" -#include "spring.hh" -#include "paper-column.hh" +#include "pointer-group-interface.hh" #include "spaceable-grob.hh" +#include "staff-spacing.hh" +#include "spacing-interface.hh" -/* - paper-column: - - Don't be confused by right-items: each spacing wish can also contain - a number of items, with which a spacing constraint may be kept. It's - a little baroque, but it might come in handy later on? - - */ -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 (Link_array const &); - static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment); - static void find_loose_columns () {} - static void prune_loose_colunms (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 )); -}; - -/* - Return whether COL is fixed to its neighbors by some kind of spacing - constraint. -*/ -static bool -loose_column (Grob *l, Grob *c, Grob *r) -{ - 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->column_l(); - 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 true; - } - - - /* - If in doubt: we're not loose; the spacing engine should space for - it, risking suboptimal spacing. - - (Otherwise, we might risk core dumps, and other weird stuff.) - - */ - return false; -} - -/* - 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_colunms (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_f_ = 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) +Rational +Spacing_spanner::effective_shortest_duration (Grob *me, + Link_array const &all) { - for (int i=0; i < cols.size(); i++) + SCM preset_shortest = me->get_property ("common-shortest-duration"); + Rational global_shortest; + if (unsmob_moment (preset_shortest)) + global_shortest = unsmob_moment (preset_shortest)->main_part_; + else { - 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->column_l (); - Grob * right = Note_spacing::right_column (wish); - - if (!right) - continue; - - Item * rc = dynamic_cast (right); - - int right_rank = Paper_column::rank_i (rc); - int left_rank = Paper_column::rank_i (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::rank_i (it->column_l()); - } - - 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); - } + global_shortest = Spacing_spanner::find_shortest (me, all); + if (be_verbose_global) + message (_f ("Global shortest duration is %s", global_shortest.to_string ()) + "\n"); } -} -/* - 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)); - } - } + return global_shortest; } -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_l_->line_l_->column_l_arr ()) ; + /* + can't use get_system() ? --hwn. + */ + Link_array all (get_root_system (me)->columns ()); set_explicit_neighbor_columns (all); - Rational global_shortest = find_shortest (all); - prune_loose_colunms (me, &all, global_shortest); - set_implicit_neighbor_columns (all); + Spacing_options options; + options.init_from_grob (me); + options.global_shortest_ = effective_shortest_duration (me, all); - - 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, &all, &options); + set_implicit_neighbor_columns (all); + generate_springs (me, all, &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 @@ -371,42 +76,41 @@ 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 (Link_array const &cols) +Spacing_spanner::find_shortest (Grob *me, Link_array const &cols) { /* ascending in duration - */ - Array durations; + */ + Array durations; Array counts; - + Rational shortest_in_measure; shortest_in_measure.set_infinite (1); - - for (int i =0 ; i < cols.size (); i++) + + for (int 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) { @@ -421,19 +125,19 @@ Spacing_spanner::find_shortest (Link_array const &cols) } } - if (durations.size() == j) + if (durations.size () == j) { durations.push (shortest_in_measure); counts.push (1); } - shortest_in_measure.set_infinite(1); + shortest_in_measure.set_infinite (1); } } int max_idx = -1; int max_count = 0; - for (int i =durations.size(); i--;) + for (int i = durations.size (); i--;) { if (counts[i] >= max_count) { @@ -441,332 +145,315 @@ Spacing_spanner::find_shortest (Link_array const &cols) max_count = counts[i]; } - printf ("duration %d/%d, count %d\n", durations[i].num (), durations[i].den (), counts[i]); + // printf ("duration %d/%d, count %d\n", + // durations[i].num (), durations[i].den (), counts[i]); } - /* - TODO: 1/8 should be adjustable? - */ - 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)); + bool skip_unbroken_right = false; - Paper_column * lc = dynamic_cast (l); - Paper_column * rc = dynamic_cast (r); + if (!Paper_column::is_musical (right_col) + && options->float_nonmusical_columns_ + && after_right_col + && Paper_column::is_musical (after_right_col)) + skip_unbroken_right = true; - if (!Paper_column::musical_b (l)) + if (skip_unbroken_right) { - 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); - - musical_column_spacing (me, lc, rc, headwid, shortest); - if (Item *rb = r->find_prebroken_piece (LEFT)) - musical_column_spacing (me, lc, rb, headwid, shortest); - } -} - - -/* - Generate the space between two musical columns LC and RC, given spacing parameters INCR and SHRTEST. - */ -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); - - Real max_note_space = -infinity_f; - Real max_fixed_note_space = -infinity_f; - - SCM seq = lc->get_grob_property ("right-neighbors"); - - /* - 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)) + if (Item *rb = right_col->find_prebroken_piece (LEFT)) + musical_column_spacing (me, left_col, rb, options); + } + else { - Grob * wish = unsmob_grob (gh_car (s)); + /* + 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); - Item *wish_rcol = Note_spacing::right_column (wish); - if (Note_spacing::left_column (wish) != lc - || (wish_rcol != rc && wish_rcol != rc->original_l_)) - continue; + if (left_col && right_col) + breakable_column_spacing (me, left_col, right_col, options); - /* - This is probably a waste of time in the case of polyphonic - music. */ - if (Note_spacing::has_interface (wish)) - { - Real space =0.0; - Real fixed =0.0; - - Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed); - max_note_space = max_note_space >? space; - max_fixed_note_space = max_fixed_note_space >? fixed; - } - } + if (lb && right_col) + breakable_column_spacing (me, lb, right_col, options); - if (max_note_space < 0) - { - max_note_space = base_note_space; - max_fixed_note_space = increment; - } + if (left_col && rb) + breakable_column_spacing (me, left_col, rb, options); - bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright")); - Real strength = (ragged) ? 1.0 : 1 / (max_note_space - max_fixed_note_space); - Real distance = (ragged) ? max_fixed_note_space : max_note_space; - Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only); + if (lb && rb) + breakable_column_spacing (me, lb, rb, options); + } } void -Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r, - Real * fixed, Real * space, - Moment shortest) +Spacing_spanner::generate_springs (Grob *me, + Link_array const &cols, + Spacing_options const *options) { - *fixed = l->extent (l, X_AXIS)[RIGHT] - r->extent (r, X_AXIS)[LEFT]; - - if (l->breakable_b (l) && r->breakable_b(r)) + Paper_column *next = 0; + Paper_column *next_next = 0; + for (int i = cols.size (); i--;) { - Moment *dt = unsmob_moment (l->get_grob_property ("measure-length")); - Moment mlen (1); - if (dt) - mlen = *dt; - - Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); - - *space = *fixed + incr * double (mlen.main_part_ / shortest.main_part_) * 0.8; - } - else - { - Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); - bool dummy; + Paper_column *col = dynamic_cast (cols[i]); + if (next) + generate_pair_spacing (me, col, next, next_next, options); - *space = *fixed + get_duration_space (me, dt, shortest.main_part_, &dummy); + next_next = next; + next = col; } - - } - /* - Read hints from L and generate springs. - */ + Generate the space between two musical columns LEFT_COL and RIGHT_COL, given + spacing parameters INCR and SHORTEST. +*/ 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 max_fixed = -infinity_f; - Real max_space = -infinity_f; - - standard_breakable_column_spacing (me, l, r, &max_fixed, &max_space , - shortest); - - for (SCM s = l->get_grob_property ("spacing-wishes"); - gh_pair_p (s); s = gh_cdr (s)) - { - Item * spacing_grob = dynamic_cast (unsmob_grob (gh_car (s))); + bool expand_only = false; + Real base_note_space = note_spacing (me, left_col, right_col, options, &expand_only); - if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) - continue; + Real compound_note_space = 0.0; + Real compound_fixed_note_space = 0.0; - Real space; - Real fixed_space; + if (options->stretch_uniformly_) + compound_note_space = base_note_space; + else + { + int wish_count = 0; - /* - column for the left one settings should be ok due automatic - pointer munging. + extract_grob_set (left_col, "right-neighbors", neighbors); + /* + 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. */ - assert (spacing_grob-> column_l () == l); + for (int i = 0; i < neighbors.size (); i++) + { + Grob *wish = neighbors[i]; + + Item *wish_rcol = Note_spacing::right_column (wish); + if (Note_spacing::left_column (wish) != left_col + || (wish_rcol != right_col && wish_rcol != right_col->original ())) + continue; + + /* + This is probably a waste of time in the case of polyphonic + music. */ + if (Note_spacing::has_interface (wish)) + { + Real space = 0.0; + Real fixed = 0.0; + + Note_spacing::get_spacing (wish, right_col, base_note_space, options->increment_, &space, &fixed); - Staff_spacing::get_spacing_params (spacing_grob, - &space, &fixed_space); - if (space > max_space) + compound_note_space = compound_note_space + space; + compound_fixed_note_space = compound_fixed_note_space + fixed; + wish_count++; + } + } + + if (Paper_column::when_mom (right_col).grace_part_ + && !Paper_column::when_mom (left_col).grace_part_) { - max_space = space; - max_fixed = fixed_space; + /* + 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 = options->increment_; + } + else + { + compound_note_space /= wish_count; + compound_fixed_note_space /= wish_count; + } - if (isinf (max_space)) - { - programming_error ("No pref spacing found"); - max_space = 2.0; - max_fixed = 1.0; - } + /* + Whatever we do, the fixed space is smaller than the real + space. - - if (l->break_status_dir() == RIGHT - && Paper_column::when_mom (l) == Paper_column::when_mom (r)) - { - /* Start of line: this space is not stretchable */ - max_fixed = max_space; + TODO: this criterion is discontinuous in the derivative. + Maybe it should be continuous? + */ + compound_fixed_note_space = min (compound_fixed_note_space, + compound_note_space); } - /* - Hmm. we do 1/0 in the next thing. Perhaps we should check if this - works on all architectures. - */ - - bool ragged = to_boolean (me->paper_l ()->get_scmvar ("raggedright")); - Real strength = (ragged) ? 1.0 : 1 / (max_space - max_fixed); - Real distance = (ragged) ? max_fixed : max_space; - Spaceable_grob::add_spring (l, r, distance, strength, false); -} - + Real inverse_strength = 1.0; + Real distance = 1.0; -/** - Get the measure wide ant for arithmetic spacing. + /* + TODO: make sure that the space doesn't exceed the right margin. */ -Real -Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool * expand_only) -{ - Real k = gh_scm2double (me->get_grob_property ("shortest-duration-space")); - Real incr = gh_scm2double (me->get_grob_property ("spacing-increment")); - - if (d < shortest) + if (options->packed_) { /* - 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. - - 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 - - (1.2 / 1.5)^{-log2(duration ratio)} - - - */ - Rational ratio = d.main_part_ / shortest; - - *expand_only = true; - return ((k-1) + double (ratio)) * incr; + 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. + */ + inverse_strength = 1.0; + distance = compound_fixed_note_space; } 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; + inverse_strength = (compound_note_space - compound_fixed_note_space); + distance = compound_note_space; } + + Spaceable_grob::add_spring (left_col, right_col, distance, inverse_strength); } -Real -Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc, - Moment 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) { - Moment shortest_playing_len = 0; - SCM s = lc->get_grob_property ("shortest-playing-duration"); + Real compound_fixed = 0.0; + Real compound_space = 0.0; + int wish_count = 0; - if (unsmob_moment (s)) - shortest_playing_len = *unsmob_moment (s); - - if (! shortest_playing_len.to_bool ()) + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); + + if (dt == Moment (0, 0)) { - programming_error ("can't find a ruling note at " + Paper_column::when_mom (lc).str ()); - shortest_playing_len = 1; - } + extract_grob_set (l, "spacing-wishes", wishes); - Moment lwhen = Paper_column::when_mom (lc); - Moment rwhen = Paper_column::when_mom (rc); + for (int i = 0; i < wishes.size (); i++) + { + Item *spacing_grob = dynamic_cast (wishes[i]); + + if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) + continue; - Moment delta_t = rwhen - lwhen; - Real dist = 0.0; + Real space; + Real fixed_space; - if (delta_t.main_part_ && !lwhen.grace_part_) + /* + column for the left one settings should be ok due automatic + pointer munging. + + */ + assert (spacing_grob->get_column () == l); + + Staff_spacing::get_spacing_params (spacing_grob, + &space, &fixed_space); + + if (Paper_column::when_mom (r).grace_part_) + { + /* + Correct for grace notes. + + Ugh. The 0.8 is arbitrary. + */ + space *= 0.8; + } + + compound_space += space; + compound_fixed += fixed_space; + wish_count++; + } + } + + if (compound_space <= 0.0 || !wish_count) { - dist = get_duration_space (me, shortest_playing_len, shortest.main_part_, expand_only); - dist *= (double) (delta_t.main_part_ / shortest_playing_len.main_part_); + standard_breakable_column_spacing (me, l, r, &compound_fixed, &compound_space, + options); + wish_count = 1; } - else if (delta_t.grace_part_) + else { - /* - 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; + compound_space /= wish_count; + compound_fixed /= wish_count; } - - return dist; -} + if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT) + compound_fixed = 0.0; + assert (!isinf (compound_space)); + compound_space = max (compound_space, compound_fixed); + /* + There used to be code that changed spacing depending on + raggedright setting. Ugh. -ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface", - " -The space taken by a note is dependent on its duration. Doubling a -duration adds spacing-increment to the space. The most common shortest -note gets shortest-duration-space. Notes that are even shorter are -spaced proportonial to their duration. + Do it more cleanly, or rename the property. + + */ + Real inverse_strength = (compound_space - compound_fixed); + Real distance = compound_space; + Spaceable_grob::add_spring (l, r, distance, inverse_strength); +} -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 2 note heads width (i.e. the space following a note is 1 note -head width) A 16th note is followed by 0.5 note head width. The -quarter note is followed by 3 NHW, the half by 4 NHW, etc. -", - "spacing-increment shortest-duration-space"); +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 @code{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 " + "strict-note-spacing " + "shortest-duration-space " + "common-shortest-duration " + "uniform-stretching " + "packed-spacing " + ); + +ADD_INTERFACE (Spacing_interface, "spacing-interface", + "Something to do with line breaking and spacing. " + "Kill this one after determining line breaks.", + "");