]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/system.cc
Merge branch 'master' of ssh+git://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / system.cc
index ad5113a0fb6a447c9f3a55eae84729d06be0fe45..90eb463c44932ac307902bd3e8a7e5e210b7984f 100644 (file)
@@ -3,33 +3,34 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "system.hh"
 
-
 #include "align-interface.hh"
+#include "all-font-metrics.hh"
 #include "axis-group-interface.hh"
-#include "warn.hh"
+#include "grob-array.hh"
+#include "international.hh"
 #include "main.hh"
-#include "paper-column.hh"
 #include "output-def.hh"
+#include "paper-column.hh"
 #include "paper-score.hh"
-#include "warn.hh"
-#include "all-font-metrics.hh"
+#include "paper-system.hh"
+#include "pointer-group-interface.hh"
 #include "spacing-interface.hh"
 #include "staff-symbol-referencer.hh"
-#include "paper-book.hh"
-#include "paper-system.hh"
 #include "tweak-registration.hh"
-#include "grob-array.hh"
-#include "pointer-group-interface.hh"
+#include "warn.hh"
+
+extern bool debug_skylines;
 
 System::System (System const &src, int count)
   : Spanner (src, count)
 {
   all_elements_ = 0;
+  pscore_ = 0;
   rank_ = 0;
   init_elements ();
 }
@@ -47,13 +48,14 @@ System::init_elements ()
 {
   SCM scm_arr = Grob_array::make_array ();
   all_elements_ = unsmob_grob_array (scm_arr);
+  all_elements_->set_ordered (false);
   set_object ("all-elements", scm_arr);
 }
 
 Grob *
-System::clone (int count) const
+System::clone (int index) const
 {
-  return new System (*this, count);
+  return new System (*this, index);
 }
 
 int
