X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faxis-group-interface.cc;h=4ce0a01a65918d486bb1d7be9dca9603eb8ef9be;hb=794dcbdb52faf4292036cd1b0270a956cf4316a3;hp=bd00b283073a0e9e09ca531887a1f870272cb0b5;hpb=a93cdac09beaeb940a1776a5177fb823d1fa8337;p=lilypond.git diff --git a/lily/axis-group-interface.cc b/lily/axis-group-interface.cc index bd00b28307..4ce0a01a65 100644 --- a/lily/axis-group-interface.cc +++ b/lily/axis-group-interface.cc @@ -3,21 +3,23 @@ source file of the GNU LilyPond music typesetter - (c) 2000--2007 Han-Wen Nienhuys + (c) 2000--2009 Han-Wen Nienhuys */ #include "axis-group-interface.hh" #include "align-interface.hh" #include "directional-element-interface.hh" -#include "pointer-group-interface.hh" #include "grob-array.hh" #include "hara-kiri-group-spanner.hh" #include "international.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 "stencil.hh" #include "system.hh" #include "warn.hh" @@ -73,37 +75,58 @@ Axis_group_interface::relative_group_extent (vector const &elts, return r; } +Interval +Axis_group_interface::cached_pure_height (Grob *me, int start, int end) +{ + SCM adjacent_pure_heights = me->get_property ("adjacent-pure-heights"); -/* - FIXME: pure extent handling has a lot of ad-hoc caching. - This should be done with grob property callbacks. + if (!scm_is_pair (adjacent_pure_heights) + || !scm_is_vector (scm_cdr (adjacent_pure_heights))) + return Interval (0, 0); - --hwn -*/ + return combine_pure_heights (me, scm_cdr (adjacent_pure_heights), start, end); +} Interval -Axis_group_interface::cached_pure_height (Grob *me, int start, int end) +Axis_group_interface::begin_of_line_pure_height (Grob *me, int start) +{ + SCM adjacent_pure_heights = me->get_property ("adjacent-pure-heights"); + + if (!scm_is_pair (adjacent_pure_heights) + || !scm_is_vector (scm_car (adjacent_pure_heights))) + return Interval (0, 0); + + return combine_pure_heights (me, scm_car (adjacent_pure_heights), start, start+1); +} + +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 (); - SCM extents = me->get_property ("adjacent-pure-heights"); - Interval ext; for (vsize i = 0; i + 1 < breaks.size (); i++) { int r = Paper_column::get_rank (cols[breaks[i]]); - if (r > end) + if (r >= end) break; if (r >= start) - ext.unite (ly_scm2interval (scm_c_vector_ref (extents, i))); + 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) @@ -118,24 +141,30 @@ Axis_group_interface::adjacent_pure_heights (SCM smob) vector breaks = ps->get_break_indices (); vector cols = ps->get_columns (); - SCM ret = scm_c_make_vector (breaks.size () - 1, SCM_EOL); + 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); + vsize it_index = 0; for (vsize i = 0; i + 1 < breaks.size (); i++) { int start = Paper_column::get_rank (cols[breaks[i]]); int end = Paper_column::get_rank (cols[breaks[i+1]]); - Interval iv; + 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)) + 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 ()) - iv.unite (dims); + target_iv.unite (dims); } if (rank < end) @@ -147,17 +176,20 @@ Axis_group_interface::adjacent_pure_heights (SCM smob) 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) + 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 ()) - iv.unite (dims); + mid_line_iv.unite (dims); } } - scm_vector_set_x (ret, scm_from_int (i), ly_interval2scm (iv)); + 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)); } - return ret; + return scm_cons (begin_line_heights, mid_line_heights); } Interval @@ -189,7 +221,8 @@ Axis_group_interface::relative_pure_height (Grob *me, int start, int end) if (rank > end) break; - else if (rank >= start && it->pure_is_visible (start, end)) + 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 ()) @@ -200,7 +233,8 @@ Axis_group_interface::relative_pure_height (Grob *me, int start, int end) for (vsize i = 0; i < spanners.size (); i++) { Interval_t rank_span = spanners[i]->spanned_rank_interval (); - if (rank_span[LEFT] <= end && rank_span[RIGHT] >= start) + 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 ()) @@ -256,13 +290,6 @@ Axis_group_interface::calc_skylines (SCM smob) extract_grob_set (me, "elements", elts); Skyline_pair skylines = skyline_spacing (me, elts); - /* add a minimum-Y-extent-sized box to the skyline */ - SCM min_y_extent = me->get_property ("minimum-Y-extent"); - if (is_number_pair (min_y_extent)) - { - Box b (me->extent (me, X_AXIS), ly_scm2interval (min_y_extent)); - skylines.insert (b, 0, X_AXIS); - } return skylines.smobbed_copy (); } @@ -279,8 +306,10 @@ Axis_group_interface::combine_skylines (SCM smob) 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); - assert (y_common == me); + 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++) @@ -291,6 +320,7 @@ Axis_group_interface::combine_skylines (SCM smob) 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); } } @@ -313,6 +343,22 @@ Axis_group_interface::generic_group_extent (Grob *me, Axis a) return ly_interval2scm (r - my_coord); } +/* 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) +{ + extract_grob_set (me, "elements", elts); + vector new_elts; + + 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); +} + Grob * Axis_group_interface::calc_pure_elts_and_common (Grob *me) @@ -366,26 +412,33 @@ Axis_group_interface::calc_pure_elts_and_common (Grob *me) return common; } -MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_x_common, 1); SCM -Axis_group_interface::calc_x_common (SCM grob) +Axis_group_interface::calc_common (Grob *me, Axis axis) { - Grob *me = unsmob_grob (grob); - extract_grob_set (me, "elements", elts); - Grob *common = common_refpoint_of_array (elts, me, X_AXIS); + 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) { - Grob *me = unsmob_grob (grob); - - extract_grob_set (me, "elements", elts); - Grob *common = common_refpoint_of_array (elts, me, Y_AXIS); - return common->self_scm (); + return calc_common (unsmob_grob (grob), Y_AXIS); } Interval @@ -527,7 +580,7 @@ add_grobs_of_one_priority (Skyline_pair *const skylines, b.translate (Offset (0, dir*dist)); elements[i]->translate_axis (dir*dist, Y_AXIS); } - (*skylines)[dir].insert (b, 0, X_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]; } @@ -540,9 +593,27 @@ add_grobs_of_one_priority (Skyline_pair *const skylines, } } +// TODO: 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, vector elements) { + /* 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); @@ -555,19 +626,27 @@ Axis_group_interface::skyline_spacing (Grob *me, vector elements) Skyline_pair skylines; for (i = 0; i < elements.size () && !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++) - add_boxes (elements[i], x_common, y_common, &boxes, &skylines); + if (!to_boolean (elements[i]->get_property ("cross-staff"))) + add_boxes (elements[i], x_common, y_common, &boxes, &skylines); 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; + SCM priority = elements[i]->get_property ("outside-staff-priority"); 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)) - current_elts.push_back (elements[++i]); + { + 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); } @@ -575,22 +654,6 @@ Axis_group_interface::skyline_spacing (Grob *me, vector elements) return skylines; } -MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_max_stretch, 1) -SCM -Axis_group_interface::calc_max_stretch (SCM smob) -{ - Grob *me = unsmob_grob (smob); - Real ret = 0; - extract_grob_set (me, "elements", elts); - - for (vsize i = 0; i < elts.size (); i++) - if (Axis_group_interface::has_interface (elts[i])) - ret += robust_scm2double (elts[i]->get_property ("max-stretch"), 0.0); - - return scm_from_double (ret); -} - -extern bool debug_skylines; MAKE_SCHEME_CALLBACK (Axis_group_interface, print, 1) SCM Axis_group_interface::print (SCM smob) @@ -602,27 +665,55 @@ Axis_group_interface::print (SCM 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)); + 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 (); } -ADD_INTERFACE (Axis_group_interface, +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_next_staff_spacing, 1) +SCM +Axis_group_interface::calc_next_staff_spacing (SCM smob) +{ + Grob *me = unsmob_grob (smob); + Grob *grouper = unsmob_grob (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"); + else + return grouper->get_property ("between-staff-spacing"); + } + return me->get_property ("default-next-staff-spacing"); +} +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 " "vertical-skylines " );