]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/constrained-breaking.cc
Merge branch 'lilypond/translation' of ssh://jomand@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / constrained-breaking.cc
index 33426c0b3f3b0ca5bcd24bd5f38263431b9013fe..98722c53db4d1fc9f4a11b26423512e470cbabd3 100644 (file)
@@ -4,7 +4,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2006--2007 Joe Neeman <joeneeman@gmail.com>
+  (c) 2006--2009 Joe Neeman <joeneeman@gmail.com>
 */
 
 #include "constrained-breaking.hh"
@@ -12,6 +12,7 @@
 #include "international.hh"
 #include "main.hh"
 #include "output-def.hh"
+#include "page-layout-problem.hh"
 #include "paper-column.hh"
 #include "paper-score.hh"
 #include "simple-spacer.hh"
 #include "warn.hh"
 
 /*
-  We use the following optimal substructure. Let W(A) be our weight function.
+  We use the following optimal substructure. Let W (A) be our weight function.
 
-  Let A_{k,n} = (a_{k,n,1}, ... a_{k,n,k}) be the optimal set of line breaks
-  for k systems and n potential breakpoints. a_{k,n,k} = n (it is the end of
+  Let A_{k, n} = (a_{k, n, 1}, ... a_{k, n, k}) be the optimal set of line breaks
+  for k systems and n potential breakpoints. a_{k, n, k} = n (it is the end of
   the piece)
 
   Then A_{k+1, m} is contructed from
-  min_ {k < j < m} ( W(A_{k,j} :: m) )
+  min_ {k < j < m} ( W (A_{k, j} :: m) )
   where by A::m we denote appending m to the list A
 
   Indices in the code:
 
   The above algorithm makes it easy to end at a point before the end of the
-  score (just find A_{k,m} for some m < breaks_.size () - 1). However, we must
+  score (just find A_{k, m} for some m < breaks_.size () - 1). However, we must
   add information for starting at a point after the beginning. One constructor
   allows the specification of a list of starting columns, start_. We then have
   start_.size () different solution arrays. state_[i] is the array for the
        .         .         .     .
        .         .         .       .
   where the X's mark invalid solutions (can't have more systems than
-  breakpoints). Note that each value is of the form a_{x,n,x}. This is because
-  a breakpoint of the form a_{x,n,x-1} will also be called a_{x-1,m,x-1} for
+  breakpoints). Note that each value is of the form a_{x, n, x}. This is because
+  a breakpoint of the form a_{x, n, x-1} will also be called a_{x-1, m, x-1} for
   some m < n. Each cell in the array stores the value of its m (ie. the
   ending breakpoint of the previous line) as "prev_".
 
-  For finding A_{sys, brk}, let "me" be the (sys_count,brk) cell in our
+  For finding A_{sys, brk}, let "me" be the (sys_count, brk) cell in our
   solution array (state_[start][sys * rank + brk]).
 
   Then A_{sys, brk} = A_{sys - 1, me.prev_} :: me
@@ -109,6 +110,7 @@ Constrained_breaking::calc_subproblem (vsize start, vsize sys, vsize brk)
   return found_something;
 }
 
+
 Column_x_positions
 Constrained_breaking::space_line (vsize i, vsize j)
 {
@@ -117,11 +119,20 @@ Constrained_breaking::space_line (vsize i, vsize j)
   Column_x_positions col;
 
   vector<Grob*> line (all_.begin () + breaks_[i],
-                     all_.begin() + breaks_[j] + 1);
+                     all_.begin () + breaks_[j] + 1);
   Interval line_dims = line_dimensions_int (pscore_->layout (), i);
   bool last = j == breaks_.size () - 1;
   bool ragged = ragged_right || (last && ragged_last);
 
+  /* As a special case, if there is only one line in the score and ragged-right
+     hasn't been specifically forbidden and the line is stretched, use
+     ragged spacing. */
+  if (last && i == 0
+      && lines_.at (i, j).force_ >= 0
+      && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-right"))
+      && !scm_is_bool (pscore_->layout ()->c_variable ("ragged-last")))
+    ragged = true;
+
   return get_line_configuration (line, line_dims[RIGHT] - line_dims[LEFT], line_dims[LEFT], ragged);
 }
 