@@ -66,7 +68,7 @@ int
 System::spanner_count () const
 {
   int k = 0;
-  for (int i = all_elements_->size (); i--;)
+  for (vsize i = all_elements_->size (); i--;)
     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
       k++;
   return k;
@@ -75,11 +77,11 @@ System::spanner_count () const
 void
 System::typeset_grob (Grob *elem)
 {
-  if (elem->pscore_)
+  if (elem->layout_)
     programming_error ("adding element twice");
   else
     {
-      elem->pscore_ = pscore_;
+      elem->layout_ = pscore_->layout ();
       all_elements_->add (elem);
       elem->unprotect ();
     }
@@ -88,9 +90,9 @@ System::typeset_grob (Grob *elem)
 void
 System::derived_mark () const
 {
-  if (!all_elements_->is_empty ())
+  if (!all_elements_->empty ())
     {
-      Grob **ptr = &all_elements_->array_reference ().elem_ref (0);
+      Grob **ptr = &all_elements_->array_reference ()[0];
       Grob **end = ptr + all_elements_->size ();
       while (ptr < end)
        {
@@ -106,16 +108,16 @@ System::derived_mark () const
 }
 
 static void
-fixup_refpoints (Link_array<Grob> const &grobs)
+fixup_refpoints (vector<Grob*> const &grobs)
 {
-  for (int i = grobs.size (); i--;)
+  for (vsize i = grobs.size (); i--;)
     grobs[i]->fixup_refpoint ();
 }
 
 SCM
 System::get_paper_systems ()
 {
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
       Grob *g = all_elements_->grob (i);
       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
@@ -124,7 +126,7 @@ System::get_paper_systems ()
            Kill no longer needed grobs.
          */
          Item *it = dynamic_cast<Item *> (g);
-         if (it && Item::is_breakable (it))
+         if (it && Item::is_non_musical (it))
            {
              it->find_prebroken_piece (LEFT)->suicide ();
              it->find_prebroken_piece (RIGHT)->suicide ();
@@ -139,12 +141,12 @@ System::get_paper_systems ()
     fixups must be done in broken line_of_scores, because new elements
     are put over there.  */
   int count = 0;
-  for (int i = 0; i < broken_intos_.size (); i++)
+  for (vsize i = 0; i < broken_intos_.size (); i++)
     {
       Grob *se = broken_intos_[i];
 
       extract_grob_set (se, "all-elements", all_elts);
-      for (int j = 0; j < all_elts.size (); j++)
+      for (vsize j = 0; j < all_elts.size (); j++)
        {
          Grob *g = all_elts[j];
          g->fixup_refpoint ();
@@ -158,39 +160,43 @@ System::get_paper_systems ()
   */
   fixup_refpoints (all_elements_->array ());
 
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     all_elements_->grob (i)->handle_broken_dependencies ();
 
   handle_broken_dependencies ();
 
-#if 0  /* FIXME: strange side effects.  */
-
   /* Because the this->get_property (all-elements) contains items in 3
      versions, handle_broken_dependencies () will leave duplicated
      items in all-elements.  Strictly speaking this is harmless, but
-     it leads to duplicated symbols in the output.  ly_list_qsort_uniq_x ()
-     makes sure that no duplicates are in the list.  */
-  for (int i = 0; i < line_count; i++)
+     it leads to duplicated symbols in the output.  uniq makes sure
+     that no duplicates are in the list.  */
+  for (vsize i = 0; i < broken_intos_.size (); i++)
     {
-      SCM all = broken_intos_[i]->get_object ("all-elements");
-      all = ly_list_qsort_uniq_x (all);
+      System *child = dynamic_cast<System*> (broken_intos_[i]);
+      child->all_elements_->remove_duplicates ();
     }
-#endif
 
   if (be_verbose_global)
     message (_f ("Element count %d.", count + element_count ()));
 
-  int line_count = broken_intos_.size ();
-  SCM lines = scm_c_make_vector (line_count, SCM_EOL);
-
-  for (int i = 0; i < line_count; i++)
+  SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
+  for (vsize i = 0; i < broken_intos_.size (); i++)
     {
       if (be_verbose_global)
        progress_indication ("[");
 
       System *system = dynamic_cast<System *> (broken_intos_[i]);
+
       system->post_processing ();
-      scm_vector_set_x (lines, scm_from_int (i), system->get_paper_system ());
+      system->build_skylines ();
+      if (i > 0)
+       {
+         System *prev = dynamic_cast<System*> (broken_intos_[i-1]);
+         Real r = prev->skylines_[DOWN].distance (system->skylines_[UP]);
+         system->set_property ("skyline-distance", scm_from_double (r));
+       }
+      scm_vector_set_x (lines, scm_from_int (i),
+                       system->get_paper_system ());
 
       if (be_verbose_global)
        progress_indication (to_string (i) + "]");
@@ -199,25 +205,31 @@ System::get_paper_systems ()
 }
 
 void
-System::break_into_pieces (Array<Column_x_positions> const &breaking)
+System::break_into_pieces (vector<Column_x_positions> const &breaking)
 {
-  for (int i = 0; i < breaking.size (); i++)
+  for (vsize i = 0; i < breaking.size (); i++)
     {
-      System *system = dynamic_cast<System *> (clone (i));
-      system->rank_ = i;
+      System *system = dynamic_cast<System *> (clone (broken_intos_.size ()));
+      system->rank_ = broken_intos_.size ();
 
-      Link_array<Grob> c (breaking[i].cols_);
+      vector<Grob*> c (breaking[i].cols_);
       pscore_->typeset_system (system);
 
+      int st = Paper_column::get_rank (c[0]);
+      int end = Paper_column::get_rank (c.back ());
+      Interval iv (pure_height (this, st, end));
+      system->set_property ("pure-Y-extent", ly_interval2scm (iv));
+
       system->set_bound (LEFT, c[0]);
-      system->set_bound (RIGHT, c.top ());
-      for (int j = 0; j < c.size (); j++)
+      system->set_bound (RIGHT, c.back ());
+      for (vsize j = 0; j < c.size (); j++)
        {
          c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
          dynamic_cast<Paper_column *> (c[j])->system_ = system;
        }
+      
       set_loose_columns (system, &breaking[i]);
-      broken_intos_.push (system);
+      broken_intos_.push_back (system);
     }
 }
 
@@ -235,7 +247,7 @@ System::add_column (Paper_column *p)
 
   p->rank_
     = ga->size ()
-    ? Paper_column::get_rank (ga->array ().top ()) + 1
+    ? Paper_column::get_rank (ga->array ().back ()) + 1
     : 0;
 
   ga->add (p);
@@ -245,7 +257,7 @@ System::add_column (Paper_column *p)
 void
 apply_tweaks (Grob *g, bool broken)
 {
-  if (bool (g->original_) == broken)
+  if (bool (g->original ()) == broken)
     {
       SCM tweaks = global_registry_->get_tweaks (g);
       for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
@@ -260,7 +272,7 @@ apply_tweaks (Grob *g, bool broken)
 void
 System::pre_processing ()
 {
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     all_elements_->grob (i)->discretionary_processing ();
 
   if (be_verbose_global)
@@ -271,36 +283,31 @@ System::pre_processing ()
     array, and should be processed before the original is potentially
     killed.
   */
-  for (int i = all_elements_->size (); i--;)
+  for (vsize i = all_elements_->size (); i--;)
     all_elements_->grob (i)->handle_prebroken_dependencies ();
 
   fixup_refpoints (all_elements_->array ());
 
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     apply_tweaks (all_elements_->grob (i), false);
 
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
       Grob *g = all_elements_->grob (i);
       (void) g->get_property ("before-line-breaking");
     }
 
-  message (_ ("Calculating line breaks..."));
-  progress_indication (" ");
-
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
       Grob *e = all_elements_->grob (i);
-      SCM proc = e->get_property ("spacing-procedure");
-      if (ly_is_procedure (proc))
-       scm_call_1 (proc, e->self_scm ());
+      (void) e->get_property ("springs-and-rods");
     }
 }
 
 void
 System::post_processing ()
 {
-  for (int i = 0; i < all_elements_->size (); i++)
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
       Grob *g = all_elements_->grob (i);
 
@@ -318,53 +325,72 @@ System::post_processing ()
      This might seem inefficient, but Stencils are cached per grob
      anyway. */
 
-  Link_array<Grob> all_elts_sorted (all_elements_->array ());
-  all_elts_sorted.default_sort ();
-  all_elts_sorted.uniq ();
+  vector<Grob*> all_elts_sorted (all_elements_->array ());
+  vector_sort (all_elts_sorted, std::less<Grob*> ());
+  uniq (all_elts_sorted);
   this->get_stencil ();
-  for (int i = all_elts_sorted.size (); i--;)
+  for (vsize i = all_elts_sorted.size (); i--;)
     {
       Grob *g = all_elts_sorted[i];
       g->get_stencil ();
     }
 }
 
+struct Layer_entry
+{
+  Grob *grob_;
+  int layer_;
+};
+
+bool
+operator< (Layer_entry  const &a,
+          Layer_entry  const &b)
+{
+  return a.layer_ < b.layer_;
+}
+
+
 SCM
 System::get_paper_system ()
 {
-  static int const LAYER_COUNT = 3;
-
   SCM exprs = SCM_EOL;
   SCM *tail = &exprs;
 
-  /* Output stencils in three layers: 0, 1, 2.  Default layer: 1. */
-  for (int i = 0; i < LAYER_COUNT; i++)
-    for (int j = all_elements_->size (); j--;)
-      {
-       Grob *g = all_elements_->grob (j);
-       Stencil *stil = g->get_stencil ();
+  vector<Layer_entry> entries;
+  for (vsize j = 0; j < all_elements_->size (); j++)
+    {
+      Layer_entry e;
+      e.grob_ = all_elements_->grob (j);
+      e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
+      
+      entries.push_back (e); 
+    }
 
-       /* Skip empty stencils and grobs that are not in this layer.  */
-       if (!stil
-           || robust_scm2int (g->get_property ("layer"), 1) != i)
-         continue;
+  vector_sort (entries, std::less<Layer_entry> ());
+  for (vsize j = 0; j < entries.size (); j++)
+    {
+      Grob *g = entries[j].grob_;
+      Stencil st = g->get_print_stencil ();
 
-       Offset o (g->relative_coordinate (this, X_AXIS),
-                 g->relative_coordinate (this, Y_AXIS));
+      if (st.expr() == SCM_EOL)
+       continue;
+      
+      Offset o;
+      for (int a = X_AXIS; a < NO_AXES; a++)
+       o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 
-       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
-                                         Offset (0, 0))
-         * Staff_symbol_referencer::staff_space (g);
+      Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
+                                       Offset (0, 0))
+       * Staff_symbol_referencer::staff_space (g);
 
-       /* Must copy the stencil, for we cannot change the stencil
-          cached in G.  */
+      /* Must copy the stencil, for we cannot change the stencil
+        cached in G.  */
 
-       Stencil st = *stil;
-       st.translate (o + extra);
+      st.translate (o + extra);
 
-       *tail = scm_cons (st.expr (), SCM_EOL);
-       tail = SCM_CDRLOC (*tail);
-      }
+      *tail = scm_cons (st.expr (), SCM_EOL);
+      tail = SCM_CDRLOC (*tail);
+    }
 
   if (Stencil *me = get_stencil ())
     exprs = scm_cons (me->expr (), exprs);
@@ -374,64 +400,77 @@ System::get_paper_system ()
   Stencil sys_stencil (Box (x, y),
                       scm_cons (ly_symbol2scm ("combine-stencil"),
                                 exprs));
-
-
+  if (debug_skylines)
+    {
+      sys_stencil.add_stencil (points_to_line_stencil (skylines_[UP].to_points ()).in_color (255, 0, 0));
+      sys_stencil.add_stencil (points_to_line_stencil (skylines_[DOWN].to_points ()).in_color (0, 255, 0));
+    }
 
   Grob *left_bound = this->get_bound (LEFT);
   SCM prop_init = left_bound->get_property ("line-break-system-details");
-  Paper_system *pl = new Paper_system (sys_stencil,
-                                      prop_init);
-  pl->set_property ("penalty",
-                   left_bound->get_property ("page-penalty"));
-  
+  Prob *pl = make_paper_system (prop_init);
+  paper_system_set_stencil (pl, sys_stencil);
+
+  /* information that the page breaker might need */
+  Grob *right_bound = this->get_bound (RIGHT);
+  pl->set_property ("skyline-distance", get_property ("skyline-distance"));
+  pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
+  pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
+  pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
+  pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
+
   if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
     {
       Interval staff_refpoints;
       staff_refpoints.set_empty ();
       extract_grob_set (this, "spaceable-staves", staves);
-      for (int i = staves.size (); i--;)
+      for (vsize i = 0; i < staves.size (); i++)
        {
          Grob *g = staves[i];
          staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
        }
       pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
     }
-  
+
+  pl->set_property ("system-grob", this->self_scm ()); 
+
   return pl->unprotect ();
 }
 
-Link_array<Item>
+vector<Item*>
 System::broken_col_range (Item const *left, Item const *right) const
 {
-  Link_array<Item> ret;
+  vector<Item*> ret;
 
   left = left->get_column ();
   right = right->get_column ();
 
+  
   extract_grob_set (this, "columns", cols);
-  int i = 0;
-  while (i < cols.size ()
-        && cols[i] != left)
-    i++;
 
+  vsize i = binary_search (cols, (Grob *) left,
+                          Paper_column::less_than);
+
+  int end_rank = Paper_column::get_rank (right);
   if (i < cols.size ())
     i++;
 
   while (i < cols.size ()
-        && cols[i] != right)
+        && Paper_column::get_rank (cols[i]) < end_rank)
     {
       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
-      if (Item::is_breakable (c) && !c->system_)
-       ret.push (c);
+      if (Paper_column::is_breakable (c) && !c->system_)
+       ret.push_back (c);
       i++;
     }
 
   return ret;
 }
 
+
 /** Return all columns, but filter out any unused columns , since they might
     disrupt the spacing problem. */
-Link_array<Grob>
+vector<Grob*>
 System::columns () const
 {
   extract_grob_set (this, "columns", ro_columns);
@@ -440,27 +479,75 @@ System::columns () const
 
   while (last_breakable--)
     {
-      if (Item::is_breakable (ro_columns [last_breakable]))
+      if (Paper_column::is_breakable (ro_columns [last_breakable]))
        break;
     }
 
-  Link_array<Grob> columns;
+  vector<Grob*> columns;
   for (int i = 0; i <= last_breakable; i++)
     {
       if (Paper_column::is_used (ro_columns[i]))
-       columns.push (ro_columns[i]);
+       columns.push_back (ro_columns[i]);
     }
 
   return columns;
 }
 
+Paper_score*
+System::paper_score () const
+{
+  return pscore_;
+}
+
 int
 System::get_rank () const
 {
   return rank_;
 }
 
-ADD_INTERFACE (System, "system-interface",
+System *
+get_root_system (Grob *me) 
+{
+  Grob *system_grob = me;
+  
+  while (system_grob->get_parent (Y_AXIS))
+    system_grob = system_grob->get_parent (Y_AXIS);
+
+  return dynamic_cast<System*> (system_grob); 
+}
+
+void
+System::build_skylines ()
+{
+  vector<Box> boxes;
+  for (vsize i = 0; i < all_elements_->size (); i++)
+    {
+      Grob *g = all_elements_->grob (i);
+      if (!unsmob_stencil (g->get_property ("stencil")))
+       continue;
+
+      Interval xiv = g->extent (this, X_AXIS);
+      Interval yiv = g->extent (this, Y_AXIS);
+      if (!xiv.is_empty () && !yiv.is_empty ())
+       boxes.push_back (Box (xiv, yiv));
+    }
+
+  SCM horizon_padding_scm = get_property ("skyline-horizontal-padding");
+  Real horizon_padding = robust_scm2double (horizon_padding_scm, 0);
+  skylines_[UP] = Skyline (boxes, horizon_padding, X_AXIS, UP);
+  skylines_[DOWN] = Skyline (boxes, horizon_padding, X_AXIS, DOWN);
+}
+
+
+ADD_INTERFACE (System,
               "This is the toplevel object: each object in a score "
               "ultimately has a System object as its X and Y parent. ",
-              "all-elements spaceable-staves columns")
+
+              /* properties */
+              "all-elements "
+              "columns "
+              "pure-Y-extent "
+              "spaceable-staves "
+              "skyline-distance "
+              "skyline-horizontal-padding "
+              )