]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-determine-loose-columns.cc
lilypond-manuals.css: edit color scheme and some spacing
[lilypond.git] / lily / spacing-determine-loose-columns.cc
index 7953a3f150bdc6db226b2aa857a147ff4424f4b0..4be23042ad44bbddc007c8879714cd0c201bd35d 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2005--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -47,7 +47,6 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
 {
   if (!to_boolean (col->get_property ("allow-loose-spacing")))
     return false;
-  
 
   if ((options->float_nonmusical_columns_
        || options->float_grace_columns_)
@@ -56,7 +55,6 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
       return true;
     }
 
-  
   if (Paper_column::is_musical (col))
     return false;
 
@@ -82,8 +80,8 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
 
   */
 
-  Item *r_neighbor = unsmob_item (col->get_object ("right-neighbor"));
-  Item *l_neighbor = unsmob_item (col->get_object ("left-neighbor"));
+  Item *r_neighbor = unsmob<Item> (col->get_object ("right-neighbor"));
+  Item *l_neighbor = unsmob<Item> (col->get_object ("left-neighbor"));
 
   if (!l_neighbor || !r_neighbor)
     return false;
@@ -92,7 +90,7 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
      its neighbor (ie. no funny polyphonic stuff), don't make it loose.
   */
   if (l == l_neighbor && r == r_neighbor && col->extent (col, X_AXIS).length () > 0)
-     return false;
+    return false;
 
   /*
     Only declare loose if the bounds make a little sense.  This means
@@ -100,7 +98,7 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
     nicely folded, but hey, then don't do that.
   */
   if (! ((Paper_column::is_musical (l_neighbor) || Paper_column::is_breakable (l_neighbor))
-        && (Paper_column::is_musical (r_neighbor) || Paper_column::is_breakable (r_neighbor))))
+         && (Paper_column::is_musical (r_neighbor) || Paper_column::is_breakable (r_neighbor))))
     return false;
 
   /*
@@ -110,22 +108,23 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
   for (vsize i = elts.size (); i--;)
     {
       Grob *g = elts[i];
-      if (g && Break_alignment_interface::has_interface (g))
-       {
-         extract_grob_set (g, "elements", gelts);
-         for (vsize j = gelts.size (); j--;)
-           {
-             Grob *h = gelts[j];
-
-             if (h && h->get_property ("break-align-symbol") == ly_symbol2scm ("staff-bar"))
-               {
-                 extract_grob_set (h, "elements", helts);
-                 for (vsize k = helts.size (); k--;)
-                   if ("" != robust_scm2string (helts[k]->get_property ("glyph-name"), ""))
-                     return false;
-               }
-           }
-       }
+      if (has_interface<Break_alignment_interface> (g))
+        {
+          extract_grob_set (g, "elements", gelts);
+          for (vsize j = gelts.size (); j--;)
+            {
+              Grob *h = gelts[j];
+
+              if (h && scm_is_eq (h->get_property ("break-align-symbol"),
+                                  ly_symbol2scm ("staff-bar")))
+                {
+                  extract_grob_set (h, "elements", helts);
+                  for (vsize k = helts.size (); k--;)
+                    if ("" != robust_scm2string (helts[k]->get_property ("glyph-name"), ""))
+                      return false;
+                }
+            }
+        }
     }
 
   return true;
@@ -133,55 +132,52 @@ is_loose_column (Grob *l, Grob *col, Grob *r, Spacing_options const *options)
 
 void
 Spacing_spanner::set_distances_for_loose_col (Grob *me, Grob *c,
-                                             Drul_array<Item *> next_door,
-                                             Spacing_options const *options)
+                                              Drul_array<Item *> next_door,
+                                              Spacing_options const *options)
 {
-  Direction d = LEFT;
   Drul_array<Real> dists (0, 0);
 
-  do
+  for (LEFT_and_RIGHT (d))
     {
       Item *lc = dynamic_cast<Item *> ((d == LEFT) ? next_door[LEFT] : c);
       Item *rc = dynamic_cast<Item *> (d == LEFT ? c : next_door[RIGHT]);
 
       extract_grob_set (lc, "spacing-wishes", wishes);
       for (vsize k = wishes.size (); k--;)
-       {
-         Grob *sp = wishes[k];
-         if (Spacing_interface::left_column (sp) != lc
-             || Spacing_interface::right_column (sp) != rc)
-           continue;
-
-         if (Note_spacing::has_interface (sp))
-           {
-             /*
-               The note spacing should be taken from the musical
-               columns.
-             */
-             Real base = note_spacing (me, lc, rc, options);
-             Spring spring = Note_spacing::get_spacing (sp, rc, base, options->increment_);
-
-             dists[d] = max (dists[d], spring.min_distance ());
-           }
-         else if (Staff_spacing::has_interface (sp))
-           {
-             Spring spring = Staff_spacing::get_spacing (sp, rc);
-
-             dists[d] = max (dists[d], spring.min_distance ());
-           }
-         else
-           programming_error ("Subversive spacing wish");
-       }
+        {
+          Grob *sp = wishes[k];
+          if (Spacing_interface::left_column (sp) != lc
+              || Spacing_interface::right_column (sp) != rc)
+            continue;
+
+          if (has_interface<Note_spacing> (sp))
+            {
+              /*
+                The note spacing should be taken from the musical
+                columns.
+              */
+              Spring base = note_spacing (me, lc, rc, options);
+              Spring spring = Note_spacing::get_spacing (sp, rc, base, options->increment_);
+
+              dists[d] = max (dists[d], spring.min_distance ());
+            }
+          else if (has_interface<Staff_spacing> (sp))
+            {
+              Spring spring = Staff_spacing::get_spacing (sp, rc, 0.0);
+
+              dists[d] = max (dists[d], spring.min_distance ());
+            }
+          else
+            programming_error ("Subversive spacing wish");
+        }
     }
