source file of the GNU LilyPond music typesetter
- (c) 2000--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 2000--2009 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 "grob-array.hh"
+#include "hara-kiri-group-spanner.hh"
+#include "international.hh"
+#include "item.hh"
+#include "page-layout-problem.hh"
+#include "paper-book.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, calc_positioning_done, 1);
+MAKE_SCHEME_CALLBACK (Align_interface, align_to_minimum_distances, 1);
SCM
-Align_interface::calc_positioning_done (SCM smob)
+Align_interface::align_to_minimum_distances (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_minimum_distances (me, ax);
return SCM_BOOL_T;
}
-/*
- merge with align-to-extents?
-*/
-MAKE_SCHEME_CALLBACK(Align_interface, stretch_after_break, 1)
+MAKE_SCHEME_CALLBACK (Align_interface, align_to_ideal_distances, 1);
SCM
-Align_interface::stretch_after_break (SCM grob)
+Align_interface::align_to_ideal_distances (SCM smob)
{
- Grob *me = unsmob_grob (grob);
+ Grob *me = unsmob_grob (smob);
+
+ me->set_property ("positioning-done", SCM_BOOL_T);
+
+ Align_interface::align_elements_to_ideal_distances (me);
+
+ return SCM_BOOL_T;
+}
- Spanner *me_spanner = dynamic_cast<Spanner *> (me);
- extract_grob_set (me, "elements", elems);
- if (me_spanner && elems.size ())
+/* 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 */
+// TODO(jneem): the pure and non-pure parts seem to share very little
+// code. Split them into 2 functions, perhaps?
+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_common = common_refpoint_of_array (*elements, me, other_axis (a));
+
+ for (vsize i = elements->size (); i--;)
{
- Grob *common = common_refpoint_of_array (elems, me, Y_AXIS);
-
- /* force position callbacks */
- for (int 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 (int i = 0; i < elems.size (); i++)
- elems[i]->translate_axis (i * delta, Y_AXIS);
+ Grob *g = (*elements)[i];
+ Skyline_pair skylines;
+
+ if (!pure)
+ {
+ Skyline_pair *skys = Skyline_pair::unsmob (g->get_property (a == Y_AXIS
+ ? "vertical-skylines"
+ : "horizontal-skylines"));
+ if (skys)
+ skylines = *skys;
+
+ /* 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);
+
+ // This is a hack to get better accuracy on the pure-height of VerticalAlignment.
+ // It's quite common for a treble clef to be the highest element of one system
+ // and for a low note (or lyrics) to be the lowest note on another. The two will
+ // never collide, but the pure-height stuff only works with bounding boxes, so it
+ // doesn't know that. The result is a significant over-estimation of the pure-height,
+ // especially on systems with many staves. To correct for this, we build a skyline
+ // in two parts: the part we did above contains most of the grobs (note-heads, etc.)
+ // while the bit we're about to do only contains the breakable grobs at the beginning
+ // of the system. This way, the tall treble clefs are only compared with the treble
+ // clefs of the other staff and they will be ignored if the staff above is, for example,
+ // lyrics.
+ if (Axis_group_interface::has_interface (g)
+ && !Hara_kiri_group_spanner::request_suicide (g, start, end))
+ {
+ extent = Axis_group_interface::rest_of_line_pure_height (g, start, end);
+ Interval begin_of_line_extent = Axis_group_interface::begin_of_line_pure_height (g, start);
+ if (!begin_of_line_extent.is_empty ())
+ {
+ Box b;
+ b[a] = begin_of_line_extent;
+ b[other_axis (a)] = Interval (-infinity_f, -1);
+ skylines.insert (b, 0, other_axis (a));
+ }
+ }
+
+ if (!extent.is_empty ())
+ {
+ Box b;
+ b[a] = extent;
+ b[other_axis (a)] = Interval (0, infinity_f);
+ skylines.insert (b, 0, other_axis (a));
+ }
+ }
+
+ if (skylines.is_empty ())
+ elements->erase (elements->begin () + i);
+ else
+ ret->push_back (skylines);
}
-
- return SCM_UNSPECIFIED;
+ reverse (*ret);
}
-/*
- merge with align-to-extents?
-*/
-void
-Align_interface::align_to_fixed_distance (Grob *me, Axis a)
+vector<Real>
+Align_interface::get_minimum_translations (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a,
+ bool pure, int start, int end)
{
+ if (!pure && a == Y_AXIS && dynamic_cast<Spanner*> (me) && !me->get_system ())
+ me->programming_error ("vertical alignment called before line-breaking");
+
Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
DOWN);
+ vector<Grob*> elems (all_grobs); // writable copy
+ vector<Skyline_pair> skylines;
- Real dy = robust_scm2double (me->get_property ("forced-distance"), 0.0);
+ get_skylines (me, &elems, a, pure, start, end, &skylines);
- extract_grob_set (me, "elements", elem_source);
+ SCM forced_distances = ly_assoc_get (ly_symbol2scm ("alignment-distances"),
+ Page_layout_problem::get_details (me),
+ SCM_EOL);
+
+ Real where = 0;
+ Real default_padding = robust_scm2double (me->get_property ("padding"), 0.0);
+ vector<Real> translates;
+ Skyline down_skyline (stacking_dir);
+ Real last_spaceable_element_pos = 0;
+ Grob *last_spaceable_element = 0;
+ for (vsize j = 0; j < elems.size (); j++)
+ {
+ Real dy = 0;
+ Real padding = default_padding;
- Link_array<Grob> elems (elem_source); // writable..
+ 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]);
+
+ SCM spec = Page_layout_problem::get_spacing_spec (elems[j-1], elems[j]);
+ Page_layout_problem::read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
+
+ Real min_distance = 0;
+ if (Page_layout_problem::read_spacing_spec (spec, &min_distance, ly_symbol2scm ("minimum-distance")))
+ dy = max (dy, min_distance);
+
+ if (Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element)
+ {
+ // Spaceable staves may have min-distance and padding
+ // constraints coming from the previous spaceable staff
+ // as well as from the previous staff.
+ spec = Page_layout_problem::get_spacing_spec (last_spaceable_element, elems[j]);
+ Real spaceable_padding = 0;
+ Page_layout_problem::read_spacing_spec (spec,
+ &spaceable_padding,
+ ly_symbol2scm ("padding"));
+ padding = max (padding, spaceable_padding);
+
+ Real min_distance = 0;
+ if (Page_layout_problem::read_spacing_spec (spec,
+ &min_distance,
+ ly_symbol2scm ("minimum-distance")))
+ dy = max (dy, min_distance + stacking_dir*(last_spaceable_element_pos - where));
+
+ if (scm_is_pair (forced_distances))
+ {
+ SCM forced_dist = scm_car (forced_distances);
+ forced_distances = scm_cdr (forced_distances);
+
+ if (scm_is_number (forced_dist))
+ dy = scm_to_double (forced_dist) + stacking_dir * (last_spaceable_element_pos - where);
+ }
+ }
+ }
- Real where_f = 0;
+ if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
+ dy = 0.0;
- Interval v;
- v.set_empty ();
- Array<Real> translates;
+ dy = max (0.0, dy + padding);
+ down_skyline.raise (-stacking_dir * dy);
+ where += stacking_dir * dy;
+ translates.push_back (where);
- for (int 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.del (j);
+ if (Page_layout_problem::is_spaceable (elems[j]))
+ {
+ last_spaceable_element = elems[j];
+ last_spaceable_element_pos = where;
+ }
}
- for (int j = 0; j < elems.size (); j++)
+ // 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 ())
{
- where_f += stacking_dir * dy;
- translates.push (where_f);
- v.unite (Interval (where_f, where_f));
+ 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);
+ }
}
-
- /*
- TODO: support self-alignment-{Y, X}
- */
- for (int i = 0; i < translates.size (); i++)
- elems[i]->translate_axis (translates[i] - v.center (), a);
+ return all_translates;
}
-/*
- 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)
+Align_interface::align_elements_to_ideal_distances (Grob *me)
{
- Real extra_space = 0.0;
- Spanner *me_spanner = dynamic_cast<Spanner *> (me);
- if (a == Y_AXIS
- && me_spanner)
- {
-#if 0
- /*
- TODO: messes up for figured bass alignments.
- */
- if (me_spanner->get_bound (LEFT)->break_status_dir () == CENTER)
- me->warning (_ ("vertical alignment called before line-breaking. "
- "Only do cross-staff spanners with PianoStaff."));
-#endif
-
- SCM details = me_spanner->get_bound (LEFT)->get_property ("line-break-system-details");
- SCM extra_space_handle = scm_assoc (ly_symbol2scm ("alignment-extra-space"), details);
-
- extra_space = robust_scm2double (scm_is_pair (extra_space_handle)
- ? scm_cdr (extra_space_handle)
- : SCM_EOL,
- extra_space);
- }
-
- Direction stacking_dir = robust_scm2dir (me->get_property ("stacking-dir"),
- DOWN);
+ System *sys = me->get_system ();
+ Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()));
- Interval threshold = robust_scm2interval (me->get_property ("threshold"),
- Interval (0, Interval::infinity ()));
+ layout.solution (true);
+}
- Array<Interval> dims;
+void
+Align_interface::align_elements_to_minimum_distances (Grob *me, Axis a)
+{
+ extract_grob_set (me, "elements", all_grobs);
- Link_array<Grob> elems;
+ vector<Real> translates = get_minimum_translations (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);
- for (int i = 0; i < all_grobs.size (); i++)
+ SCM dy_scm = me->get_property ("forced-distance");
+
+ if (scm_is_number (dy_scm))
{
- Interval y = all_grobs[i]->extent (me, a);
- if (!y.is_empty ())
+ 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]);
-
- 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.
- */
- SCM align ((a == X_AXIS)
- ? me->get_property ("self-alignment-X")
- : me->get_property ("self-alignment-Y"));
-
- Array<Real> translates;
- Interval total;
- Real where = 0;
-
- for (int j = 0; j < elems.size (); j++)
+ else
{
- 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);
- translates.push (where);
- }
+ vector<Real> translates = get_minimum_translations (me, all_grobs, Y_AXIS, true, start, end);
- 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 (translates.size ())
{
- if (i < elems.size () && all_grobs[j] == elems[i])
- w = translates[i++];
- all_translates.push (w);
- j++;
+ for (vsize i = 0; i < all_grobs.size (); i++)
+ if (all_grobs[i] == ch)
+ return translates[i];
}
-
- /*
- 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);
+ 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)
{
void
Align_interface::add_element (Grob *me, Grob *element)
{
- element->add_offset_callback (Grob::same_axis_parent_positioning_proc,
- Align_interface::axis (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->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)
-{
- 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."
- ,
+ "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
- */
- "forced-distance "
- "stacking-dir "
+ /* properties */
"align-dir "
- "threshold "
+ "axes "
+ "elements "
+ "padding "
"positioning-done "
- "elements axes");
-
-struct Foobar
-{
- bool has_interface (Grob *);
-};
-
+ "stacking-dir "
+ );
projects / lilypond.git / blobdiff