X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Falign-interface.cc;h=0e350c142628d8db4eda48664b7a6e554f5443d8;hb=4b4331d24c2c39592f2da381156da92d140c9419;hp=d77b642726bc0dbe3477a18e64e2ade0b7110521;hpb=5aa64a57ecc6c9ceb236116bcd16cc5a829fdd02;p=lilypond.git diff --git a/lily/align-interface.cc b/lily/align-interface.cc index d77b642726..0e350c1426 100644 --- a/lily/align-interface.cc +++ b/lily/align-interface.cc @@ -1,9 +1,20 @@ /* - align-interface.cc -- implement Align_interface + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2000--2012 Han-Wen Nienhuys - (c) 2000--2009 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 "align-interface.hh" @@ -21,7 +32,6 @@ #include "system.hh" #include "warn.hh" - MAKE_SCHEME_CALLBACK (Align_interface, align_to_minimum_distances, 1); SCM Align_interface::align_to_minimum_distances (SCM smob) @@ -59,154 +69,206 @@ Align_interface::align_to_ideal_distances (SCM smob) // code. Split them into 2 functions, perhaps? static void get_skylines (Grob *me, - vector *const elements, - Axis a, - bool pure, int start, int end, - vector *const ret) + vector *const elements, + Axis a, + bool pure, int start, int end, + vector *const ret) { Grob *other_common = common_refpoint_of_array (*elements, me, other_axis (a)); - + for (vsize i = elements->size (); i--;) { Grob *g = (*elements)[i]; Skyline_pair skylines; if (!pure) - { - Skyline_pair *skys = Skyline_pair::unsmob (g->get_property (a == Y_AXIS - ? "vertical-skylines" - : "horizontal-skylines")); - if (skys) - skylines = *skys; - - /* This skyline was calculated relative to the grob g. In order to compare it to - skylines belonging to other grobs, we need to shift it so that it is relative - to the common reference. */ - Real offset = g->relative_coordinate (other_common, other_axis (a)); - skylines.shift (offset); - } + { + Skyline_pair *skys = Skyline_pair::unsmob (g->get_property (a == Y_AXIS + ? "vertical-skylines" + : "horizontal-skylines")); + if (skys) + skylines = *skys; + + /* This skyline was calculated relative to the grob g. In order to compare it to + skylines belonging to other grobs, we need to shift it so that it is relative + to the common reference. */ + Real offset = g->relative_coordinate (other_common, other_axis (a)); + skylines.shift (offset); + } else - { - assert (a == Y_AXIS); - Interval extent = g->pure_height (g, start, end); - if (!extent.is_empty ()) - { - Box b; - b[a] = extent; - b[other_axis (a)] = Interval (0, infinity_f); - skylines.insert (b, 0, other_axis (a)); - } - - // This is a hack to get better accuracy on the pure-height of VerticalAlignment. - // It's quite common for a treble clef to be the highest element of one system - // and for a low note (or lyrics) to be the lowest note on another. The two will - // never collide, but the pure-height stuff only works with bounding boxes, so it - // doesn't know that. The result is a significant over-estimation of the pure-height, - // especially on systems with many staves. To correct for this, we build a skyline - // in two parts: the part we did above contains most of the grobs (note-heads, etc.) - // while the bit we're about to do only contains the breakable grobs at the beginning - // of the system. This way, the tall treble clefs are only compared with the treble - // clefs of the other staff and they will be ignored if the staff above is, for example, - // lyrics. - if (Axis_group_interface::has_interface (g) - && !Hara_kiri_group_spanner::request_suicide (g, start, end)) - { - Interval begin_of_line_extent = Axis_group_interface::begin_of_line_pure_height (g, start); - if (!begin_of_line_extent.is_empty ()) - { - Box b; - b[a] = begin_of_line_extent; - b[other_axis (a)] = Interval (-infinity_f, -1); - skylines.insert (b, 0, other_axis (a)); - } - } - } + { + assert (a == Y_AXIS); + Interval extent = g->pure_height (g, start, end); + + // This is a hack to get better accuracy on the pure-height of VerticalAlignment. + // It's quite common for a treble clef to be the highest element of one system + // and for a low note (or lyrics) to be the lowest note on another. The two will + // never collide, but the pure-height stuff only works with bounding boxes, so it + // doesn't know that. The result is a significant over-estimation of the pure-height, + // especially on systems with many staves. To correct for this, we build a skyline + // in two parts: the part we did above contains most of the grobs (note-heads, etc.) + // while the bit we're about to do only contains the breakable grobs at the beginning + // of the system. This way, the tall treble clefs are only compared with the treble + // clefs of the other staff and they will be ignored if the staff above is, for example, + // lyrics. + if (Axis_group_interface::has_interface (g) + && !Hara_kiri_group_spanner::request_suicide (g, start, end)) + { + extent = Axis_group_interface::rest_of_line_pure_height (g, start, end); + Interval begin_of_line_extent = Axis_group_interface::begin_of_line_pure_height (g, start); + if (!begin_of_line_extent.is_empty ()) + { + Box b; + b[a] = begin_of_line_extent; + b[other_axis (a)] = Interval (-infinity_f, -1); + skylines.insert (b, 0, other_axis (a)); + } + } + + if (!extent.is_empty ()) + { + Box b; + b[a] = extent; + b[other_axis (a)] = Interval (0, infinity_f); + skylines.insert (b, 0, other_axis (a)); + } + } if (skylines.is_empty ()) - elements->erase (elements->begin () + i); + elements->erase (elements->begin () + i); else - ret->push_back (skylines); + ret->push_back (skylines); } reverse (*ret); } vector Align_interface::get_minimum_translations (Grob *me, - vector const &all_grobs, - Axis a, - bool pure, int start, int end) + vector const &all_grobs, + Axis a) +{ + return internal_get_minimum_translations (me, all_grobs, a, true, false, 0, 0); +} + +vector +Align_interface::get_pure_minimum_translations (Grob *me, + vector const &all_grobs, + Axis a, int start, int end) { - if (!pure && a == Y_AXIS && dynamic_cast (me) && !me->get_system ()) + return internal_get_minimum_translations (me, all_grobs, a, true, true, start, end); +} + +vector +Align_interface::get_minimum_translations_without_min_dist (Grob *me, + vector const &all_grobs, + Axis a) +{ + return internal_get_minimum_translations (me, all_grobs, a, false, false, 0, 0); +} + +// If include_fixed_spacing is false, the only constraints that will be measured +// here are those that result from collisions (+ padding) and the spacing spec +// between adjacent staves. +// If include_fixed_spacing is true, constraints from line-break-system-details, +// basic-distance+stretchable=0, and staff-staff-spacing of spaceable staves +// with loose lines in between, are included as well. +// - If you want to find the minimum height of a system, include_fixed_spacing should be true. +// - If you're going to actually lay out the page, then it should be false (or +// else centered dynamics will break when there is a fixed alignment). +vector +Align_interface::internal_get_minimum_translations (Grob *me, + vector const &all_grobs, + Axis a, + bool include_fixed_spacing, + bool pure, int start, int end) +{ + if (!pure && a == Y_AXIS && dynamic_cast (me) && !me->get_system ()) me->programming_error ("vertical alignment called before line-breaking"); - + + // If include_fixed_spacing is true, we look at things like system-system-spacing + // and alignment-distances, which only make sense for the toplevel VerticalAlignment. + // If we aren't toplevel, we're working on something like BassFigureAlignment + // and so we definitely don't want to include alignment-distances! + if (!dynamic_cast (me->get_parent (Y_AXIS))) + include_fixed_spacing = false; + Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), - DOWN); - vector elems (all_grobs); // writable copy + DOWN); + vector elems (all_grobs); // writable copy vector skylines; get_skylines (me, &elems, a, pure, start, end, &skylines); - SCM forced_distances = ly_assoc_get (ly_symbol2scm ("alignment-distances"), - Page_layout_problem::get_details (me), - SCM_EOL); - Real where = 0; Real default_padding = robust_scm2double (me->get_property ("padding"), 0.0); vector translates; Skyline down_skyline (stacking_dir); - SCM last_spaceable_element_details = SCM_EOL; Real last_spaceable_element_pos = 0; - bool found_spaceable_element = false; + Grob *last_spaceable_element = 0; + Skyline last_spaceable_skyline (stacking_dir); + int spaceable_count = 0; for (vsize j = 0; j < elems.size (); j++) { Real dy = 0; Real padding = default_padding; if (j == 0) - dy = skylines[j][-stacking_dir].max_height (); + dy = skylines[j][-stacking_dir].max_height () + padding; else - { - down_skyline.merge (skylines[j-1][stacking_dir]); - dy = down_skyline.distance (skylines[j][-stacking_dir]); - } + { + SCM spec = Page_layout_problem::get_spacing_spec (elems[j - 1], elems[j], pure, start, end); + Page_layout_problem::read_spacing_spec (spec, &padding, ly_symbol2scm ("padding")); + + dy = down_skyline.distance (skylines[j][-stacking_dir]) + padding; + + Real spec_distance = 0; + if (Page_layout_problem::read_spacing_spec (spec, &spec_distance, ly_symbol2scm ("minimum-distance"))) + dy = max (dy, spec_distance); + // Consider the likely final spacing when estimating distance between staves of the full score + if (INT_MAX == end && 0 == start + && Page_layout_problem::read_spacing_spec (spec, &spec_distance, ly_symbol2scm ("basic-distance"))) + dy = max (dy, spec_distance); + + if (include_fixed_spacing && Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element) + { + // Spaceable staves may have + // constraints coming from the previous spaceable staff + // as well as from the previous staff. + spec = Page_layout_problem::get_spacing_spec (last_spaceable_element, elems[j], pure, start, end); + Real spaceable_padding = 0; + Page_layout_problem::read_spacing_spec (spec, + &spaceable_padding, + ly_symbol2scm ("padding")); + dy = max (dy, (last_spaceable_skyline.distance (skylines[j][-stacking_dir]) + + stacking_dir * (last_spaceable_element_pos - where) + spaceable_padding)); + + Real spaceable_min_distance = 0; + if (Page_layout_problem::read_spacing_spec (spec, + &spaceable_min_distance, + ly_symbol2scm ("minimum-distance"))) + dy = max (dy, spaceable_min_distance + stacking_dir * (last_spaceable_element_pos - where)); + + dy = max (dy, Page_layout_problem::get_fixed_spacing (last_spaceable_element, elems[j], spaceable_count, + pure, start, end)); + } + } if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */ - dy = 0.0; + dy = 0.0; - if (Page_layout_problem::is_spaceable (elems[j])) - { - Real min_distance = 0; - Page_layout_problem::read_spacing_spec (last_spaceable_element_details, - &padding, - ly_symbol2scm ("padding")); - if (Page_layout_problem::read_spacing_spec (last_spaceable_element_details, - &min_distance, - ly_symbol2scm ("minimum-distance"))) - dy = max (dy, min_distance + stacking_dir*(last_spaceable_element_pos - where)); - - if (found_spaceable_element && scm_is_pair (forced_distances)) - { - SCM forced_dist = scm_car (forced_distances); - forced_distances = scm_cdr (forced_distances); - - if (scm_is_number (forced_dist)) - dy = scm_to_double (forced_dist) + stacking_dir * (last_spaceable_element_pos - where); - } - last_spaceable_element_details = elems[j]->get_property ("next-staff-spacing"); - found_spaceable_element = true; - } - else - { - // TODO: provide support for min-distance and padding for non-spaceable elements also. - } - - dy = max (0.0, dy + padding); + dy = max (0.0, dy); down_skyline.raise (-stacking_dir * dy); + down_skyline.merge (skylines[j][stacking_dir]); where += stacking_dir * dy; translates.push_back (where); if (Page_layout_problem::is_spaceable (elems[j])) - last_spaceable_element_pos = where; + { + spaceable_count++; + last_spaceable_element = elems[j]; + last_spaceable_element_pos = where; + last_spaceable_skyline = down_skyline; + } } // So far, we've computed the translates for all the non-empty elements. @@ -216,12 +278,12 @@ Align_interface::get_minimum_translations (Grob *me, if (!translates.empty ()) { Real w = translates[0]; - for (vsize i = 0, j = 0; j < all_grobs.size (); j++) - { - if (i < elems.size () && all_grobs[j] == elems[i]) - w = translates[i++]; - all_translates.push_back (w); - } + for (vsize i = 0, j = 0; j < all_grobs.size (); j++) + { + if (i < elems.size () && all_grobs[j] == elems[i]) + w = translates[i++]; + all_translates.push_back (w); + } } return all_translates; } @@ -230,9 +292,13 @@ void Align_interface::align_elements_to_ideal_distances (Grob *me) { System *sys = me->get_system (); - Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ())); - - layout.solution (true); + if (sys) + { + Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ())); + layout.solution (true); + } + else + programming_error ("vertical alignment called before line breaking"); } void @@ -240,44 +306,39 @@ Align_interface::align_elements_to_minimum_distances (Grob *me, Axis a) { extract_grob_set (me, "elements", all_grobs); - vector translates = get_minimum_translations (me, all_grobs, a, false, 0, 0); + vector translates = get_minimum_translations (me, all_grobs, a); if (translates.size ()) for (vsize j = 0; j < all_grobs.size (); j++) all_grobs[j]->translate_axis (translates[j], a); } +MAKE_SCHEME_CALLBACK (Align_interface, full_score_pure_minimum_translations, 1); +SCM +Align_interface::full_score_pure_minimum_translations (SCM smob) +{ + Grob *me = unsmob_grob (smob); + extract_grob_set (me, "elements", all_grobs); + + vector pure_minimum_translations = Align_interface::get_pure_minimum_translations (me, all_grobs, Y_AXIS, 0, INT_MAX); + return ly_floatvector2scm (pure_minimum_translations); +} + Real Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end) { extract_grob_set (me, "elements", all_grobs); - SCM dy_scm = me->get_property ("forced-distance"); + vector translates = start == 0 && end == INT_MAX + ? ly_scm2floatvector (me->get_object ("full-score-pure-minimum-translations")) + : get_pure_minimum_translations (me, all_grobs, Y_AXIS, start, end); - if (scm_is_number (dy_scm)) + if (translates.size ()) { - Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN); - Real pos = 0; for (vsize i = 0; i < all_grobs.size (); i++) - { - if (all_grobs[i] == ch) - return pos; - if (!Hara_kiri_group_spanner::has_interface (all_grobs[i]) - || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end)) - pos += dy; - } + if (all_grobs[i] == ch) + return translates[i]; } else - { - vector translates = get_minimum_translations (me, all_grobs, Y_AXIS, true, start, end); - - if (translates.size ()) - { - for (vsize i = 0; i < all_grobs.size (); i++) - if (all_grobs[i] == ch) - return translates[i]; - } - else - return 0; - } + return 0; programming_error ("tried to get a translation for something that is no child of mine"); return 0; @@ -295,7 +356,7 @@ Align_interface::add_element (Grob *me, Grob *element) Axis a = Align_interface::axis (me); SCM sym = axis_offset_symbol (a); SCM proc = axis_parent_positioning (a); - + element->set_property (sym, proc); Axis_group_interface::add_element (me, element); } @@ -316,21 +377,18 @@ Align_interface::set_ordered (Grob *me) } ADD_INTERFACE (Align_interface, - "Order grobs from top to bottom, left to right, right to left" - " or bottom to top. For vertical alignments of staves, the" - " @code{break-system-details} of the left" - " @rinternals{NonMusicalPaperColumn} may be set to tune" - " vertical spacing. Set @code{alignment-extra-space} to add" - " extra space for staves. Set" - " @code{fixed-alignment-extra-space} to force staves in" - " @code{PianoStaff}s further apart.", - - /* properties */ - "align-dir " - "axes " - "elements " - "padding " - "positioning-done " - "stacking-dir " - "threshold " - ); + "Order grobs from top to bottom, left to right, right to left" + " or bottom to top. For vertical alignments of staves, the" + " @code{break-system-details} of the left" + " @rinternals{NonMusicalPaperColumn} may be set to tune" + " vertical spacing.", + + /* properties */ + "align-dir " + "axes " + "full-score-pure-minimum-translations " + "elements " + "padding " + "positioning-done " + "stacking-dir " + );