@@ -188,7 +199,7 @@ Constrained_breaking::solve (vsize start, vsize end, vsize sys_count)
 vector<Column_x_positions>
 Constrained_breaking::best_solution (vsize start, vsize end)
 {
-  vsize min_systems =  min_system_count (start, end);
+  vsize min_systems = min_system_count (start, end);
   vsize max_systems = max_system_count (start, end);
   Real best_demerits = infinity_f;
   vector<Column_x_positions> best_so_far;
@@ -264,7 +275,7 @@ Constrained_breaking::min_system_count (vsize start, vsize end)
 int
 Constrained_breaking::max_system_count (vsize start, vsize end)
 {
-  vsize brk = (end >= start_.size ()) ? breaks_.size () : starting_breakpoints_[end];
+  vsize brk = (end >= start_.size ()) ? breaks_.size () - 1 : starting_breakpoints_[end];
   return brk - starting_breakpoints_[start];
 }
 
@@ -300,6 +311,17 @@ Constrained_breaking::Constrained_breaking (Paper_score *ps, vector<vsize> const
   initialize ();
 }
 
+static SCM
+min_permission (SCM perm1, SCM perm2)
+{
+  if (perm1 == ly_symbol2scm ("force"))
+    return perm2;
+  if (perm1 == ly_symbol2scm ("allow")
+     && perm2 != ly_symbol2scm ("force"))
+    return perm2;
+  return SCM_EOL;
+}
+
 /* find the forces for all possible lines and cache ragged_ and ragged_right_ */
 void
 Constrained_breaking::initialize ()
@@ -312,11 +334,15 @@ Constrained_breaking::initialize ()
       
   Output_def *l = pscore_->layout ();
   System *sys = pscore_->root_system ();
-  Real space = robust_scm2double (l->c_variable ("ideal-system-space"), 0);
-  SCM padding_scm = l->c_variable ("page-breaking-between-system-padding");
-  if (!scm_is_number (padding_scm))
-    padding_scm = l->c_variable ("between-system-padding");
-  Real padding = robust_scm2double (padding_scm, 0.0);
+
+  // TODO: add support for minimum-distance and stretchability here and
+  // to the page-breaker.
+  SCM spacing_spec = l->c_variable ("between-system-spacing");
+  SCM page_breaking_spacing_spec = l->c_variable ("page-breaking-between-system-spacing");
+  Real space = 0;
+  Real padding = 0;
+  Page_layout_problem::read_spacing_spec (spacing_spec, &padding, ly_symbol2scm ("padding"));
+  Page_layout_problem::read_spacing_spec (page_breaking_spacing_spec, &padding, ly_symbol2scm ("padding"));
 
   Interval first_line = line_dimensions_int (pscore_->layout (), 0);
   Interval other_lines = line_dimensions_int (pscore_->layout (), 1);
@@ -330,7 +356,6 @@ Constrained_breaking::initialize ()
                                         ragged_right_);
   for (vsize i = 0; i + 1 < breaks_.size (); i++)
     {
-      Real max_ext = 0;
       for (vsize j = i + 1; j < breaks_.size (); j++)
        {
          int start = Paper_column::get_rank (all_[breaks_[i]]);
@@ -342,20 +367,36 @@ Constrained_breaking::initialize ()
 
          line.force_ = forces[i*breaks_.size () + j];
          if (ragged && last && !isinf (line.force_))
-           line.force_ = (line.force_ < 0) ? infinity_f : 0;
+           line.force_ = (line.force_ < 0 && j > i + 1) ? infinity_f : 0;
          if (isinf (line.force_))
            break;
 
          Grob *c = all_[breaks_[j]];
+         line.last_column_ = c;
          line.break_penalty_ = robust_scm2double (c->get_property ("line-break-penalty"), 0);
          line.page_penalty_ = robust_scm2double (c->get_property ("page-break-penalty"), 0);
          line.turn_penalty_ = robust_scm2double (c->get_property ("page-turn-penalty"), 0);
          line.break_permission_ = c->get_property ("line-break-permission");
          line.page_permission_ = c->get_property ("page-break-permission");
          line.turn_permission_ = c->get_property ("page-turn-permission");
-
-         max_ext = max (max_ext, extent.length ());
-         line.extent_ = extent;
+         
+         /* turn permission should always be stricter than page permission
+            and page permission should always be stricter than line permission */
+         line.page_permission_ = min_permission (line.break_permission_,
+                                                 line.page_permission_);
+         line.turn_permission_ = min_permission (line.page_permission_,
+                                                 line.turn_permission_);
+
+         // TODO: see the hack regarding begin_of_line and
+         // rest_of_line extents in align-interface.  Perhaps we
+         // should do the same thing here so that the effect extends
+         // between systems as well as within systems.  It isn't as
+         // crucial here, however, because the effect is largest when
+         // dealing with large systems.
+         line.extent_ = (extent.is_empty ()
+                         || isnan (extent[LEFT])
+                         || isnan (extent[RIGHT]))
+           ? Interval (0, 0) : extent;
          line.padding_ = padding;
          line.space_ = space;
          line.inverse_hooke_ = extent.length () + space;