]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/page-layout-problem.cc
Fix 1240.
[lilypond.git] / lily / page-layout-problem.cc
index 0fb646a68e57a1253781ebf68d20762fc7bc40e9..7292126ddcf52ee2d3f9030304792824cc36064d 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2009 Joe Neeman <joeneeman@gmail.com>
+  Copyright (C) 2009--2010 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
@@ -57,30 +57,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 +89,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,13 +107,13 @@ 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;
@@ -126,7 +126,7 @@ Page_layout_problem::Page_layout_problem (Paper_book *pb, SCM page_scm, SCM syst
       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 +141,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 +150,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)
@@ -190,7 +190,7 @@ Page_layout_problem::append_system (System *sys, Spring const& spring, Real padd
 
   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,
+  vector<Real> minimum_offsets = Align_interface::get_minimum_translations (align, elts, Y_AXIS, false,
                                                                            false, 0, 0);
 
   Skyline up_skyline (UP);
@@ -303,6 +303,10 @@ Page_layout_problem::solve_rod_spring_problem (bool ragged)
 
   spacer.solve (page_height_, ragged);
   solution_ = spacer.spring_positions ();
+
+  if (!spacer.fits ())
+    warning (_f ("couldn't fit music on page: overflow is %f",
+                spacer.configuration_length(spacer.force()) - page_height_));
 }
 
 // The solution_ vector stores the position of every live VerticalAxisGroup
@@ -322,19 +326,20 @@ Page_layout_problem::find_system_offsets ()
   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
 
              loose_line_min_distances.push_back (min_distance);
@@ -348,6 +353,7 @@ Page_layout_problem::find_system_offsets ()
 
          last_spaceable_line = 0;
          last_spaceable_line_translation = -solution_[spring_idx];
+         last_title_extent = prob_extent;
          spring_idx++;
        }
       else
@@ -414,6 +420,12 @@ Page_layout_problem::find_system_offsets ()
                        min_dist = Axis_group_interface::minimum_distance (loose_lines.back (),
                                                                           staff,
                                                                           Y_AXIS);
+                     else if (!last_title_extent.is_empty ())
+                       { // distance to the preceding title
+                         // TODO: add options for controlling the space between a loose line
+                         // and a title/markup preceding it.
+                         min_dist = staff->extent (staff, Y_AXIS)[UP] - last_title_extent[DOWN];
+                       }
                      else // distance to the top margin
                        min_dist = header_padding_ + header_height_ + staff->extent (staff, Y_AXIS)[UP];
 
@@ -453,6 +465,7 @@ Page_layout_problem::find_system_offsets ()
 // Given two lines that are already spaced (the first and last
 // elements of loose_lines), distribute some unspaced lines between
 // them.
+// first_translation and last_translation are relative to the page.
 void
 Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
                                             vector<Real> const &min_distances,
@@ -461,7 +474,7 @@ Page_layout_problem::distribute_loose_lines (vector<Grob*> const &loose_lines,
   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]);
@@ -614,6 +627,39 @@ 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)
+{
+  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 ("space"));
+
+  // 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));
+       }
+    }
+  return ret;
+}
+
 static SCM
 add_stretchability (SCM alist, Real stretch)
 {
@@ -633,7 +679,7 @@ const double HUGE_STRETCH = 10e7;
 
 // 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
@@ -645,38 +691,41 @@ Page_layout_problem::get_spacing_spec (Grob *before, Grob *after)
   if (is_spaceable (before))
     {
       if (is_spaceable (after))
-       return before->get_property ("next-staff-spacing");
+       return before->get_maybe_pure_property ("next-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 ("non-affinity-spacing", pure, start, end),
+                                 LARGE_STRETCH)
+           : after->get_maybe_pure_property ("inter-staff-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 ("non-affinity-spacing", pure, start, end),
+                                 LARGE_STRETCH)
+           : before->get_maybe_pure_property ("inter-staff-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"));
+         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));
          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");
+           return before->get_maybe_pure_property ("inter-loose-line-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 ("inter-loose-line-spacing", pure, start, end);
+         return add_stretchability (before->get_maybe_pure_property ("non-affinity-spacing", pure, start, end),
+                                    LARGE_STRETCH);
        }
     }