-  while (flip (&d) != LEFT);
 
   Rod r;
   r.distance_ = dists[LEFT] + dists[RIGHT];
   r.item_drul_ = next_door;
-  r.add_to_cols (); 
-}
 
+  r.add_to_cols ();
+}
 
 /*
   Remove columns that are not tightly fitting from COLS. In the
@@ -190,60 +186,70 @@ Spacing_spanner::set_distances_for_loose_col (Grob *me, Grob *c,
 */
 void
 Spacing_spanner::prune_loose_columns (Grob *me,
-                                     vector<Grob*> *cols,
-                                     Spacing_options *options)
+                                      vector<Grob *> *cols,
+                                      Spacing_options *options)
 {
-  vector<Grob*> newcols;
-
+  vector<Grob *> newcols;
   for (vsize i = 0; i < cols->size (); i++)
     {
       Grob *c = cols->at (i);
 
       bool loose = (i > 0 && i + 1 < cols->size ())
-       && is_loose_column (cols->at (i - 1), c, cols->at (i + 1), options);
+                   && is_loose_column (cols->at (i - 1), c, cols->at (i + 1), options);
 
       /* Breakable columns never get pruned; even if they are loose,
         their broken pieces are not.  However, we mark them so that
         the spacing can take their mid-line looseness into account. */
       if (loose && Paper_column::is_breakable (c))
-       {
-         loose = false;
-         c->set_property ("maybe-loose", SCM_BOOL_T);
-       }
+        {
+          loose = false;
+          c->set_property ("maybe-loose", SCM_BOOL_T);
+        }
+      /*
+        Unbreakable columns which only contain page-labels also
+        never get pruned, otherwise the labels are lost before they can
+        be collected by the System: so we mark these columns too.
+      */
+      if (!loose && !Paper_column::is_breakable (c)
+          && scm_is_pair (c->get_property ("labels")))
+        {
+          extract_grob_set (c, "elements", elts);
+          if (elts.empty ())
+            c->set_property ("maybe-loose", SCM_BOOL_T);
+        }
 
       if (loose)
-       {
-         Grob *right_neighbor = unsmob_grob (c->get_object ("right-neighbor"));
-         Grob *left_neighbor = unsmob_grob (c->get_object ("left-neighbor"));
-
-         /*
-           Either object can be non existent, if the score ends
-           prematurely.
-         */
-         if (!right_neighbor || !left_neighbor)
-           {
-             c->programming_error ("Cannot determine neighbors for floating column. ");
-             c->set_object ("between-cols", scm_cons (cols->at (i-1)->self_scm (),
-                                                      cols->at (i+1)->self_scm ()));
-           }
-         else
-           {
-             c->set_object ("between-cols", scm_cons (left_neighbor->self_scm (),
-                                                      right_neighbor->self_scm ()));
-
-
-             /*
-               Set distance constraints for loose columns
-             */
-             Drul_array<Item *> next_door (dynamic_cast<Item*> (cols->at (i - 1)),
-                                           dynamic_cast<Item*> (cols->at (i + 1)));
-
-             set_distances_for_loose_col (me, c, next_door, options);
-           }
-       }
-
-      if (!loose)
-       newcols.push_back (c);
+        {
+          Grob *right_neighbor = unsmob<Grob> (c->get_object ("right-neighbor"));
+          Grob *left_neighbor = unsmob<Grob> (c->get_object ("left-neighbor"));
+
+          /*
+            Either object can be non existent, if the score ends
+            prematurely.
+          */
+          if (!right_neighbor || !left_neighbor)
+            {
+              c->programming_error ("Cannot determine neighbors for floating column.");
+              c->set_object ("between-cols", scm_cons (cols->at (i - 1)->self_scm (),
+                                                       cols->at (i + 1)->self_scm ()));
+            }
+          else
+            {
+              c->set_object ("between-cols", scm_cons (left_neighbor->self_scm (),
+                                                       right_neighbor->self_scm ()));
+
+              /*
+                Set distance constraints for loose columns
+              */
+              Drul_array<Item *> next_door (dynamic_cast<Item *> (left_neighbor),
+                                            dynamic_cast<Item *> (right_neighbor));
+
+              set_distances_for_loose_col (me, c, next_door, options);
+            }
+        }
+
+      else
+        newcols.push_back (c);
     }
 
   *cols = newcols;
@@ -253,35 +259,35 @@ Spacing_spanner::prune_loose_columns (Grob *me,
   Set neighboring columns determined by the spacing-wishes grob property.
 */
 void
-Spacing_spanner::set_explicit_neighbor_columns (vector<Grob*> const &cols)
+Spacing_spanner::set_explicit_neighbor_columns (vector<Grob *> const &cols)
 {
   for (vsize i = 0; i < cols.size (); i++)
     {
       extract_grob_set (cols[i], "spacing-wishes", wishes);
       for (vsize j = wishes.size (); j--;)
-       {
-         Item *wish = dynamic_cast<Item*> (wishes[j]);
-         Item *left_col = wish->get_column ();
-         int left_rank = Paper_column::get_rank (left_col);
-         int min_right_rank = INT_MAX;
-
-         extract_grob_set (wish, "right-items", right_items);
-         for (vsize k = right_items.size (); k--;)
-           {
-             Item *right_col = dynamic_cast<Item*> (right_items[k])->get_column ();
-             int right_rank = Paper_column::get_rank (right_col);
-
-             if (right_rank < min_right_rank)
-               {
-                 left_col->set_object ("right-neighbor", right_col->self_scm ());
-                 min_right_rank = right_rank;
-               }
-
-             Grob *old_left_neighbor = unsmob_grob (right_col->get_object ("left-neighbor"));
-             if (!old_left_neighbor || left_rank > Paper_column::get_rank (old_left_neighbor))
-               right_col->set_object ("left-neighbor", left_col->self_scm ());
-           }
-       }
+        {
+          Item *wish = dynamic_cast<Item *> (wishes[j]);
+          Item *left_col = wish->get_column ();
+          int left_rank = Paper_column::get_rank (left_col);
+          int min_right_rank = INT_MAX;
+
+          extract_grob_set (wish, "right-items", right_items);
+          for (vsize k = right_items.size (); k--;)
+            {
+              Item *right_col = dynamic_cast<Item *> (right_items[k])->get_column ();
+              int right_rank = Paper_column::get_rank (right_col);
+
+              if (right_rank < min_right_rank)
+                {
+                  left_col->set_object ("right-neighbor", right_col->self_scm ());
+                  min_right_rank = right_rank;
+                }
+
+              Grob *old_left_neighbor = unsmob<Grob> (right_col->get_object ("left-neighbor"));
+              if (!old_left_neighbor || left_rank > Paper_column::get_rank (old_left_neighbor))
+                right_col->set_object ("left-neighbor", left_col->self_scm ());
+            }
+        }
     }
 }
 
@@ -291,17 +297,17 @@ Spacing_spanner::set_explicit_neighbor_columns (vector<Grob*> const &cols)
   Why only these? --jneem
 */
 void
-Spacing_spanner::set_implicit_neighbor_columns (vector<Grob*> const &cols)
+Spacing_spanner::set_implicit_neighbor_columns (vector<Grob *> const &cols)
 {
   for (vsize i = 0; i < cols.size (); i++)
     {
       Item *it = dynamic_cast<Item *> (cols[i]);
       if (!Paper_column::is_breakable (it) && !Paper_column::is_musical (it))
-       continue;
+        continue;
 
-      if (i && !unsmob_grob (cols[i]->get_object ("left-neighbor")))
-       cols[i]->set_object ("left-neighbor", cols[i-1]->self_scm ());
-      if (i + 1 < cols.size () && !unsmob_grob (cols[i]->get_object ("right-neighbor")))
-       cols[i]->set_object ("right-neighbor", cols[i+1]->self_scm ());
+      if (i && !unsmob<Grob> (cols[i]->get_object ("left-neighbor")))
+        cols[i]->set_object ("left-neighbor", cols[i - 1]->self_scm ());
+      if (i + 1 < cols.size () && !unsmob<Grob> (cols[i]->get_object ("right-neighbor")))
+        cols[i]->set_object ("right-neighbor", cols[i + 1]->self_scm ());
     }
 }