X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faxis-group-interface.cc;h=1ec518feff52bd95ed7ac0a7d5e86590539291d0;hb=f530eeb5bbaf470235e17161a3a4605ecdcfb8dd;hp=8089d316f948ac0e25b5f834a5ca8f7d72d94a63;hpb=db1b3ab250a967db1da1ff46a1f913fd511ad47c;p=lilypond.git diff --git a/lily/axis-group-interface.cc b/lily/axis-group-interface.cc index 8089d316f9..1ec518feff 100644 --- a/lily/axis-group-interface.cc +++ b/lily/axis-group-interface.cc @@ -1,27 +1,43 @@ /* - 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--2010 Han-Wen Nienhuys - (c) 2000--2007 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ #include "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" +static bool +pure_staff_priority_less (Grob *const &g1, Grob *const &g2); + void Axis_group_interface::add_element (Grob *me, Grob *e) { @@ -73,26 +89,46 @@ Axis_group_interface::relative_group_extent (vector const &elts, return r; } +Interval +Axis_group_interface::cached_pure_height (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)); -/* - FIXME: pure extent handling has a lot of ad-hoc caching. - This should be done with grob property callbacks. + return iv; +} - --hwn -*/ +Interval +Axis_group_interface::rest_of_line_pure_height (Grob *me, int start, int end) +{ + SCM adjacent_pure_heights = me->get_property ("adjacent-pure-heights"); + + if (!scm_is_pair (adjacent_pure_heights) + || !scm_is_vector (scm_cdr (adjacent_pure_heights))) + return Interval (0, 0); + + 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"); - - if (!scm_is_vector (extents)) - return Interval (0, 0); - Interval ext; for (vsize i = 0; i + 1 < breaks.size (); i++) { @@ -101,68 +137,100 @@ Axis_group_interface::cached_pure_height (Grob *me, int start, int 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) { Grob *me = unsmob_grob (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 = 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 breaks = ps->get_break_indices (); - vector cols = ps->get_columns (); + vector ranks = ps->get_break_ranks (); - SCM ret = scm_c_make_vector (breaks.size () - 1, SCM_EOL); - vsize it_index = 0; - for (vsize i = 0; i + 1 < breaks.size (); i++) + vector begin_line_heights; + vector mid_line_heights; + begin_line_heights.resize (ranks.size () - 1); + mid_line_heights.resize (ranks.size () - 1); + + 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 iv; + Grob *g = elts[i]; - for (vsize j = it_index; j < items.size (); j++) - { - Item *it = dynamic_cast (items[j]); - int rank = it->get_column ()->get_rank (); + if (to_boolean (g->get_property ("cross-staff"))) + continue; - 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); - if (!dims.is_empty ()) - iv.unite (dims); - } + bool outside_staff = scm_is_number (g->get_property ("outside-staff-priority")); + Real padding = robust_scm2double (g->get_property ("outside-staff-padding"), 0.5); - if (rank < end) - it_index++; - else if (rank > end) - break; - } + // 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 = 0; j < spanners.size (); j++) + for (vsize j = first_break; j+1 < ranks.size () && (int)ranks[j] <= rank_span[RIGHT]; ++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"))) + 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 = spanners[j]->pure_height (common, start, end); + Interval dims = g->pure_height (common, start, end); if (!dims.is_empty ()) - iv.unite (dims); + { + if (rank_span[LEFT] <= start) + { + if (outside_staff) + begin_line_heights[j].unite_disjoint (dims, padding, d); + else + begin_line_heights[j].unite (dims); + } + if (rank_span[RIGHT] > start) + { + if (outside_staff) + mid_line_heights[j].unite_disjoint (dims, padding, d); + else + mid_line_heights[j].unite (dims); + } + } } } + } - scm_vector_set_x (ret, scm_from_int (i), ly_interval2scm (iv)); + // 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 ret; + + return scm_cons (begin_scm, mid_scm); } Interval @@ -173,43 +241,26 @@ 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); - 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 = unsmob_grob (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"))) + && g->pure_is_visible (start, end) + && !to_boolean (g->get_property ("cross-staff"))) { - Interval dims = spanners[i]->pure_height (common, start, end); + Interval dims = g->pure_height (common, start, end); if (!dims.is_empty ()) r.unite (dims); } @@ -333,56 +384,57 @@ Axis_group_interface::staff_extent (Grob *me, Grob *refp, Axis ext_a, Grob *staf } -Grob * -Axis_group_interface::calc_pure_elts_and_common (Grob *me) +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_relevant_grobs, 1); +SCM +Axis_group_interface::calc_pure_relevant_grobs (SCM smob) { - if (Grob *c = unsmob_grob (me->get_object ("pure-Y-common"))) - return c; + Grob *me = unsmob_grob (smob); extract_grob_set (me, "elements", elts); - vector relevant_items; - vector relevant_spanners; + vector relevant_grobs; SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?"); for (vsize i = 0; i < elts.size (); i++) { if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL))) + relevant_grobs.push_back (elts[i]); + + if (Item *it = dynamic_cast (elts[i])) { - if (dynamic_cast (elts[i])) - relevant_items.push_back (elts[i]); - else if (dynamic_cast (elts[i])) - relevant_spanners.push_back (elts[i]); + Direction d = LEFT; + do + { + Item *piece = it->find_prebroken_piece (d); + if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL))) + relevant_grobs.push_back (piece); + } + while (flip (&d) != LEFT); } - - - 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); } - 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 (); + unsmob_grob_array (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 = unsmob_grob (smob); - return common; + extract_grob_set (me, "pure-relevant-grobs", elts); + Grob *common = common_refpoint_of_array (elts, me, Y_AXIS); + if (!common) + { + me->programming_error ("No common parent found in calc_pure_y_common."); + return SCM_EOL; + } + + return common->self_scm (); } SCM @@ -395,7 +447,7 @@ 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 (); } @@ -417,8 +469,13 @@ Axis_group_interface::calc_y_common (SCM grob) Interval Axis_group_interface::pure_group_height (Grob *me, int start, int end) { - Grob *common = calc_pure_elts_and_common (me); - + 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->relative_coordinate (common, Y_AXIS); Interval r (relative_pure_height (me, start, end)); @@ -441,7 +498,7 @@ Axis_group_interface::get_children (Grob *me, vector *found) } } -bool +static bool staff_priority_less (Grob * const &g1, Grob * const &g2) { Real priority_1 = robust_scm2double (g1->get_property ("outside-staff-priority"), -infinity_f); @@ -465,6 +522,15 @@ 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) { @@ -553,7 +619,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]; } @@ -566,9 +632,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); @@ -581,19 +665,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); } @@ -601,22 +693,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) @@ -628,26 +704,87 @@ 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 (); } +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_pure_next_staff_spacing, 3) +SCM +Axis_group_interface::calc_pure_next_staff_spacing (SCM smob, SCM start, SCM end) +{ + return calc_maybe_pure_next_staff_spacing (unsmob_grob (smob), + true, + scm_to_int (start), + scm_to_int (end)); +} + +MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_next_staff_spacing, 1) +SCM +Axis_group_interface::calc_next_staff_spacing (SCM smob) +{ + return calc_maybe_pure_next_staff_spacing (unsmob_grob (smob), + false, + 0, + INT_MAX); +} + +SCM +Axis_group_interface::calc_maybe_pure_next_staff_spacing (Grob *me, bool pure, int start, int end) +{ + Grob *grouper = unsmob_grob (me->get_object ("staff-grouper")); + + if (grouper) + { + Grob *last_in_group = Staff_grouper_interface::get_maybe_pure_last_grob (grouper, pure, start, end); + if (me == last_in_group) + return grouper->get_maybe_pure_property ("after-last-staff-spacing", pure, start, end); + else + return grouper->get_maybe_pure_property ("between-staff-spacing", pure, start, end); + } + return me->get_maybe_pure_property ("default-next-staff-spacing", pure, start, end); +} + +Real +Axis_group_interface::minimum_distance (Grob *g1, Grob *g2, Axis a) +{ + SCM sym = ly_symbol2scm ((a == Y_AXIS) ? "vertical-skylines" : "horizontal-skylines"); + + Skyline_pair *s1 = Skyline_pair::unsmob (g1->get_property (sym)); + Skyline_pair *s2 = Skyline_pair::unsmob (g2->get_property (sym)); + if (s1 && s2) + return (*s1)[DOWN].distance ((*s2)[UP]); + return 0; +} + 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 " - "keep-fixed-while-stretching " + "inter-loose-line-spacing " + "inter-staff-spacing " "max-stretch " + "non-affinity-spacing " + "next-staff-spacing " "no-alignment " "pure-Y-common " + "pure-relevant-grobs " "pure-relevant-items " "pure-relevant-spanners " + "staff-affinity " + "staff-grouper " + "system-Y-offset " "vertical-skylines " );