]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/system.cc
2003 -> 2004
[lilypond.git] / lily / system.cc
index 1a789591ea35f0b724a05957ed362f5edddb162f..dc7bba5b15f6d985c2083a7a36d5152f2aedc824 100644 (file)
@@ -3,12 +3,12 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1996--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 #include "input-smob.hh"
 #include "axis-group-interface.hh"
-#include "debug.hh"
+#include "warn.hh"
 #include "system.hh"
 #include "main.hh"
 #include "paper-column.hh"
@@ -20,6 +20,8 @@
 #include "dimensions.hh"
 #include "molecule.hh"
 #include "all-font-metrics.hh"
+#include "spacing-interface.hh"
+#include "staff-symbol-referencer.hh"
 
 // todo: use map.
 void
@@ -35,7 +37,7 @@ fixup_refpoints (SCM s)
 System::System (SCM s)
   : Spanner (s)
 {
-  rank_i_ = 0;
+  rank_ = 0;
 }
 
 int
@@ -44,12 +46,76 @@ System::element_count () const
   return scm_ilength (get_grob_property ("all-elements"));
 }
 
+int
+System::spanner_count () const
+{
+  int k =0;
+  for (SCM s = get_grob_property ("all-elements");
+       gh_pair_p (s); s = ly_cdr (s))
+    {
+      if (dynamic_cast<Spanner*> (unsmob_grob (gh_car(s))))
+       k++;
+    }
+
+  return k;
+}
+  
+
+int
+scm_default_compare (const void * a, const void *b)
+{
+  SCM pa = *(SCM *)a;
+  SCM pb = *(SCM *)b;
+
+  if (pa < pb) return -1 ;
+  else if (pa > pb) return 1;
+  else return 0;
+}
+
+/*
+  modify L in place: sort it 
+*/
+
+SCM
+uniquify_list (SCM l)
+{
+  int len = scm_ilength (l);
+  SCM  * arr = new SCM[len];
+  int k = 0;
+  for (SCM s =l ; SCM_NNULLP (s); s = SCM_CDR(s))
+    arr[k++] = SCM_CAR(s);
+
+  assert (k == len);
+  qsort (arr, len, sizeof (SCM), &scm_default_compare);
+
+  k = 0;
+  SCM s =l;
+  for (int i = 0; i < len ; i++)
+    {
+      if (i && arr[i] == arr[i-1])
+       continue;
+
+      SCM_SETCAR(s, arr[i]);
+
+      if (i < len - 1)
+       s = SCM_CDR(s);
+    }
+
+  SCM_SETCDR(s, SCM_EOL);
+  delete arr;
+  
+  return l; 
+}
+
 void
-System::typeset_grob (Grob * elem_p)
+System::typeset_grob (Grob * elem)
 {
-  elem_p->pscore_l_ = pscore_l_;
-  Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"),elem_p);
-  scm_gc_unprotect_object (elem_p->self_scm ());
+  if (elem->pscore_)
+    programming_error ("Adding element twice.");
+  
+  elem->pscore_ = pscore_;
+  Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem);
+  scm_gc_unprotect_object (elem->self_scm ());
 }
 
 void
@@ -58,16 +124,31 @@ System::output_lines ()
   for (SCM s = get_grob_property ("all-elements");
        gh_pair_p (s); s = ly_cdr (s))
     {
-      unsmob_grob (ly_car (s))->do_break_processing ();
+      Grob * g = unsmob_grob (ly_car (s));
+      if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
+       {
+         /*
+           Kill no longer needed grobs. 
+          */
+         Item * it = dynamic_cast<Item*> (g);
+         if (it && Item::breakable_b(it))
+           {
+             it->find_prebroken_piece (LEFT)->suicide();
+             it->find_prebroken_piece (RIGHT)->suicide();
+           }
+         g->suicide ();
+       }
+      else if (g->live ())
+       g->do_break_processing ();
     }
 
   /*
     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_into_l_arr_.size (); i++)
+  for (int i=0; i < broken_intos_.size (); i++)
     {
-      Grob *se = broken_into_l_arr_[i];
+      Grob *se = broken_intos_[i];
       SCM all = se->get_grob_property ("all-elements");
       for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
        {
@@ -89,34 +170,51 @@ System::output_lines ()
     }
   handle_broken_dependencies ();
 
+  /*
+    Because the this->get_grob_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. uniquify_list() makes
+    sure that no duplicates are in the list.
+   */
+  for (int i=0; i < broken_intos_.size (); i++)
+    {
+      /*
+       don't do this: strange side effects.
+       */
+      //    SCM al = broken_intos_[i]->get_grob_property ("all-elements");
+      //      al  = uniquify_list (al); 
+    }
+  
   if (verbose_global_b)
     progress_indication (_f ("Element count %d.",  count + element_count ()));
 
   
