X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fpage-layout-problem.cc;h=636e937a72eab6290433b242a24e992d074f3f0b;hb=ac3dd3ad38528113d97f6a8a7b81751c328f1c36;hp=38a7548f3b785fbdbfd0ad83bea6a910a60a9cd1;hpb=05d8315484c180e02bf9297513bd0c3db1e4615a;p=lilypond.git diff --git a/lily/page-layout-problem.cc b/lily/page-layout-problem.cc index 38a7548f3b..636e937a72 100644 --- a/lily/page-layout-problem.cc +++ b/lily/page-layout-problem.cc @@ -1,7 +1,7 @@ /* This file is part of LilyPond, the GNU music typesetter. - Copyright (C) 2009--2010 Joe Neeman + Copyright (C) 2009--2011 Joe Neeman LilyPond is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -27,10 +27,103 @@ #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 (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) @@ -46,7 +139,13 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst { 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); @@ -57,30 +156,30 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst // 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 @@ -89,7 +188,7 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst + 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; @@ -107,26 +206,27 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst 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); @@ -141,8 +241,8 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst 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); @@ -150,7 +250,7 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst { 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) @@ -180,7 +280,7 @@ Page_layout_problem::set_footer_height (Real height) } 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) @@ -190,14 +290,22 @@ Page_layout_problem::append_system (System *sys, Spring const& spring, Real padd extract_grob_set (align, "elements", all_elts); vector elts = filter_dead_elements (all_elts); - vector minimum_offsets = Align_interface::get_minimum_translations (align, elts, Y_AXIS, - false, 0, 0); + vector minimum_offsets = Align_interface::get_minimum_translations_without_min_dist (align, elts, Y_AXIS); + vector 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); @@ -228,7 +336,7 @@ Page_layout_problem::append_system (System *sys, Spring const& spring, Real padd } 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); @@ -305,7 +413,22 @@ Page_layout_problem::solve_rod_spring_problem (bool ragged) 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 @@ -626,6 +749,57 @@ Page_layout_problem::read_spacing_spec (SCM spec, Real* dest, SCM sym) 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 (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) { @@ -657,14 +831,14 @@ Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int if (is_spaceable (before)) { if (is_spaceable (after)) - return before->get_maybe_pure_property ("next-staff-spacing", pure, start, end); + return before->get_maybe_pure_property ("staff-staff-spacing", pure, start, end); else { Direction affinity = to_dir (after->get_maybe_pure_property ("staff-affinity", pure, start, end)); return (affinity == DOWN) - ? add_stretchability (after->get_maybe_pure_property ("non-affinity-spacing", pure, start, end), + ? add_stretchability (after->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end), LARGE_STRETCH) - : after->get_maybe_pure_property ("inter-staff-spacing", pure, start, end); + : after->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end); } } else @@ -673,9 +847,9 @@ Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int { Direction affinity = to_dir (before->get_maybe_pure_property ("staff-affinity", pure, start, end)); return (affinity == UP) - ? add_stretchability (before->get_maybe_pure_property ("non-affinity-spacing", pure, start, end), + ? add_stretchability (before->get_maybe_pure_property ("nonstaff-unrelatedstaff-spacing", pure, start, end), LARGE_STRETCH) - : before->get_maybe_pure_property ("inter-staff-spacing", pure, start, end); + : before->get_maybe_pure_property ("nonstaff-relatedstaff-spacing", pure, start, end); } else { @@ -687,10 +861,10 @@ Page_layout_problem::get_spacing_spec (Grob *before, Grob *after, bool pure, int after_affinity = before_affinity; } if (before_affinity != UP) - return before->get_maybe_pure_property ("inter-loose-line-spacing", pure, start, end); + return before->get_maybe_pure_property ("nonstaff-nonstaff-spacing", pure, start, end); else if (after_affinity != DOWN) - return before->get_maybe_pure_property ("inter-loose-line-spacing", pure, start, end); - return add_stretchability (before->get_maybe_pure_property ("non-affinity-spacing", pure, start, end), + 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); } } @@ -705,7 +879,7 @@ Page_layout_problem::alter_spring_from_spacing_spec (SCM spec, Spring* spring) 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);