X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fspacing-spanner.cc;h=cc353bc365896abd19b5ada958a688d5a3d8a27e;hb=b872748c6aa8bb721ced458691b38ac2fac5dfc8;hp=4a6d0b05156dd602f7bcefde0261f539f00ad0aa;hpb=e344ae579fa1d81fc6c6f3049494697872fd39f9;p=lilypond.git diff --git a/lily/spacing-spanner.cc b/lily/spacing-spanner.cc index 4a6d0b0515..cc353bc365 100644 --- a/lily/spacing-spanner.cc +++ b/lily/spacing-spanner.cc @@ -1,9 +1,20 @@ /* - spacing-spanner.cc -- implement Spacing_spanner + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1999--2015 Han-Wen Nienhuys - (c) 1999--2008 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 "spacing-spanner.hh" @@ -28,18 +39,18 @@ #include "system.hh" #include "warn.hh" -vector +vector Spacing_spanner::get_columns (Grob *me_grob) { - 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); - - all = vector::vector (all.begin () + start, - all.begin () + end + 1); + 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); + + all = vector (all.begin () + start, + all.begin () + end + 1); return all; } @@ -47,14 +58,14 @@ MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1); SCM Spacing_spanner::set_springs (SCM smob) { - Spanner *me = unsmob_spanner (smob); + Spanner *me = unsmob (smob); /* can't use get_system () ? --hwn. */ Spacing_options options; options.init_from_grob (me); - vector cols = Spacing_spanner::get_columns (me); + vector cols = Spacing_spanner::get_columns (me); set_explicit_neighbor_columns (cols); prune_loose_columns (me, &cols, &options); @@ -75,13 +86,13 @@ Spacing_spanner::set_springs (SCM smob) */ MAKE_SCHEME_CALLBACK (Spacing_spanner, calc_common_shortest_duration, 1); -SCM +SCM Spacing_spanner::calc_common_shortest_duration (SCM grob) { - Spanner *me = unsmob_spanner (grob); + Spanner *me = unsmob (grob); + + vector cols (get_columns (me)); - vector cols (get_columns (me)); - /* ascending in duration */ @@ -94,47 +105,47 @@ Spacing_spanner::calc_common_shortest_duration (SCM grob) for (vsize i = 0; i < cols.size (); i++) { if (Paper_column::is_musical (cols[i])) - { - 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_property ("shortest-starter-duration"); - Moment this_shortest = *unsmob_moment (st); - assert (this_shortest.to_bool ()); - shortest_in_measure = min (shortest_in_measure, this_shortest.main_part_); - } + { + Moment *when = unsmob (cols[i]->get_property ("when")); + + /* + ignore grace notes for shortest notes. + */ + if (when && when->grace_part_) + continue; + + SCM st = cols[i]->get_property ("shortest-starter-duration"); + Moment this_shortest = *unsmob (st); + assert (this_shortest.to_bool ()); + shortest_in_measure = min (shortest_in_measure, this_shortest.main_part_); + } else if (!shortest_in_measure.is_infinity () - && Paper_column::is_breakable (cols[i])) - { - vsize j = 0; - for (; j < durations.size (); j++) - { - if (durations[j] > shortest_in_measure) - { - counts.insert (counts.begin () + j, 1); - durations.insert (durations.begin () + j, shortest_in_measure); - break; - } - else if (durations[j] == shortest_in_measure) - { - counts[j]++; - break; - } - } - - if (durations.size () == j) - { - durations.push_back (shortest_in_measure); - counts.push_back (1); - } - - shortest_in_measure.set_infinite (1); - } + && Paper_column::is_breakable (cols[i])) + { + vsize j = 0; + for (; j < durations.size (); j++) + { + if (durations[j] > shortest_in_measure) + { + counts.insert (counts.begin () + j, 1); + durations.insert (durations.begin () + j, shortest_in_measure); + break; + } + else if (durations[j] == shortest_in_measure) + { + counts[j]++; + break; + } + } + + if (durations.size () == j) + { + durations.push_back (shortest_in_measure); + counts.push_back (1); + } + + shortest_in_measure.set_infinite (1); + } } vsize max_idx = VPOS; @@ -142,15 +153,15 @@ Spacing_spanner::calc_common_shortest_duration (SCM grob) for (vsize i = durations.size (); i--;) { if (counts[i] >= max_count) - { - max_idx = i; - max_count = counts[i]; - } + { + max_idx = i; + max_count = counts[i]; + } } SCM bsd = me->get_property ("base-shortest-duration"); Rational d = Rational (1, 8); - if (Moment *m = unsmob_moment (bsd)) + if (Moment *m = unsmob (bsd)) d = m->main_part_; if (max_idx != VPOS) @@ -161,149 +172,138 @@ Spacing_spanner::calc_common_shortest_duration (SCM grob) void Spacing_spanner::generate_pair_spacing (Grob *me, - Paper_column *left_col, Paper_column *right_col, - Paper_column *after_right_col, - Spacing_options const *options) + Paper_column *left_col, Paper_column *right_col, + Paper_column *after_right_col, + Spacing_options const *options) { if (Paper_column::is_musical (left_col)) { if (!Paper_column::is_musical (right_col) - && options->float_nonmusical_columns_ - && after_right_col - && Paper_column::is_musical (after_right_col)) - { - /* - 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 ())); - } + && (options->float_nonmusical_columns_ || to_boolean (right_col->get_property ("maybe-loose"))) + && after_right_col + && Paper_column::is_musical (after_right_col)) + { + /* + 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, left_col, right_col, options); if (Item *rb = right_col->find_prebroken_piece (LEFT)) - musical_column_spacing (me, left_col, rb, options); + 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. + 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); if (left_col && right_col) - breakable_column_spacing (me, left_col, right_col, options); + breakable_column_spacing (me, left_col, right_col, options); if (lb && right_col) - breakable_column_spacing (me, lb, right_col, options); + breakable_column_spacing (me, lb, right_col, options); if (left_col && rb) - breakable_column_spacing (me, left_col, rb, options); + breakable_column_spacing (me, left_col, rb, options); if (lb && rb) - breakable_column_spacing (me, lb, rb, options); + breakable_column_spacing (me, lb, rb, options); } } static void -set_column_rods (vector const &cols, Real padding) +set_column_rods (vector const &cols, Real padding) { - /* distances[i] will be the minimum distance between column i and column i+1 */ - vector distances; + /* distances[i] will be the distance betwen cols[i-1] and cols[i], and + overhangs[j] the amount by which cols[0 thru j] extend beyond cols[j] + when each column is placed as far to the left as possible. */ + vector distances (cols.size ()); + vector overhangs (cols.size ()); - for (vsize i = 1; i < cols.size (); i++) + for (vsize i = 0; i < cols.size (); i++) { - assert (distances.size () == i-1); - - Item *r = dynamic_cast (cols[i]); + Item *r = dynamic_cast (cols[i]); Item *rb = r->find_prebroken_piece (LEFT); if (Separation_item::is_empty (r) && (!rb || Separation_item::is_empty (rb))) - { - distances.push_back (0); - continue; - } + continue; - Skyline_pair *skys = Skyline_pair::unsmob (r->get_property ("horizontal-skylines")); - Real right_stickout = skys ? (*skys)[LEFT].max_height () : 0.0; + Skyline_pair *skys = unsmob (r->get_property ("horizontal-skylines")); + overhangs[i] = skys ? (*skys)[RIGHT].max_height () : 0.0; - /* 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 ()); + if (0 == i) continue; - Drul_array r_cols (r, rb); - Drul_array cur_dist (0.0, 0.0); + /* min rather than max because stickout will be negative if the right-hand column + sticks out a lot to the left */ + Real stickout = min (skys ? (*skys)[LEFT].max_height () : 0.0, + Separation_item::conditional_skyline (r, cols[i - 1]).max_height ()); + + Real prev_distances = 0.0; /* 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. */ + 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; - - Direction d = LEFT; - do - { - if (j < i-1) - cur_dist[d] += distances[j]; - - Item *r_col = r_cols[d]; - bool touches = right_stickout - left_stickout + cur_dist[d] < 0.0; - Real dist = 0.0; - - /* 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); - - 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; - } + { + if (overhangs[j] + padding <= prev_distances + distances[i] + stickout) + break; // cols[0 thru j] cannot reach cols[i] + + Item *l = dynamic_cast (cols[j]); + Item *lb = l->find_prebroken_piece (RIGHT); + + Real dist = Separation_item::set_distance (l, r, padding); + distances[i] = max (distances[i], dist - prev_distances); + + if (lb) + { + dist = Separation_item::set_distance (lb, r, padding); + // The left-broken version might reach more columns to the + // right than the unbroken version, by extending farther and/or + // nesting more closely; + if (j == i - 1) // check this, the first time we see each lb. + overhangs[j] = max (overhangs[j], + lb->extent (lb, X_AXIS)[RIGHT] + + distances[i] - dist); + } + if (rb) + Separation_item::set_distance (l, rb, padding); + if (lb && rb) + Separation_item::set_distance (lb, rb, padding); + + prev_distances += distances[j]; + } + overhangs[i] = max (overhangs[i], + overhangs[i - 1] - distances[i]); } } - void Spacing_spanner::generate_springs (Grob *me, - vector const &cols, - Spacing_options const *options) + vector const &cols, + Spacing_options const *options) { - Paper_column *prev = dynamic_cast (cols[0]); + Paper_column *prev = dynamic_cast (cols[0]); for (vsize i = 1; i < cols.size (); i++) { Paper_column *col = dynamic_cast (cols[i]); - Paper_column *next = (i + 1 < cols.size ()) ? dynamic_cast (cols[i+1]) : 0; - + Paper_column *next = (i + 1 < cols.size ()) ? dynamic_cast (cols[i + 1]) : 0; + generate_pair_spacing (me, prev, col, next, options); prev = col; } - set_column_rods (cols, 0.1); // FIXME: padding + Real padding = robust_scm2double (prev->get_property ("padding"), 0.1); + set_column_rods (cols, padding); } /* @@ -311,79 +311,81 @@ Spacing_spanner::generate_springs (Grob *me, */ void Spacing_spanner::musical_column_spacing (Grob *me, - Item *left_col, - Item *right_col, - Spacing_options const *options) + Item *left_col, + Item *right_col, + Spacing_options const *options) { - Real base_note_space = note_spacing (me, left_col, right_col, options); - Spring spring; + Spring spring = note_spacing (me, left_col, right_col, options); if (options->stretch_uniformly_) - spring = Spring (base_note_space, 0.0); + { + spring.set_min_distance (0.0); + spring.set_default_strength (); + } else { vector springs; - extract_grob_set (left_col, "right-neighbors", neighbors); - - for (vsize i = 0; i < neighbors.size (); i++) - { - Grob *wish = neighbors[i]; - - 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; - - /* - 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)); - } - } + extract_grob_set (left_col, "spacing-wishes", wishes); + + for (vsize i = 0; i < wishes.size (); i++) + { + Grob *wish = wishes[i]; + if (Spacing_interface::left_column (wish) != left_col) + { + /* This shouldn't really happen, but the ancient music + stuff really messes up the spacing code, grrr + */ + continue; + } + + extract_grob_set (wish, "right-items", right_items); + bool found_matching_column = false; + for (vsize j = 0; j < right_items.size (); j++) + { + Item *it = dynamic_cast (right_items[j]); + if (it && (right_col == it->get_column () + || right_col->original () == it->get_column ())) + found_matching_column = true; + } + + /* + This is probably a waste of time in the case of polyphonic + music. */ + if (found_matching_column && has_interface (wish)) + { + Real inc = options->increment_; + Grob *gsp = unsmob (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, spring, inc)); + } + } if (springs.empty ()) - { - - if (!Paper_column::is_musical (right_col)) - { - /* - 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. - */ - spring = Spring (base_note_space, 0.0); - } - } + { + if (Paper_column::is_musical (right_col)) + { + /* + Min distance should be 0.0. If there are no spacing + wishes, we're probably dealing with polyphonic spacing + of hemiolas. + */ + spring.set_min_distance (0.0); + } + } else - spring = merge_springs (springs); + spring = merge_springs (springs); } if (Paper_column::when_mom (right_col).grace_part_ && !Paper_column::when_mom (left_col).grace_part_) { /* - Ugh. 0.8 is arbitrary. + Ugh. 0.8 is arbitrary. */ spring *= 0.8; } @@ -394,19 +396,31 @@ Spacing_spanner::musical_column_spacing (Grob *me, if (options->packed_) { /* - 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. + 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 ())); + /* FIXME: the else clause below is the "right" thing to do, + but we can't do it because of all the empty columns that the + ligature-engravers leave lying around. In that case, the extent of + the column is incorrect because it includes note-heads that aren't + there. We get around this by only including the column extent if + the left-hand column is "genuine". This is a dirty hack and it + should be fixed in the ligature-engravers. --jneem + */ + if (Paper_column::is_extraneous_column_from_ligature (left_col)) + spring.set_distance (spring.min_distance ()); + else + spring.set_distance (max (left_col->extent (left_col, X_AXIS)[RIGHT], + spring.min_distance ())); + spring.set_inverse_stretch_strength (1.0); } @@ -429,21 +443,21 @@ Spacing_spanner::fills_measure (Grob *me, Item *left, Item *col) || !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")); + + Moment dt + = Paper_column::when_mom (next) - Paper_column::when_mom (col); + + Moment *len = unsmob (left->get_property ("measure-length")); if (!len) return false; - + /* 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 ())) + || next->break_status_dir ())) return true; return false; @@ -454,11 +468,17 @@ Spacing_spanner::fills_measure (Grob *me, Item *left, Item *col) */ void Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, - Spacing_options const *options) + Spacing_options const *options) { vector springs; Spring spring; + Real full_measure_space = 0.0; + if (Paper_column::is_musical (r) + && l->break_status_dir () == CENTER + && fills_measure (me, l, r)) + full_measure_space = robust_scm2double (l->get_property ("full-measure-extra-space"), 1.0); + Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l); if (dt == Moment (0, 0)) @@ -466,20 +486,21 @@ Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, extract_grob_set (l, "spacing-wishes", wishes); for (vsize i = 0; i < wishes.size (); i++) - { - Item *spacing_grob = dynamic_cast (wishes[i]); + { + Item *spacing_grob = dynamic_cast (wishes[i]); - if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob)) - continue; + if (!spacing_grob || !has_interface (spacing_grob)) + continue; - /* - column for the left one settings should be ok due automatic - pointer munging. - */ - assert (spacing_grob->get_column () == l); + /* + column for the left one settings should be ok due automatic + pointer munging. + */ + assert (spacing_grob->get_column () == l); - springs.push_back (Staff_spacing::get_spacing (spacing_grob, r)); - } + springs.push_back (Staff_spacing::get_spacing (spacing_grob, r, + full_measure_space)); + } } if (springs.empty ()) @@ -490,21 +511,13 @@ Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, if (Paper_column::when_mom (r).grace_part_) { /* - Correct for grace notes. - - Ugh. The 0.8 is arbitrary. + Correct for grace notes. + + Ugh. The 0.8 is arbitrary. */ spring *= 0.8; } - if (Paper_column::is_musical (r) - && l->break_status_dir () == CENTER - && fills_measure (me, l, r)) - { - spring.set_distance (spring.distance () + 1.0); - spring.set_default_strength (); - } - if (options->stretch_uniformly_ && l->break_status_dir () != RIGHT) { spring.set_min_distance (0.0); @@ -515,28 +528,28 @@ Spacing_spanner::breakable_column_spacing (Grob *me, Item *l, Item *r, } 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 " - ); + "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 " + );