-  for (int i=0; i < broken_into_l_arr_.size (); i++)
+  for (int i=0; i < broken_intos_.size (); i++)
     {
-      System *line_l = dynamic_cast<System*> (broken_into_l_arr_[i]);
+      System *system = dynamic_cast<System*> (broken_intos_[i]);
 
       if (verbose_global_b)
        progress_indication ("[");
-      line_l->post_processing (i+1 == broken_into_l_arr_.size ());
+      bool last = i+1 == broken_intos_.size ();
+      system->post_processing (last);
 
       if (verbose_global_b)
        {
-         progress_indication (to_str (i));
+         progress_indication (to_string (i));
          progress_indication ("]");
        }
 
-      if (i < broken_into_l_arr_.size () - 1)
+      if (i < broken_intos_.size () - 1)
        {
-         SCM lastcol =  ly_car (line_l->get_grob_property ("columns"));
+         SCM lastcol =  ly_car (system->get_grob_property ("columns"));
          Grob*  e = unsmob_grob (lastcol);
 
          SCM between = ly_symbol2scm ("between-system-string");
          SCM inter = e->internal_get_grob_property (between);
          if (gh_string_p (inter))
            {
-             pscore_l_->outputter_l_
+             pscore_->outputter_
                ->output_scheme (scm_list_n (between, 
                                             inter, SCM_UNDEFINED));          
            }
@@ -139,9 +237,8 @@ set_loose_columns (System* which, Column_x_positions const *posns)
       Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
       Paper_column* col = dynamic_cast<Paper_column*> (loose);
       
-      if (col->line_l_)
+      if (col->system_)
        continue;
-
       
       Item * left = 0;
       Item * right = 0;
@@ -160,40 +257,19 @@ set_loose_columns (System* which, Column_x_positions const *posns)
          
          if (!left && l)
            {
-             left = l->column_l ();
+             left = l->get_column ();
+             if (!left->get_system ())
+               left = left->find_prebroken_piece (RIGHT);
            }
 
          divide_over ++;
-
-         loose = right = r->column_l ();
+         loose = right = r->get_column ();
        }
       while (1);
-      
-    
-#if 0
-      Real rx = right->relative_coordinate (right->get_parent (X_AXIS), X_AXIS);
-      Real lx = left->relative_coordinate (left->get_parent (X_AXIS), X_AXIS);
-
-      /*
-       divide space equally over loose columns.
-       */
-      int j = 1;
-      loose = col;
-      while (1)
-       {
-         SCM between = loose->get_grob_property ("between-cols");
-         if (!gh_pair_p (between))
-           break;
-
-         Paper_column *thiscol = dynamic_cast<Paper_column*> (loose);
 
-         thiscol->line_l_ = which;
-         thiscol->translate_axis (lx + j*(rx - lx)/divide_over, X_AXIS);
-
-         j ++; 
-         loose = dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
-       }
-#else
+      if (!right->get_system ())
+       right = right->find_prebroken_piece (LEFT);
+      
       /*
        We divide the remaining space of the column over the left and
        right side. At the moment, we  
@@ -202,7 +278,7 @@ set_loose_columns (System* which, Column_x_positions const *posns)
       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 lx = left->extent(common, X_AXIS)[RIGHT];
       Real total_dx = rx - lx;
       Interval cval =col->extent (col, X_AXIS);
 
@@ -229,9 +305,9 @@ set_loose_columns (System* which, Column_x_positions const *posns)
       else
        dx *= 0.5;
 
-      col->line_l_ = which;
+      col->system_ = which;
+      col->translate_axis (- col->relative_coordinate (common, X_AXIS), X_AXIS);
       col->translate_axis (lx + dx - cval[LEFT], X_AXIS); 
-#endif
     }
 }
 
@@ -241,29 +317,27 @@ System::break_into_pieces (Array<Column_x_positions> const &breaking)
 {
   for (int i=0; i < breaking.size (); i++)
     {
-      System *line_l = dynamic_cast <System*> (clone ());
-      line_l->rank_i_ = i;
-      //      line_l->set_immutable_grob_property ("rank", gh_int2scm (i));
+      System *system = dynamic_cast <System*> (clone ());
+      system->rank_ = i;
+
       Link_array<Grob> c (breaking[i].cols_);
-      pscore_l_->typeset_line (line_l);
+      pscore_->typeset_line (system);
       
-      line_l->set_bound (LEFT,c[0]);
-      line_l->set_bound (RIGHT,c.top ());
+      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])->line_l_ = line_l;
+         dynamic_cast<Paper_column*> (c[j])->system_ = system;
        }
-      set_loose_columns (line_l, &breaking[i]);
-      broken_into_l_arr_.push (line_l);
+      set_loose_columns (system, &breaking[i]);
+      broken_intos_.push (system);
     }
 }
 
-
 void
 System::output_molecule (SCM expr, Offset o)
 {
-
   while (1)
     {
       if (!gh_pair_p (expr))
@@ -274,9 +348,8 @@ System::output_molecule (SCM expr, Offset o)
        {
          Input * ip = unsmob_input (head);
       
-
-         pscore_l_->outputter_l_->output_scheme (scm_list_n (ly_symbol2scm ("define-origin"),
-                                                          ly_str02scm (ip->file_str ().ch_C ()),
+         pscore_->outputter_->output_scheme (scm_list_n (ly_symbol2scm ("define-origin"),
+                                                          scm_makfrom0str (ip->file_string ().to_str0 ()),
                                                           gh_int2scm (ip->line_number ()),
                                                           gh_int2scm (ip->column_number ()),
                                                           SCM_UNDEFINED));
@@ -284,7 +357,7 @@ System::output_molecule (SCM expr, Offset o)
        }
       else  if (head ==  ly_symbol2scm ("no-origin"))
        {
-         pscore_l_->outputter_l_->output_scheme (scm_list_n (head, SCM_UNDEFINED));
+         pscore_->outputter_->output_scheme (scm_list_n (head, SCM_UNDEFINED));
          expr = ly_cadr (expr);
        }
       else if (head == ly_symbol2scm ("translate-molecule"))
@@ -299,7 +372,7 @@ System::output_molecule (SCM expr, Offset o)
        }
       else
        {
-         pscore_l_->outputter_l_->
+         pscore_->outputter_->
            output_scheme (scm_list_n (ly_symbol2scm ("placebox"),
                                    gh_double2scm (o[X_AXIS]),
                                    gh_double2scm (o[Y_AXIS]),
@@ -314,7 +387,7 @@ System::output_molecule (SCM expr, Offset o)
 void
 System::output_scheme (SCM s)
 {
-  pscore_l_->outputter_l_->output_scheme (s);
+  pscore_->outputter_->output_scheme (s);
 }
 
 void
@@ -324,18 +397,13 @@ System::add_column (Paper_column*p)
   SCM cs = me->get_grob_property ("columns");
   Grob * prev =  gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
 
-  p->rank_i_ = prev ? Paper_column::rank_i (prev) + 1 : 0; 
+  p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0; 
 
   me->set_grob_property ("columns",  gh_cons (p->self_scm (), cs));
 
   Axis_group_interface::add_element (me, p);
 }
 
-
-
-/*
-  TODO: use scm_map iso. for loops.
- */
 void
 System::pre_processing ()
 {
@@ -343,7 +411,7 @@ System::pre_processing ()
     unsmob_grob (ly_car (s))->discretionary_processing ();
 
   if (verbose_global_b)
-    progress_indication (_f ("Element count %d ",  element_count ()));
+    progress_indication (_f ("Grob count %d ",  element_count ()));
 
   
   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
@@ -357,7 +425,7 @@ System::pre_processing ()
       sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
     }
   
-  progress_indication ("\n" + _ ("Calculating column positions...") + " ");
+  progress_indication ("\n" + _ ("Calculating line breaks...") + " ");
   for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
     {
       Grob * e = unsmob_grob (ly_car (s));
@@ -367,6 +435,11 @@ System::pre_processing ()
     }
 }
 
