#include "page-layout-problem.hh"
#include "align-interface.hh"
+#include "axis-group-interface.hh"
+#include "hara-kiri-group-spanner.hh"
#include "international.hh"
#include "item.hh"
#include "output-def.hh"
#include "paper-book.hh"
+#include "paper-column.hh"
#include "pointer-group-interface.hh"
#include "prob.hh"
#include "skyline-pair.hh"
Prob *page = unsmob_prob (page_scm);
header_height_ = 0;
footer_height_ = 0;
+ header_padding_ = 0;
+ footer_padding_ = 0;
page_height_ = 100;
if (page)
bottom_skyline_.set_minimum_height (-header_height_);
SCM between_system_spacing = SCM_EOL;
+ SCM between_scores_system_spacing = SCM_EOL;
SCM after_title_spacing = SCM_EOL;
SCM before_title_spacing = SCM_EOL;
SCM between_title_spacing = SCM_EOL;
- // first_system_spacing controls the spring from the top of the printable
+ // top_system_spacing controls the spring from the top of the printable
// area to the first staff. It allows the user to control the offset of
// the first staff (as opposed to the top of the first system) from the
- // top of the page. Similarly for last_system_spacing.
- SCM first_system_spacing = SCM_EOL;
- SCM last_system_spacing = SCM_EOL;
+ // top of the page. Similarly for bottom_system_spacing.
+ SCM top_system_spacing = SCM_EOL;
+ SCM bottom_system_spacing = SCM_EOL;
if (pb && pb->paper_)
{
Output_def *paper = pb->paper_;
between_system_spacing = paper->c_variable ("between-system-spacing");
+ between_scores_system_spacing = paper->c_variable ("between-scores-system-spacing");
after_title_spacing = paper->c_variable ("after-title-spacing");
before_title_spacing = paper->c_variable ("before-title-spacing");
between_title_spacing = paper->c_variable ("between-title-spacing");
- last_system_spacing = paper->c_variable ("last-system-spacing");
- first_system_spacing = paper->c_variable ("first-system-spacing");
+ bottom_system_spacing = paper->c_variable ("bottom-system-spacing");
+ top_system_spacing = paper->c_variable ("top-system-spacing");
if (scm_is_pair (systems) && unsmob_prob (scm_car (systems)))
- first_system_spacing = paper->c_variable ("first-system-title-spacing");
+ top_system_spacing = paper->c_variable ("top-title-spacing");
// Note: the page height here does _not_ reserve space for headers and
- // footers. This is because we want to anchor the first-system-spacing
+ // footers. This is because we want to anchor the top-system-spacing
// spring at the _top_ of the header.
page_height_ -= robust_scm2double (paper->c_variable ("top-margin"), 0)
+ robust_scm2double (paper->c_variable ("bottom-margin"), 0);
+
+ read_spacing_spec (top_system_spacing, &header_padding_, ly_symbol2scm ("padding"));
+ read_spacing_spec (bottom_system_spacing, &footer_padding_, ly_symbol2scm ("padding"));
}
bool last_system_was_title = false;
continue;
}
- SCM spec = first ? first_system_spacing
- : (last_system_was_title ? after_title_spacing : between_system_spacing);
+ SCM spec = between_system_spacing;
+ if (first)
+ spec = top_system_spacing;
+ else if (last_system_was_title)
+ spec = after_title_spacing;
+ else if (0 == Paper_column::get_rank (sys->get_bound (LEFT)))
+ spec = between_scores_system_spacing;
+
Spring spring (first ? 0 : 1, 0.0);
Real padding = 0.0;
alter_spring_from_spacing_spec (spec, &spring);
}
else if (Prob *p = unsmob_prob (scm_car (s)))
{
- SCM spec = first ? first_system_spacing
+ SCM spec = first ? top_system_spacing
: (last_system_was_title ? between_title_spacing : before_title_spacing);
Spring spring (first ? 0 : 1, 0.0);
Real padding = 0.0;
Spring last_spring (0, 0);
Real last_padding = 0;
- alter_spring_from_spacing_spec (last_system_spacing, &last_spring);
- read_spacing_spec (last_system_spacing, &last_padding, ly_symbol2scm ("padding"));
+ alter_spring_from_spacing_spec (bottom_system_spacing, &last_spring);
+ read_spacing_spec (bottom_system_spacing, &last_padding, ly_symbol2scm ("padding"));
last_spring.ensure_min_distance (last_padding - bottom_skyline_.max_height () + footer_height_);
springs_.push_back (last_spring);
+
+ if (elements_.size ())
+ {
+ Real bottom_padding = 0;
+
+ // TODO: junk bottom-space now that we have bottom-system-spacing?
+ // bottom-space has the flexibility that one can do it per-system.
+ // NOTE: bottom-space is misnamed since it is not stretchable space.
+ if (Prob *p = elements_.back ().prob)
+ bottom_padding = robust_scm2double (p->get_property ("bottom-space"), 0);
+ else if (elements_.back ().staves.size ())
+ {
+ SCM details = get_details (elements_.back ());
+ bottom_padding = robust_scm2double (ly_assoc_get (ly_symbol2scm ("bottom-space"),
+ details,
+ SCM_BOOL_F),
+ 0.0);
+ }
+ page_height_ -= bottom_padding;
+ }
}
void
footer_height_ = height;
}
-Grob*
-Page_layout_problem::find_vertical_alignment (System *sys)
-{
- extract_grob_set (sys, "elements", elts);
- for (vsize i = 0; i < elts.size (); ++i)
- if (Align_interface::has_interface (elts[i]))
- return elts[i];
-
- return 0;
-}
-
void
Page_layout_problem::append_system (System *sys, Spring const& spring, Real padding)
{
- Grob *align = find_vertical_alignment (sys);
+ Grob *align = sys->get_vertical_alignment ();
if (!align)
- {
- sys->programming_error ("no VerticalAlignment in system: can't do vertical spacing");
- return;
- }
+ return;
align->set_property ("positioning-done", SCM_BOOL_T);
- extract_grob_set (align, "elements", elts);
+ extract_grob_set (align, "elements", all_elts);
+ vector<Grob*> elts = filter_dead_elements (all_elts);
vector<Real> minimum_offsets = Align_interface::get_minimum_translations (align, elts, Y_AXIS,
false, 0, 0);
SCM details = get_details (elements_.back ());
SCM manual_dists = ly_assoc_get (ly_symbol2scm ("alignment-distances"), details, SCM_EOL);
vsize last_spaceable_staff = 0;
- bool first_live_element = true;
+ bool found_spaceable_staff = false;
for (vsize i = 0; i < elts.size (); ++i)
{
- if (elts[i]->is_live () && is_spaceable (elts[i]))
+ if (is_spaceable (elts[i]))
{
- // We don't add a spring for the first live element, since
+ // We don't add a spring for the first staff, since
// we are only adding springs _between_ staves here.
- if (first_live_element)
+ if (!found_spaceable_staff)
{
- if (i > 0)
- add_loose_lines_as_spaceable_lines (elts, minimum_offsets, 0, i-1);
-
- first_live_element = false;
+ found_spaceable_staff = true;
last_spaceable_staff = i;
continue;
}
alter_spring_from_spacing_spec (spec, &spring);
springs_.push_back (spring);
- Real min_distance = minimum_offsets[last_spaceable_staff] - minimum_offsets[i];
+ Real min_distance = (found_spaceable_staff ? minimum_offsets[last_spaceable_staff] : 0) - minimum_offsets[i];
springs_.back ().ensure_min_distance (min_distance);
if (scm_is_pair (manual_dists))
last_spaceable_staff = i;
}
}
- // Any loose lines hanging off the end are treated as spaceable
- // lines. This might give slightly weird results if the hanging
- // systems have staff-affinity != UP. It's not quite clear what
- // should happen in that case, though.
- if (last_spaceable_staff + 1 < elts.size ())
- add_loose_lines_as_spaceable_lines (elts, minimum_offsets,
- first_live_element ? 0 : last_spaceable_staff + 1,
- elts.size () - 1);
-}
-
-void
-Page_layout_problem::add_loose_lines_as_spaceable_lines (vector<Grob*> const& elts,
- vector<Real> const& minimum_offsets,
- vsize first, vsize last)
-{
- Direction last_affinity = UP;
- SCM last_spec = SCM_EOL;
- bool found_live_line = false;
- for (vsize i = first; i <= last; ++i)
- {
- if (elts[i]->is_live ())
- {
- Direction affinity = robust_scm2dir (elts[i]->get_property ("staff-affinity"), CENTER);
- if (affinity > last_affinity)
- {
- warning (_ ("staff-affinities should only decrease"));
- affinity = last_affinity;
- }
-
- SCM spec = elts[i]->get_property ("inter-staff-spacing");
- if ((affinity != DOWN && found_live_line)
- || (affinity == DOWN && i != last)) // FIXME: we want to know if we are the last _live_ line.
- spec = elts[i]->get_property ("inter-loose-line-spacing");
-
- Spring spring (1.0, 0.0);
- // When affinity == DOWN, the spacing spec specifies the
- // spacing to the staff below.
- if (affinity == DOWN)
- alter_spring_from_spacing_spec (last_spec, &spring);
- else
- alter_spring_from_spacing_spec (spec, &spring);
-
- Real min_distance = (i > 0 ? minimum_offsets[i-1] : 0) - minimum_offsets[i];
- spring.ensure_min_distance (min_distance);
-
- // The first line in a system doesn't get a spring.
- if (first > 0 || found_live_line)
- springs_.push_back (spring);
-
- mark_as_spaceable (elts[i]);
- last_spec = spec;
- last_affinity = affinity;
- found_live_line = true;
- }
- }
- if (found_live_line && last + 1 < elts.size ())
- {
- Spring spring (1.0, 0.0);
- if (last_affinity == UP)
- warning (_ ("a system with staff-affinity UP is stranded above the system"));
- alter_spring_from_spacing_spec (last_spec, &spring);
-
- Real min_distance = minimum_offsets[last] - minimum_offsets[last+1];
- spring.ensure_min_distance (min_distance);
- springs_.push_back (spring);
- }
+ // Corner case: there was only one staff, and it wasn't spaceable.
+ // Mark it spaceable, because we do not allow non-spaceable staves
+ // to be at the top or bottom of a system.
+ if (!found_spaceable_staff && elts.size ())
+ mark_as_spaceable (elts[0]);
}
void
for (vsize i = 0; i < springs_.size (); ++i)
spacer.add_spring (springs_[i]);
- Real bottom_padding = 0;
- Interval first_staff_iv (0, 0);
- Interval last_staff_iv (0, 0);
- if (elements_.size ())
- {
- first_staff_iv = first_staff_extent (elements_[0]);
- last_staff_iv = last_staff_extent (elements_.back ());
-
- // TODO: junk bottom-space now that we have last-spring-spacing?
- // bottom-space has the flexibility that one can do it per-system.
- // NOTE: bottom-space is misnamed since it is not stretchable space.
- if (Prob *p = elements_.back ().prob)
- bottom_padding = robust_scm2double (p->get_property ("bottom-space"), 0);
- else if (elements_.back ().staves.size ())
- {
- SCM details = get_details (elements_.back ());
- bottom_padding = robust_scm2double (ly_assoc_get (ly_symbol2scm ("bottom-space"),
- details,
- SCM_BOOL_F),
- 0.0);
- }
- }
-
- spacer.solve (page_height_ - bottom_padding, ragged);
+ spacer.solve (page_height_, ragged);
solution_ = spacer.spring_positions ();
}
// spring_idx 0 is the top of the page. Interesting values start from 1.
vsize spring_idx = 1;
+ vector<Grob*> loose_lines;
+ vector<Real> loose_line_min_distances;
+ Grob *last_spaceable_line = 0;
+ Real last_spaceable_line_translation = 0;
for (vsize i = 0; i < elements_.size (); ++i)
{
if (elements_[i].prob)
{
*tail = scm_cons (scm_from_double (solution_[spring_idx]), SCM_EOL);
tail = SCM_CDRLOC (*tail);
+
+ // Lay out any non-spaceable lines between this line and
+ // the last one.
+ if (loose_lines.size ())
+ {
+ Interval loose_extent = loose_lines.back ()->extent (loose_lines.back (), Y_AXIS);
+ Interval prob_extent = unsmob_stencil (elements_[i].prob->get_property ("stencil"))->extent (Y_AXIS);
+ Real min_distance = -loose_extent[DOWN] + prob_extent[UP]; // TODO: include padding/minimum-distance
+
+ loose_line_min_distances.push_back (min_distance);
+ loose_lines.push_back (0);
+
+ distribute_loose_lines (loose_lines, loose_line_min_distances,
+ last_spaceable_line_translation, -solution_[spring_idx]);
+ loose_lines.clear ();
+ loose_line_min_distances.clear ();
+ }
+
+ last_spaceable_line = 0;
+ last_spaceable_line_translation = -solution_[spring_idx];
spring_idx++;
}
else
// Position the staves within this system.
Real translation = 0;
- bool found_live_staff = false;
- vector<Grob*> loose_lines;
vector<Real> const& min_offsets = elements_[i].min_offsets;
- vector<Real> loose_line_min_distances;
- Grob *last_spaceable_line = 0;
- Real last_spaceable_line_translation = 0;
- vsize last_live_staff = 0;
+ bool found_spaceable_staff = false;
for (vsize staff_idx = 0; staff_idx < elements_[i].staves.size (); ++staff_idx)
{
Grob *staff = elements_[i].staves[staff_idx];
+ staff->set_property ("system-Y-offset", scm_from_double (-system_position));
- // Dead VerticalAxisGroups didn't participate in the
- // rod-and-spring problem, but they still need to be
- // translated. We translate them by the same amount as
- // the VerticalAxisGroup directly before. (but we don't
- // increment spring_idx!)
- if (is_spaceable (staff) || !staff->is_live ())
+ if (is_spaceable (staff))
{
- if (staff->is_live ())
+ // this is relative to the system: negative numbers are down.
+ translation = system_position - solution_[spring_idx];
+ spring_idx++;
+
+ // Lay out any non-spaceable lines between this line and
+ // the last one.
+ if (loose_lines.size ())
{
- // this is relative to the system: negative numbers are down.
- translation = system_position - solution_[spring_idx];
- found_live_staff = true;
- spring_idx++;
-
- // Lay out any non-spaceable lines between this line and
- // the last one.
- if (loose_lines.size ())
- {
- loose_line_min_distances.push_back (min_offsets[last_live_staff] - min_offsets[staff_idx]);
- distribute_loose_lines (last_spaceable_line, last_spaceable_line_translation,
- loose_lines, loose_line_min_distances,
- staff, translation);
- loose_lines.clear ();
- loose_line_min_distances.clear ();
- }
- last_spaceable_line = staff;
- last_spaceable_line_translation = translation;
- last_live_staff = staff_idx;
+ loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
+ loose_lines.push_back (staff);
+
+ distribute_loose_lines (loose_lines, loose_line_min_distances,
+ last_spaceable_line_translation, translation - system_position);
+ loose_lines.clear ();
+ loose_line_min_distances.clear ();
}
+ last_spaceable_line = staff;
+ // Negative is down but the translation is relative to the whole page.
+ last_spaceable_line_translation = -system_position + translation;
staff->translate_axis (translation, Y_AXIS);
+ found_spaceable_staff = true;
}
- // We only need to deal with loose lines if we've
- // already found a live staff (because any loose lines
- // that occur before our first live staff are treated as
- // spaced lines anyway).
- else if (found_live_staff)
+ else
{
+ if (loose_lines.empty ())
+ loose_lines.push_back (last_spaceable_line);
+
loose_lines.push_back (staff);
- loose_line_min_distances.push_back (min_offsets[last_live_staff] - min_offsets[staff_idx]);
- last_live_staff = staff_idx;
+ if (staff_idx)
+ loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
+ else
+ {
+ Real min_dist = 0;
+ if (last_spaceable_line)
+ min_dist = Axis_group_interface::minimum_distance (last_spaceable_line,
+ staff,
+ Y_AXIS);
+ else // distance to the top margin
+ min_dist = header_padding_ + header_height_ + staff->extent (staff, Y_AXIS)[UP];
+
+ loose_line_min_distances.push_back (min_dist);
+ }
}
}
// Corner case: even if a system has no live staves, it still takes up
// one spring (a system with one live staff also takes up one spring),
// which we need to increment past.
- if (!found_live_staff)
+ if (!found_spaceable_staff)
spring_idx++;
*tail = scm_cons (scm_from_double (system_position), SCM_EOL);
}
}
+ if (loose_lines.size ())
+ {
+ Grob *last = loose_lines.back ();
+ Interval last_ext = last->extent (last, Y_AXIS);
+ loose_line_min_distances.push_back (-last_ext[DOWN] + footer_height_ + footer_padding_);
+ loose_lines.push_back (0);
+
+ distribute_loose_lines (loose_lines, loose_line_min_distances,
+ last_spaceable_line_translation, -page_height_);
+
+ }
+
assert (spring_idx == solution_.size () - 1);
return system_offsets;
}
-// Given two lines that are already spaced (line_before and line_after), distribute
-// some unspaced lines between them. If line_before is null, the unspaced lines
-// will be packed as closely as possible to line_after. If line_after is null, the
-// unspaced lines will be packed as closely as possible to line_before. If both are
-// null, the first loose_line will be translated to before_offset and the rest
-// of the loose_lines will be packed as closely as possible to it.
-//
-// min_distances has one more element than loose_lines; the first element of
-// min_distances contains the minimum skyline distance between line_before
-// and loose_lines[0].
+// Given two lines that are already spaced (the first and last
+// elements of loose_lines), distribute some unspaced lines between
+// them.
void
-Page_layout_problem::distribute_loose_lines (Grob *line_before, Real before_offset,
- vector<Grob*> const &loose_lines,
+Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
vector<Real> const &min_distances,
- Grob *line_after, Real after_offset)
+ Real first_translation, Real last_translation)
{
- vector<Real> offsets;
- assert (line_before && line_after);
-
Simple_spacer spacer;
- Direction last_affinity = UP;
- for (vsize i = 0; i < loose_lines.size (); ++i)
+ for (vsize i = 0; i + 1 < loose_lines.size (); ++i)
{
- Direction affinity = robust_scm2dir (loose_lines[i]->get_property ("staff-affinity"), CENTER);
- if (affinity > last_affinity)
- {
- warning (_ ("staff-affinities should only decrease"));
- affinity = last_affinity;
- }
-
- SCM staff_spec = loose_lines[i]->get_property ("inter-staff-spacing");
- SCM loose_spec = loose_lines[i]->get_property ("inter-loose-line-spacing");
- SCM spec = loose_spec;
- if ((i == 0 && affinity == UP)
- || (i + 1 == loose_lines.size () && affinity != UP))
- spec = staff_spec;
-
+ SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1]);
Spring spring (1.0, 0.0);
alter_spring_from_spacing_spec (spec, &spring);
+ spring.ensure_min_distance (min_distances[i]);
- if (affinity != last_affinity)
+ if ((spec == SCM_BOOL_F && loose_lines[0] && loose_lines.back ())
+ || !loose_lines[i]
+ || !loose_lines[i+1])
{
- if (affinity == CENTER)
- {
- Spring up_spring (1.0, 0.0);
- SCM up_spec = (i == 0) ? staff_spec : loose_spec;
- alter_spring_from_spacing_spec (up_spec, &up_spring);
- up_spring.ensure_min_distance (min_distances[i]);
-
- spacer.add_spring (up_spring);
- }
- else if (affinity == DOWN && last_affinity == UP)
- {
- // Insert a very flexible spring, so it doesn't mess things up too much.
- Spring extra_spr (1.0, min_distances[i]);
- extra_spr.set_inverse_stretch_strength (100000);
- extra_spr.set_inverse_compress_strength (100000);
- spacer.add_spring (extra_spr);
- }
+ // Insert a very flexible spring, so it doesn't have much effect.
+ // TODO: set a default distance and a compress strength so that a
+ // lyrics line, for example, will stay closer to the top staff
+ // even in a compressed configuration.
+ spring.set_inverse_stretch_strength (100000);
+ spring.set_inverse_compress_strength (100000);
}
- if (affinity == UP)
- spring.ensure_min_distance (min_distances[i]);
- else
- spring.ensure_min_distance (min_distances[i+1]);
spacer.add_spring (spring);
- last_affinity = affinity;
- }
-
- if (last_affinity == UP)
- {
- Spring extra_spr (1.0, min_distances.back ());
- extra_spr.set_inverse_stretch_strength (100000);
- extra_spr.set_inverse_compress_strength (100000);
- spacer.add_spring (extra_spr);
}
// Remember: offsets are decreasing, since we're going from UP to DOWN!
- spacer.solve (before_offset - after_offset, false);
+ spacer.solve (first_translation - last_translation, false);
vector<Real> solution = spacer.spring_positions ();
for (vsize i = 1; i + 1 < solution.size (); ++i)
- offsets.push_back (before_offset - solution[i]);
-
- assert (offsets.size () == loose_lines.size ());
- for (vsize i = 0; i < offsets.size (); ++i)
- loose_lines[i]->translate_axis (offsets[i], Y_AXIS);
+ {
+ Real system_offset = scm_to_double (loose_lines[i]->get_property ("system-Y-offset"));
+ loose_lines[i]->translate_axis (first_translation - solution[i] - system_offset, Y_AXIS);
+ }
}
SCM
assert (staves.size () == minimum_translations.size ());
Real first_translation = minimum_translations[0];
- Real last_dy = 0;
+ Real last_spaceable_dy = 0;
+ Real first_spaceable_dy = 0;
+ bool found_spaceable_staff = false;
for (vsize i = 0; i < staves.size (); ++i)
{
down->raise (-dy);
down->merge ((*sky)[DOWN]);
down->raise (dy);
-
- last_dy = dy;
+ }
+ if (is_spaceable (staves[i]))
+ {
+ if (!found_spaceable_staff)
+ {
+ found_spaceable_staff = true;
+ first_spaceable_dy = dy;
+ }
+ last_spaceable_dy = dy;
}
}
+ // Leave the up skyline at a position relative
+ // to the top spaceable staff.
+ up->raise (-first_spaceable_dy);
+
// Leave the down skyline at a position
- // relative to the bottom staff.
- down->raise (-last_dy);
+ // relative to the bottom spaceable staff.
+ down->raise (-last_spaceable_dy);
}
Interval
return false;
}
+// Returns the spacing spec connecting BEFORE to AFTER. A return
+// value of SCM_BOOL_F means that there should be no spring (in
+// practice, this means that we use a very flexible spring).
+SCM
+Page_layout_problem::get_spacing_spec (Grob *before, Grob *after)
+{
+ if (!before || !after)
+ return SCM_BOOL_F;
+
+ if (is_spaceable (before))
+ {
+ if (is_spaceable (after))
+ return before->get_property ("next-staff-spacing");
+ else
+ {
+ Direction affinity = to_dir (after->get_property ("staff-affinity"));
+ return (affinity == DOWN) ? SCM_BOOL_F : after->get_property ("inter-staff-spacing");
+ }
+ }
+ else
+ {
+ if (is_spaceable (after))
+ {
+ Direction affinity = to_dir (before->get_property ("staff-affinity"));
+ return (affinity == UP) ? SCM_BOOL_F : before->get_property ("inter-staff-spacing");
+ }
+ else
+ {
+ Direction before_affinity = to_dir (before->get_property ("staff-affinity"));
+ Direction after_affinity = to_dir (after->get_property ("staff-affinity"));
+ if (after_affinity > before_affinity)
+ {
+ warning (_ ("staff-affinities should only decrease"));
+ after_affinity = before_affinity;
+ }
+ if (before_affinity != UP)
+ return before->get_property ("inter-loose-line-spacing");
+ else if (after_affinity != DOWN)
+ return before->get_property ("inter-loose-line-spacing");
+ }
+ }
+ return SCM_BOOL_F;
+}
+
void
Page_layout_problem::alter_spring_from_spacing_spec (SCM spec, Spring* spring)
{
spring->set_inverse_compress_strength (stretch);
}
}
+
+vector<Grob*>
+Page_layout_problem::filter_dead_elements (vector<Grob*> const& input)
+{
+ vector<Grob*> output;
+ for (vsize i = 0; i < input.size (); ++i)
+ {
+ if (Hara_kiri_group_spanner::has_interface (input[i]))
+ Hara_kiri_group_spanner::consider_suicide (input[i]);
+
+ if (input[i]->is_live ())
+ output.push_back (input[i]);
+ }
+
+ return output;
+}