-/*
- align-interface.cc -- implement Align_interface
-
+/*
+ align-interface.cc -- implement Align_interface
+
source file of the GNU LilyPond music typesetter
-
- (c) 2000--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
-#include "align-interface.hh"
+ (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
+#include "align-interface.hh"
+#include "spanner.hh"
+#include "item.hh"
#include "axis-group-interface.hh"
+#include "pointer-group-interface.hh"
#include "hara-kiri-group-spanner.hh"
-#include "output-def.hh"
+#include "grob-array.hh"
+#include "international.hh"
+#include "warn.hh"
-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)scm_to_int (axis);
- Grob * par = me->get_parent (ax);
- if (par && !to_boolean (par->get_property ("positioning-done")))
- {
- Align_interface::align_elements_to_extents (par, ax);
- }
- return scm_make_real (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)scm_to_int (axis);
- Grob * par = me->get_parent (ax);
- if (par && !to_boolean (par->get_property ("positioning-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::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 scm_make_real (0.0);
+
+ return SCM_UNSPECIFIED;
}
/*
- merge with align-to-extents?
- */
+ 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_property ("positioning-done", SCM_BOOL_T);
-
- SCM d = me->get_property ("stacking-dir");
-
- Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
- if (!stacking_dir)
- stacking_dir = DOWN;
+ Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+ DOWN);
- Real dy = robust_scm2double (me->get_property ("forced-distance"),0.0);
-
- Link_array<Grob> elems
- = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+ 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_f= 0;
+ Real where = 0;
Interval v;
v.set_empty ();
- Array<Real> translates;
-
- for (int j= elems.size (); j--; )
+ vector<Real> translates;
+
+ for (vsize j = elems.size (); j--;)
{
/*
This is not very elegant, in that we need special support for
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.del (j);
+ elems.erase (elems.begin () + j);
}
- for (int j = 0; j < elems.size (); j++)
+ for (vsize j = 0; j < elems.size (); j++)
{
- where_f += stacking_dir * dy;
- translates.push (where_f);
- v.unite (Interval (where_f, where_f));
+ where += stacking_dir * dy;
+ translates.push_back (where);
+ v.unite (Interval (where, where));
}
- /*
- TODO: support self-alignment-{Y,X}
- */
- for (int i = 0; i < translates.size (); i++)
- {
- elems[i]->translate_axis (translates[i] - v.center (), a);
- }
+ 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 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 ().
-*/
-void
-Align_interface::align_elements_to_extents (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<Grob*> *const elements,
+ Axis a,
+ bool pure, int start, int end,
+ vector<Skyline_pair> *const ret)
{
- me->set_property ("positioning-done", SCM_BOOL_T);
-
- SCM d = me->get_property ("stacking-dir");
-
- Direction stacking_dir = scm_is_number (d) ? to_dir (d) : CENTER;
- if (!stacking_dir)
- stacking_dir = DOWN;
-
- Interval threshold = robust_scm2interval (me->get_property ("threshold"),
- Interval (0, Interval::infinity ()));
-
- Array<Interval> dims;
-
- Link_array<Grob> elems;
- Link_array<Grob> all_grobs
- = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
- for (int i= 0; i < all_grobs.size (); i++)
+ Grob *other_axis_common = common_refpoint_of_array (*elements, me, other_axis (a));
+ for (vsize i = elements->size (); i--;)
{
- Interval y = all_grobs[i]->extent (me, a);
- if (!y.is_empty ())
+ 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 ())
{
- Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
+ elements->erase (elements->begin () + i);
+ continue;
+ }
- elems.push (e);
- dims.push (y);
+ 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");
+
+ 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))
+ {
+ b[a] = ly_scm2interval (min_extent);
+ skylines.insert (b, 0, other_axis (a));
+ }
+ Real offset = g->relative_coordinate (other_axis_common, other_axis (a));
+ skylines.shift (-offset);
+ }
+
+
+ ret->push_back (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.
- */
- static SCM prop_syms[2];
-
- if (!prop_syms[0])
+ reverse (*ret);
+}
+
+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)
{
- prop_syms[X_AXIS] = ly_symbol2scm ("self-alignment-X");
- prop_syms[Y_AXIS] = ly_symbol2scm ("self-alignment-Y");
+ 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."));
+
}
- SCM align (me->internal_get_property (prop_syms[a]));
-
- Array<Real> translates ;
- Interval total;
- Real where_f= 0;
-
- for (int j= 0 ; j < elems.size (); j++)
- {
- Real dy = - dims[j][-stacking_dir];
- if (j)
- dy += dims[j-1][stacking_dir];
+ Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
+ DOWN);
+ vector<Grob*> elems (all_grobs); // writable copy
+ vector<Skyline_pair> skylines;
- /*
- we want dy to be > 0
- */
- dy *= stacking_dir;
- if (j)
+ 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 padding = robust_scm2double (me->get_property ("padding"), 0.0);
+ vector<Real> translates;
+ for (vsize j = 0; j < elems.size (); j++)
+ {
+ 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 * (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));
}
-
- where_f += stacking_dir * dy;
- total.unite (dims[j] + where_f);
- translates.push (where_f);
}
-
- Real center_offset = 0.0;
- /*
- also move the grobs that were empty, to maintain spatial order.
- */
- Array<Real> all_translates;
- if (translates.size ())
+ vector<Real> all_translates;
+
+ if (!translates.empty ())
{
- int i = 0;
- int j = 0;
Real w = translates[0];
- while (j < all_grobs.size ())
+ 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 (w);
- j++;
+ w = translates[i++];
+ all_translates.push_back (w);
}
+ }
+ return all_translates;
+}
+void
+Align_interface::align_elements_to_extents (Grob *me, Axis a)
+{
+ extract_grob_set (me, "elements", all_grobs);
- /*
- 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));
-
- for (int j = 0 ; j < all_grobs.size (); j++)
- all_grobs[j]->translate_axis (all_translates[j] - center_offset, a);
+ 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);
+}
+
+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");
+
+ 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<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;
}
+
+ programming_error (_ ("tried to get a translation for something that isn't my child"));
+ return 0;
}
+
Axis
-Align_interface::axis (Grob*me)
+Align_interface::axis (Grob *me)
{
- return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
+ return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
}
void
-Align_interface::add_element (Grob*me,Grob* s, SCM cb)
+Align_interface::add_element (Grob *me, Grob *element)
{
- s->add_offset_callback (cb, Align_interface::axis (me));
- Axis_group_interface::add_element (me, s);
+ 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);
+}
/*
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)
+find_fixed_alignment_parent (Grob *g)
{
while (g)
{
return 0;
}
-
-
-
-ADD_INTERFACE (Align_interface, "align-interface",
- "Order grobs from top to bottom, left to right, right to left or bottom"
- "to top."
+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."
,
- "forced-distance stacking-dir align-dir threshold positioning-done "
- "center-element elements axes");
-
-
-struct Foobar
-{
- bool has_interface (Grob*);
-};
-
+
+ /*
+ properties
+ */
+ "align-dir "
+ "axes "
+ "elements "
+ "forced-distance "
+ "padding "
+ "positioning-done "
+ "stacking-dir "
+ "threshold "
+ );
projects / lilypond.git / blobdiff