+
+  const int LAYER_COUNT= 3;
+
+
+
 void
 System::post_processing (bool last_line)
 {
@@ -379,7 +452,7 @@ System::post_processing (bool last_line)
     }
 
   Interval i (extent (this, Y_AXIS));
-  if (i.empty_b ())
+  if (i.is_empty ())
     programming_error ("Huh?  Empty System?");
   else
     translate_axis (- i[MAX], Y_AXIS);
@@ -395,15 +468,27 @@ System::post_processing (bool last_line)
     generate all molecules  to trigger all font loads.
 
     (ugh. This is not very memory efficient.)  */
+
+  SCM all = get_grob_property ("all-elements")  ;
+  all = uniquify_list (all);
+
+  /*
+    triger font loads first.
+
+    This might seem inefficient, but Molecules are cached per grob
+    anyway.
+    */
   this->get_molecule();
-  for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
+  for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
     {
-      unsmob_grob (ly_car (s))->get_molecule ();
+      Grob * g = unsmob_grob (ly_car (s));
+      g->get_molecule ();
     }
+  
   /*
     font defs;
    */
-  SCM font_names = ly_quote_scm (paper_l ()->font_descriptions ());  
+  SCM font_names = ly_quote_scm (get_paper ()->font_descriptions ());  
   output_scheme (scm_list_n (ly_symbol2scm ("define-fonts"),
                             font_names,
                             SCM_UNDEFINED));
