-/*
- align-interface.cc -- implement Align_interface
-
- source file of the GNU LilyPond music typesetter
-
- (c) 2000--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-
- */
+/*
+ This file is part of LilyPond, the GNU music typesetter.
+
+ Copyright (C) 2000--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
+
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
+*/
#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"
-
-MAKE_SCHEME_CALLBACK (Align_interface,alignment_callback,2);
+#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"
+
+
+MAKE_SCHEME_CALLBACK (Align_interface, align_to_minimum_distances, 1);
SCM
-Align_interface::alignment_callback (SCM element_smob, SCM axis)
+Align_interface::align_to_minimum_distances (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);
-MAKE_SCHEME_CALLBACK (Align_interface,fixed_distance_alignment_callback,2);
-SCM
-Align_interface::fixed_distance_alignment_callback (SCM element_smob, SCM axis)
-{
- 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_to_fixed_distance (par, ax);
- }
- return gh_double2scm (0.0);
+ 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_minimum_distances (me, ax);
+
+ return SCM_BOOL_T;
}
-/*
- merge with align-to-extents?
- */
-void
-Align_interface::align_to_fixed_distance (Grob *me , Axis a)
+MAKE_SCHEME_CALLBACK (Align_interface, align_to_ideal_distances, 1);
+SCM
+Align_interface::align_to_ideal_distances (SCM smob)
{
- 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;
+ Grob *me = unsmob_grob (smob);
- SCM force = me->get_grob_property ("forced-distance");
+ me->set_property ("positioning-done", SCM_BOOL_T);
- Real dy = 0.0;
- if (gh_number_p (force))
- {
- dy = gh_scm2double (force);
- }
-
- Link_array<Grob> elems
- = Pointer_group_interface__extract_grobs (me, (Grob*) 0, "elements");
+ Align_interface::align_elements_to_ideal_distances (me);
- Real where_f=0;
+ return SCM_BOOL_T;
+}
- Interval v;
- v.set_empty ();
- Array<Real> translates;
+/* 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 (int j= elems.size (); j--; )
+ for (vsize i = elements->size (); i--;)
{
- /*
- 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);
- }
+ Grob *g = (*elements)[i];
+ Skyline_pair skylines;
- for (int j =0; j < elems.size (); j++)
- {
- where_f += stacking_dir * dy;
- translates.push (where_f);
- v.unite (Interval (where_f, where_f));
- }
+ 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));
+ }
+ }
- /*
- TODO: support self-alignment-{Y,X}
- */
- for (int i = 0; i < translates.size (); i++)
- {
- elems[i]->translate_axis (translates[i] - v.center (), 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);
}
+ reverse (*ret);
}
-/*
- 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)
+vector<Real>
+Align_interface::get_minimum_translations (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a)
{
- me->set_grob_property ("alignment-done", SCM_BOOL_T);
-
- SCM d = me->get_grob_property ("stacking-dir");
+ return internal_get_minimum_translations (me, all_grobs, a, true, false, 0, 0);
+}
-
- Direction stacking_dir = gh_number_p (d) ? to_dir (d) : CENTER;
- if (!stacking_dir)
- stacking_dir = DOWN;
+vector<Real>
+Align_interface::get_pure_minimum_translations (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a, int start, int end)
+{
+ return internal_get_minimum_translations (me, all_grobs, a, true, true, start, end);
+}
+vector<Real>
+Align_interface::get_minimum_translations_without_min_dist (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a)
+{
+ return internal_get_minimum_translations (me, all_grobs, a, false, false, 0, 0);
+}
+// If include_fixed_spacing is false, the only constraints that will be measured
+// here are those that result from collisions (+ padding) and minimum-distance
+// between adjacent staves.
+// If include_fixed_spacing is true, constraints from line-break-system-details,
+// basic-distance+stretchable=0, and staff-staff-spacing of spaceable staves
+// with loose lines in between, are included as well.
+// - If you want to find the minimum height of a system, include_fixed_spacing should be true.
+// - If you're going to actually lay out the page, then it should be false (or
+// else centered dynamics will break when there is a fixed alignment).
+vector<Real>
+Align_interface::internal_get_minimum_translations (Grob *me,
+ vector<Grob*> const &all_grobs,
+ Axis a,
+ bool include_fixed_spacing,
+ 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");
+
+ // If include_fixed_spacing is true, we look at things like system-system-spacing
+ // and alignment-distances, which only make sense for the toplevel VerticalAlignment.
+ // If we aren't toplevel, we're working on something like BassFigureAlignment
+ // and so we definitely don't want to include alignment-distances!
+ if (!dynamic_cast<System*> (me->get_parent (Y_AXIS)))
+ include_fixed_spacing = false;
- Interval threshold = Interval (0, Interval::infinity ());
- SCM thr = me->get_grob_property ("threshold");
- if (gh_pair_p (thr))
+ 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;
+ 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;
+ Skyline last_spaceable_skyline (stacking_dir);
+ int spaceable_count = 0;
+ for (vsize j = 0; j < elems.size (); j++)
{
- threshold[SMALLER] = gh_scm2double (ly_car (thr));
- threshold[BIGGER] = gh_scm2double (ly_cdr (thr));
- }
-
-
- Array<Interval> dims;
+ Real dy = 0;
+ Real padding = default_padding;
- 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++)
- {
- Interval y = all_grobs[i]->extent (me, a);
- if (!y.empty_b ())
+ if (j == 0)
+ dy = skylines[j][-stacking_dir].max_height () + padding;
+ else
{
- Grob *e =dynamic_cast<Grob*> (all_grobs[i]);
+ SCM spec = Page_layout_problem::get_spacing_spec (elems[j-1], elems[j], pure, start, end);
+ Page_layout_problem::read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
- // 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)))
+ dy = down_skyline.distance (skylines[j][-stacking_dir]) + 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 (include_fixed_spacing)
+ dy = max (dy, Page_layout_problem::get_fixed_spacing (elems[j-1], elems[j], spaceable_count, pure, start, end));
+
+ if (include_fixed_spacing && Page_layout_problem::is_spaceable (elems[j]) && last_spaceable_element)
{
- y[LEFT] += gh_scm2double (ly_car (extra_dims));
- y[RIGHT] += gh_scm2double (ly_cdr (extra_dims));
+ // Spaceable staves may have
+ // 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], pure, start, end);
+ Real spaceable_padding = 0;
+ Page_layout_problem::read_spacing_spec (spec,
+ &spaceable_padding,
+ ly_symbol2scm ("padding"));
+ dy = max(dy, (last_spaceable_skyline.distance (skylines[j][-stacking_dir])
+ + stacking_dir*(last_spaceable_element_pos - where) + spaceable_padding));
+
+ Real spaceable_min_distance = 0;
+ if (Page_layout_problem::read_spacing_spec (spec,
+ &spaceable_min_distance,
+ ly_symbol2scm ("minimum-distance")))
+ dy = max (dy, spaceable_min_distance + stacking_dir*(last_spaceable_element_pos - where));
+
+ dy = max (dy, Page_layout_problem::get_fixed_spacing (last_spaceable_element, elems[j], spaceable_count,
+ pure, start, end));
}
-
- elems.push (e);
- dims.push (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.
- */
-
- 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++)
- {
- Real dy = - dims[j][-stacking_dir];
- if (j)
- dy += dims[j-1][stacking_dir];
+ if (isinf (dy)) /* if the skyline is empty, maybe max_height is infinity_f */
+ dy = 0.0;
+
+ dy = max (0.0, dy);
+ down_skyline.raise (-stacking_dir * dy);
+ down_skyline.merge (skylines[j][stacking_dir]);
+ where += stacking_dir * dy;
+ translates.push_back (where);
- /*
- we want dy to be > 0
- */
- dy *= stacking_dir;
- if (j)
+ if (Page_layout_problem::is_spaceable (elems[j]))
{
- dy = (dy >? threshold[SMALLER])
- <? threshold[BIGGER];
+ spaceable_count++;
+ last_spaceable_element = elems[j];
+ last_spaceable_element_pos = where;
+ last_spaceable_skyline = down_skyline;
}
-
- where_f += stacking_dir * dy;
- total.unite (dims[j] + where_f);
- translates.push (where_f);
}
-
- 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 ())
+ // 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 ())
{
- 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++];
- }
- if (all_grobs[j] == align_center)
- center_offset = w;
- all_translates .push (w);
- j++;
+ w = translates[i++];
+ all_translates.push_back (w);
}
-
-
- /*
- 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);
}
+ return all_translates;
}
-Axis
-Align_interface::axis (Grob*me)
-{
- return Axis (gh_scm2int (ly_car (me->get_grob_property ("axes"))));
-}
-
-/*
- should use generic Scm funcs.
- */
-int
-Align_interface::get_count (Grob*me,Grob*s)
+void
+Align_interface::align_elements_to_ideal_distances (Grob *me)
{
- SCM e = me->get_grob_property ("elements");
- int c =0;
- while (gh_pair_p (e))
+ System *sys = me->get_system ();
+ if (sys)
{
- if (ly_car (e) == s->self_scm ())
- break;
- c++;
- e = ly_cdr (e);
+ Page_layout_problem layout (NULL, SCM_EOL, scm_list_1 (sys->self_scm ()));
+ layout.solution (true);
}
- return c;
+ else
+ programming_error ("vertical alignment called before line breaking");
}
void
-Align_interface::add_element (Grob*me,Grob* s, SCM cb)
+Align_interface::align_elements_to_minimum_distances (Grob *me, Axis a)
{
- s->add_offset_callback (cb, Align_interface::axis (me));
- Axis_group_interface::add_element (me, s);
-}
+ extract_grob_set (me, "elements", all_grobs);
+ vector<Real> translates = get_minimum_translations (me, all_grobs, a);
+ if (translates.size ())
+ for (vsize j = 0; j < all_grobs.size (); j++)
+ all_grobs[j]->translate_axis (translates[j], a);
+}
-void
-Align_interface::set_interface (Grob*me)
+Real
+Align_interface::get_pure_child_y_translation (Grob *me, Grob *ch, int start, int end)
{
- me->set_interface (ly_symbol2scm ("align-interface"));
+ extract_grob_set (me, "elements", all_grobs);
+ vector<Real> translates = get_pure_minimum_translations (me, all_grobs, Y_AXIS, start, end);
- Axis_group_interface::set_interface (me);
+ 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 is no child of mine");
+ return 0;
+}
+
+Axis
+Align_interface::axis (Grob *me)
+{
+ return Axis (scm_to_int (scm_car (me->get_property ("axes"))));
}
void
-Align_interface::set_axis (Grob*me,Axis a)
+Align_interface::add_element (Grob *me, Grob *element)
{
- Axis_group_interface::set_axes (me, a,a);
+ 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);
}
-bool
-Align_interface::has_interface (Grob*me)
+void
+Align_interface::set_ordered (Grob *me)
{
- return me && me->has_interface (ly_symbol2scm ("align-interface"));
+ 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);
}
+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.",
+
+ /* properties */
+ "align-dir "
+ "axes "
+ "elements "
+ "padding "
+ "positioning-done "
+ "stacking-dir "
+ );
projects / lilypond.git / blobdiff