X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Falign-interface.cc;h=736ecb9096a51a48111595b51d938b74c896189a;hb=90d3cd494153c10b1ae81ed4545c1b6ce4882294;hp=5df19061aad3e580d2ec1f6c28a4c8c5bbc7e7c9;hpb=643c1a49be582b0f0959db5904c284e8f1dd2a16;p=lilypond.git diff --git a/lily/align-interface.cc b/lily/align-interface.cc index 5df19061aa..736ecb9096 100644 --- a/lily/align-interface.cc +++ b/lily/align-interface.cc @@ -1,265 +1,397 @@ -/* - align-interface.cc -- implement Align_interface - +/* + align-interface.cc -- implement Align_interface + source file of the GNU LilyPond music typesetter - - (c) 2000--2001 Han-Wen Nienhuys - - */ + + (c) 2000--2006 Han-Wen Nienhuys +*/ #include "align-interface.hh" -#include "grob.hh" -#include "group-interface.hh" +#include "spanner.hh" +#include "item.hh" #include "axis-group-interface.hh" -#include "paper-def.hh" +#include "pointer-group-interface.hh" +#include "hara-kiri-group-spanner.hh" +#include "grob-array.hh" +#include "international.hh" +#include "warn.hh" /* - This callback is set in the children of the align element. It does - not compute anything, but a side effect of a->do_side_processing () - is that the elements are placed correctly. */ -MAKE_SCHEME_CALLBACK(Align_interface,alignment_callback,2); + TODO: for vertical spacing, should also include a rod & spring + scheme of sorts into this: the alignment should default to a certain + distance between element refpoints, unless bbox force a bigger + distance. + */ + +MAKE_SCHEME_CALLBACK (Align_interface, calc_positioning_done, 1); SCM -Align_interface::alignment_callback (SCM element_smob, SCM axis) +Align_interface::calc_positioning_done (SCM smob) { - Grob * me = unsmob_grob (element_smob); - Axis ax = (Axis )gh_scm2int (axis); - Grob * par = me->parent_l (ax); - if (par && !to_boolean (par->get_grob_property ("alignment-done"))) - { - Align_interface::align_elements_to_extents (par, ax); - } - return gh_double2scm (0.0); + Grob *me = unsmob_grob (smob); + SCM axis = scm_car (me->get_property ("axes")); + 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); + + return SCM_BOOL_T; } -MAKE_SCHEME_CALLBACK(Align_interface,fixed_distance_alignment_callback,2); +/* + merge with align-to-extents? +*/ +MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1) SCM -Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis) +Align_interface::stretch_after_break (SCM grob) { - Grob * me = unsmob_grob (element_smob); - Axis ax = (Axis )gh_scm2int (axis); - Grob * par = me->parent_l (ax); - if (par && !to_boolean (par->get_grob_property ("alignment-done"))) + Grob *me = unsmob_grob (grob); + + Spanner *me_spanner = dynamic_cast (me); + extract_grob_set (me, "elements", elems); + + if (me_spanner && elems.size ()) { - Align_interface::align_to_fixed_distance (par, ax); + Grob *common = common_refpoint_of_array (elems, me, Y_AXIS); + + /* force position callbacks */ + 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 extra_space_handle = scm_assoc (ly_symbol2scm ("fixed-alignment-extra-space"), details); + + Real extra_space = robust_scm2double (scm_is_pair (extra_space_handle) + ? scm_cdr (extra_space_handle) + : SCM_EOL, + 0.0); + + Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), + DOWN); + Real delta = extra_space / elems.size() * stacking_dir; + for (vsize i = 0; i < elems.size (); i++) + elems[i]->translate_axis (i * delta, Y_AXIS); } - return gh_double2scm (0.0); + + return SCM_UNSPECIFIED; } +/* + merge with align-to-extents? +*/ void -Align_interface::align_to_fixed_distance (Grob *me , Axis a) +Align_interface::align_to_fixed_distance (Grob *me, Axis a) { - me->set_grob_property ("alignment-done", SCM_BOOL_T); - - SCM d = me->get_grob_property ("stacking-dir"); + Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), + DOWN); - - Direction stacking_dir = gh_number_p(d) ? to_dir (d) : CENTER; - if (!stacking_dir) - stacking_dir = DOWN; + Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0); + + extract_grob_set (me, "elements", elem_source); + + vector elems (elem_source); // writable.. + Real where = 0; - SCM force = me->get_grob_property ("forced-distance"); + Interval v; + v.set_empty (); + vector translates; - Real dy = 0.0; - if (gh_number_p (force)) + for (vsize j = elems.size (); j--;) { - dy = gh_scm2double (force); + /* + 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); } - - Link_array elems - = Pointer_group_interface__extract_elements ( me, (Grob*) 0, "elements"); - Real where_f=0; - for (int j=0 ; j < elems.size(); j++) + + for (vsize j = 0; j < elems.size (); j++) { - where_f += stacking_dir * dy; - elems[j]->translate_axis (where_f, a); + where += stacking_dir * dy; + translates.push_back (where); + v.unite (Interval (where, where)); } + + /* + TODO: support self-alignment-{Y, X} + */ + for (vsize i = 0; i < translates.size (); i++) + elems[i]->translate_axis (translates[i] - v.center (), a); } /* Hairy function to put elements where they should be. Can be tweaked - from the outside by setting minimum-space and extra-space in its - children */ -void -Align_interface::align_elements_to_extents (Grob * me, Axis a) + 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 (). +*/ + +vector +Align_interface::get_extents_aligned_translates (Grob *me, + vector const &all_grobs, + Axis a, + bool pure, int start, int end) { - me->set_grob_property ("alignment-done", SCM_BOOL_T); - - SCM d = me->get_grob_property ("stacking-dir"); - - - Direction stacking_dir = gh_number_p(d) ? to_dir (d) : CENTER; - if (!stacking_dir) - stacking_dir = DOWN; + Spanner *me_spanner = dynamic_cast (me); - - Interval threshold = Interval (0, Interval::infinity ()); - SCM thr = me->get_grob_property ("threshold"); - if (gh_pair_p (thr)) + SCM line_break_details = SCM_EOL; + if (a == Y_AXIS && me_spanner) { - threshold[SMALLER] = gh_scm2double (gh_car (thr)); - threshold[BIGGER] = gh_scm2double (gh_cdr (thr)); - } + 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.")); + + } - Array dims; + Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"), + DOWN); + + Interval threshold = robust_scm2interval (me->get_property ("threshold"), + Interval (0, Interval::infinity ())); - Link_array elems; - Link_array all_grobs - = Pointer_group_interface__extract_elements (me, (Grob*) 0, "elements"); - for (int i=0; i < all_grobs.size(); i++) + vector dims; + vector elems; + + for (vsize i = 0; i < all_grobs.size (); i++) { - Interval y = all_grobs[i]->extent(me, a); - if (!y.empty_b()) + Interval y = all_grobs[i]->maybe_pure_extent (all_grobs[i], a, pure, start, end); + if (!y.is_empty ()) { - Grob *e =dynamic_cast(all_grobs[i]); - - // todo: fucks up if item both in Halign & Valign. - SCM min_dims = e->remove_grob_property ("minimum-space"); - if (gh_pair_p (min_dims) && - gh_number_p (gh_car (min_dims)) - && gh_number_p (gh_cdr (min_dims))) - { - y.unite (ly_scm2interval (min_dims)); - } - - SCM extra_dims = e->remove_grob_property ("extra-space"); - if (gh_pair_p (extra_dims) && - gh_number_p (gh_car (extra_dims)) - && gh_number_p (gh_cdr (extra_dims))) - { - y[LEFT] += gh_scm2double (gh_car (extra_dims)); - y[RIGHT] += gh_scm2double (gh_cdr (extra_dims)); - } - - elems.push (e); - dims.push (y); + Grob *e = dynamic_cast (all_grobs[i]); + + elems.push_back (e); + dims.push_back (y); } } - - + /* 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")); - String s ("self-alignment-"); - - s += (a == X_AXIS) ? "X" : "Y"; - - SCM align (me->get_grob_property (s.ch_C())); - - Array translates ; Interval total; - Real where_f=0; - - for (int j=0 ; j < elems.size(); j++) + Real where = 0; + Real extra_space = 0.0; + SCM extra_space_handle = scm_assq (ly_symbol2scm ("alignment-extra-space"), line_break_details); + + extra_space = robust_scm2double (scm_is_pair (extra_space_handle) + ? scm_cdr (extra_space_handle) + : SCM_EOL, + extra_space); + + Real padding = robust_scm2double (me->get_property ("padding"), + 0.0); + vector translates; + for (vsize j = 0; j < elems.size (); j++) { - Real dy = 0.0; - dy = - stacking_dir * dims[j][-stacking_dir]; + Real dy = -dims[j][-stacking_dir]; if (j) - dy += stacking_dir * dims[j-1][stacking_dir]; + 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 + padding + extra_space / elems.size ()); + total.unite (dims[j] + where); + translates.push_back (where); + } + + 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++) { - dy = (dy >? threshold[SMALLER] ) - all_translates; - if (translates.size ()) + also move the grobs that were empty, to maintain spatial order. + */ + vector all_translates; + if (translates.size ()) { - int i =0; - int j =0; Real w = translates[0]; - while (j < all_grobs.size ()) + + if (scm_is_number (align)) + center_offset = total.linear_combination (scm_to_double (align)); + + for (vsize i = 0, j = 0; j < all_grobs.size (); j++) { if (i < elems.size () && all_grobs[j] == elems[i]) - { - w = translates[i++]; - } - if (all_grobs[j] == align_center) - center_offset = w; - all_translates .push (w); - j++; + w = translates[i++]; + all_translates.push_back (w - center_offset); } } - - if (isdir_b (align)) - { - center_offset = total.linear_combination (gh_scm2double (align)); - } - - for (int j = 0 ; j < all_grobs.size (); j++) - all_grobs[j]->translate_axis (all_translates[j] - center_offset, a); + return all_translates; } -Axis -Align_interface::axis (Grob*me) +void +Align_interface::align_elements_to_extents (Grob *me, Axis a) { - return Axis (gh_scm2int (gh_car (me->get_grob_property ("axes")))); -} + 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); +} -/* - should use generic Scm funcs. - */ -int -Align_interface::get_count (Grob*me,Grob*s) +Real +Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end) { - SCM e = me->get_grob_property ("elements"); - int c =0; - while (gh_pair_p (e)) + extract_grob_set (me, "elements", all_grobs); + SCM dy_scm = me->get_property ("forced-distance"); + + if (scm_is_number (dy_scm)) { - if (gh_car (e) == s->self_scm ()) - break; - c++; - e = gh_cdr (e); + 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; + } } - return c; + 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 isn't my child")); + return 0; } -void -Align_interface::add_element (Grob*me,Grob* s, SCM cb) +Axis +Align_interface::axis (Grob *me) { - s->add_offset_callback (cb, Align_interface::axis (me)); - Axis_group_interface::add_element (me, s); + return Axis (scm_to_int (scm_car (me->get_property ("axes")))); } - void -Align_interface::set_interface (Grob*me) +Align_interface::add_element (Grob *me, Grob *element) { - me->set_interface (ly_symbol2scm ("align-interface")); - - Axis_group_interface::set_interface (me); + Axis a = Align_interface::axis (me); + SCM sym = axis_offset_symbol (a); + SCM proc = axis_parent_positioning (a); + + element->set_property (sym, proc); + Axis_group_interface::add_element (me, element); } void -Align_interface::set_axis (Grob*me,Axis a) +Align_interface::set_ordered (Grob *me) { - Axis_group_interface::set_axes (me, a,a ); + SCM ga_scm = me->get_object ("elements"); + Grob_array *ga = unsmob_grob_array (ga_scm); + if (!ga) + { + ga_scm = Grob_array::make_array (); + ga = unsmob_grob_array (ga_scm); + me->set_object ("elements", ga_scm); + } + + ga->set_ordered (true); } -bool -Align_interface::has_interface (Grob*me) +/* + 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. +*/ +Grob * +find_fixed_alignment_parent (Grob *g) { - return me && me->has_interface (ly_symbol2scm ("align-interface")); + while (g) + { + if (scm_is_number (g->get_property ("forced-distance"))) + return g; + + g = g->get_parent (Y_AXIS); + } + + return 0; } +ADD_INTERFACE (Align_interface, + "align-interface", + + "Order grobs from top to bottom, left to right, right to left or bottom " + "to top. " + "For vertical alignments of staves, the @code{break-system-details} of " + "the left @internalsref{NonMusicalPaperColumn} may be set to tune vertical spacing " + "Set @code{alignment-extra-space} to add extra space for staves. Set " + "@code{fixed-alignment-extra-space} to force staves in PianoStaves further apart." + , + + /* + properties + */ + "align-dir " + "axes " + "elements " + "forced-distance " + "padding " + "positioning-done " + "stacking-dir " + "threshold " + ); + +struct Foobar +{ + bool has_interface (Grob *); +}; +