X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faxis-group-interface.cc;h=1e945f2f9ec8e58f768dc0ae50932e4f450b70e3;hb=refs%2Fheads%2Fdon%2Ffix_configure_ac;hp=3d6889c6ac3d9c828f57d6ba745756917c574cdf;hpb=2c22efe5a46a37065b10c3f51c5d7db00d07d318;p=lilypond.git diff --git a/lily/axis-group-interface.cc b/lily/axis-group-interface.cc index 3d6889c6ac..1e945f2f9e 100644 --- a/lily/axis-group-interface.cc +++ b/lily/axis-group-interface.cc @@ -1,17 +1,55 @@ /* - 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--2012 Han-Wen Nienhuys - (c) 2000--2005 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 "pointer-group-interface.hh" -#include "grob.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" +#include "pointer-group-interface.hh" +#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) @@ -20,56 +58,393 @@ Axis_group_interface::add_element (Grob *me, Grob *e) if (!scm_is_pair (axes)) programming_error ("axes should be nonempty"); - for (SCM ax = axes; ax != SCM_EOL; ax = scm_cdr (ax)) + for (SCM ax = axes; scm_is_pair (ax); ax = scm_cdr (ax)) { 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->internal_set_object ((a == X_AXIS) - ? ly_symbol2scm ("axis-group-parent-X") - : ly_symbol2scm ("axis-group-parent-Y"), - me->self_scm ()); + e->set_object ((a == X_AXIS) + ? ly_symbol2scm ("axis-group-parent-X") + : ly_symbol2scm ("axis-group-parent-Y"), + me->self_scm ()); } + /* must be ordered, because Align_interface also uses + Axis_group_interface */ Pointer_group_interface::add_grob (me, ly_symbol2scm ("elements"), e); } bool Axis_group_interface::has_axis (Grob *me, Axis a) { - /* - urg. FIXME, check for Hara_kiri_group_spanner shouldn't be necessary? - */ - return me->has_extent_callback (group_extent_callback_proc, a) - || (me->has_extent_callback (Hara_kiri_group_spanner::y_extent_proc, a)); + SCM axes = me->get_property ("axes"); + + return (SCM_BOOL_F != scm_memq (scm_from_int (a), axes)); } Interval -Axis_group_interface::relative_group_extent (Link_array 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 (int i = 0; i < elts.size (); i++) + for (vsize i = 0; i < elts.size (); i++) { Grob *se = elts[i]; - Interval dims = se->extent (common, a); - if (!dims.is_empty ()) - r.unite (dims); + if (!to_boolean (se->get_property ("cross-staff"))) + { + 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::generic_bound_extent (Grob *me, Grob *common, Axis a) +{ + /* 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; + + SCM interfaces = me->get_property ("bound-alignment-interfaces"); + + 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::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; +} + +Interval +Axis_group_interface::begin_of_line_pure_height (Grob *me, int start) +{ + return part_of_line_pure_height (me, true, 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 +Axis_group_interface::combine_pure_heights (Grob *me, SCM measure_extents, int start, int end) +{ + Paper_score *ps = get_root_system (me)->paper_score (); + vector breaks = ps->get_break_indices (); + 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; + + if (r >= start) + ext.unite (ly_scm2interval (scm_c_vector_ref (measure_extents, i))); + } + + return ext; +} + +// adjacent-pure-heights is a pair of vectors, each of which has one element +// for every measure in the score. The first vector stores, for each measure, +// the combined height of the elements that are present only when the bar +// 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 *common = unsmob_grob (me->get_object ("pure-Y-common")); + extract_grob_set (me, "pure-relevant-grobs", elts); + + Paper_score *ps = get_root_system (me)->paper_score (); + vector ranks = ps->get_break_ranks (); + + 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); + + for (vsize i = 0; i < elts.size (); ++i) + { + 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); + } + } + } + } + } + + // 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 +Axis_group_interface::relative_pure_height (Grob *me, int start, int end) +{ + /* It saves a _lot_ of time if we assume a VerticalAxisGroup is additive + (ie. height (i, k) = max (height (i, j) height (j, k)) for all i <= j <= k). + Unfortunately, it isn't always true, particularly if there is a + VerticalAlignment somewhere in the descendants. + + 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::sum_partial_pure_heights (me, start, end); + + Grob *common = unsmob_grob (me->get_object ("pure-Y-common")); + extract_grob_set (me, "pure-relevant-grobs", elts); + + Interval r; + for (vsize i = 0; i < elts.size (); i++) + { + Grob *g = elts[i]; + Interval_t rank_span = g->spanned_rank_interval (); + if (rank_span[LEFT] <= end && rank_span[RIGHT] >= start + && 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; } +MAKE_SCHEME_CALLBACK (Axis_group_interface, width, 1); +SCM +Axis_group_interface::width (SCM smob) +{ + Grob *me = unsmob_grob (smob); + return generic_group_extent (me, X_AXIS); +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, height, 1); +SCM +Axis_group_interface::height (SCM smob) +{ + Grob *me = unsmob_grob (smob); + return generic_group_extent (me, Y_AXIS); +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, pure_height, 3); +SCM +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); + + /* 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); + 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 ly_interval2scm (pure_group_height (me, start, end)); +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_skylines, 1); +SCM +Axis_group_interface::calc_skylines (SCM smob) +{ + Grob *me = unsmob_grob (smob); + Skyline_pair skylines = skyline_spacing (me); + return skylines.smobbed_copy (); +} -MAKE_SCHEME_CALLBACK (Axis_group_interface, group_extent_callback, 2); +/* whereas calc_skylines calculates skylines for axis-groups with a lot of + visible children, combine_skylines is designed for axis-groups whose only + children are other axis-groups (ie. VerticalAlignment). Rather than + calculating all the skylines from scratch, we just merge the skylines + of the children. +*/ +MAKE_SCHEME_CALLBACK (Axis_group_interface, combine_skylines, 1); SCM -Axis_group_interface::group_extent_callback (SCM element_smob, SCM scm_axis) +Axis_group_interface::combine_skylines (SCM smob) { - Grob *me = unsmob_grob (element_smob); - Axis a = (Axis) scm_to_int (scm_axis); + Grob *me = unsmob_grob (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); + + if (y_common != me) + programming_error ("combining skylines that don't belong to me"); + Skyline_pair ret; + for (vsize i = 0; i < elements.size (); i++) + { + 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); + } + } + 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) + 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"); + Grob *common = common_refpoint_of_array (elts, me, a); Real my_coord = me->relative_coordinate (common, a); @@ -78,54 +453,609 @@ Axis_group_interface::group_extent_callback (SCM element_smob, SCM scm_axis) return ly_interval2scm (r - my_coord); } -void -Axis_group_interface::set_axes (Grob *me, Axis a1, Axis a2) +/* This is like generic_group_extent, but it only counts the grobs that + are children of some other axis-group. This is uncached; if it becomes + commonly used, it may be necessary to cache it somehow. */ +Interval +Axis_group_interface::staff_extent (Grob *me, Grob *refp, Axis ext_a, Grob *staff, Axis parent_a) { - SCM sa1 = scm_from_int (a1); - SCM sa2 = scm_from_int (a2); + extract_grob_set (me, "elements", elts); + vector new_elts; - SCM axes = me->get_property ("axes"); + for (vsize i = 0; i < elts.size (); i++) + if (elts[i]->common_refpoint (staff, parent_a) == staff) + new_elts.push_back (elts[i]); + + 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 = unsmob_grob (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"); +} + +SCM +Axis_group_interface::internal_calc_pure_relevant_grobs (Grob *me, const string &grob_set_name) +{ + extract_grob_set (me, grob_set_name.c_str (), elts); + + vector relevant_grobs; + + for (vsize i = 0; i < elts.size (); i++) + { + 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_grobs, pure_staff_priority_less); + SCM grobs_scm = Grob_array::make_array (); + unsmob_grob_array (grobs_scm)->set_array (relevant_grobs); + + return grobs_scm; +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_y_common, 1); +SCM +Axis_group_interface::calc_pure_y_common (SCM smob) +{ + Grob *me = unsmob_grob (smob); - if (!scm_is_pair (axes) - || scm_c_memq (sa1, axes) == SCM_BOOL_F - || scm_c_memq (sa2, axes) == SCM_BOOL_F) + 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)) { - SCM ax = scm_cons (sa1, SCM_EOL); - if (a1 != a2) - ax = scm_cons (sa2, ax); - me->set_property ("axes", ax); + 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; } - if (a1 != X_AXIS && a2 != X_AXIS) - me->set_extent (SCM_EOL, X_AXIS); - if (a1 != Y_AXIS && a2 != Y_AXIS) - me->set_extent (SCM_EOL, Y_AXIS); + return common->self_scm (); +} - /* - why so convoluted ? (fixme/documentme?) - */ - if (me->has_extent_callback (Grob::stencil_extent_proc, a1)) - me->set_extent_callback (Axis_group_interface::group_extent_callback_proc, a1); - if (me->has_extent_callback (Grob::stencil_extent_proc, a2)) - me->set_extent_callback (Axis_group_interface::group_extent_callback_proc, a2); +SCM +Axis_group_interface::calc_common (Grob *me, Axis axis) +{ + extract_grob_set (me, "elements", elts); + Grob *common = common_refpoint_of_array (elts, me, axis); + if (!common) + { + 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); +} + +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); +} + +Interval +Axis_group_interface::pure_group_height (Grob *me, int start, int end) +{ + Grob *common = unsmob_grob (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, Link_array *found) +Axis_group_interface::get_children (Grob *me, vector *found) { - found->push (me); + found->push_back (me); if (!has_interface (me)) return; extract_grob_set (me, "elements", elements); - for (int i = 0; i < elements.size (); i++) + for (vsize i = 0; i < elements.size (); i++) { Grob *e = elements[i]; Axis_group_interface::get_children (e, found); } } -ADD_INTERFACE (Axis_group_interface, "axis-group-interface", - "An object that groups other layout objects.", - "axes elements"); +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); + + if (priority_1 < priority_2) + return true; + else if (priority_1 > priority_2) + return false; + + /* if neither grob has an outside-staff priority, the ordering will have no + effect -- we just need to choose a consistent ordering. We do this to + avoid the side-effect of calculating extents. */ + if (isinf (priority_1)) + return g1 < g2; + + /* if there is no preference in staff priority, choose the left-most one */ + Grob *common = g1->common_refpoint (g2, X_AXIS); + Real start_1 = g1->extent (common, X_AXIS)[LEFT]; + Real start_2 = g2->extent (common, X_AXIS)[LEFT]; + 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_interior_skylines (Grob *me, Grob *x_common, Grob *y_common, vector *skylines) +{ + if (Grob_array *elements = unsmob_grob_array (me->get_object ("elements"))) + { + for (vsize i = 0; i < elements->size (); i++) + 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"))) + { + 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)); + } +} + +// 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 (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) +{ + + 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 ()) + { + 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 (); + } +} + +// 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 +// really depend on position of the cross-staff grobs that lie between them. +// Currently, we just leave cross-staff grobs out of the +// skyline altogether, but this could mean that staves are placed so close together +// 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) +{ + 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 + are triggered beforehand. + */ + for (vsize i = 0; i < elements.size (); i++) + if (scm_is_number (elements[i]->get_property ("outside-staff-priority"))) + elements[i]->extent (elements[i], X_AXIS); + + vector_sort (elements, staff_priority_less); + Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS); + Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS); + + 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 inside_staff_skylines; + + for (i = 0; i < elements.size () + && !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); + } + + for (; i < elements.size (); i++) + { + if (to_boolean (elements[i]->get_property ("cross-staff"))) + continue; + + // Collect all the outside-staff grobs that have a particular priority. + SCM priority = elements[i]->get_property ("outside-staff-priority"); + vector current_elts; + current_elts.push_back (elements[i]); + 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; +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, print, 1) +SCM +Axis_group_interface::print (SCM smob) +{ + if (!debug_skylines) + return SCM_BOOL_F; + + Grob *me = unsmob_grob (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)); + ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[DOWN].to_points (X_AXIS)) + .in_color (0, 255, 255)); + } + return ret.smobbed_copy (); +} + +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 (unsmob_grob (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 (unsmob_grob (smob), + false, + 0, + INT_MAX); +} + +SCM +Axis_group_interface::calc_maybe_pure_staff_staff_spacing (Grob *me, bool pure, int start, int end) +{ + Grob *grouper = unsmob_grob (me->get_object ("staff-grouper")); + + if (grouper) + { + 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_maybe_pure_property ("staffgroup-staff-spacing", pure, start, end); + } + 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 */ + "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 " + "outside-staff-placement-directive " + "pure-relevant-grobs " + "pure-relevant-items " + "pure-relevant-spanners " + "pure-Y-common " + "staff-affinity " + "staff-grouper " + "staff-staff-spacing " + "system-Y-offset " + "vertical-skyline-elements " + "X-common " + "Y-common " + );