]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/system.cc
* ly/engraver-init.ly (AncientRemoveEmptyStaffContext): use length-fraction.
[lilypond.git] / lily / system.cc
index d16b5a3b4e85c1134e6e6c422c3d4a20f9c443db..60bdfeed59b017bb9d74e84b46c4dd20bcdc36d7 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-#include <math.h>
+#include "system.hh"
+
 
 #include "align-interface.hh"
 #include "axis-group-interface.hh"
 #include "warn.hh"
-#include "system.hh"
 #include "main.hh"
 #include "paper-column.hh"
 #include "output-def.hh"
-#include "paper-outputter.hh"
 #include "paper-score.hh"
-#include "string.hh"
 #include "warn.hh"
-#include "stencil.hh"
 #include "all-font-metrics.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"
 
 System::System (System const &src, int count)
   : Spanner (src, count)
 {
+  all_elements_ = 0;
   rank_ = 0;
+  init_elements ();
 }
 
-System::System (SCM s, Object_key const*key)
+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);
+  set_object ("all-elements", scm_arr);
+}
 
-Grob * 
+Grob *
 System::clone (int count) const
 {
   return new System (*this, count);
 }
 
-
 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 (int i = all_elements_->size (); i--;)
+    if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
       k++;
   return k;
 }
 
 void
