]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/system.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / system.cc
index e6b034251bd04fbc2d9b78140d126be12639c2f9..dda8fdf1321182e7c8d2dd56e934ac9eb44d6a46 100644 (file)
@@ -3,58 +3,72 @@
 
   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 <math.h>
-
 #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 "warn.hh"
+#include "warn.hh"
 
 System::System (System const &src, int count)
   : Spanner (src, count)
 {
+  all_elements_ = 0;
+  pscore_ = 0;
   rank_ = 0;
+  init_elements ();
 }
 
 System::System (SCM s, Object_key const *key)
   : Spanner (s, key)
 {
+  all_elements_ = 0;
   rank_ = 0;
+  init_elements ();
+}
+
+void
+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
 System::element_count () const
 {
-  return scm_ilength (get_property ("all-elements"));
+  return all_elements_->size ();
 }
 
 int
 System::spanner_count () const
 {
   int k = 0;
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
-    if (dynamic_cast<Spanner *> (unsmob_grob (scm_car (s))))
+  for (vsize i = all_elements_->size (); i--;)
+    if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
       k++;
   return k;
 }
@@ -62,39 +76,56 @@ 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_;
-      Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem);
-      scm_gc_unprotect_object (elem->self_scm ());
+      elem->layout_ = pscore_->layout ();
+      all_elements_->add (elem);
+      elem->unprotect ();
     }
 }
 
-// todo: use map.
-static void
-fixup_refpoints (SCM s)
+void
+System::derived_mark () const
 {
-  for (; scm_is_pair (s); s = scm_cdr (s))
+  if (!all_elements_->empty ())
     {
-      Grob::fixup_refpoint (scm_car (s));
+      Grob **ptr = &all_elements_->array_reference ()[0];
+      Grob **end = ptr + all_elements_->size ();
+      while (ptr < end)
+       {
+         scm_gc_mark ((*ptr)->self_scm ());
+         ptr++;
+       }
     }
+
+  if (pscore_)
+    scm_gc_mark (pscore_->self_scm ());
+
+  Spanner::derived_mark ();
+}
+
+static void
+fixup_refpoints (vector<Grob*> const &grobs)
+{
+  for (vsize i = grobs.size (); i--;)
+    grobs[i]->fixup_refpoint ();
 }
 
 SCM