@@ -411,13 +496,16 @@ System::post_processing (bool last_line)
   /*
     line preamble.
    */
+  Interval j (extent (this, X_AXIS));
+  Real length = j[RIGHT];
+    
   output_scheme (scm_list_n (ly_symbol2scm ("start-system"),
+                         gh_double2scm (length),
                          gh_double2scm (height),
                          SCM_UNDEFINED));
   
   /* Output elements in three layers, 0, 1, 2.
      The default layer is 1. */
-
   {
     Molecule *m = this->get_molecule();
     if (m)
@@ -444,8 +532,10 @@ System::post_processing (bool last_line)
        SCM e = sc->get_grob_property ("extra-offset");
        if (gh_pair_p (e))
          {
-           o[X_AXIS] += gh_scm2double (ly_car (e));
-           o[Y_AXIS] += gh_scm2double (ly_cdr (e));      
+           Offset z = ly_scm2offset (e);
+           z *= Staff_symbol_referencer::staff_space (sc);
+           
+           o += z;
          }
        
        output_molecule (m->get_expr (), o);
@@ -469,8 +559,8 @@ System::broken_col_range (Item const*l, Item const*r) const
 {
   Link_array<Item> ret;
 
-  l = l->column_l ();
-  r = r->column_l ();
+  l = l->get_column ();
+  r = r->get_column ();
   SCM s = get_grob_property ("columns");
 
   while (gh_pair_p (s) && ly_car (s) != r->self_scm ())
@@ -482,7 +572,7 @@ System::broken_col_range (Item const*l, Item const*r) const
   while (gh_pair_p (s) && ly_car (s) != l->self_scm ())
     {
       Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
-      if (Item::breakable_b (c) && !c->line_l_)
+      if (Item::breakable_b (c) && !c->system_)
        ret.push (c);
 
       s = ly_cdr (s);
@@ -497,7 +587,7 @@ System::broken_col_range (Item const*l, Item const*r) const
    disrupt the spacing problem.
  */
 Link_array<Grob>
-System::column_l_arr ()const
+System::columns ()const
 {
   Link_array<Grob> acs
     = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
@@ -522,11 +612,11 @@ System::column_l_arr ()const
 
 
 ADD_INTERFACE (System,"system-interface",
-  "Super grob, parent of all:
-
-The columns of a score that form one line.  The toplevel grob.  Any
-grob has a Line_of_score as both X and Y reference point. The
-Paper_score contains one grob of this type. Control enters the
-Grob dependency calculation from this single Line_of_score
-object.",
+  "Super grob, parent of all: "
+"\n\n"
+"The columns of a score that form one line.  The toplevel grob.  Any "
+"grob has a Line_of_score as both X and Y reference point. The "
+"Paper_score contains one grob of this type. Control enters the "
+"Grob dependency calculation from this single Line_of_score "
+"object.",
   "between-system-string all-elements columns");