-/*
- align-interface.cc -- implement Align_interface
-
+/*
+ align-interface.cc -- implement Align_interface
+
source file of the GNU LilyPond music typesetter
-
- (c) 2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+
+ (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "align-interface.hh"
-#include "score-element.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"
+
+/*
+ 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::calc_positioning_done (SCM smob)
+{
+ 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;
+}
/*
- 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);
+ merge with align-to-extents?
+*/
+MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
SCM
-Align_interface::alignment_callback (SCM element_smob, SCM axis)
+Align_interface::stretch_after_break (SCM grob)
{
- Score_element * me = unsmob_element (element_smob);
- Axis ax = (Axis )gh_scm2int (axis);
- Score_element * par = me->parent_l (ax);
- if (par && !to_boolean (par->get_elt_property ("alignment-done")))
+ Grob *me = unsmob_grob (grob);
+
+ Spanner *me_spanner = dynamic_cast<Spanner *> (me);
+ extract_grob_set (me, "elements", elems);
+
+ if (me_spanner && elems.size ())
{
- Align_interface::do_side_processing (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;
}
-
/*
- 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 */
+ merge with align-to-extents?
+*/
void
-Align_interface::do_side_processing (Score_element * me, Axis a)
+Align_interface::align_to_fixed_distance (Grob *me, Axis a)
{
- me->set_elt_property ("alignment-done", SCM_BOOL_T);
-
- SCM d = me->get_elt_property ("stacking-dir");
- Direction stacking_dir = gh_number_p(d) ? to_dir (d) : CENTER;
- if (!stacking_dir)
- stacking_dir = DOWN;
+ Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+ DOWN);
-
- Array<Interval> dims;
+ Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
+
+ extract_grob_set (me, "elements", elem_source);
+
+ vector<Grob*> elems (elem_source); // writable..
+
+ Real where = 0;
+
+ Interval v;
+ v.set_empty ();
+ vector<Real> translates;
+
+ for (vsize j = elems.size (); j--;)
+ {
+ /*
+ 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);
+ }
+
+ for (vsize j = 0; j < elems.size (); j++)
+ {
+ where += stacking_dir * dy;
+ translates.push_back (where);
+ v.unite (Interval (where, where));
+ }
- Link_array<Score_element> elems;
- Link_array<Score_element> all_elts
- = Pointer_group_interface__extract_elements ( me, (Score_element*) 0, "elements");
- for (int i=0; i < all_elts.size(); i++)
+ for (vsize i = 0; i < translates.size (); i++)
+ elems[i]->translate_axis (translates[i] - v.center (), 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<Grob*> *const elements,
+ Axis a,
+ bool pure, int start, int end,
+ vector<Skyline_pair> *const ret)
+{
+ Grob *other_axis_common = common_refpoint_of_array (*elements, me, other_axis (a));
+ for (vsize i = elements->size (); i--;)
{
- Interval y = all_elts[i]->extent(me, a);
- if (!y.empty_b())
+ Grob *g = (*elements)[i];
+ Interval extent = g->maybe_pure_extent (g, a, pure, start, end);
+ Interval other_extent = pure ? Interval (-infinity_f, infinity_f)
+ : g->extent (other_axis_common, other_axis (a));
+ Box b = (a == X_AXIS) ? Box (extent, other_extent) : Box (other_extent, extent);
+
+ if (extent.is_empty ())
{
- Score_element *e =dynamic_cast<Score_element*>(all_elts[i]);
+ elements->erase (elements->begin () + i);
+ continue;
+ }
- // todo: fucks up if item both in Halign & Valign.
- SCM min_dims = e->remove_elt_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));
-
- }
+ Skyline_pair skylines;
+ if (!pure
+ && Skyline_pair::unsmob (g->get_property ("skylines")))
+ skylines = *Skyline_pair::unsmob (g->get_property ("skylines"));
+ else
+ {
+ if (!pure)
+ programming_error ("no skylines for alignment-child\n");
- SCM extra_dims = e->remove_elt_property ("extra-space");
- if (gh_pair_p (extra_dims) &&
- gh_number_p (gh_car (extra_dims))
- && gh_number_p (gh_cdr (extra_dims)))
+ skylines = Skyline_pair (b, 0, other_axis (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)
+ {
+ /* 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))
{
- y[LEFT] += gh_scm2double (gh_car (extra_dims));
- y[RIGHT] += gh_scm2double (gh_cdr (extra_dims));
+ b[a] = ly_scm2interval (min_extent);
+ skylines.insert (b, 0, other_axis (a));
}
-
- elems.push (e);
- dims.push (y);
+ Real offset = g->relative_coordinate (other_axis_common, other_axis (a));
+ skylines.shift (-offset);
}
+
+
+ ret->push_back (skylines);
}
+ reverse (*ret);
+}
-
- Interval threshold = Interval (0, Interval::infinity ());
- SCM thr = me->get_elt_property ("threshold");
- if (gh_pair_p (thr))
+vector<Real>
+Align_interface::get_extents_aligned_translates (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a,
+ bool pure, int start, int end)
+{
+ Spanner *me_spanner = dynamic_cast<Spanner *> (me);
+
+
+ SCM line_break_details = SCM_EOL;
+ if (a == Y_AXIS && me_spanner)
{
- Real ss = 1.0;
- threshold[SMALLER] = ss *gh_scm2double (gh_car (thr));
- threshold[BIGGER] = ss * 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."));
+
}
+
+ Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+ DOWN);
+
+ vector<Grob*> elems (all_grobs); // writable copy
+ vector<Skyline_pair> skylines;
+
+ get_skylines (me, &elems, a, pure, start, end, &skylines);
+
+ Real where = 0;
+ 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);
- Real where_f=0;
- for (int j=0 ; j < elems.size(); j++)
+ Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
+ vector<Real> translates;
+ for (vsize j = 0; j < elems.size (); j++)
{
- Real dy = - stacking_dir * dims[j][-stacking_dir];
- if (j)
- dy += stacking_dir * dims[j-1][stacking_dir];
+ 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]);
- if (j)
+ where += stacking_dir * (dy + padding + extra_space / elems.size ());
+ 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] )
- <? threshold[BIGGER];
+ if (scm_is_number (scm_car (s)))
+ translates[i] = scm_to_double (scm_car (s));
}
+ }
+
+ vector<Real> all_translates;
- where_f += stacking_dir * dy;
- elems[j]->translate_axis (where_f, a);
+ if (!translates.empty ())
+ {
+ Real w = translates[0];
+ for (vsize i = 0, j = 0; j < all_grobs.size (); j++)
+ {
+ if (i < elems.size () && all_grobs[j] == elems[i])
+ w = translates[i++];
+ all_translates.push_back (w);
+ }
}
+ return all_translates;
}
-
-Axis
-Align_interface::axis (Score_element*me)
+void
+Align_interface::align_elements_to_extents (Grob *me, Axis a)
{
- return Axis (gh_scm2int (gh_car (me->get_elt_property ("axes"))));
-}
+ extract_grob_set (me, "elements", all_grobs);
+ vector<Real> 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 (Score_element*me,Score_element*s)
+Real
+Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
{
- SCM e = me->get_elt_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))
+ {
+ 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
{
- if (gh_car (e) == s->self_scm ())
- break;
- c++;
- e = gh_cdr (e);
+ vector<Real> 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;
}
- return c;
+
+ programming_error (_ ("tried to get a translation for something that isn't my child"));
+ return 0;
}
-void
-Align_interface::add_element (Score_element*me,Score_element* s)
+Axis
+Align_interface::axis (Grob *me)
{
- s->add_offset_callback (Align_interface::alignment_callback_proc, 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 (Score_element*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 (Score_element*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 (Score_element*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,
+
+ "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 "
+ );