-/*
- align-interface.cc -- implement Align_interface
-
+/*
+ align-interface.cc -- implement Align_interface
+
source file of the GNU LilyPond music typesetter
-
- (c) 2000--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+
+ (c) 2000--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
#include "align-interface.hh"
-#include "grob.hh"
-#include "group-interface.hh"
#include "axis-group-interface.hh"
+#include "grob-array.hh"
#include "hara-kiri-group-spanner.hh"
-#include "paper-def.hh"
+#include "international.hh"
+#include "item.hh"
+#include "paper-column.hh"
+#include "pointer-group-interface.hh"
+#include "spanner.hh"
+#include "skyline-pair.hh"
+#include "system.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,alignment_callback,2);
+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->get_parent (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);
+
+ me->set_property ("positioning-done", SCM_BOOL_T);
+
+ SCM axis = scm_car (me->get_property ("axes"));
+ Axis ax = Axis (scm_to_int (axis));
+
+ Align_interface::align_elements_to_extents (me, ax);
+
+ return SCM_BOOL_T;
}
-MAKE_SCHEME_CALLBACK (Align_interface,fixed_distance_alignment_callback,2);
+/*
+ TODO: This belongs to the old two-pass spacing. Delete me.
+*/
+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->get_parent (ax);
- if (par && !to_boolean (par->get_grob_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::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)
+/* 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_grob_property ("alignment-done", SCM_BOOL_T);
+ Grob *other_common = common_refpoint_of_array (*elements, me, other_axis (a));
- 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;
+ for (vsize i = elements->size (); i--;)
+ {
+ Grob *g = (*elements)[i];
+ Skyline_pair skylines;
- SCM force = me->get_grob_property ("forced-distance");
+ if (!pure)
+ {
+ Skyline_pair *skys = Skyline_pair::unsmob (g->get_property (a == Y_AXIS
+ ? "vertical-skylines"
+ : "horizontal-skylines"));
+ if (skys)
+ skylines = *skys;
+
+ /* 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
+ ? ly_symbol2scm ("minimum-X-extent")
+ : ly_symbol2scm ("minimum-Y-extent"));
+
+ if (is_number_pair (min_extent))
+ {
+ Box b;
+ Interval other_extent = g->extent (other_common, 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 dy = 0.0;
- if (gh_number_p (force))
- {
- dy = gh_scm2double (force);
+ /* This skyline was calculated relative to the grob g. In order to compare it to
+ skylines belonging to other grobs, we need to shift it so that it is relative
+ to the common reference. */
+ Real offset = g->relative_coordinate (other_common, 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));
+ }
+ }
+
+ if (skylines.is_empty ())
+ elements->erase (elements->begin () + i);
+ else
+ ret->push_back (skylines);
}
-
- Link_array<Grob> elems
- = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+ reverse (*ret);
+}
- Real where_f=0;
+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)
+ {
+ 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");
- Interval v;
- v.set_empty ();
- Array<Real> translates;
+ if (!me->get_system () && !pure)
+ me->programming_error ("vertical alignment called before line-breaking");
+ }
- for (int j= elems.size (); j--; )
+ 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;
+ /* 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);
+
+ Real padding = robust_scm2double (me->get_property ("padding"), 0.0);
+ vector<Real> translates;
+ Skyline down_skyline (stacking_dir);
+ for (vsize j = 0; 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 (!ly_pair_p (elems[j]-> immutable_property_alist_))
- elems.del(j);
+ Real dy = 0;
+ if (j == 0)
+ dy = skylines[j][-stacking_dir].max_height ();
+ else
+ {
+ down_skyline.merge (skylines[j-1][stacking_dir]);
+ dy = down_skyline.distance (skylines[j][-stacking_dir]);
+ }
+
+ if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
+ dy = 0.0;
+
+ dy = max (0.0, dy + padding + extra_space / elems.size ());
+ down_skyline.raise (-stacking_dir * dy);
+ where += stacking_dir * dy;
+ translates.push_back (where);
}
- for (int j =0; j < elems.size (); j++)
+ SCM offsets_handle = scm_assq (ly_symbol2scm ("alignment-offsets"),
+ line_break_details);
+ if (scm_is_pair (offsets_handle))
{
- where_f += stacking_dir * dy;
- translates.push (where_f);
- v.unite (Interval (where_f, where_f));
+ vsize i = 0;
+
+ 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));
+ }
}
- /*
- TODO: support self-alignment-{Y,X}
- */
- for (int i = 0; i < translates.size (); i++)
+ // So far, we've computed the translates for all the non-empty elements.
+ // Here, we set the translates for the empty elements: an empty element
+ // gets the same translation as the last non-empty element before it.
+ vector<Real> all_translates;
+ if (!translates.empty ())
{
- elems[i]->translate_axis (translates[i] - v.center (), a);
+ 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;
}
-/*
- Hairy function to put elements where they should be. Can be tweaked
- from the outside by setting minimum-space-pair and 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)
+Align_interface::align_elements_to_extents (Grob *me, Axis a)
{
- 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;
-
- Interval threshold = Interval (0, Interval::infinity ());
- SCM thr = me->get_grob_property ("threshold");
- if (gh_pair_p (thr))
+ 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);
+}
+
+/* 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 = 1; i < elts.size (); i++)
{
- threshold[SMALLER] = gh_scm2double (ly_car (thr));
- threshold[BIGGER] = gh_scm2double (ly_cdr (thr));
+ if (!elts[i]->extent (me, a).is_empty ()
+ && !to_boolean (elts[i]->get_property ("keep-fixed-while-stretching")))
+ offset += amount / non_empty_elts;
+ elts[i]->translate_axis (dir * offset, a);
}
+ me->flush_extent_cache (Y_AXIS);
+}
-
- Array<Interval> dims;
+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");
- 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++)
+ if (scm_is_number (dy_scm))
{
- Interval y = all_grobs[i]->extent (me, a);
- if (!y.empty_b ())
+ 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++)
{
- Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
-
- // todo: fucks up if item both in Halign & Valign.
- SCM min_dims = e->remove_grob_property ("minimum-space-pair");
- if (gh_pair_p (min_dims) &&
- gh_number_p (ly_car (min_dims))
- && gh_number_p (ly_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 (ly_car (extra_dims))
- && gh_number_p (ly_cdr (extra_dims)))
- {
- y[LEFT] += gh_scm2double (ly_car (extra_dims));
- y[RIGHT] += gh_scm2double (ly_cdr (extra_dims));
- }
-
- elems.push (e);
- dims.push (y);
+ 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;
}
}
-
-
- /*
- 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.
- */
-
- String s ("self-alignment-");
-
- s += (a == X_AXIS) ? "X" : "Y";
-
- SCM align (me->get_grob_property (s.ch_C ()));
-
- Array<Real> translates ;
- Interval total;
- Real where_f=0;
-
- for (int j=0 ; j < elems.size (); j++)
+ else
{
- Real dy = - dims[j][-stacking_dir];
- if (j)
- dy += dims[j-1][stacking_dir];
+ vector<Real> translates = get_extents_aligned_translates (me, all_grobs, Y_AXIS, true, start, end);
-
- /*
- we want dy to be > 0
- */
- dy *= stacking_dir;
- if (j)
+ if (translates.size ())
{
- dy = (dy >? threshold[SMALLER])
- <? threshold[BIGGER];
+ for (vsize i = 0; i < all_grobs.size (); i++)
+ if (all_grobs[i] == ch)
+ return translates[i];
}
-
- where_f += stacking_dir * dy;
- total.unite (dims[j] + where_f);
- translates.push (where_f);
+ else
+ return 0;
}
-
- Grob * align_center = unsmob_grob (align);
- Real center_offset = 0.0;
-
- /*
- also move the grobs that were empty, to maintain spatial order.
- */
- Array<Real> all_translates;
- if (translates.size ())
- {
- int i =0;
- int j =0;
- Real w = translates[0];
- while (j < all_grobs.size ())
- {
- 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++;
- }
-
-
- /*
- FIXME: uncommenting freaks out the Y-alignment of
- line-of-score.
- */
- // Real align_param = ly_dir_p (align) ? gh_scm2double (align) : 0.0;
-
- if (gh_number_p (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);
- }
+ programming_error (_ ("tried to get a translation for something that is no child of mine"));
+ return 0;
}
+
Axis
-Align_interface::axis (Grob*me)
+Align_interface::axis (Grob *me)
{
- return Axis (gh_scm2int (ly_car (me->get_grob_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);
+}
+int
+Align_interface::stretchable_children_count (Grob const *me)
+{
+ extract_grob_set (me, "elements", elts);
+ int ret = 0;
-ADD_INTERFACE (Align_interface, "align-interface",
- " Order grobs top to bottom/left to right/right to left etc.",
- "forced-distance stacking-dir align-dir threshold alignment-done center-element elements axes");
+ /* 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;
+}
-struct Foobar
+MAKE_SCHEME_CALLBACK (Align_interface, calc_max_stretch, 1)
+SCM
+Align_interface::calc_max_stretch (SCM smob)
{
- bool has_interface (Grob*);
-};
-ADD_INTERFACE (Foobar, "aligned-interface",
- "read by align-interface",
- "minimum-space-pair extra-space");
+ Grob *me = unsmob_grob (smob);
+ Spanner *spanner_me = dynamic_cast<Spanner*> (me);
+ Real ret = 0;
+
+ if (spanner_me && stretchable_children_count (me) > 0)
+ {
+ Paper_column *left = dynamic_cast<Paper_column*> (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);
+}
+
+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"
+ " @rinternals{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"
+ " @code{PianoStaff}s further apart.",
+
+ /* properties */
+ "align-dir "
+ "axes "
+ "elements "
+ "padding "
+ "positioning-done "
+ "stacking-dir "
+ "threshold "
+ );
projects / lilypond.git / blobdiff