X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faxis-group-interface.cc;h=e27ce099c5bee8868e736b3e6514e5ba1984fc7c;hb=5bbfc22fce036b9b69df5e420de93e11da23c05e;hp=4de8b6cf900565301e64b5c021687490eb336b35;hpb=92782fde87fb68e945b9eb60cacab6c01d0397df;p=lilypond.git diff --git a/lily/axis-group-interface.cc b/lily/axis-group-interface.cc index 4de8b6cf90..e27ce099c5 100644 --- a/lily/axis-group-interface.cc +++ b/lily/axis-group-interface.cc @@ -1,18 +1,32 @@ /* - axis-group-interface.cc -- implement Axis_group_interface + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 2000--2014 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 "axis-group-interface.hh" +#include + #include "align-interface.hh" #include "directional-element-interface.hh" #include "grob-array.hh" #include "hara-kiri-group-spanner.hh" #include "international.hh" +#include "interval-set.hh" #include "lookup.hh" #include "paper-column.hh" #include "paper-score.hh" @@ -20,9 +34,22 @@ #include "separation-item.hh" #include "skyline-pair.hh" #include "staff-grouper-interface.hh" +#include "stem.hh" #include "stencil.hh" #include "system.hh" #include "warn.hh" +#include "unpure-pure-container.hh" + +static bool +pure_staff_priority_less (Grob *const &g1, Grob *const &g2); + +Real Axis_group_interface::default_outside_staff_padding_ = 0.46; + +Real +Axis_group_interface::get_default_outside_staff_padding () +{ + return default_outside_staff_padding_; +} void Axis_group_interface::add_element (Grob *me, Grob *e) @@ -36,12 +63,12 @@ Axis_group_interface::add_element (Grob *me, Grob *e) Axis a = (Axis) scm_to_int (scm_car (ax)); if (!e->get_parent (a)) - e->set_parent (me, a); + e->set_parent (me, a); e->set_object ((a == X_AXIS) - ? ly_symbol2scm ("axis-group-parent-X") - : ly_symbol2scm ("axis-group-parent-Y"), - me->self_scm ()); + ? ly_symbol2scm ("axis-group-parent-X") + : ly_symbol2scm ("axis-group-parent-Y"), + me->self_scm ()); } /* must be ordered, because Align_interface also uses @@ -58,45 +85,109 @@ Axis_group_interface::has_axis (Grob *me, Axis a) } Interval -Axis_group_interface::relative_group_extent (vector const &elts, - Grob *common, Axis a) +Axis_group_interface::relative_group_extent (vector const &elts, + Grob *common, Axis a) +{ + return relative_maybe_bound_group_extent (elts, common, a, false); +} + +Interval +Axis_group_interface::relative_maybe_bound_group_extent (vector const &elts, + Grob *common, Axis a, bool bound) { Interval r; for (vsize i = 0; i < elts.size (); i++) { Grob *se = elts[i]; if (!to_boolean (se->get_property ("cross-staff"))) - { - Interval dims = se->extent (common, a); - if (!dims.is_empty ()) - r.unite (dims); - } + { + Interval dims = (bound && has_interface (se) + ? generic_bound_extent (se, common, a) + : se->extent (common, a)); + if (!dims.is_empty ()) + r.unite (dims); + } } return r; } Interval -Axis_group_interface::cached_pure_height (Grob *me, int start, int end) +Axis_group_interface::generic_bound_extent (Grob *me, Grob *common, Axis a) { - SCM adjacent_pure_heights = me->get_property ("adjacent-pure-heights"); + /* trigger the callback to do skyline-spacing on the children */ + if (a == Y_AXIS) + (void) me->get_property ("vertical-skylines"); + + extract_grob_set (me, "elements", elts); + vector new_elts; - if (!scm_is_pair (adjacent_pure_heights) - || !scm_is_vector (scm_cdr (adjacent_pure_heights))) - return Interval (0, 0); + SCM interfaces = me->get_property ("bound-alignment-interfaces"); - return combine_pure_heights (me, scm_cdr (adjacent_pure_heights), start, end); + for (vsize i = 0; i < elts.size (); i++) + for (SCM l = interfaces; scm_is_pair (l); l = scm_cdr (l)) + if (elts[i]->internal_has_interface (scm_car (l))) + new_elts.push_back (elts[i]); + + if (!new_elts.size ()) + return robust_relative_extent (me, common, a); + + if (!common) + common = common_refpoint_of_array (new_elts, me, a); + + return relative_maybe_bound_group_extent (new_elts, common, a, true); } Interval -Axis_group_interface::begin_of_line_pure_height (Grob *me, int start) +Axis_group_interface::sum_partial_pure_heights (Grob *me, int start, int end) +{ + Interval iv = begin_of_line_pure_height (me, start); + iv.unite (rest_of_line_pure_height (me, start, end)); + + return iv; +} + +Interval +Axis_group_interface::part_of_line_pure_height (Grob *me, bool begin, int start, int end) { + Spanner *sp = dynamic_cast (me); + SCM cache_symbol = begin + ? ly_symbol2scm ("begin-of-line-pure-height") + : ly_symbol2scm ("rest-of-line-pure-height"); + SCM cached = sp->get_cached_pure_property (cache_symbol, start, end); + if (scm_is_pair (cached)) + return robust_scm2interval (cached, Interval (0, 0)); + SCM adjacent_pure_heights = me->get_property ("adjacent-pure-heights"); + Interval ret; + + if (!scm_is_pair (adjacent_pure_heights)) + ret = Interval (0, 0); + else + { + SCM these_pure_heights = begin + ? scm_car (adjacent_pure_heights) + : scm_cdr (adjacent_pure_heights); + + if (scm_is_vector (these_pure_heights)) + ret = combine_pure_heights (me, these_pure_heights, start, end); + else + ret = Interval (0, 0); + } + + sp->cache_pure_property (cache_symbol, start, end, ly_interval2scm (ret)); + return ret; +} - if (!scm_is_pair (adjacent_pure_heights) - || !scm_is_vector (scm_car (adjacent_pure_heights))) - return Interval (0, 0); +Interval +Axis_group_interface::begin_of_line_pure_height (Grob *me, int start) +{ + return part_of_line_pure_height (me, true, start, start + 1); +} - return combine_pure_heights (me, scm_car (adjacent_pure_heights), start, start+1); +Interval +Axis_group_interface::rest_of_line_pure_height (Grob *me, int start, int end) +{ + return part_of_line_pure_height (me, false, start, end); } Interval @@ -104,17 +195,17 @@ Axis_group_interface::combine_pure_heights (Grob *me, SCM measure_extents, int s { Paper_score *ps = get_root_system (me)->paper_score (); vector breaks = ps->get_break_indices (); - vector cols = ps->get_columns (); + vector cols = ps->get_columns (); Interval ext; for (vsize i = 0; i + 1 < breaks.size (); i++) { int r = Paper_column::get_rank (cols[breaks[i]]); if (r >= end) - break; + break; if (r >= start) - ext.unite (ly_scm2interval (scm_c_vector_ref (measure_extents, i))); + ext.unite (ly_scm2interval (scm_c_vector_ref (measure_extents, i))); } return ext; @@ -126,70 +217,103 @@ Axis_group_interface::combine_pure_heights (Grob *me, SCM measure_extents, int s // is at the beginning of a line. The second vector stores, for each measure, // the combined height of the elements that are present only when the bar // is not at the beginning of a line. - MAKE_SCHEME_CALLBACK (Axis_group_interface, adjacent_pure_heights, 1) SCM Axis_group_interface::adjacent_pure_heights (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); - Grob *common = calc_pure_elts_and_common (me); - extract_grob_set (me, "pure-relevant-items", items); - extract_grob_set (me, "pure-relevant-spanners", spanners); + Grob *common = Grob::unsmob (me->get_object ("pure-Y-common")); + extract_grob_set (me, "pure-relevant-grobs", elts); Paper_score *ps = get_root_system (me)->paper_score (); - vector breaks = ps->get_break_indices (); - vector cols = ps->get_columns (); + vector ranks = ps->get_break_ranks (); - SCM begin_line_heights = scm_c_make_vector (breaks.size () - 1, SCM_EOL); - SCM mid_line_heights = scm_c_make_vector (breaks.size () - 1, SCM_EOL); + vector begin_line_heights; + vector mid_line_heights; + vector begin_line_staff_heights; + vector mid_line_staff_heights; + begin_line_heights.resize (ranks.size () - 1); + mid_line_heights.resize (ranks.size () - 1); - vsize it_index = 0; - for (vsize i = 0; i + 1 < breaks.size (); i++) + for (vsize i = 0; i < elts.size (); ++i) { - int start = Paper_column::get_rank (cols[breaks[i]]); - int end = Paper_column::get_rank (cols[breaks[i+1]]); - Interval begin_line_iv; - Interval mid_line_iv; - - for (vsize j = it_index; j < items.size (); j++) - { - Item *it = dynamic_cast (items[j]); - int rank = it->get_column ()->get_rank (); - - if (rank <= end && it->pure_is_visible (start, end) - && !to_boolean (it->get_property ("cross-staff"))) - { - Interval dims = items[j]->pure_height (common, start, end); - Interval &target_iv = start == it->get_column ()->get_rank () ? begin_line_iv : mid_line_iv; - - if (!dims.is_empty ()) - target_iv.unite (dims); - } - - if (rank < end) - it_index++; - else if (rank > end) - break; - } - - for (vsize j = 0; j < spanners.size (); j++) - { - Interval_t rank_span = spanners[j]->spanned_rank_interval (); - if (rank_span[LEFT] <= end && rank_span[RIGHT] >= start - && !to_boolean (spanners[j]->get_property ("cross-staff"))) - { - Interval dims = spanners[j]->pure_height (common, start, end); - - if (!dims.is_empty ()) - mid_line_iv.unite (dims); - } - } - - scm_vector_set_x (begin_line_heights, scm_from_int (i), ly_interval2scm (begin_line_iv)); - scm_vector_set_x (mid_line_heights, scm_from_int (i), ly_interval2scm (mid_line_iv)); + Grob *g = elts[i]; + + if (to_boolean (g->get_property ("cross-staff"))) + continue; + + if (!g->is_live ()) + continue; + + bool outside_staff = scm_is_number (g->get_property ("outside-staff-priority")); + Real padding = robust_scm2double (g->get_property ("outside-staff-padding"), get_default_outside_staff_padding ()); + + // When we encounter the first outside-staff grob, make a copy + // of the current heights to use as an estimate for the staff heights. + // Note that the outside-staff approximation that we use here doesn't + // consider any collisions that might occur between outside-staff grobs, + // but only the fact that outside-staff grobs may need to be raised above + // the staff. + if (outside_staff && begin_line_staff_heights.empty ()) + { + begin_line_staff_heights = begin_line_heights; + mid_line_staff_heights = mid_line_heights; + } + + // TODO: consider a pure version of get_grob_direction? + Direction d = to_dir (g->get_property_data ("direction")); + d = (d == CENTER) ? UP : d; + + Interval_t rank_span = g->spanned_rank_interval (); + vsize first_break = lower_bound (ranks, (vsize)rank_span[LEFT], less ()); + if (first_break > 0 && ranks[first_break] >= (vsize)rank_span[LEFT]) + first_break--; + + for (vsize j = first_break; j + 1 < ranks.size () && (int)ranks[j] <= rank_span[RIGHT]; ++j) + { + int start = ranks[j]; + int end = ranks[j + 1]; + + // Take grobs that are visible with respect to a slightly longer line. + // Otherwise, we will never include grobs at breakpoints which aren't + // end-of-line-visible. + int visibility_end = j + 2 < ranks.size () ? ranks[j + 2] : end; + + if (g->pure_is_visible (start, visibility_end)) + { + Interval dims = g->pure_height (common, start, end); + if (!dims.is_empty ()) + { + if (rank_span[LEFT] <= start) + { + if (outside_staff) + begin_line_heights[j].unite (begin_line_staff_heights[j].union_disjoint (dims, padding, d)); + else + begin_line_heights[j].unite (dims); + } + if (rank_span[RIGHT] > start) + { + if (outside_staff) + mid_line_heights[j].unite (mid_line_staff_heights[j].union_disjoint (dims, padding, d)); + else + mid_line_heights[j].unite (dims); + } + } + } + } } - return scm_cons (begin_line_heights, mid_line_heights); + + // Convert begin_line_heights and min_line_heights to SCM. + SCM begin_scm = scm_c_make_vector (ranks.size () - 1, SCM_EOL); + SCM mid_scm = scm_c_make_vector (ranks.size () - 1, SCM_EOL); + for (vsize i = 0; i < begin_line_heights.size (); ++i) + { + scm_vector_set_x (begin_scm, scm_from_int (i), ly_interval2scm (begin_line_heights[i])); + scm_vector_set_x (mid_scm, scm_from_int (i), ly_interval2scm (mid_line_heights[i])); + } + + return scm_cons (begin_scm, mid_scm); } Interval @@ -200,46 +324,30 @@ Axis_group_interface::relative_pure_height (Grob *me, int start, int end) Unfortunately, it isn't always true, particularly if there is a VerticalAlignment somewhere in the descendants. - Apart from PianoStaff, which has a fixed VerticalAlignment so it doesn't - count, the only VerticalAlignment comes from Score. This makes it + Usually, the only VerticalAlignment comes from Score. This makes it reasonably safe to assume that if our parent is a VerticalAlignment, we can assume additivity and cache things nicely. */ Grob *p = me->get_parent (Y_AXIS); if (p && Align_interface::has_interface (p)) - return Axis_group_interface::cached_pure_height (me, start, end); + return Axis_group_interface::sum_partial_pure_heights (me, start, end); - Grob *common = calc_pure_elts_and_common (me); - extract_grob_set (me, "pure-relevant-items", items); - extract_grob_set (me, "pure-relevant-spanners", spanners); + Grob *common = Grob::unsmob (me->get_object ("pure-Y-common")); + extract_grob_set (me, "pure-relevant-grobs", elts); Interval r; - - for (vsize i = 0; i < items.size (); i++) - { - Item *it = dynamic_cast (items[i]); - int rank = it->get_column ()->get_rank (); - - if (rank > end) - break; - else if (rank >= start && it->pure_is_visible (start, end) - && !to_boolean (it->get_property ("cross-staff"))) - { - Interval dims = it->pure_height (common, start, end); - if (!dims.is_empty ()) - r.unite (dims); - } - } - - for (vsize i = 0; i < spanners.size (); i++) + for (vsize i = 0; i < elts.size (); i++) { - Interval_t rank_span = spanners[i]->spanned_rank_interval (); + Grob *g = elts[i]; + Interval_t rank_span = g->spanned_rank_interval (); if (rank_span[LEFT] <= end && rank_span[RIGHT] >= start - && !to_boolean (spanners[i]->get_property ("cross-staff"))) - { - Interval dims = spanners[i]->pure_height (common, start, end); - if (!dims.is_empty ()) - r.unite (dims); - } + && g->pure_is_visible (start, end) + && !(to_boolean (g->get_property ("cross-staff")) + && Stem::has_interface (g))) + { + Interval dims = g->pure_height (common, start, end); + if (!dims.is_empty ()) + r.unite (dims); + } } return r; } @@ -248,7 +356,7 @@ MAKE_SCHEME_CALLBACK (Axis_group_interface, width, 1); SCM Axis_group_interface::width (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); return generic_group_extent (me, X_AXIS); } @@ -256,7 +364,7 @@ MAKE_SCHEME_CALLBACK (Axis_group_interface, height, 1); SCM Axis_group_interface::height (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); return generic_group_extent (me, Y_AXIS); } @@ -266,17 +374,17 @@ Axis_group_interface::pure_height (SCM smob, SCM start_scm, SCM end_scm) { int start = robust_scm2int (start_scm, 0); int end = robust_scm2int (end_scm, INT_MAX); - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); /* Maybe we are in the second pass of a two-pass spacing run. In that case, the Y-extent of a system is already given to us */ - System *system = dynamic_cast (me); + System *system = dynamic_cast (me); if (system) { SCM line_break_details = system->column (start)->get_property ("line-break-system-details"); SCM system_y_extent = scm_assq (ly_symbol2scm ("system-Y-extent"), line_break_details); if (scm_is_pair (system_y_extent)) - return scm_cdr (system_y_extent); + return scm_cdr (system_y_extent); } return ly_interval2scm (pure_group_height (me, start, end)); @@ -286,10 +394,8 @@ MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_skylines, 1); SCM Axis_group_interface::calc_skylines (SCM smob) { - Grob *me = unsmob_grob (smob); - extract_grob_set (me, "elements", elts); - Skyline_pair skylines = skyline_spacing (me, elts); - + Grob *me = Grob::unsmob (smob); + Skyline_pair skylines = skyline_spacing (me); return skylines.smobbed_copy (); } @@ -303,7 +409,7 @@ MAKE_SCHEME_CALLBACK (Axis_group_interface, combine_skylines, 1); SCM Axis_group_interface::combine_skylines (SCM smob) { - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); extract_grob_set (me, "elements", elements); Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS); Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS); @@ -316,25 +422,29 @@ Axis_group_interface::combine_skylines (SCM smob) { SCM skyline_scm = elements[i]->get_property ("vertical-skylines"); if (Skyline_pair::unsmob (skyline_scm)) - { - Real offset = elements[i]->relative_coordinate (y_common, Y_AXIS); - Skyline_pair other = *Skyline_pair::unsmob (skyline_scm); - other.raise (offset); - other.shift (elements[i]->relative_coordinate (x_common, X_AXIS)); - ret.merge (other); - } + { + Real offset = elements[i]->relative_coordinate (y_common, Y_AXIS); + Skyline_pair other = *Skyline_pair::unsmob (skyline_scm); + other.raise (offset); + other.shift (elements[i]->relative_coordinate (x_common, X_AXIS)); + ret.merge (other); + } } return ret.smobbed_copy (); } - + SCM Axis_group_interface::generic_group_extent (Grob *me, Axis a) { + extract_grob_set (me, "elements", elts); + /* trigger the callback to do skyline-spacing on the children */ if (a == Y_AXIS) - (void) me->get_property ("vertical-skylines"); + for (vsize i = 0; i < elts.size (); i++) + if (!(Stem::has_interface (elts[i]) + && to_boolean (elts[i]->get_property ("cross-staff")))) + (void) elts[i]->get_property ("vertical-skylines"); - extract_grob_set (me, "elements", elts); Grob *common = common_refpoint_of_array (elts, me, a); Real my_coord = me->relative_coordinate (common, a); @@ -350,7 +460,7 @@ Interval Axis_group_interface::staff_extent (Grob *me, Grob *refp, Axis ext_a, Grob *staff, Axis parent_a) { extract_grob_set (me, "elements", elts); - vector new_elts; + vector new_elts; for (vsize i = 0; i < elts.size (); i++) if (elts[i]->common_refpoint (staff, parent_a) == staff) @@ -359,57 +469,83 @@ Axis_group_interface::staff_extent (Grob *me, Grob *refp, Axis ext_a, Grob *staf return relative_group_extent (new_elts, refp, ext_a); } +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_relevant_grobs, 1); +SCM +Axis_group_interface::calc_pure_relevant_grobs (SCM smob) +{ + Grob *me = Grob::unsmob (smob); + /* TODO: Filter out elements that belong to a different Axis_group, + such as the tie in + << \new Staff=A { c'1~ \change Staff=B c'} + \new Staff=B { \clef bass R1 R } >> + because thier location relative to this Axis_group is not known before + page layout. For now, we need to trap this case in calc_pure_y_common. + */ + return internal_calc_pure_relevant_grobs (me, "elements"); +} -Grob * -Axis_group_interface::calc_pure_elts_and_common (Grob *me) +SCM +Axis_group_interface::internal_calc_pure_relevant_grobs (Grob *me, const string &grob_set_name) { - if (Grob *c = unsmob_grob (me->get_object ("pure-Y-common"))) - return c; - - extract_grob_set (me, "elements", elts); + extract_grob_set (me, grob_set_name.c_str (), elts); - vector relevant_items; - vector relevant_spanners; - SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?"); + vector relevant_grobs; for (vsize i = 0; i < elts.size (); i++) { - if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL))) - { - if (dynamic_cast (elts[i])) - relevant_items.push_back (elts[i]); - else if (dynamic_cast (elts[i])) - relevant_spanners.push_back (elts[i]); - } - - - Item *it = dynamic_cast (elts[i]); - Direction d = LEFT; - if (it) - do - { - Item *piece = it->find_prebroken_piece (d); - if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL))) - relevant_items.push_back (piece); - } - while (flip (&d) != LEFT); + if (elts[i] && elts[i]->is_live ()) + relevant_grobs.push_back (elts[i]); + /* + TODO (mikesol): it is probably bad that we're reading prebroken + pieces from potentially suicided elements. This behavior + has been in current master since at least 2.16. + + We need to fully suicide all Items, meaning that their + prebroken pieces should not be accessible, which means that + Item::handle_prebroken_dependencies should only be called + AFTER this list is composed. The list composition function + should probably not check for suicided items or NULL pointers + but leave that to the various methods that use it. + */ + if (Item *it = dynamic_cast (elts[i])) + { + for (LEFT_and_RIGHT (d)) + { + Item *piece = it->find_prebroken_piece (d); + if (piece && piece->is_live ()) + relevant_grobs.push_back (piece); + } + } } - vector_sort (relevant_items, Item::less); - Grob *common = common_refpoint_of_array (relevant_items, me, Y_AXIS); - common = common_refpoint_of_array (relevant_spanners, common, Y_AXIS); + vector_sort (relevant_grobs, pure_staff_priority_less); + SCM grobs_scm = Grob_array::make_array (); + Grob_array::unsmob (grobs_scm)->set_array (relevant_grobs); - me->set_object ("pure-Y-common", common->self_scm ()); - - SCM items_scm = Grob_array::make_array (); - SCM spanners_scm = Grob_array::make_array (); + return grobs_scm; +} - unsmob_grob_array (items_scm)->set_array (relevant_items); - unsmob_grob_array (spanners_scm)->set_array (relevant_spanners); - me->set_object ("pure-relevant-items", items_scm); - me->set_object ("pure-relevant-spanners", spanners_scm); +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_y_common, 1); +SCM +Axis_group_interface::calc_pure_y_common (SCM smob) +{ + Grob *me = Grob::unsmob (smob); - return common; + extract_grob_set (me, "pure-relevant-grobs", elts); + Grob *common = common_refpoint_of_array (elts, me, Y_AXIS); + if (common != me && Align_interface::has_interface (common)) + { + me->programming_error("My pure_y_common is a VerticalAlignment," + " which might contain several staves."); + common = me; + } + if (!common) + { + me->programming_error ("No common parent found in calc_pure_y_common."); + return SCM_EOL; + } + + return common->self_scm (); } SCM @@ -422,38 +558,42 @@ Axis_group_interface::calc_common (Grob *me, Axis axis) me->programming_error ("No common parent found in calc_common axis."); return SCM_EOL; } - + return common->self_scm (); } - MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_x_common, 1); SCM Axis_group_interface::calc_x_common (SCM grob) { - return calc_common (unsmob_grob (grob), X_AXIS); + return calc_common (Grob::unsmob (grob), X_AXIS); } MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_y_common, 1); SCM Axis_group_interface::calc_y_common (SCM grob) { - return calc_common (unsmob_grob (grob), Y_AXIS); + return calc_common (Grob::unsmob (grob), Y_AXIS); } Interval Axis_group_interface::pure_group_height (Grob *me, int start, int end) { - Grob *common = calc_pure_elts_and_common (me); - - Real my_coord = me->relative_coordinate (common, Y_AXIS); + Grob *common = Grob::unsmob (me->get_object ("pure-Y-common")); + + if (!common) + { + programming_error ("no pure Y common refpoint"); + return Interval (); + } + Real my_coord = me->pure_relative_y_coordinate (common, start, end); Interval r (relative_pure_height (me, start, end)); return r - my_coord; } void -Axis_group_interface::get_children (Grob *me, vector *found) +Axis_group_interface::get_children (Grob *me, vector *found) { found->push_back (me); @@ -468,8 +608,8 @@ Axis_group_interface::get_children (Grob *me, vector *found) } } -bool -staff_priority_less (Grob * const &g1, Grob * const &g2) +static bool +staff_priority_less (Grob *const &g1, Grob *const &g2) { Real priority_1 = robust_scm2double (g1->get_property ("outside-staff-priority"), -infinity_f); Real priority_2 = robust_scm2double (g2->get_property ("outside-staff-priority"), -infinity_f); @@ -492,108 +632,229 @@ staff_priority_less (Grob * const &g1, Grob * const &g2) return start_1 < start_2; } +static bool +pure_staff_priority_less (Grob *const &g1, Grob *const &g2) +{ + Real priority_1 = robust_scm2double (g1->get_property ("outside-staff-priority"), -infinity_f); + Real priority_2 = robust_scm2double (g2->get_property ("outside-staff-priority"), -infinity_f); + + return priority_1 < priority_2; +} + static void -add_boxes (Grob *me, Grob *x_common, Grob *y_common, vector *const boxes, Skyline_pair *skylines) +add_interior_skylines (Grob *me, Grob *x_common, Grob *y_common, vector *skylines) { - /* if a child has skylines, use them instead of the extent box */ - if (Skyline_pair *pair = Skyline_pair::unsmob (me->get_property ("vertical-skylines"))) - { - Skyline_pair s = *pair; - s.shift (me->relative_coordinate (x_common, X_AXIS)); - s.raise (me->relative_coordinate (y_common, Y_AXIS)); - skylines->merge (s); - } - else if (Grob_array *elements = unsmob_grob_array (me->get_object ("elements"))) + if (Grob_array *elements = Grob_array::unsmob (me->get_object ("elements"))) { for (vsize i = 0; i < elements->size (); i++) - add_boxes (elements->grob (i), x_common, y_common, boxes, skylines); + add_interior_skylines (elements->grob (i), x_common, y_common, skylines); } else if (!scm_is_number (me->get_property ("outside-staff-priority")) - && !to_boolean (me->get_property ("cross-staff"))) + && !to_boolean (me->get_property ("cross-staff"))) { - boxes->push_back (Box (me->extent (x_common, X_AXIS), - me->extent (y_common, Y_AXIS))); + Skyline_pair *maybe_pair = Skyline_pair::unsmob (me->get_property ("vertical-skylines")); + if (!maybe_pair) + return; + if (maybe_pair->is_empty ()) + return; + skylines->push_back (Skyline_pair (*maybe_pair)); + skylines->back ().shift (me->relative_coordinate (x_common, X_AXIS)); + skylines->back ().raise (me->relative_coordinate (y_common, Y_AXIS)); } } -/* We want to avoid situations like this: - still more text - more text - text - ------------------- - staff - ------------------- - - The point is that "still more text" should be positioned under - "more text". In order to achieve this, we place the grobs in several - passes. We keep track of the right-most horizontal position that has been - affected by the current pass so far (actually we keep track of 2 - positions, one for above the staff, one for below). - - In each pass, we loop through the unplaced grobs from left to right. - If the grob doesn't overlap the right-most affected position, we place it - (and then update the right-most affected position to point to the right - edge of the just-placed grob). Otherwise, we skip it until the next pass. -*/ +// Raises the grob elt (whose skylines are given by h_skyline +// and v_skyline) so that it doesn't intersect with staff_skyline, +// or with anything in other_h_skylines and other_v_skylines. +void +avoid_outside_staff_collisions (Grob *elt, + Skyline_pair *v_skyline, + Real padding, + Real horizon_padding, + vector const &other_v_skylines, + vector const &other_padding, + vector const &other_horizon_padding, + Direction const dir) +{ + assert (other_v_skylines.size () == other_padding.size ()); + assert (other_v_skylines.size () == other_horizon_padding.size ()); + vector forbidden_intervals; + for (vsize j = 0; j < other_v_skylines.size (); j++) + { + Skyline_pair const &v_other = other_v_skylines[j]; + Real pad = max (padding, other_padding[j]); + Real horizon_pad = max (horizon_padding, other_horizon_padding[j]); + + // We need to push elt up by at least this much to be above v_other. + Real up = (*v_skyline)[DOWN].distance (v_other[UP], horizon_pad) + pad; + // We need to push elt down by at least this much to be below v_other. + Real down = (*v_skyline)[UP].distance (v_other[DOWN], horizon_pad) + pad; + + forbidden_intervals.push_back (Interval (-down, up)); + } + + Interval_set allowed_shifts + = Interval_set::interval_union (forbidden_intervals).complement (); + Real move = allowed_shifts.nearest_point (0, dir); + v_skyline->raise (move); + elt->translate_axis (move, Y_AXIS); +} + +SCM +valid_outside_staff_placement_directive (Grob *me) +{ + SCM directive = me->get_property ("outside-staff-placement-directive"); + + if ((directive == ly_symbol2scm ("left-to-right-greedy")) + || (directive == ly_symbol2scm ("left-to-right-polite")) + || (directive == ly_symbol2scm ("right-to-left-greedy")) + || (directive == ly_symbol2scm ("right-to-left-polite"))) + return directive; + + me->warning (_f ("\"%s\" is not a valid outside-staff-placement-directive", + robust_symbol2string (directive, "").c_str ())); + + return ly_symbol2scm ("left-to-right-polite"); +} + +// Shifts the grobs in elements to ensure that they (and any +// connected riders) don't collide with the staff skylines +// or anything in all_X_skylines. Afterwards, the skylines +// of the grobs in elements will be added to all_v_skylines. static void -add_grobs_of_one_priority (Skyline_pair *const skylines, - vector elements, - Grob *x_common, - Grob *y_common) +add_grobs_of_one_priority (Grob *me, + Drul_array > *all_v_skylines, + Drul_array > *all_paddings, + Drul_array > *all_horizon_paddings, + vector elements, + Grob *x_common, + Grob *y_common, + multimap const &riders) { - vector boxes; - Drul_array last_affected_position; - reverse (elements); + SCM directive + = valid_outside_staff_placement_directive (me); + + bool l2r = ((directive == ly_symbol2scm ("left-to-right-greedy")) + || (directive == ly_symbol2scm ("left-to-right-polite"))); + + bool polite = ((directive == ly_symbol2scm ("left-to-right-polite")) + || (directive == ly_symbol2scm ("right-to-left-polite"))); + + vector boxes; + vector skylines_to_merge; + + // We want to avoid situations like this: + // still more text + // more text + // text + // ------------------- + // staff + // ------------------- + + // The point is that "still more text" should be positioned under + // "more text". In order to achieve this, we place the grobs in several + // passes. We keep track of the right-most horizontal position that has been + // affected by the current pass so far (actually we keep track of 2 + // positions, one for above the staff, one for below). + + // In each pass, we loop through the unplaced grobs from left to right. + // If the grob doesn't overlap the right-most affected position, we place it + // (and then update the right-most affected position to point to the right + // edge of the just-placed grob). Otherwise, we skip it until the next pass. while (!elements.empty ()) { - last_affected_position[UP] = -infinity_f; - last_affected_position[DOWN] = -infinity_f; - /* do one pass */ - for (vsize i = elements.size (); i--;) - { - Direction dir = get_grob_direction (elements[i]); - if (dir == CENTER) - { - warning (_ ("an outside-staff object should have a direction, defaulting to up")); - dir = UP; - } - - Box b (elements[i]->extent (x_common, X_AXIS), - elements[i]->extent (y_common, Y_AXIS)); - SCM horizon_padding_scm = elements[i]->get_property ("outside-staff-horizontal-padding"); - Real horizon_padding = robust_scm2double (horizon_padding_scm, 0.0); - - if (b[X_AXIS][LEFT] - 2*horizon_padding < last_affected_position[dir]) - continue; - - if (!b[X_AXIS].is_empty () && !b[Y_AXIS].is_empty ()) - { - boxes.clear (); - boxes.push_back (b); - Skyline other = Skyline (boxes, horizon_padding, X_AXIS, -dir); - Real padding = robust_scm2double (elements[i]->get_property ("outside-staff-padding"), 0.5); - Real dist = (*skylines)[dir].distance (other) + padding; - - if (dist > 0) - { - b.translate (Offset (0, dir*dist)); - elements[i]->translate_axis (dir*dist, Y_AXIS); - } - skylines->insert (b, 0, X_AXIS); - elements[i]->set_property ("outside-staff-priority", SCM_BOOL_F); - last_affected_position[dir] = b[X_AXIS][RIGHT]; - } - - /* - Ugh: quadratic. --hwn - */ - elements.erase (elements.begin () + i); - } + Drul_array last_end (-infinity_f, -infinity_f); + vector skipped_elements; + for (vsize i = l2r ? 0 : elements.size (); + l2r ? i < elements.size () : i--; + l2r ? i++ : 0) + { + Grob *elt = elements[i]; + Real padding + = robust_scm2double (elt->get_property ("outside-staff-padding"), + Axis_group_interface + ::get_default_outside_staff_padding ()); + Real horizon_padding + = robust_scm2double (elt->get_property ("outside-staff-horizontal-padding"), 0.0); + Interval x_extent = elt->extent (x_common, X_AXIS); + x_extent.widen (horizon_padding); + + Direction dir = get_grob_direction (elt); + if (dir == CENTER) + { + warning (_ ("an outside-staff object should have a direction, defaulting to up")); + dir = UP; + } + + if (x_extent[LEFT] <= last_end[dir] && polite) + { + skipped_elements.push_back (elt); + continue; + } + last_end[dir] = x_extent[RIGHT]; + + Skyline_pair *v_orig = Skyline_pair::unsmob (elt->get_property ("vertical-skylines")); + if (v_orig->is_empty ()) + continue; + + // Find the riders associated with this grob, and merge their + // skylines with elt's skyline. + typedef multimap::const_iterator GrobMapIterator; + pair range = riders.equal_range (elt); + vector rider_v_skylines; + for (GrobMapIterator j = range.first; j != range.second; j++) + { + Grob *rider = j->second; + Skyline_pair *v_rider = Skyline_pair::unsmob (rider->get_property ("vertical-skylines")); + if (v_rider) + { + Skyline_pair copy (*v_rider); + copy.shift (rider->relative_coordinate (x_common, X_AXIS)); + copy.raise (rider->relative_coordinate (y_common, Y_AXIS)); + rider_v_skylines.push_back (copy); + } + } + Skyline_pair v_skylines (*v_orig); + v_skylines.shift (elt->relative_coordinate (x_common, X_AXIS)); + v_skylines.raise (elt->relative_coordinate (y_common, Y_AXIS)); + v_skylines.merge (Skyline_pair (rider_v_skylines)); + + avoid_outside_staff_collisions (elt, + &v_skylines, + padding, + horizon_padding, + (*all_v_skylines)[dir], + (*all_paddings)[dir], + (*all_horizon_paddings)[dir], + dir); + + elt->set_property ("outside-staff-priority", SCM_BOOL_F); + (*all_v_skylines)[dir].push_back (v_skylines); + (*all_paddings)[dir].push_back (padding); + (*all_horizon_paddings)[dir].push_back (horizon_padding); + } + swap (elements, skipped_elements); + skipped_elements.clear (); } } -// TODO: it is tricky to correctly handle skyline placement of cross-staff grobs. +// If the Grob has a Y-ancestor with outside-staff-priority, return it. +// Otherwise, return 0. +Grob * +Axis_group_interface::outside_staff_ancestor (Grob *me) +{ + Grob *parent = me->get_parent (Y_AXIS); + if (!parent) + return 0; + + if (scm_is_number (parent->get_property ("outside-staff-priority"))) + return parent; + + return outside_staff_ancestor (parent); +} + +// It is tricky to correctly handle skyline placement of cross-staff grobs. // For example, cross-staff beams cannot be formatted until the distance between // staves is known and therefore any grobs that depend on the beam cannot be placed // until the skylines are known. On the other hand, the distance between staves should @@ -603,8 +864,23 @@ add_grobs_of_one_priority (Skyline_pair *const skylines, // that there is no room for the cross-staff grob. It also means, of course, that // we don't get the benefits of skyline placement for cross-staff grobs. Skyline_pair -Axis_group_interface::skyline_spacing (Grob *me, vector elements) +Axis_group_interface::skyline_spacing (Grob *me) { + extract_grob_set (me, Grob_array::unsmob (me->get_object ("vertical-skyline-elements")) ? "vertical-skyline-elements" : "elements", fakeelements); + vector elements (fakeelements); + for (vsize i = 0; i < elements.size (); i++) + /* + As a sanity check, we make sure that no grob with an outside staff priority + has a Y-parent that also has an outside staff priority, which would result + in two movings. + */ + if (scm_is_number (elements[i]->get_property ("outside-staff-priority")) + && outside_staff_ancestor (elements[i])) + { + elements[i]->warning ("Cannot set outside-staff-priority for element and elements' Y parent."); + elements[i]->set_property ("outside-staff-priority", SCM_BOOL_F); + } + /* For grobs with an outside-staff-priority, the sorting function might call extent and cause suicide. This breaks the contract that is required for the STL sort function. To avoid this, we make sure that any suicides @@ -618,39 +894,83 @@ Axis_group_interface::skyline_spacing (Grob *me, vector elements) Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS); Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS); - assert (y_common == me); + if (y_common != me) + { + me->programming_error("Some of my vertical-skyline-elements" + " are outside my VerticalAxisGroup."); + y_common = me; + } + + // A rider is a grob that is not outside-staff, but has an outside-staff + // ancestor. In that case, the rider gets moved along with its ancestor. + multimap riders; vsize i = 0; - vector boxes; + vector inside_staff_skylines; - Skyline_pair skylines; for (i = 0; i < elements.size () - && !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++) - if (!to_boolean (elements[i]->get_property ("cross-staff"))) - add_boxes (elements[i], x_common, y_common, &boxes, &skylines); + && !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++) + { + Grob *elt = elements[i]; + Grob *ancestor = outside_staff_ancestor (elt); + if (!(to_boolean (elt->get_property ("cross-staff")) || ancestor)) + add_interior_skylines (elt, x_common, y_common, &inside_staff_skylines); + if (ancestor) + riders.insert (pair (ancestor, elt)); + } + + Skyline_pair skylines (inside_staff_skylines); + + // These are the skylines of all outside-staff grobs + // that have already been processed. We keep them around in order to + // check them for collisions with the currently active outside-staff grob. + Drul_array > all_v_skylines; + Drul_array > all_paddings; + Drul_array > all_horizon_paddings; + for (UP_and_DOWN (d)) + { + all_v_skylines[d].push_back (skylines); + all_paddings[d].push_back (0); + all_horizon_paddings[d].push_back (0); + } - SCM padding_scm = me->get_property ("skyline-horizontal-padding"); - Real padding = robust_scm2double (padding_scm, 0.1); - skylines.merge (Skyline_pair (boxes, padding, X_AXIS)); for (; i < elements.size (); i++) { if (to_boolean (elements[i]->get_property ("cross-staff"))) - continue; + continue; + // Collect all the outside-staff grobs that have a particular priority. SCM priority = elements[i]->get_property ("outside-staff-priority"); - vector current_elts; + vector current_elts; current_elts.push_back (elements[i]); - while (i + 1 < elements.size () - && scm_eq_p (elements[i+1]->get_property ("outside-staff-priority"), priority)) - { - if (!to_boolean (elements[i+1]->get_property ("cross-staff"))) - current_elts.push_back (elements[i+1]); - ++i; - } - - add_grobs_of_one_priority (&skylines, current_elts, x_common, y_common); + while (i + 1 < elements.size () + && scm_is_eq (elements[i + 1]->get_property ("outside-staff-priority"), priority)) + { + if (!to_boolean (elements[i + 1]->get_property ("cross-staff"))) + current_elts.push_back (elements[i + 1]); + ++i; + } + + add_grobs_of_one_priority (me, + &all_v_skylines, + &all_paddings, + &all_horizon_paddings, + current_elts, + x_common, + y_common, + riders); } + + // Now everything in all_v_skylines has been shifted appropriately; merge + // them all into skylines to get the complete outline. + Skyline_pair other_skylines (all_v_skylines[UP]); + other_skylines.merge (Skyline_pair (all_v_skylines[DOWN])); + skylines.merge (other_skylines); + + // We began by shifting my skyline to be relative to the common refpoint; now + // shift it back. skylines.shift (-me->relative_coordinate (x_common, X_AXIS)); + return skylines; } @@ -661,60 +981,79 @@ Axis_group_interface::print (SCM smob) if (!debug_skylines) return SCM_BOOL_F; - Grob *me = unsmob_grob (smob); + Grob *me = Grob::unsmob (smob); Stencil ret; if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("vertical-skylines"))) { ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[UP].to_points (X_AXIS)) - .in_color (255, 0, 255)); + .in_color (255, 0, 255)); ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[DOWN].to_points (X_AXIS)) - .in_color (0, 255, 255)); + .in_color (0, 255, 255)); } return ret.smobbed_copy (); } -MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_next_staff_spacing, 1) +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_staff_staff_spacing, 3) +SCM +Axis_group_interface::calc_pure_staff_staff_spacing (SCM smob, SCM start, SCM end) +{ + return calc_maybe_pure_staff_staff_spacing (Grob::unsmob (smob), + true, + scm_to_int (start), + scm_to_int (end)); +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_staff_staff_spacing, 1) +SCM +Axis_group_interface::calc_staff_staff_spacing (SCM smob) +{ + return calc_maybe_pure_staff_staff_spacing (Grob::unsmob (smob), + false, + 0, + INT_MAX); +} + SCM -Axis_group_interface::calc_next_staff_spacing (SCM smob) +Axis_group_interface::calc_maybe_pure_staff_staff_spacing (Grob *me, bool pure, int start, int end) { - Grob *me = unsmob_grob (smob); - Grob *grouper = unsmob_grob (me->get_object ("staff-grouper")); + Grob *grouper = Grob::unsmob (me->get_object ("staff-grouper")); if (grouper) { - Grob *last_in_group = Staff_grouper_interface::get_last_grob (grouper); - if (me == last_in_group) - return grouper->get_property ("after-last-staff-spacing"); + bool within_group = Staff_grouper_interface::maybe_pure_within_group (grouper, me, pure, start, end); + if (within_group) + return grouper->get_maybe_pure_property ("staff-staff-spacing", pure, start, end); else - return grouper->get_property ("between-staff-spacing"); + return grouper->get_maybe_pure_property ("staffgroup-staff-spacing", pure, start, end); } - return me->get_property ("default-next-staff-spacing"); + return me->get_maybe_pure_property ("default-staff-staff-spacing", pure, start, end); } ADD_INTERFACE (Axis_group_interface, - "An object that groups other layout objects.", - - // TODO: some of these properties are specific to - // VerticalAxisGroup. We should split off a - // vertical-axis-group-interface. - /* properties */ - "X-common " - "Y-common " - "adjacent-pure-heights " - "axes " - "default-next-staff-spacing " - "elements " - "inter-loose-line-spacing " - "inter-staff-spacing " - "keep-fixed-while-stretching " - "max-stretch " - "next-staff-spacing " - "no-alignment " - "pure-Y-common " - "pure-relevant-items " - "pure-relevant-spanners " - "staff-affinity " - "staff-grouper " - "system-Y-offset " - "vertical-skylines " - ); + "An object that groups other layout objects.", + + // TODO: some of these properties are specific to + // VerticalAxisGroup. We should split off a + // vertical-axis-group-interface. + /* properties */ + "adjacent-pure-heights " + "axes " + "bound-alignment-interfaces " + "default-staff-staff-spacing " + "elements " + "max-stretch " + "no-alignment " + "nonstaff-nonstaff-spacing " + "nonstaff-relatedstaff-spacing " + "nonstaff-unrelatedstaff-spacing " + "pure-relevant-grobs " + "pure-relevant-items " + "pure-relevant-spanners " + "pure-Y-common " + "staff-affinity " + "staff-grouper " + "staff-staff-spacing " + "system-Y-offset " + "X-common " + "Y-common " + );