X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstaff-spacing.cc;h=99052146bb2bbfed8278c9acd04f4a0160c2de6d;hb=47db9a3883d726ca53e2133a3b2298f78dd6a32e;hp=e688d60cfbcbcbb300de09907c4179f05d067a61;hpb=7a32d3103c22d916cec37d1d7bb7e5cd4dc0463a;p=lilypond.git diff --git a/lily/staff-spacing.cc b/lily/staff-spacing.cc index e688d60cfb..99052146bb 100644 --- a/lily/staff-spacing.cc +++ b/lily/staff-spacing.cc @@ -1,9 +1,20 @@ /* - staff-spacing.cc -- implement Staff_spacing + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2001--2015 Han-Wen Nienhuys - (c) 2001--2007 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 "staff-spacing.hh" @@ -11,110 +22,50 @@ #include using namespace std; +#include "international.hh" #include "paper-column.hh" #include "separation-item.hh" #include "warn.hh" -#include "bar-line.hh" #include "staff-symbol-referencer.hh" #include "note-column.hh" #include "stem.hh" +#include "spacing-interface.hh" #include "accidental-placement.hh" #include "pointer-group-interface.hh" #include "directional-element-interface.hh" -/* - Insert some more space for the next note, in case it has a stem in - the wrong direction +/* A stem following a bar-line creates an optical illusion similar to the + one mentioned in note-spacing.cc. We correct for it here. + + TODO: should we still correct if there are accidentals/arpeggios before + the stem? */ -void -Staff_spacing::next_note_correction (Grob *me, - Grob *g, - Interval bar_size, - Real current_space, Real current_fixed, - Real *space, - Real *fix, - int *wish_count) + +Real +Staff_spacing::optical_correction (Grob *me, Grob *g, Interval bar_height) { - (void) current_fixed; if (!g || !Note_column::has_interface (g)) - return ; + return 0; - Item *col = dynamic_cast (g)->get_column (); - Real left_stickout_correction = max (0., (- g->extent (col, X_AXIS)[LEFT])); - - /* staff space -> positions */ - bar_size *= 2; - - /* - Duh. If this gets out of hand, we should invent something more generic. - */ - Grob *accs = Note_column::accidentals (g); - if (accs) - { - Interval v; - if (Accidental_placement::has_interface (accs)) - v = Accidental_placement::get_relevant_accidental_extent (accs, col, me); - else - v = accs->extent (col, X_AXIS); - - left_stickout_correction = max (left_stickout_correction, (- v[LEFT])); - } - Grob *arpeggio = unsmob_grob (g->get_object ("arpeggio")); - if (arpeggio) - left_stickout_correction = max (left_stickout_correction, - arpeggio->extent (col, X_AXIS)[LEFT]); - - - /* - Let's decrease the space a little if the problem is not located - after a barline. - */ - if (bar_size.is_empty ()) - left_stickout_correction *= 0.75; - - Real optical_corr = 0.0; Grob *stem = Note_column::get_stem (g); - if (!bar_size.is_empty () - && !arpeggio - && !accs - && stem) + Real ret = 0.0; + + if (!bar_height.is_empty () && stem) { Direction d = get_grob_direction (stem); if (Stem::is_normal_stem (stem) && d == DOWN) - { - - /* - can't look at stem-end-position, since that triggers - beam slope computations. - */ - Real stem_start = Stem::head_positions (stem) [d]; - Real stem_end = stem_start + - d * robust_scm2double (stem->get_property ("length"), 7); - - Interval stem_posns (min (stem_start, stem_end), - max (stem_end, stem_start)); - - stem_posns.intersect (bar_size); - - optical_corr = min (abs (stem_posns.length () / 7.0), 1.0); - optical_corr *= robust_scm2double (me->get_property ("stem-spacing-correction"), 1); - } - } - + { + Interval stem_posns = stem->pure_height (stem, 0, INT_MAX); - Real correction = optical_corr + left_stickout_correction; - if (correction) - { - (*wish_count) ++; + stem_posns.intersect (bar_height); - /* - This minute adjustments don't make sense for widely spaced scores. - Hence, we need to keep the stretchable (that is, space - fix) - distance equal. - */ - *space += correction; - *fix += correction; + ret = min (abs (stem_posns.length () / 7.0), 1.0); + ret *= robust_scm2double (me->get_property ("stem-spacing-correction"), 1); + } } + return ret; } + /* Y-positions that are covered by BAR_GROB, in the case that it is a barline. */ @@ -123,192 +74,145 @@ Staff_spacing::bar_y_positions (Grob *bar_grob) { Interval bar_size; bar_size.set_empty (); - if (Bar_line::has_interface (bar_grob)) + + if (bar_grob->internal_has_interface (ly_symbol2scm ("bar-line-interface"))) { SCM glyph = bar_grob->get_property ("glyph-name"); Grob *staff_sym = Staff_symbol_referencer::get_staff_symbol (bar_grob); string glyph_string = scm_is_string (glyph) ? ly_scm2string (glyph) : ""; if (glyph_string.substr (0, 1) == "|" - || glyph_string.substr (0, 1) == ".") - { - Grob *common = bar_grob->common_refpoint (staff_sym, Y_AXIS); - bar_size = bar_grob->extent (common, Y_AXIS); - bar_size *= 1.0 / Staff_symbol_referencer::staff_space (bar_grob); - } + || glyph_string.substr (0, 1) == ".") + { + Grob *common = bar_grob->common_refpoint (staff_sym, Y_AXIS); + bar_size = bar_grob->extent (common, Y_AXIS); + bar_size *= 1.0 / Staff_symbol_referencer::staff_space (bar_grob); + } } return bar_size; } -/* - Do corrections for the following notes. - - This is slightly convoluted, since the staffspacing grob gets - pointers to the separation-items, not the note-columns or - note-spacings. -*/ - -void -Staff_spacing::next_notes_correction (Grob *me, Grob *last_grob, - Real current_space, Real current_fixed, - Real *compound_space, Real *compound_fixed - ) +Real +Staff_spacing::next_notes_correction (Grob *me, + Grob *last_grob) { Interval bar_size = bar_y_positions (last_grob); Grob *orig = me->original () ? me->original () : me; + vector note_columns = Spacing_interface::right_note_columns (orig); - extract_grob_set (orig, "right-items", right_items); + Real max_optical = 0.0; - *compound_fixed = 0.0; - *compound_space = 0.0; - int wish_count = 0; + for (vsize i = 0; i < note_columns.size (); i++) + max_optical = max (max_optical, optical_correction (me, note_columns[i], bar_size)); - for (vsize i = right_items.size (); i--;) - { - Grob *g = right_items[i]; - if (Note_column::has_interface (right_items[i])) - { - Grob *g = right_items[i]; - - Real space = 0.0; - Real fixed = 0.0; - - next_note_correction (me, g, bar_size, - current_space, current_fixed, - &space, &fixed, &wish_count); - - *compound_space += space; - *compound_fixed += fixed; - } - else - { - extract_grob_set (g, "elements", elts); - for (vsize j = elts.size (); j--;) - { - Real space = 0.0; - Real fixed = 0.0; - next_note_correction (me, elts[j], bar_size, - current_space, current_fixed, - &space, &fixed, - &wish_count); - *compound_fixed += fixed; - *compound_space += space; - } - } - } - - if (wish_count > 1) - { - *compound_space /= wish_count; - *compound_fixed /= wish_count; - } + return max_optical; } -void -Staff_spacing::get_spacing_params (Grob *me, Real *space, Real *fixed) +/* We calculate three things here: the ideal distance, the minimum distance + (which is the distance at which collisions will occur) and the "fixed" + distance, which is the distance at which things start to look really bad. + We arrange things so that the fixed distance will be attained when the + line is compressed with a force of 1.0 */ +Spring +Staff_spacing::get_spacing (Grob *me, Grob *right_col, Real situational_space) { - *space = 1.0; - *fixed = 1.0; - - Grob *separation_item = 0; Item *me_item = dynamic_cast (me); - - extract_grob_set (me, "left-items", items); - for (vsize i = items.size (); i--;) - { - Grob *cand = items[i]; - if (cand && Separation_item::has_interface (cand)) - separation_item = cand; - } - - // printf ("doing col %d\n" , Paper_column::get_rank (left_col)); - if (!separation_item) - { - programming_error ("no sep item"); - return; - } + Grob *left_col = me_item->get_column (); Interval last_ext; - Grob *last_grob = Separation_item::extremal_break_aligned_grob (separation_item, RIGHT, - &last_ext); + Direction break_dir = me_item->break_status_dir (); + Grob *last_grob = Spacing_interface::extremal_break_aligned_grob (me, LEFT, + break_dir, + &last_ext); if (!last_grob) { /* - TODO: + TODO: - Should insert a adjustable space here? For excercises, you might want to - use a staff without a clef in the beginning. + Should insert an adjustable space here? For exercises, you might want to + use a staff without a clef in the beginning. */ /* - we used to have a warning here, but it generates a lot of - spurious error messages. + we used to have a warning here, but it generates a lot of + spurious error messages. */ - return; + return Spring (); } - *fixed = last_ext[RIGHT]; - *space = *fixed + 1.0; - SCM alist = last_grob->get_property ("space-alist"); - if (!scm_list_p (alist)) - return; + if (!ly_is_list (alist)) + return Spring (); SCM space_def = scm_sloppy_assq (ly_symbol2scm ("first-note"), alist); if (me_item->break_status_dir () == CENTER) { SCM nndef = scm_sloppy_assq (ly_symbol2scm ("next-note"), alist); if (scm_is_pair (nndef)) - space_def = nndef; + space_def = nndef; } if (!scm_is_pair (space_def)) { programming_error ("unknown prefatory spacing"); - return; + return Spring (); } space_def = scm_cdr (space_def); Real distance = scm_to_double (scm_cdr (space_def)); SCM type = scm_car (space_def); - *fixed = last_ext[RIGHT]; + Real fixed = last_ext[RIGHT]; + Real ideal = fixed + 1.0; + if (type == ly_symbol2scm ("fixed-space")) { - *fixed += distance; - *space = *fixed; + fixed += distance; + ideal = fixed; } else if (type == ly_symbol2scm ("extra-space")) - *space = *fixed + distance; + ideal = fixed + distance; else if (type == ly_symbol2scm ("semi-fixed-space")) { - *fixed += distance / 2; - *space = *fixed + distance / 2; + fixed += distance / 2; + ideal = fixed + distance / 2; } else if (type == ly_symbol2scm ("minimum-space")) - *space = last_ext[LEFT] + max (last_ext.length (), distance); + ideal = last_ext[LEFT] + max (last_ext.length (), distance); else if (type == ly_symbol2scm ("minimum-fixed-space")) { - *space = last_ext[LEFT] + max (last_ext.length (), distance); - *fixed = *space; + fixed = last_ext[LEFT] + max (last_ext.length (), distance); + ideal = fixed; } - Real correction_fixed = 0.0; - Real correction_space = 0.0; - next_notes_correction (me, last_grob, - *space, *fixed, - &correction_space, &correction_fixed ); - *space += correction_space; - *fixed += correction_fixed; + Real stretchability = ideal - fixed; + + /* 'situational_space' passed by the caller + could include full-measure-extra-space */ + ideal += situational_space; + + Real optical_correction = next_notes_correction (me, last_grob); + fixed += optical_correction; + ideal += optical_correction; + + Real min_dist = Paper_column::minimum_distance (left_col, right_col); + + /* ensure that the "fixed" distance will leave a gap of at least 0.3 ss. */ + Real min_dist_correction = max (0.0, 0.3 + min_dist - fixed); + fixed += min_dist_correction; + ideal = max (ideal, fixed); + + Spring ret (ideal, min_dist); + ret.set_inverse_stretch_strength (max (0.0, stretchability)); + ret.set_inverse_compress_strength (max (0.0, ideal - fixed)); + return ret; } ADD_INTERFACE (Staff_spacing, - "This object calculates spacing details from a " - " breakable symbol (left) to another object. For example, it takes care " - " of optical spacing from a bar lines to a note.", - - /* properties */ - "stem-spacing-correction " - "left-items " - "right-items " - ); + "This object calculates spacing details from a breakable" + " symbol (left) to another object. For example, it takes care" + " of optical spacing from a bar line to a note.", + + /* properties */ + "stem-spacing-correction " + );