-System::get_lines ()
+System::get_paper_systems ()
 {
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
-      Grob *g = unsmob_grob (scm_car (s));
+      Grob *g = all_elements_->grob (i);
       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
        {
          /*
            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 ();
@@ -109,52 +140,54 @@ System::get_lines ()
     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];
-      SCM all = se->get_property ("all-elements");
-      for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
-       fixup_refpoint (scm_car (s));
-      count += scm_ilength (all);
+
+      extract_grob_set (se, "all-elements", all_elts);
+      for (vsize j = 0; j < all_elts.size (); j++)
+       {
+         Grob *g = all_elts[j];
+         g->fixup_refpoint ();
+       }
+
+      count += all_elts.size ();
     }
 
   /*
     needed for doing items.
   */
-  fixup_refpoints (get_property ("all-elements"));
+  fixup_refpoints (all_elements_->array ());
 
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
-    unsmob_grob (scm_car (s))->handle_broken_dependencies ();
-  handle_broken_dependencies ();
+  for (vsize i = 0; i < all_elements_->size (); i++)
+    all_elements_->grob (i)->handle_broken_dependencies ();
 
-#if 0  /* don't do this: strange side effects.  */
+  handle_broken_dependencies ();
 
   /* 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_property ("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_int2num (i), system->get_line ());
+      scm_vector_set_x (lines, scm_from_int (i),
+                       system->get_paper_system ());
 
       if (be_verbose_global)
        progress_indication (to_string (i) + "]");
@@ -163,25 +196,25 @@ System::get_lines ()
 }
 
 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_);
-      pscore_->typeset_line (system);
+      vector<Grob*> c (breaking[i].cols_);
+      pscore_->typeset_system (system);
 
       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);
     }
 }
 
@@ -189,20 +222,27 @@ void
 System::add_column (Paper_column *p)
 {
   Grob *me = this;
-  SCM cs = me->get_property ("columns");
-  Grob *prev = scm_is_pair (cs) ? unsmob_grob (scm_car (cs)) : 0;
-
-  p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
+  Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
+  if (!ga)
+    {
+      SCM scm_ga = Grob_array::make_array ();
+      me->set_object ("columns", scm_ga);
+      ga = unsmob_grob_array (scm_ga);
+    }
 
-  me->set_property ("columns", scm_cons (p->self_scm (), cs));
+  p->rank_
+    = ga->size ()
+    ? Paper_column::get_rank (ga->array ().back ()) + 1
+    : 0;
 
-  Axis_group_interface::add_element (me, p);
+  ga->add (p);
+  Axis_group_interface::add_element (this, 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))
@@ -217,108 +257,125 @@ apply_tweaks (Grob *g, bool broken)
 void
 System::pre_processing ()
 {
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
-    unsmob_grob (scm_car (s))->discretionary_processing ();
+  for (vsize i = 0; i < all_elements_->size (); i++)
+    all_elements_->grob (i)->discretionary_processing ();
 
   if (be_verbose_global)
     message (_f ("Grob count %d", element_count ()));
 
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
-    unsmob_grob (scm_car (s))->handle_prebroken_dependencies ();
+  /*
+    order is significant: broken grobs are added to the end of the
+    array, and should be processed before the original is potentially
+    killed.
+  */
+  for (vsize i = all_elements_->size (); i--;)
+    all_elements_->grob (i)->handle_prebroken_dependencies ();
 
-  fixup_refpoints (get_property ("all-elements"));
+  fixup_refpoints (all_elements_->array ());
 
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
-    apply_tweaks (unsmob_grob (scm_car (s)), false);
+  for (vsize i = 0; i < all_elements_->size (); i++)
+    apply_tweaks (all_elements_->grob (i), false);
 
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
-      Grob *sc = unsmob_grob (scm_car (s));
-      sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
+      Grob *g = all_elements_->grob (i);
+      (void) g->get_property ("before-line-breaking");
     }
 
-  message (_ ("Calculating line breaks..."));
-  progress_indication (" ");
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
-      Grob *e = unsmob_grob (scm_car (s));
-      SCM proc = e->get_property ("spacing-procedure");
-      if (ly_c_procedure_p (proc))
-       scm_call_1 (proc, e->self_scm ());
+      Grob *e = all_elements_->grob (i);
+      (void) e->get_property ("springs-and-rods");
     }
 }
 
 void
 System::post_processing ()
 {
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+  for (vsize i = 0; i < all_elements_->size (); i++)
     {
-      Grob *g = unsmob_grob (scm_car (s));
+      Grob *g = all_elements_->grob (i);
 
       apply_tweaks (g, true);
-
-      g->calculate_dependencies (POSTCALCED, POSTCALCING,
-                                ly_symbol2scm ("after-line-breaking-callback"));
+      (void) g->get_property ("after-line-breaking");
     }
 
   Interval iv (extent (this, Y_AXIS));
   if (iv.is_empty ())
-    programming_error ("system with zero extent");
+    programming_error ("system with empty extent");
   else
     translate_axis (-iv[MAX], Y_AXIS);
 
   /* Generate all stencils to trigger font loads.
      This might seem inefficient, but Stencils are cached per grob
      anyway. */
-  SCM all = get_property ("all-elements");
-  all = ly_list_qsort_uniq_x (all);
 
+  vector<Grob*> all_elts_sorted (all_elements_->array ());
+  vector_sort (all_elts_sorted, default_compare);
+  uniq (all_elts_sorted);
   this->get_stencil ();
-  for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
+  for (vsize i = all_elts_sorted.size (); i--;)
     {
-      Grob *g = unsmob_grob (scm_car (s));
+      Grob *g = all_elts_sorted[i];
       g->get_stencil ();
     }
 }
 
-SCM
-System::get_line ()
+struct Layer_entry
 {
-  static int const LAYER_COUNT = 3;
+  Grob *grob_;
+  int layer_;
+};
+
+bool
+operator< (Layer_entry  const &a,
+          Layer_entry  const &b)
+{
+  return a.layer_ < b.layer_;
+}
 