-System::typeset_grob (Grob * elem)
+System::typeset_grob (Grob *elem)
 {
   if (elem->pscore_)
-    programming_error ("Adding element twice.");
+    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 ());
+      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_->is_empty ())
     {
-      Grob::fixup_refpoint (scm_car (s));
+      Grob **ptr = &all_elements_->array_reference ().elem_ref (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 (Link_array<Grob> const &grobs)
+{
+  for (int 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 (int 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);
+           Kill no longer needed grobs.
+         */
+         Item *it = dynamic_cast<Item *> (g);
          if (it && Item::is_breakable (it))
            {
              it->find_prebroken_piece (LEFT)->suicide ();
@@ -114,26 +139,32 @@ 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 (int 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 (int 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 (int i = 0; i < all_elements_->size (); i++)
+    all_elements_->grob (i)->handle_broken_dependencies ();
 
-  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 ();
 
-#if 0  /* don't do this: strange side effects.  */
-  
+#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
@@ -141,123 +172,49 @@ System::get_lines ()
      makes sure that no duplicates are in the list.  */
   for (int i = 0; i < line_count; i++)
     {
-      SCM all = broken_intos_[i]->get_property ("all-elements");
-      all = ly_list_qsort_uniq_x(all); 
+      SCM all = broken_intos_[i]->get_object ("all-elements");
+      all = ly_list_qsort_uniq_x (all);
     }
 #endif
-  
-  if (verbose_global_b)
-    progress_indication (_f ("Element count %d.",  count + element_count ()));
+
+  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++)
     {
-      if (verbose_global_b)
+      if (be_verbose_global)
        progress_indication ("[");
 
-      System *system = dynamic_cast<System*> (broken_intos_[i]);
+      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 (verbose_global_b)
+      if (be_verbose_global)
        progress_indication (to_string (i) + "]");
     }
   return lines;
 }
 
-/* Find the loose columns in POSNS, and drape them around the columns
-   specified in BETWEEN-COLS.  */
-static void
-set_loose_columns (System* which, Column_x_positions const *posns)
-{
-  int loose_col_count = posns->loose_cols_.size ();
-  for (int i = 0; i < loose_col_count; i++)
-    {
-      int divide_over = 1;
-      Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
-      Paper_column* col = dynamic_cast<Paper_column*> (loose);
-      
-      if (col->system_)
-       continue;
-      
-      Item *left = 0;
-      Item *right = 0;
-      while (1)
-       {
-         SCM between = loose->get_property ("between-cols");
-         if (!scm_is_pair (between))
-           break;
-
-         Item *le = dynamic_cast<Item*> (unsmob_grob (scm_car (between)));
-         Item *re = dynamic_cast<Item*> (unsmob_grob (scm_cdr (between)));
-
-         if (!(le && re))
-           break;
-         
-         if (!left && le)
-           {
-             left = le->get_column ();
-             if (!left->get_system ())
-               left = left->find_prebroken_piece (RIGHT);
-           }
-
-         divide_over++;
-         loose = right = re->get_column ();
-       }
-
-      if (!right->get_system ())
-       right = right->find_prebroken_piece (LEFT);
-      
-      /* Divide the remaining space of the column over the left and
-       right side.  At the moment,  FIXME  */
-      Grob *common = right->common_refpoint (left, X_AXIS);
-      
-      Real rx =        right->extent (common, X_AXIS)[LEFT];
-      Real lx = left->extent (common, X_AXIS)[RIGHT];
-      Real total_dx = rx - lx;
-      Interval cval =col->extent (col, X_AXIS);
-
-      /* Put it in the middle.  This is not an ideal solution -- the
-        break alignment code inserts a fixed space before the clef
-        (about 1 SS), while the space following the clef is flexible.
-        In tight situations, the clef will almost be on top of the
-        following note.  */
-      Real dx = rx - lx - cval.length ();
-      if (total_dx < 2* cval.length ())
-       {
-         /* TODO: this is discontinuous. I'm too tired to
-           invent a sliding mechanism.  Duh. */
-         dx *= 0.25;
-       }
-      else
-       dx *= 0.5;
-
-      col->system_ = which;
-      col->translate_axis (-col->relative_coordinate (common, X_AXIS), X_AXIS);
-      col->translate_axis (lx + dx - cval[LEFT], X_AXIS); 
-    }
-}
-
-// const?
 void
 System::break_into_pieces (Array<Column_x_positions> const &breaking)
 {
   for (int i = 0; i < breaking.size (); i++)
     {
-      System *system = dynamic_cast <System*> (clone (i));
+      System *system = dynamic_cast<System *> (clone (i));
       system->rank_ = i;
 
       Link_array<Grob> c (breaking[i].cols_);
-      pscore_->typeset_line (system);
-      
-      system->set_bound (LEFT,c[0]);
-      system->set_bound (RIGHT,c.top ());
+      pscore_->typeset_system (system);
+
+      system->set_bound (LEFT, c[0]);
+      system->set_bound (RIGHT, c.top ());
       for (int j = 0; j < c.size (); j++)
        {
          c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
-         dynamic_cast<Paper_column*> (c[j])->system_ = system;
+         dynamic_cast<Paper_column *> (c[j])->system_ = system;
        }
       set_loose_columns (system, &breaking[i]);
       broken_intos_.push (system);
@@ -265,17 +222,24 @@ System::break_into_pieces (Array<Column_x_positions> const &breaking)
 }
 
 void
-System::add_column (Paper_column*p)
+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 ().top ()) + 1
+    : 0;
 
-  Axis_group_interface::add_element (me, p);
+  ga->add (p);
+  Axis_group_interface::add_element (this, p);
 }
 
 void
@@ -288,7 +252,7 @@ apply_tweaks (Grob *g, bool broken)
        {
          SCM proc = scm_caar (s);
          SCM rest = scm_cdar (s);
-         scm_apply_1 (proc, g->self_scm(), rest);
+         scm_apply_1 (proc, g->self_scm (), rest);
        }
     }
 }
@@ -296,98 +260,96 @@ 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 (int i = 0; i < all_elements_->size (); i++)
+    all_elements_->grob (i)->discretionary_processing ();
 
-  if (verbose_global_b)
-    progress_indication (_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 ();
-  
-  fixup_refpoints (get_property ("all-elements"));
+  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))
-    apply_tweaks (unsmob_grob (scm_car (s)), false);
+  /*
+    order is significant: broken grobs are added to the end of the
+    array, and should be processed before the original is potentially
+    killed.
+  */
+  for (int 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++)
+    apply_tweaks (all_elements_->grob (i), false);
 
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+  for (int 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");
     }
-  
-  progress_indication ("\n");
-  progress_indication (_ ("Calculating line breaks..."));
+
+  message (_ ("Calculating line breaks..."));
   progress_indication (" ");
-  for (SCM s = get_property ("all-elements"); scm_is_pair (s); s = scm_cdr (s))
+
+  for (int 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 (int i = 0; i < all_elements_->size (); i++)
     {
-      Grob *g = unsmob_grob (scm_car (s));
-      
-      apply_tweaks (g, true);
+      Grob *g = all_elements_->grob (i);
 
-      g->calculate_dependencies (POSTCALCED, POSTCALCING,
-          ly_symbol2scm ("after-line-breaking-callback"));
+      apply_tweaks (g, true);
+      (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);
 
+  Link_array<Grob> all_elts_sorted (all_elements_->array ());
+  all_elts_sorted.default_sort ();
+  all_elts_sorted.uniq ();
   this->get_stencil ();
-  for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
+  for (int 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 ()
-{  
+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.
-
-     Start with layer 3, since scm_cons prepends to list.  */
-  SCM all = get_property ("all-elements");
-  
-  for (int i = LAYER_COUNT; i--;)
-    for (SCM s = all; scm_is_pair (s); s = scm_cdr (s))
+  /* 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 = unsmob_grob (scm_car (s));
-       Stencil *stil = g->get_stencil ();
+       Grob *g = all_elements_->grob (j);
+       Stencil st = g->get_print_stencil ();
 
        /* Skip empty stencils and grobs that are not in this layer.  */
-       if (!stil
+       if (st.expr() == SCM_EOL
            || robust_scm2int (g->get_property ("layer"), 1) != i)
          continue;
 
-       Offset o (g->relative_coordinate (this, X_AXIS),
-                 g->relative_coordinate (this, Y_AXIS));
+       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))
@@ -396,10 +358,10 @@ System::get_line ()
        /* Must copy the stencil, for we cannot change the stencil
           cached in G.  */
 
-       Stencil st = *stil;
        st.translate (o + extra);
+
        *tail = scm_cons (st.expr (), SCM_EOL);
-       tail = SCM_CDRLOC(*tail);
+       tail = SCM_CDRLOC (*tail);
       }
 
   if (Stencil *me = get_stencil ())
@@ -407,54 +369,61 @@ System::get_line ()
 
   Interval x (extent (this, X_AXIS));
   Interval y (extent (this, Y_AXIS));
-  Stencil sys_stencil (Box (x,y),
+  Stencil sys_stencil (Box (x, y),
                       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 *g = unsmob_grob (scm_car (s));
-       staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
-      }
+
+
+  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"));
   
-  Paper_system *pl = new Paper_system (sys_stencil, false);
-  pl->staff_refpoints_ = staff_refpoints;
-  Item * break_point =this->get_bound(LEFT);
-  pl->penalty_ =
-    robust_scm2double (break_point->get_property ("page-penalty"), 0.0);
+  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--;)
+       {
+         Grob *g = staves[i];
+         staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
+       }
+      pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
+    }
   
-  return scm_gc_unprotect_object (pl->self_scm ());
+  return pl->unprotect ();
 }
 
-Link_array<Item> 
+Link_array<Item>
 System::broken_col_range (Item const *left, Item const *right) const
 {
   Link_array<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);
+  int 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)));
+      Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
       if (Item::is_breakable (c) && !c->system_)
        ret.push (c);
-
-      s = scm_cdr (s);
+      i++;
     }
 
-  ret.reverse ();
   return ret;
 }
 
@@ -463,26 +432,33 @@ System::broken_col_range (Item const *left, Item const *right) const
 Link_array<Grob>
 System::columns () const
 {
-  Link_array<Grob> acs
-    = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "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--)
+    {
+      if (Item::is_breakable (ro_columns [last_breakable]))
+       break;
+    }
+
+  Link_array<Grob> columns;
+  for (int i = 0; i <= last_breakable; i++)
     {
-      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_used (ro_columns[i]))
+       columns.push (ro_columns[i]);
     }
-  return acs;
+
+  return columns;
+}
+
+int
+System::get_rank () const
+{
+  return rank_;
 }
 
-ADD_INTERFACE (System,"system-interface",
+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")