/*
This file is part of LilyPond, the GNU music typesetter.
- Copyright (C) 2009--2010 Joe Neeman <joeneeman@gmail.com>
+ Copyright (C) 2009--2011 Joe Neeman <joeneeman@gmail.com>
LilyPond is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include "output-def.hh"
#include "paper-book.hh"
#include "paper-column.hh"
+#include "paper-score.hh"
#include "pointer-group-interface.hh"
#include "prob.hh"
#include "skyline-pair.hh"
#include "system.hh"
+#include "text-interface.hh"
+
+/*
+ Returns a stencil for the footnote of each system. This stencil may
+ itself be comprised of several footnotes.
+*/
+
+SCM
+Page_layout_problem::get_footnotes_from_lines (SCM lines, Real padding)
+{
+ SCM footnotes = SCM_EOL;
+ // ugh...code dup from the Page_layout_problem constructor
+ for (SCM s = lines; scm_is_pair (s); s = scm_cdr (s))
+ {
+ if (Grob *g = unsmob_grob (scm_car (s)))
+ {
+ System *sys = dynamic_cast<System *> (g);
+ if (!sys)
+ {
+ programming_error ("got a grob for footnotes that wasn't a System");
+ continue;
+ }
+ footnotes = scm_cons (sys->make_footnote_stencil (padding).smobbed_copy (), footnotes);
+ }
+ else if (Prob *p = unsmob_prob (scm_car (s)))
+ {
+ SCM stencils = p->get_property ("footnotes");
+ if (stencils == SCM_EOL)
+ continue;
+ Stencil footnote_stencil;
+
+ for (SCM st = stencils; scm_is_pair (st); st = scm_cdr (st))
+ footnote_stencil.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (scm_car (st)), padding);
+ footnotes = scm_cons (footnote_stencil.smobbed_copy (), footnotes);
+ }
+ }
+
+ if (!scm_is_pair (footnotes))
+ return SCM_EOL;
+
+ return scm_reverse (footnotes);
+}
+
+Stencil*
+Page_layout_problem::get_footnote_separator_stencil (Output_def *paper)
+{
+ SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
+ paper->self_scm ());
+
+ SCM markup = paper->c_variable ("footnote-separator-markup");
+
+ if (!Text_interface::is_markup (markup))
+ return NULL;
+
+ SCM footnote_stencil = Text_interface::interpret_markup (paper->self_scm (),
+ props, markup);
+
+ Stencil *footnote_separator = unsmob_stencil (footnote_stencil);
+
+ return footnote_separator;
+}
+
+void
+Page_layout_problem::add_footnotes_to_footer (SCM footnotes, Stencil *foot, Paper_book *pb)
+{
+ bool footnotes_found = false;
+ Real footnote_padding = robust_scm2double (pb->paper_->c_variable ("footnote-padding"), 0.0);
+ Real footnote_footer_padding = robust_scm2double (pb->paper_->c_variable ("footnote-footer-padding"), 0.0);
+
+ footnotes = scm_reverse (footnotes);
+
+ for (SCM s = footnotes; scm_is_pair (s); s = scm_cdr (s))
+ {
+ Stencil *stencil = unsmob_stencil (scm_car (s));
+
+ if (!stencil)
+ continue;
+
+ if (!stencil->is_empty ())
+ {
+ foot->add_at_edge (Y_AXIS, UP, *stencil, (!footnotes_found ? footnote_footer_padding : footnote_padding));
+ footnotes_found = true;
+ }
+ }
+
+ if (footnotes_found)
+ {
+ Stencil *separator = get_footnote_separator_stencil (pb->paper_);
+ if (separator)
+ foot->add_at_edge (Y_AXIS, UP, *separator, footnote_padding);
+ }
+}
Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM systems)
: bottom_skyline_ (DOWN)
{
Stencil *head = unsmob_stencil (page->get_property ("head-stencil"));
Stencil *foot = unsmob_stencil (page->get_property ("foot-stencil"));
-
+
+ Real footnote_padding = 0.0;
+ if (pb && pb->paper_)
+ footnote_padding = robust_scm2double (pb->paper_->c_variable ("footnote-padding"), 0.0);
+ SCM footnotes = get_footnotes_from_lines (systems, footnote_padding);
+ add_footnotes_to_footer (footnotes, foot, pb);
+
header_height_ = head ? head->extent (Y_AXIS).length () : 0;
footer_height_ = foot ? foot->extent (Y_AXIS).length () : 0;
page_height_ = robust_scm2double (page->get_property ("paper-height"), 100);
// below the top of the printable area.
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;
+ SCM system_system_spacing = SCM_EOL;
+ SCM score_system_spacing = SCM_EOL;
+ SCM markup_system_spacing = SCM_EOL;
+ SCM score_markup_spacing = SCM_EOL;
+ SCM markup_markup_spacing = SCM_EOL;
// 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 bottom_system_spacing.
+ // top of the page. Similarly for last_bottom_spacing.
SCM top_system_spacing = SCM_EOL;
- SCM bottom_system_spacing = SCM_EOL;
+ SCM last_bottom_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");
- bottom_system_spacing = paper->c_variable ("bottom-system-spacing");
+ system_system_spacing = paper->c_variable ("system-system-spacing");
+ score_system_spacing = paper->c_variable ("score-system-spacing");
+ markup_system_spacing = paper->c_variable ("markup-system-spacing");
+ score_markup_spacing = paper->c_variable ("score-markup-spacing");
+ markup_markup_spacing = paper->c_variable ("markup-markup-spacing");
+ last_bottom_spacing = paper->c_variable ("last-bottom-spacing");
top_system_spacing = paper->c_variable ("top-system-spacing");
if (scm_is_pair (systems) && unsmob_prob (scm_car (systems)))
- top_system_spacing = paper->c_variable ("top-title-spacing");
+ top_system_spacing = paper->c_variable ("top-markup-spacing");
// Note: the page height here does _not_ reserve space for headers and
// footers. This is because we want to anchor the top-system-spacing
+ 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"));
+ read_spacing_spec (last_bottom_spacing, &footer_padding_, ly_symbol2scm ("padding"));
}
bool last_system_was_title = false;
continue;
}
- SCM spec = between_system_spacing;
+ SCM spec = system_system_spacing;
if (first)
spec = top_system_spacing;
else if (last_system_was_title)
- spec = after_title_spacing;
+ spec = markup_system_spacing;
else if (0 == Paper_column::get_rank (sys->get_bound (LEFT)))
- spec = between_scores_system_spacing;
+ spec = score_system_spacing;
Spring spring (0, 0);
Real padding = 0.0;
+ Real indent = line_dimensions_int (sys->paper_score ()->layout (), sys->get_rank ())[LEFT];
alter_spring_from_spacing_spec (spec, &spring);
read_spacing_spec (spec, &padding, ly_symbol2scm ("padding"));
- append_system (sys, spring, padding);
+ append_system (sys, spring, indent, padding);
last_system_was_title = false;
}
else if (Prob *p = unsmob_prob (scm_car (s)))
{
SCM spec = first ? top_system_spacing
- : (last_system_was_title ? between_title_spacing : before_title_spacing);
+ : (last_system_was_title ? markup_markup_spacing : score_markup_spacing);
Spring spring (0, 0);
Real padding = 0.0;
alter_spring_from_spacing_spec (spec, &spring);
Spring last_spring (0, 0);
Real last_padding = 0;
- alter_spring_from_spacing_spec (bottom_system_spacing, &last_spring);
- read_spacing_spec (bottom_system_spacing, &last_padding, ly_symbol2scm ("padding"));
+ alter_spring_from_spacing_spec (last_bottom_spacing, &last_spring);
+ read_spacing_spec (last_bottom_spacing, &last_padding, ly_symbol2scm ("padding"));
last_spring.ensure_min_distance (last_padding - bottom_skyline_.max_height () + footer_height_);
springs_.push_back (last_spring);
{
Real bottom_padding = 0;
- // TODO: junk bottom-space now that we have bottom-system-spacing?
+ // TODO: junk bottom-space now that we have last-bottom-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)
}
void
-Page_layout_problem::append_system (System *sys, Spring const& spring, Real padding)
+Page_layout_problem::append_system (System *sys, Spring const& spring, Real indent, Real padding)
{
Grob *align = sys->get_vertical_alignment ();
if (!align)
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);
+ vector<Real> minimum_offsets = Align_interface::get_minimum_translations_without_min_dist (align, elts, Y_AXIS);
+ vector<Real> minimum_offsets_with_min_dist = Align_interface::get_minimum_translations (align, elts, Y_AXIS);
Skyline up_skyline (UP);
Skyline down_skyline (DOWN);
- build_system_skyline (elts, minimum_offsets, &up_skyline, &down_skyline);
-
- Real minimum_distance = up_skyline.distance (bottom_skyline_) + padding;
+ build_system_skyline (elts, minimum_offsets_with_min_dist, &up_skyline, &down_skyline);
+ up_skyline.shift (indent);
+ down_skyline.shift (indent);
+
+ /*
+ We need to call distance with skyline-horizontal-padding because
+ the system skyline-horizontal-padding is not added during the creation
+ of an individual staff. So we add the padding for the distance check
+ at the time of adding in the system.
+ */
+ Real minimum_distance = up_skyline.distance (bottom_skyline_, robust_scm2double (sys->get_property ("skyline-horizontal-padding"), 0)) + padding;
Spring spring_copy = spring;
spring_copy.ensure_min_distance (minimum_distance);
springs_.push_back (spring_copy);
bottom_skyline_ = down_skyline;
- elements_.push_back (Element (elts, minimum_offsets));
+ elements_.push_back (Element (elts, minimum_offsets, padding));
// Add the springs for the VerticalAxisGroups in this system.
}
Spring spring (0.5, 0.0);
- SCM spec = elts[last_spaceable_staff]->get_property ("next-staff-spacing");
+ SCM spec = elts[last_spaceable_staff]->get_property ("staff-staff-spacing");
alter_spring_from_spacing_spec (spec, &spring);
springs_.push_back (spring);
- Real min_distance = (found_spaceable_staff ? minimum_offsets[last_spaceable_staff] : 0) - minimum_offsets[i];
+ Real min_distance = (found_spaceable_staff ? minimum_offsets_with_min_dist[last_spaceable_staff] : 0) - minimum_offsets_with_min_dist[i];
springs_.back ().ensure_min_distance (min_distance);
if (scm_is_pair (manual_dists))
spring_copy.ensure_min_distance (minimum_distance + padding);
springs_.push_back (spring_copy);
- elements_.push_back (Element (prob));
+ elements_.push_back (Element (prob, padding));
}
void
solution_ = spacer.spring_positions ();
if (!spacer.fits ())
- warning (_ ("couldn't fit music on page"));
+ {
+ Real overflow = spacer.configuration_length (spacer.force ())
+ - page_height_;
+ if (ragged && overflow < 1e-6)
+ warning (_ ("cannot fit music on page: ragged-spacing was requested, but page was compressed"));
+ else
+ {
+ warning (_f ("cannot fit music on page: overflow is %f",
+ overflow));
+ warning (_ ("compressing music to fit"));
+ vsize space_count = solution_.size ();
+ Real spacing_increment = overflow / (space_count - 2);
+ for (vsize i = 2; i < space_count; i++)
+ solution_[i] -= (i-1) * spacing_increment;
+ }
+ }
}
// The solution_ vector stores the position of every live VerticalAxisGroup
vector<Real> loose_line_min_distances;
Grob *last_spaceable_line = 0;
Real last_spaceable_line_translation = 0;
+ Interval last_title_extent;
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);
+ Interval prob_extent = unsmob_stencil (elements_[i].prob->get_property ("stencil"))->extent (Y_AXIS);
// 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
+ Real min_distance = (-loose_extent[DOWN] + prob_extent[UP]
+ + elements_[i].padding);
loose_line_min_distances.push_back (min_distance);
loose_lines.push_back (0);
last_spaceable_line = 0;
last_spaceable_line_translation = -solution_[spring_idx];
+ last_title_extent = prob_extent;
spring_idx++;
}
else
// the last one.
if (loose_lines.size ())
{
- loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
+ if (staff_idx)
+ loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
+ else
+ loose_line_min_distances.push_back (elements_[i].padding - min_offsets[staff_idx]);
loose_lines.push_back (staff);
distribute_loose_lines (loose_lines, loose_line_min_distances,
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;
+ last_spaceable_line_translation = -solution_[spring_idx - 1];
staff->translate_axis (translation, Y_AXIS);
found_spaceable_staff = true;
loose_lines.push_back (last_spaceable_line);
if (staff_idx)
+ // NOTE: the way we do distances between loose lines (and other lines too, actually)
+ // is not the most accurate way possible: we only insert rods between adjacent
+ // lines. To be more accurate, we could insert rods between non-adjacent lines
+ // using a scheme similar to the one in set_column_rods.
loose_line_min_distances.push_back (min_offsets[staff_idx-1] - min_offsets[staff_idx]);
else
- {
+ { // this is the first line in a system
Real min_dist = 0;
if (loose_lines.back ())
- min_dist = Axis_group_interface::minimum_distance (loose_lines.back (),
- staff,
- Y_AXIS);
+ // distance to the final line in the preceding system,
+ // including 'system-system-spacing 'padding
+ min_dist = (Axis_group_interface::minimum_distance (loose_lines.back (),
+ staff,
+ Y_AXIS)
+ + elements_[i].padding);
+ else if (!last_title_extent.is_empty ())
+ // distance to the preceding title,
+ // including 'markup-system-spacing 'padding
+ min_dist = (staff->extent (staff, Y_AXIS)[UP] - last_title_extent[DOWN]
+ + elements_[i].padding);
else // distance to the top margin
min_dist = header_padding_ + header_height_ + staff->extent (staff, Y_AXIS)[UP];
Simple_spacer spacer;
for (vsize i = 0; i + 1 < loose_lines.size (); ++i)
{
- SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1]);
+ SCM spec = get_spacing_spec (loose_lines[i], loose_lines[i+1], false, 0, INT_MAX);
Spring spring (1.0, 0.0);
alter_spring_from_spacing_spec (spec, &spring);
spring.ensure_min_distance (min_distances[i]);
return false;
}
+// If there is a forced, fixed spacing between BEFORE and AFTER, return it.
+// Otherwise, return -infinity_f.
+// If after is spaceable, it is the (spaceable_index + 1)th spaceable grob in
+// its alignment.
+Real
+Page_layout_problem::get_fixed_spacing (Grob *before, Grob *after, int spaceable_index, bool pure, int start, int end)
+{
+ Spanner *after_sp = dynamic_cast<Spanner*> (after);
+ SCM cache_symbol = (is_spaceable (before) && is_spaceable (after))
+ ? ly_symbol2scm ("spaceable-fixed-spacing")
+ : ly_symbol2scm ("loose-fixed-spacing");
+ if (pure)
+ {
+ // The result of this function doesn't depend on "end," so we can reduce the
+ // size of the cache by ignoring it.
+ SCM cached = after_sp->get_cached_pure_property (cache_symbol, start, 0);
+ if (scm_is_number (cached))
+ return robust_scm2double (cached, 0.0);
+ }
+
+ SCM spec = Page_layout_problem::get_spacing_spec (before, after, pure, start, end);
+ Real ret = -infinity_f;
+ Real stretchability = 0;
+ if (Page_layout_problem::read_spacing_spec (spec, &stretchability, ly_symbol2scm ("stretchability"))
+ && stretchability == 0)
+ Page_layout_problem::read_spacing_spec (spec, &ret, ly_symbol2scm ("basic-distance"));
+
+ // If we're pure, then paper-columns have not had their systems set,
+ // and so elts[i]->get_system () is unreliable.
+ System *sys = pure ? Grob::get_system (before) : before->get_system ();
+ Grob *left_bound = sys ? sys->get_maybe_pure_bound (LEFT, pure, start, end) : 0;
+
+ if (is_spaceable (before) && is_spaceable (after) && left_bound)
+ {
+ SCM details = left_bound->get_property ("line-break-system-details");
+ SCM manual_dists = ly_assoc_get (ly_symbol2scm ("alignment-distances"), details, SCM_EOL);
+ if (scm_is_pair (manual_dists))
+ {
+ SCM forced = robust_list_ref (spaceable_index - 1, manual_dists);
+ if (scm_is_number (forced))
+ ret = max (ret, scm_to_double (forced));
+ }
+ }
+
+ // Cache the result. As above, we ignore "end."
+ if (pure)
+ after_sp->cache_pure_property (cache_symbol, start, 0, scm_from_double (ret));
+
+ return ret;
+}
+
static SCM
add_stretchability (SCM alist, Real stretch)
{
// Returns the spacing spec connecting BEFORE to AFTER.
SCM
-Page_layout_problem::get_spacing_spec (Grob *before, Grob *after)
+Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int start, int end)
{
// If there are no spacing wishes, return a very flexible spring.
// This will occur, for example, if there are lyrics at the bottom of
if (is_spaceable (before))
{
if (is_spaceable (after))
- return before->get_property ("next-staff-spacing");
+ return before->get_maybe_pure_property ("staff-staff-spacing", pure, start, end);
else
{
- Direction affinity = to_dir (after->get_property ("staff-affinity"));
+ Direction affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
return (affinity == DOWN)
- ? add_stretchability (after->get_property ("non-affinity-spacing"), LARGE_STRETCH)
- : after->get_property ("inter-staff-spacing");
+ ? add_stretchability (after->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
+ LARGE_STRETCH)
+ : after->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end);
}
}
else
{
if (is_spaceable (after))
{
- Direction affinity = to_dir (before->get_property ("staff-affinity"));
+ Direction affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
return (affinity == UP)
- ? add_stretchability (before->get_property ("non-affinity-spacing"), LARGE_STRETCH)
- : before->get_property ("inter-staff-spacing");
+ ? add_stretchability (before->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
+ LARGE_STRETCH)
+ : before->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end);
}
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)
+ Direction before_affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end));
+ Direction after_affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end));
+ static bool warned = false;
+ if (after_affinity > before_affinity
+ && !warned && !pure)
{
warning (_ ("staff-affinities should only decrease"));
- after_affinity = before_affinity;
+ warned = true;
}
if (before_affinity != UP)
- return before->get_property ("inter-loose-line-spacing");
+ return before->get_maybe_pure_property ("nonstaff-nonstaff-spacing", pure, start, end);
else if (after_affinity != DOWN)
- return before->get_property ("inter-loose-line-spacing");
- return add_stretchability (before->get_property ("non-affinity-spacing"), LARGE_STRETCH);
+ return before->get_maybe_pure_property ("nonstaff-nonstaff-spacing", pure, start, end);
+ return add_stretchability (before->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end),
+ LARGE_STRETCH);
}
}
Real space;
Real stretch;
Real min_dist;
- if (read_spacing_spec (spec, &space, ly_symbol2scm ("space")))
+ if (read_spacing_spec (spec, &space, ly_symbol2scm ("basic-distance")))
spring->set_distance (space);
if (read_spacing_spec (spec, &min_dist, ly_symbol2scm ("minimum-distance")))
spring->set_min_distance (min_dist);
projects / lilypond.git / blobdiff