+
+SCM
+System::get_paper_system ()
+{
   SCM exprs = SCM_EOL;
   SCM *tail = &exprs;
 
-  /* Output stencils in three layers: 0, 1, 2.  Default layer: 1. */
-  SCM all = get_property ("all-elements");
-
-  for (int i = 0; i < LAYER_COUNT; i++)
-    for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
-      {
-       Grob *g = unsmob_grob (scm_car (s));
-       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, default_compare);
+  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);
@@ -329,78 +386,123 @@ System::get_line ()
                       scm_cons (ly_symbol2scm ("combine-stencil"),
                                 exprs));
 
-  Interval staff_refpoints;
-  staff_refpoints.set_empty ();
-  for (SCM s = get_property ("spaceable-staves");
-       scm_is_pair (s); s = scm_cdr (s))
+  Grob *left_bound = this->get_bound (LEFT);
+  SCM prop_init = left_bound->get_property ("line-break-system-details");
+  Prob *pl = make_paper_system (prop_init);
+  paper_system_set_stencil (pl, sys_stencil);
+
+  /* backwards-compatibility hack for the old page-breaker */
+  SCM turn_perm = left_bound->get_property ("page-break-permission");
+  if (!scm_is_symbol (turn_perm))
+    pl->set_property ("penalty", scm_from_double (10001.0));
+  else if (turn_perm == ly_symbol2scm ("force"))
+    pl->set_property ("penalty", scm_from_double (-10001.0));
+  else
+    pl->set_property ("penalty", scm_from_double (0.0));
+  
+  if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
     {
-      Grob *g = unsmob_grob (scm_car (s));
-      staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
+      Interval staff_refpoints;
+      staff_refpoints.set_empty ();
+      extract_grob_set (this, "spaceable-staves", staves);
+      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));
     }
 
-  Paper_system *pl = new Paper_system (sys_stencil, false);
-  pl->staff_refpoints_ = staff_refpoints;
-  Item *break_point = this->get_bound (LEFT);
-  pl->break_before_penalty_
-    = robust_scm2double (break_point->get_property ("page-penalty"), 0.0);
+  pl->set_property ("system-grob", this->self_scm ()); 
 
-  return scm_gc_unprotect_object (pl->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 ();
-  SCM s = get_property ("columns");
 
-  while (scm_is_pair (s) && scm_car (s) != right->self_scm ())
-    s = scm_cdr (s);
+  extract_grob_set (this, "columns", cols);
+  vsize i = 0;
+  while (i < cols.size ()
+        && cols[i] != left)
+    i++;
 
-  if (scm_is_pair (s))
-    s = scm_cdr (s);
+  if (i < cols.size ())
+    i++;
 
-  while (scm_is_pair (s) && scm_car (s) != left->self_scm ())
+  while (i < cols.size ()
+        && cols[i] != right)
     {
-      Paper_column *c = dynamic_cast<Paper_column *> (unsmob_grob (scm_car (s)));
-      if (Item::is_breakable (c) && !c->system_)
-       ret.push (c);
-
-      s = scm_cdr (s);
+      Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
+      if (Paper_column::is_breakable (c) && !c->system_)
+       ret.push_back (c);
+      i++;
     }
 
-  ret.reverse ();
   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
 {
-  Link_array<Grob> acs
-    = extract_grob_array (this, ly_symbol2scm ("columns"));
-  bool found = false;
-  for (int i = acs.size (); i--;)
+  extract_grob_set (this, "columns", ro_columns);
+
+  int last_breakable = ro_columns.size ();
+
+  while (last_breakable--)
     {
-      bool brb = Item::is_breakable (acs[i]);
-      found = found || brb;
-
-      /*
-       the last column should be breakable. Weed out any columns that
-       seem empty. We need to retain breakable columns, in case
-       someone forced a breakpoint.
-      */
-      if (!found || !Paper_column::is_used (acs[i]))
-       acs.del (i);
+      if (Paper_column::is_breakable (ro_columns [last_breakable]))
+       break;
     }
-  return acs;
+
+  vector<Grob*> columns;
+  for (int i = 0; i <= last_breakable; i++)
+    {
+      if (Paper_column::is_used (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_;
 }
 
+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); 
+}
+
+
 
 ADD_INTERFACE (System, "system-interface",
               "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 "
+              "spaceable-staves "
+              )