X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Falign-interface.cc;h=68077c817622aa69c77bcda35d434bb808a5a12d;hb=e9a308e9c6002900fc336733950a0175bcbcc333;hp=6faaa013c075f5f0345f1f6889e00eddfd2baca7;hpb=77c7eccb319949accf3076b2a138e3ca16cf513e;p=lilypond.git diff --git a/lily/align-interface.cc b/lily/align-interface.cc index 6faaa013c0..68077c8176 100644 --- a/lily/align-interface.cc +++ b/lily/align-interface.cc @@ -3,7 +3,7 @@ source file of the GNU LilyPond music typesetter - (c) 2000--2006 Han-Wen Nienhuys + (c) 2000--2007 Han-Wen Nienhuys */ #include "align-interface.hh" @@ -13,6 +13,10 @@ #include "pointer-group-interface.hh" #include "hara-kiri-group-spanner.hh" #include "grob-array.hh" +#include "international.hh" +#include "system.hh" +#include "warn.hh" +#include "paper-column.hh" /* TODO: for vertical spacing, should also include a rod & spring @@ -26,20 +30,19 @@ SCM Align_interface::calc_positioning_done (SCM smob) { Grob *me = unsmob_grob (smob); + + me->set_property ("positioning-done", SCM_BOOL_T); + SCM axis = scm_car (me->get_property ("axes")); - Axis ax = (Axis)scm_to_int (axis); + Axis ax = Axis (scm_to_int (axis)); - SCM force = me->get_property ("forced-distance"); - if (scm_is_number (force)) - Align_interface::align_to_fixed_distance (me, ax); - else - Align_interface::align_elements_to_extents (me, ax); + Align_interface::align_elements_to_extents (me, ax); return SCM_BOOL_T; } /* - merge with align-to-extents? + TODO: This belongs to the old two-pass spacing. Delete me. */ MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1) SCM @@ -58,7 +61,7 @@ Align_interface::stretch_after_break (SCM grob) for (vsize i = 0; i < elems.size (); i++) elems[i]->relative_coordinate (common, Y_AXIS); - SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details"); + SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details"); SCM extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details); Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle) @@ -76,165 +79,164 @@ Align_interface::stretch_after_break (SCM grob) return SCM_UNSPECIFIED; } -/* - merge with align-to-extents? -*/ -void -Align_interface::align_to_fixed_distance (Grob *me, Axis a) +/* for each grob, find its upper and lower skylines. If the grob has + an empty extent, delete it from the list instead. If the extent is + non-empty but there is no skyline available (or pure is true), just + create a flat skyline from the bounding box */ +static void +get_skylines (Grob *me, + vector *const elements, + Axis a, + bool pure, int start, int end, + vector *const ret) { - Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), - DOWN); - - Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0); - - extract_grob_set (me, "elements", elem_source); - - Link_array__Grob_ elems (elem_source); // writable.. - - Real where_f = 0; - - Interval v; - v.set_empty (); - std::vector translates; - - for (vsize j = elems.size (); j--;) + /* each child's skyline was calculated according to the common refpoint of its + elements. Here we need all the skylines to be positioned with respect to + a single refpoint, so we need the common refpoint of the common refpoints + of the elements of the children */ + vector child_refpoints; + for (vsize i = 0; i < elements->size (); i++) { - /* - This is not very elegant, in that we need special support for - hara-kiri. Unfortunately, the generic wiring of - force_hara_kiri_callback () (extent and offset callback) is - such that we might get into a loop if we call extent () or - offset () the elements. - */ - if (a == Y_AXIS - && Hara_kiri_group_spanner::has_interface (elems[j])) - Hara_kiri_group_spanner::consider_suicide (elems[j]); - - if (!elems[j]->is_live ()) - elems.erase (elems.begin () + j); + Grob *elt = (*elements)[i]; + Grob *child_common = unsmob_grob ((a == Y_AXIS) + ? elt->get_object ("X-common") + : elt->get_object ("Y-common")); + + if (!child_common) + { + extract_grob_set (elt, "elements", child_elts); + child_common = common_refpoint_of_array (child_elts, elt, other_axis (a)); + } + + child_refpoints.push_back (child_common); } - - for (vsize j = 0; j < elems.size (); j++) + Grob *common_refpoint = common_refpoint_of_array (child_refpoints, me, other_axis (a)); + + for (vsize i = elements->size (); i--;) { - where_f += stacking_dir * dy; - translates.push_back (where_f); - v.unite (Interval (where_f, where_f)); - } + Grob *g = (*elements)[i]; + Skyline_pair skylines; - /* - TODO: support self-alignment-{Y, X} - */ - for (vsize i = 0; i < translates.size (); i++) - elems[i]->translate_axis (translates[i] - v.center (), a); -} + /* each skyline is calculated relative to (potentially) a different other_axis + coordinate. In order to compare the skylines effectively, we need to shift them + to some absolute reference point */ + if (!pure) + { + Skyline_pair *skys = Skyline_pair::unsmob (g->get_property ("skylines")); + if (skys) + skylines = *skys; + else + programming_error ("no skylines for alignment-child\n"); + + /* this is perhaps an abuse of minimum-?-extent: maybe we should create + another property? But it seems that the only (current) use of + minimum-Y-extent is to separate vertically-aligned elements */ + SCM min_extent = g->get_property (a == X_AXIS ? "minimum-X-extent" : "minimum-Y-extent"); + + if (is_number_pair (min_extent)) + { + Box b; + Interval other_extent = g->extent (common_refpoint, other_axis (a)); + b[a] = ly_scm2interval (min_extent); + b[other_axis (a)] = other_extent; + if (!other_extent.is_empty ()) + skylines.insert (b, 0, other_axis (a)); + } + + Real offset = child_refpoints[i]->relative_coordinate (common_refpoint, other_axis (a)); + skylines.shift (offset); + } + else + { + assert (a == Y_AXIS); + Interval extent = g->pure_height (g, start, end); + if (!extent.is_empty ()) + { + Box b; + b[a] = extent; + b[other_axis (a)] = Interval (-infinity_f, infinity_f); + skylines.insert (b, 0, other_axis (a)); + } + } -/* - Hairy function to put elements where they should be. Can be tweaked - from the outside by setting extra-space in its - children - - We assume that the children the refpoints of the children are still - found at 0.0 -- we will fuck up with thresholds if children's - extents are already moved to locations such as (-16, -8), since the - dy needed to put things in a row doesn't relate to the distances - between original refpoints. - - TODO: maybe we should rethink and throw out thresholding altogether. - The original function has been taken over by - align_to_fixed_distance (). -*/ + if (skylines.is_empty ()) + elements->erase (elements->begin () + i); + else + ret->push_back (skylines); + } + reverse (*ret); +} -void -Align_interface::align_elements_to_extents (Grob *me, Axis a) +vector +Align_interface::get_extents_aligned_translates (Grob *me, + vector const &all_grobs, + Axis a, + bool pure, int start, int end) { Spanner *me_spanner = dynamic_cast (me); SCM line_break_details = SCM_EOL; if (a == Y_AXIS && me_spanner) - line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details"); + { + if (pure) + line_break_details = get_root_system (me)->column (start)->get_property ("line-break-system-details"); + else + line_break_details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details"); + + if (!me->get_system () && !pure) + me->warning (_ ("vertical alignment called before line-breaking.\n" + "Only do cross-staff spanners with PianoStaff.")); + + } Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), DOWN); - Interval threshold = robust_scm2interval (me->get_property ("threshold"), - Interval (0, Interval::infinity ())); - - std::vector dims; - Link_array__Grob_ elems; - - extract_grob_set (me, "elements", all_grobs); - for (vsize i = 0; i < all_grobs.size (); i++) - { - Interval y = all_grobs[i]->extent (me, a); - if (!y.is_empty ()) - { - Grob *e = dynamic_cast (all_grobs[i]); + vector elems (all_grobs); // writable copy + vector skylines; - elems.push_back (e); - dims.push_back (y); - } - } + get_skylines (me, &elems, a, pure, start, end, &skylines); - /* - Read self-alignment-X and self-alignment-Y. This may seem like - code duplication. (and really: it is), but this is necessary to - prevent ugly cyclic dependencies that arise when you combine - self-alignment on a child with alignment of children. - */ - SCM align ((a == X_AXIS) - ? me->get_property ("self-alignment-X") - : me->get_property ("self-alignment-Y")); - - Interval total; Real where = 0; - Real extra_space = 0.0; + /* TODO: extra-space stuff belongs to two-pass spacing. Delete me */ SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details); + Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle) + ? scm_cdr (extra_space_handle) + : SCM_EOL, + 0.0); - extra_space = robust_scm2double (scm_is_pair (extra_space_handle) - ? scm_cdr (extra_space_handle) - : SCM_EOL, - extra_space); - - std::vector translates; + Real padding = robust_scm2double (me->get_property ("padding"), 0.0); + vector translates; for (vsize j = 0; j < elems.size (); j++) { - Real dy = -dims[j][-stacking_dir]; - if (j) - dy += dims[j - 1][stacking_dir]; - - /* - we want dy to be > 0 - */ - dy *= stacking_dir; - if (j) - dy = min (max (dy, threshold[SMALLER]), threshold[BIGGER]); - - where += stacking_dir * (dy + extra_space / elems.size ()); - total.unite (dims[j] + where); + Real dy = 0; + if (j == 0) + dy = skylines[j][-stacking_dir].max_height (); + else + dy = skylines[j-1][stacking_dir].distance (skylines[j][-stacking_dir]); + + where += stacking_dir * max (0.0, dy + padding + extra_space / elems.size ()); translates.push_back (where); } - SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"), line_break_details); + SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"), + line_break_details); if (scm_is_pair (offsets_handle)) { vsize i = 0; - for (SCM s = scm_cdr (offsets_handle); scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++) + for (SCM s = scm_cdr (offsets_handle); + scm_is_pair (s) && i < translates.size (); s = scm_cdr (s), i++) { if (scm_is_number (scm_car (s))) translates[i] = scm_to_double (scm_car (s)); } } - - Real center_offset = 0.0; - - /* - also move the grobs that were empty, to maintain spatial order. - */ - std::vector all_translates; - if (translates.size ()) + vector all_translates; + + if (!translates.empty ()) { Real w = translates[0]; for (vsize i = 0, j = 0; j < all_grobs.size (); j++) @@ -243,18 +245,77 @@ Align_interface::align_elements_to_extents (Grob *me, Axis a) w = translates[i++]; all_translates.push_back (w); } + } + return all_translates; +} - /* - FIXME: uncommenting freaks out the Y-alignment of - line-of-score. - */ - if (scm_is_number (align)) - center_offset = total.linear_combination (scm_to_double (align)); +void +Align_interface::align_elements_to_extents (Grob *me, Axis a) +{ + extract_grob_set (me, "elements", all_grobs); + + vector translates = get_extents_aligned_translates (me, all_grobs, a, false, 0, 0); + if (translates.size ()) + for (vsize j = 0; j < all_grobs.size (); j++) + all_grobs[j]->translate_axis (translates[j], a); +} + +/* After we have already determined the y-offsets of our children, we may still + want to stretch them a little. */ +void +Align_interface::stretch (Grob *me, Real amount, Axis a) +{ + extract_grob_set (me, "elements", elts); + Real non_empty_elts = stretchable_children_count (me); + Real offset = 0.0; + Direction dir = robust_scm2dir (me->get_property ("stacking-dir"), DOWN); + for (vsize i = 0; i < elts.size (); i++) + { + elts[i]->translate_axis (dir * offset, a); + if (!elts[i]->extent (me, a).is_empty () + && !to_boolean (elts[i]->get_property ("keep-fixed-while-stretching"))) + offset += amount / non_empty_elts; + } + me->flush_extent_cache (Y_AXIS); +} + +Real +Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end) +{ + extract_grob_set (me, "elements", all_grobs); + SCM dy_scm = me->get_property ("forced-distance"); - for (vsize j = 0; j < all_grobs.size (); j++) - all_grobs[j]->translate_axis (all_translates[j] - center_offset, a); + if (scm_is_number (dy_scm)) + { + Real dy = scm_to_double (dy_scm) * robust_scm2dir (me->get_property ("stacking-dir"), DOWN); + Real pos = 0; + for (vsize i = 0; i < all_grobs.size (); i++) + { + if (all_grobs[i] == ch) + return pos; + if (!Hara_kiri_group_spanner::has_interface (all_grobs[i]) + || !Hara_kiri_group_spanner::request_suicide (all_grobs[i], start, end)) + pos += dy; + } } + else + { + vector translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end); + + if (translates.size ()) + { + for (vsize i = 0; i < all_grobs.size (); i++) + if (all_grobs[i] == ch) + return translates[i]; + } + else + return 0; + } + + programming_error (_ ("tried to get a translation for something that is no child of mine")); + return 0; } + Axis Align_interface::axis (Grob *me) { @@ -268,7 +329,7 @@ Align_interface::add_element (Grob *me, Grob *element) SCM sym = axis_offset_symbol (a); SCM proc = axis_parent_positioning (a); - element->internal_set_property (sym, proc); + element->set_property (sym, proc); Axis_group_interface::add_element (me, element); } @@ -287,27 +348,63 @@ Align_interface::set_ordered (Grob *me) ga->set_ordered (true); } +int +Align_interface::stretchable_children_count (Grob const *me) +{ + extract_grob_set (me, "elements", elts); + int ret = 0; + + /* start at 1: we will never move the first child while stretching */ + for (vsize i = 1; i < elts.size (); i++) + if (!to_boolean (elts[i]->get_property ("keep-fixed-while-stretching")) + && !elts[i]->extent (elts[i], Y_AXIS).is_empty ()) + ret++; + + return ret; +} + +MAKE_SCHEME_CALLBACK (Align_interface, calc_max_stretch, 1) +SCM +Align_interface::calc_max_stretch (SCM smob) +{ + Grob *me = unsmob_grob (smob); + Spanner *spanner_me = dynamic_cast (me); + Real ret = 0; + + if (spanner_me && stretchable_children_count (me) > 0) + { + Paper_column *left = dynamic_cast (spanner_me->get_bound (LEFT)); + Real height = me->extent (me, Y_AXIS).length (); + SCM line_break_details = left->get_property ("line-break-system-details"); + SCM fixed_offsets = scm_assq (ly_symbol2scm ("alignment-offsets"), + line_break_details); + + /* if there are fixed offsets, we refuse to stretch */ + if (fixed_offsets != SCM_BOOL_F) + ret = 0; + else + ret = height * height / 80.0; /* why this, exactly? -- jneem */ + } + return scm_from_double (ret); +} + /* Find Y-axis parent of G that has a #'forced-distance property. This has the effect of finding the piano-staff given an object in that piano staff. + + FIXME: piano staves no longer have forced-distance. The code that + relies on this function (in line-spanner) is broken. */ Grob * find_fixed_alignment_parent (Grob *g) { - while (g) - { - if (scm_is_number (g->get_property ("forced-distance"))) - return g; - - g = g->get_parent (Y_AXIS); - } - + (void) g; + programming_error ("deprecated. We don't use forced-distance anymore"); return 0; } ADD_INTERFACE (Align_interface, - "align-interface", "Order grobs from top to bottom, left to right, right to left or bottom " "to top. " @@ -320,15 +417,11 @@ ADD_INTERFACE (Align_interface, /* properties */ - "forced-distance " - "stacking-dir " "align-dir " - "threshold " + "axes " + "elements " + "padding " "positioning-done " - "elements axes"); - -struct Foobar -{ - bool has_interface (Grob *); -}; - + "stacking-dir " + "threshold " + );