source file of the GNU LilyPond music typesetter
- (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+ (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
#include "axis-group-interface.hh"
#include "international.hh"
#include "paper-column.hh"
#include "paper-score.hh"
+#include "separation-item.hh"
#include "system.hh"
#include "warn.hh"
for (vsize i = 0; i < elts.size (); i++)
{
Grob *se = elts[i];
- Interval dims = se->extent (common, a);
- if (!dims.is_empty ())
- r.unite (dims);
+ if (!to_boolean (se->get_property ("cross-staff")))
+ {
+ Interval dims = se->extent (common, a);
+ if (!dims.is_empty ())
+ r.unite (dims);
+ }
}
return r;
}
+
+/*
+ FIXME: pure extent handling has a lot of ad-hoc caching.
+ This should be done with grob property callbacks.
+
+ --hwn
+*/
+
Interval
Axis_group_interface::cached_pure_height (Grob *me,
vector<Grob*> const &elts,
if (end == r)
end_index = i;
}
+ if (end == INT_MAX)
+ end_index = breaks.size () - 1;
if (start_index == VPOS || end_index == VPOS)
{
if (!scm_is_vector (extents))
{
extents = scm_c_make_vector (breaks.size () - 1, SCM_EOL);
- for (vsize i = 0; i < breaks.size () - 1; i++)
+ for (vsize i = 0; i + 1 < breaks.size (); i++)
{
int st = Paper_column::get_rank (cols[breaks[i]]);
int ed = Paper_column::get_rank (cols[breaks[i+1]]);
int end = robust_scm2int (end_scm, INT_MAX);
Grob *me = unsmob_grob (smob);
+ /* Maybe we are in the second pass of a two-pass spacing run. In that
+ case, the Y-extent of a system is already given to us */
+ System *system = dynamic_cast<System*> (me);
+ if (system)
+ {
+ SCM line_break_details = system->column (start)->get_property ("line-break-system-details");
+ SCM system_y_extent = scm_assq (ly_symbol2scm ("system-Y-extent"), line_break_details);
+ if (scm_is_pair (system_y_extent))
+ return scm_cdr (system_y_extent);
+ }
+
return pure_group_height (me, start, end);
}
+
+MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_skylines, 1);
+SCM
+Axis_group_interface::calc_skylines (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "elements", elts);
+ return skyline_spacing (me, elts).smobbed_copy ();
+}
+
+/* whereas calc_skylines calculates skylines for axis-groups with a lot of
+ visible children, combine_skylines is designed for axis-groups whose only
+ children are other axis-groups (ie. VerticalAlignment). Rather than
+ calculating all the skylines from scratch, we just merge the skylines
+ of the children.
+*/
+MAKE_SCHEME_CALLBACK (Axis_group_interface, combine_skylines, 1);
+SCM
+Axis_group_interface::combine_skylines (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ extract_grob_set (me, "elements", elements);
+ Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS);
+
+ assert (y_common == me);
+
+ Skyline_pair ret;
+ for (vsize i = 0; i < elements.size (); i++)
+ {
+ SCM skyline_scm = elements[i]->get_property ("skylines");
+ if (Skyline_pair::unsmob (skyline_scm))
+ {
+ Real offset = elements[i]->relative_coordinate (y_common, Y_AXIS);
+ Skyline_pair other = *Skyline_pair::unsmob (skyline_scm);
+ other.raise (offset);
+ ret.merge (other);
+ }
+ }
+ return ret.smobbed_copy ();
+}
SCM
Axis_group_interface::generic_group_extent (Grob *me, Axis a)
{
+ /* trigger the callback to do skyline-spacing on the children */
+ (void) me->get_property ("skylines");
+
extract_grob_set (me, "elements", elts);
- if (a == Y_AXIS && to_boolean (me->get_property ("skyline-spacing")))
- skyline_spacing (me, elts);
Grob *common = common_refpoint_of_array (elts, me, a);
Real my_coord = me->relative_coordinate (common, a);
return ly_interval2scm (r - my_coord);
}
-SCM
-Axis_group_interface::pure_group_height (Grob *me, int start, int end)
+
+Grob *
+Axis_group_interface::calc_pure_elts_and_common (Grob *me)
{
- Grob *common = unsmob_grob (me->get_object ("common-refpoint-of-elements"));
+ if (Grob *c = unsmob_grob (me->get_object ("pure-Y-common")))
+ return c;
+
+ extract_grob_set (me, "elements", elts);
+
+ vector<Grob*> relevant_elts;
+ SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
- if (!common)
+ for (vsize i = 0; i < elts.size (); i++)
{
- extract_grob_set (me, "elements", elts);
+ if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
+ relevant_elts.push_back (elts[i]);
- vector<Grob*> relevant_elts;
- SCM is_relevant = ly_lily_module_constant ("pure-relevant");
+ Item *it = dynamic_cast<Item*> (elts[i]);
+ Direction d = LEFT;
+ if (it)
+ do
+ {
+ Item *piece = it->find_prebroken_piece (d);
+ if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
+ relevant_elts.push_back (piece);
+ }
+ while (flip (&d) != LEFT);
+ }
- for (vsize i = 0; i < elts.size (); i++)
- {
- if (to_boolean (scm_apply_1 (is_relevant, elts[i]->self_scm (), SCM_EOL)))
- relevant_elts.push_back (elts[i]);
-
- Item *it = dynamic_cast<Item*> (elts[i]);
- Direction d = LEFT;
- if (it)
- do
- {
- Item *piece = it->find_prebroken_piece (d);
- if (piece && to_boolean (scm_apply_1 (is_relevant, piece->self_scm (), SCM_EOL)))
- relevant_elts.push_back (piece);
- }
- while (flip (&d) != LEFT);
- }
+ Grob *common = common_refpoint_of_array (relevant_elts, me, Y_AXIS);
+ me->set_object ("pure-Y-common", common->self_scm ());
+
+ SCM ga_scm = Grob_array::make_array ();
+ Grob_array *ga = unsmob_grob_array (ga_scm);
+ ga->set_array (relevant_elts);
+ me->set_object ("pure-relevant-elements", ga_scm);
- common = common_refpoint_of_array (relevant_elts, me, Y_AXIS);
- me->set_object ("common-refpoint-of-elements", common->self_scm ());
+ return common;
+}
- SCM ga_scm = Grob_array::make_array ();
- Grob_array *ga = unsmob_grob_array (ga_scm);
- ga->set_array (relevant_elts);
- me->set_object ("pure-relevant-elements", ga_scm);
- }
+MAKE_SCHEME_CALLBACK(Axis_group_interface,calc_x_common, 1);
+SCM
+Axis_group_interface::calc_x_common (SCM grob)
+{
+ Grob *me = unsmob_grob (grob);
+
+ extract_grob_set (me, "elements", elts);
+ Grob *common = common_refpoint_of_array (elts, me, X_AXIS);
+ return common->self_scm ();
+}
+
+MAKE_SCHEME_CALLBACK(Axis_group_interface,calc_y_common, 1);
+SCM
+Axis_group_interface::calc_y_common (SCM grob)
+{
+ Grob *me = unsmob_grob (grob);
+ extract_grob_set (me, "elements", elts);
+ Grob *common = common_refpoint_of_array (elts, me, Y_AXIS);
+ return common->self_scm ();
+}
+
+SCM
+Axis_group_interface::pure_group_height (Grob *me, int start, int end)
+{
+ Grob *common = calc_pure_elts_and_common (me);
+
extract_grob_set (me, "pure-relevant-elements", elts);
Real my_coord = me->relative_coordinate (common, Y_AXIS);
Interval r (relative_pure_height (me, elts, common, start, end, true));
bool
staff_priority_less (Grob * const &g1, Grob * const &g2)
{
- int priority_1 = robust_scm2int (g1->get_property ("outside-staff-priority"), INT_MIN);
- int priority_2 = robust_scm2int (g2->get_property ("outside-staff-priority"), INT_MIN);
+ Real priority_1 = robust_scm2double (g1->get_property ("outside-staff-priority"), -infinity_f);
+ Real priority_2 = robust_scm2double (g2->get_property ("outside-staff-priority"), -infinity_f);
if (priority_1 < priority_2)
return true;
else if (priority_1 > priority_2)
return false;
- /* if there is no preference in staff priority, choose the one with the lower rank */
- int rank_1 = g1->spanned_rank_iv ()[LEFT];
- int rank_2 = g2->spanned_rank_iv ()[LEFT];
- return rank_1 < rank_2;
+ /* if neither grob has an outside-staff priority, the ordering will have no
+ effect -- we just need to choose a consistent ordering. We do this to
+ avoid the side-effect of calculating extents. */
+ if (isinf (priority_1))
+ return g1 < g2;
+
+ /* if there is no preference in staff priority, choose the left-most one */
+ Grob *common = g1->common_refpoint (g2, X_AXIS);
+ Real start_1 = g1->extent (common, X_AXIS)[LEFT];
+ Real start_2 = g2->extent (common, X_AXIS)[LEFT];
+ return start_1 < start_2;
}
static void
add_boxes (Grob *me, Grob *x_common, Grob *y_common, vector<Box> *const boxes)
{
- if (Axis_group_interface::has_interface (me)
- && Axis_group_interface::has_axis (me, Y_AXIS))
+ /* if we are a parent, consider the children's boxes instead of mine */
+ if (Grob_array *elements = unsmob_grob_array (me->get_object ("elements")))
{
- Grob_array *elements = unsmob_grob_array (me->get_object ("elements"));
- if (elements)
- for (vsize i = 0; i < elements->size (); i++)
- add_boxes (elements->grob (i), x_common, y_common, boxes);
+ for (vsize i = 0; i < elements->size (); i++)
+ add_boxes (elements->grob (i), x_common, y_common, boxes);
}
- else
+ else if (!scm_is_number (me->get_property ("outside-staff-priority"))
+ && !to_boolean (me->get_property ("cross-staff")))
boxes->push_back (Box (me->extent (x_common, X_AXIS),
me->extent (y_common, Y_AXIS)));
}
-void
+/* We want to avoid situations like this:
+ still more text
+ more text
+ text
+ -------------------
+ staff
+ -------------------
+
+ The point is that "still more text" should be positioned under
+ "more text". In order to achieve this, we place the grobs in several
+ passes. We keep track of the right-most horizontal position that has been
+ affected by the current pass so far (actually we keep track of 2
+ positions, one for above the staff, one for below).
+
+ In each pass, we loop through the unplaced grobs from left to right.
+ If the grob overlaps the right-most affected position, we place it
+ (and then update the right-most affected position to point to the right
+ edge of the just-placed grob). Otherwise, we skip it until the next pass.
+*/
+static void
+add_grobs_of_one_priority (Skyline_pair *const skylines,
+ vector<Grob*> elements,
+ Grob *x_common,
+ Grob *y_common)
+{
+ vector<Box> boxes;
+ Drul_array<Real> last_affected_position;
+
+ reverse (elements);
+ while (!elements.empty ())
+ {
+ last_affected_position[UP] = -infinity_f;
+ last_affected_position[DOWN] = -infinity_f;
+ /* do one pass */
+ for (vsize i = elements.size (); i--;)
+ {
+ Direction dir = get_grob_direction (elements[i]);
+ if (dir == CENTER)
+ {
+ warning (_ ("an outside-staff object should have a direction, defaulting to up"));
+ dir = UP;
+ }
+
+ Box b (elements[i]->extent (x_common, X_AXIS),
+ elements[i]->extent (y_common, Y_AXIS));
+ SCM horizon_padding_scm = elements[i]->get_property ("outside-staff-horizontal-padding");
+ Real horizon_padding = robust_scm2double (horizon_padding_scm, 0.0);
+
+ if (b[X_AXIS][LEFT] - 2*horizon_padding < last_affected_position[dir])
+ continue;
+
+ if (b[X_AXIS].is_empty () || b[Y_AXIS].is_empty ())
+ warning (_f ("outside-staff object %s has an empty extent", elements[i]->name ().c_str ()));
+ else
+ {
+ boxes.clear ();
+ boxes.push_back (b);
+ Skyline other = Skyline (boxes, horizon_padding, X_AXIS, -dir);
+ Real padding = robust_scm2double (elements[i]->get_property ("outside-staff-padding"), 0.5);
+ Real dist = (*skylines)[dir].distance (other) + padding;
+
+ if (dist > 0)
+ {
+ b.translate (Offset (0, dir*dist));
+ elements[i]->translate_axis (dir*dist, Y_AXIS);
+ }
+ (*skylines)[dir].insert (b, 0, X_AXIS);
+ elements[i]->set_property ("outside-staff-priority", SCM_BOOL_F);
+ last_affected_position[dir] = b[X_AXIS][RIGHT];
+ }
+
+ /*
+ Ugh: quadratic. --hwn
+ */
+ elements.erase (elements.begin () + i);
+ }
+ }
+}
+
+Skyline_pair
Axis_group_interface::skyline_spacing (Grob *me, vector<Grob*> elements)
{
vector_sort (elements, staff_priority_less);
Grob *x_common = common_refpoint_of_array (elements, me, X_AXIS);
Grob *y_common = common_refpoint_of_array (elements, me, Y_AXIS);
+ assert (y_common == me);
+
vsize i = 0;
vector<Box> boxes;
&& !scm_is_number (elements[i]->get_property ("outside-staff-priority")); i++)
add_boxes (elements[i], x_common, y_common, &boxes);
- Drul_array<Skyline> skylines (Skyline (boxes, X_AXIS, DOWN),
- Skyline (boxes, X_AXIS, UP));
+ Skyline_pair skylines (boxes, 0, X_AXIS);
for (; i < elements.size (); i++)
{
- Direction dir = get_grob_direction (elements[i]);
- if (dir == CENTER)
- {
- warning (_ ("an outside-staff object should have a direction"));
- continue;
- }
+ SCM priority = elements[i]->get_property ("outside-staff-priority");
+ vector<Grob*> current_elts;
+ current_elts.push_back (elements[i]);
+ while (i + 1 < elements.size ()
+ && scm_eq_p (elements[i+1]->get_property ("outside-staff-priority"), priority))
+ current_elts.push_back (elements[++i]);
+
+ add_grobs_of_one_priority (&skylines, current_elts, x_common, y_common);
+ }
+ return skylines;
+}
- Box b (elements[i]->extent (x_common, X_AXIS),
- elements[i]->extent (y_common, Y_AXIS));
- if (b[X_AXIS].is_empty () || b[Y_AXIS].is_empty ())
- {
- warning (_f ("outside-staff object %s has an empty extent", elements[i]->name ().c_str ()));
- continue;
- }
+MAKE_SCHEME_CALLBACK (Axis_group_interface, calc_max_stretch, 1)
+SCM
+Axis_group_interface::calc_max_stretch (SCM smob)
+{
+ Grob *me = unsmob_grob (smob);
+ Real ret = 0;
+ extract_grob_set (me, "elements", elts);
- boxes.clear ();
- boxes.push_back (b);
- Skyline other = Skyline (boxes, X_AXIS, -dir);
- Real padding = robust_scm2double (elements[i]->get_property ("outside-staff-padding"), 0.5);
- Real dist = skylines[dir].distance (other) + padding;
+ for (vsize i = 0; i < elts.size (); i++)
+ if (Axis_group_interface::has_interface (elts[i]))
+ ret += robust_scm2double (elts[i]->get_property ("max-stretch"), 0.0);
- if (dist > 0)
- {
- b.translate (Offset (0, dir*dist));
- elements[i]->translate_axis (dir*dist, Y_AXIS);
- }
- skylines[dir].insert (b, X_AXIS);
- }
+ return scm_from_double (ret);
}
ADD_INTERFACE (Axis_group_interface,
"An object that groups other layout objects.",
/* properties */
+ "X-common "
+ "Y-common "
"axes "
"elements "
- "common-refpoint-of-elements "
+ "keep-fixed-while-stretching "
+ "max-stretch "
+ "pure-Y-common "
"pure-relevant-elements "
- "skyline-spacing "
+ "skylines "
"cached-pure-extents "
);
projects / lilypond.git / blobdiff