]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/spacing-spanner.cc
*** empty log message ***
[lilypond.git] / lily / spacing-spanner.cc
index ba8fcc352e569ed7afb51c769aec0cc5e749aabb..97604610c26ac49398277f49658721f6c3c8c3a4 100644 (file)
@@ -3,20 +3,19 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1999--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #include <math.h>
-#include <stdio.h>
+#include <cstdio>
 
 #include "main.hh"
 #include "system.hh"
 #include "warn.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
 #include "paper-score.hh"
 #include "paper-column.hh"
-#include "item.hh"
 #include "moment.hh"
 #include "note-spacing.hh"
 #include "misc.hh"
@@ -28,7 +27,6 @@
 #include "break-align-interface.hh"
 #include "spacing-interface.hh"
 
-
 /*
   TODO: this file/class is too complex. Should figure out how to chop
   this up even more.
@@ -42,18 +40,18 @@ public:
                                                 Real * fixed, Real * space, Moment);
   
 
-  static Real default_bar_spacing (Grob*,Grob*,Grob*,Moment);
-  static Real note_spacing (Grob*,Grob*,Grob*,Moment, bool*);
-  static Real get_duration_space (Grob*,Moment dur, Rational shortest, bool*);
+  static Real default_bar_spacing (Grob*, Grob*, Grob*, Moment);
+  static Real note_spacing (Grob*, Grob*, Grob*, Moment, bool*);
+  static Real get_duration_space (Grob*, Moment dur, Rational shortest, bool*);
   static Rational find_shortest (Grob *, Link_array<Grob> const &);  
   static void breakable_column_spacing (Grob*, Item* l, Item *r, Moment);
   static void find_loose_columns () {}
-  static void prune_loose_columns (Grob*,Link_array<Grob> *cols, Rational);
+  static void prune_loose_columns (Grob*, Link_array<Grob> *cols, Rational);
   static void find_loose_columns (Link_array<Grob> cols);
   static void set_explicit_neighbor_columns (Link_array<Grob> cols);
   static void set_implicit_neighbor_columns (Link_array<Grob> cols);
-  static void do_measure (Rational, Grob*me,Link_array<Grob> *cols);
-  static void musical_column_spacing (Grob*,Item*,Item*, Real, Rational); 
+  static void do_measure (Rational, Grob*me, Link_array<Grob> *cols);
+  static void musical_column_spacing (Grob*, Item*, Item*, Real, Rational); 
   DECLARE_SCHEME_CALLBACK (set_springs, (SCM ));
   static bool has_interface (Grob*);
 };
@@ -96,11 +94,11 @@ loose_column (Grob *l, Grob *c, Grob *r)
     such a borderline case.)
     
   */  
-  if (!gh_pair_p (lns) || !gh_pair_p (rns))
+  if (!scm_is_pair (lns) || !scm_is_pair (rns))
     return false;
 
-  Item * l_neighbor = dynamic_cast<Item*>  (unsmob_grob (gh_car (lns)));
-  Item * r_neighbor = dynamic_cast<Item*>  (unsmob_grob (gh_car (rns)));
+  Item * l_neighbor = dynamic_cast<Item*>  (unsmob_grob (scm_car (lns)));
+  Item * r_neighbor = dynamic_cast<Item*>  (unsmob_grob (scm_car (rns)));
 
   if (!l_neighbor || !r_neighbor)
     return false;
@@ -121,7 +119,7 @@ loose_column (Grob *l, Grob *c, Grob *r)
     some cases (two isolated, consecutive clef changes) won't be
     nicely folded, but hey, then don't do that.
   */
-  if(!  ((Paper_column::is_musical (l_neighbor) || Item::is_breakable (l_neighbor))
+  if (!  ((Paper_column::is_musical (l_neighbor) || Item::is_breakable (l_neighbor))
         && (Paper_column::is_musical (r_neighbor) || Item::is_breakable (r_neighbor))) )
     {
       return false;
@@ -133,19 +131,19 @@ loose_column (Grob *l, Grob *c, Grob *r)
 
     in any case, we don't want to move bar lines.
    */
-  for (SCM e = c->get_property ("elements"); gh_pair_p (e); e = gh_cdr (e))
+  for (SCM e = c->get_property ("elements"); scm_is_pair (e); e = scm_cdr (e))
     {
-      Grob * g = unsmob_grob (gh_car (e));
+      Grob * g = unsmob_grob (scm_car (e));
       if (g && Break_align_interface::has_interface (g))
        {
-         for (SCM s = g->get_property ("elements"); gh_pair_p (s);
-              s = gh_cdr (s))
+         for (SCM s = g->get_property ("elements"); scm_is_pair (s);
+              s = scm_cdr (s))
            {
-             Grob *h = unsmob_grob (gh_car (s));
+             Grob *h = unsmob_grob (scm_car (s));
 
              /*
                ugh. -- fix staff-bar name? 
-              */
+             */
              if (h  && h->get_property ("break-align-symbol") == ly_symbol2scm ("staff-bar"))
                return false;
            }
@@ -161,43 +159,43 @@ loose_column (Grob *l, Grob *c, Grob *r)
   between.
 */
 void
-Spacing_spanner::prune_loose_columns (Grob*me,Link_array<Grob> *cols, Rational shortest)
+Spacing_spanner::prune_loose_columns (Grob*me, Link_array<Grob> *cols, Rational shortest)
 {
   Link_array<Grob> newcols;
   Real increment = robust_scm2double (me->get_property ("spacing-increment"), 1.2);
-  for (int i=0; i < cols->size ();  i++)
+  for (int i = 0; i < cols->size ();  i++)
     {
-      if (Item::is_breakable (cols->elem(i)) || Paper_column::is_musical (cols->elem (i)))
+      if (Item::is_breakable (cols->elem (i)) || Paper_column::is_musical (cols->elem (i)))
        {
-         newcols.push (cols->elem(i));
+         newcols.push (cols->elem (i));
          continue;
        }
 
-      Grob *c = cols->elem(i);
+      Grob *c = cols->elem (i);
       if (loose_column (cols->elem (i-1), c, cols->elem (i+1)))
        {
          SCM lns = c->get_property ("left-neighbors");
-         lns = gh_pair_p (lns) ? gh_car (lns) : SCM_BOOL_F;
+         lns = scm_is_pair (lns) ? scm_car (lns) : SCM_BOOL_F;
 
          SCM rns = c->get_property ("right-neighbors");
-         rns = gh_pair_p (rns) ? gh_car (rns) : SCM_BOOL_F;
+         rns = scm_is_pair (rns) ? scm_car (rns) : SCM_BOOL_F;
 
          /*
            Either object can be non existent, if the score ends
            prematurely.
-          */
-         rns = gh_car (unsmob_grob (rns)->get_property ("right-items"));
-         c->set_property ("between-cols", gh_cons (lns,
-                                                        rns));
+         */
+         rns = scm_car (unsmob_grob (rns)->get_property ("right-items"));
+         c->set_property ("between-cols", scm_cons (lns,
+                                                    rns));
 
          /*
            Set distance constraints for loose columns
          */
          Drul_array<Grob*> next_door;
-         next_door[LEFT] =cols->elem (i - 1);
-         next_door[RIGHT] =cols->elem (i + 1);   
+         next_door[LEFT] = cols->elem (i - 1);
+         next_door[RIGHT] = cols->elem (i + 1);          
          Direction d = LEFT;
-         Drul_array<Real> dists(0,0);
+         Drul_array<Real> dists (0, 0);
 
          do
            {
@@ -206,9 +204,9 @@ Spacing_spanner::prune_loose_columns (Grob*me,Link_array<Grob> *cols, Rational s
              Item *rc = dynamic_cast<Item*> (d == LEFT  ? c : next_door[RIGHT]);
 
              for (SCM s = lc->get_property ("spacing-wishes");
-                  gh_pair_p (s); s = gh_cdr (s))
+                  scm_is_pair (s); s = scm_cdr (s))
                {
-                 Grob *sp = unsmob_grob (gh_car (s));
+                 Grob *sp = unsmob_grob (scm_car (s));
                  if (Note_spacing::left_column (sp) != lc
                      || Note_spacing::right_column (sp) != rc)
                    continue;
@@ -246,7 +244,7 @@ Spacing_spanner::prune_loose_columns (Grob*me,Link_array<Grob> *cols, Rational s
 
          Rod r;
          r.distance_ = dists[LEFT] + dists[RIGHT];
-         r.item_l_drul_[LEFT] = dynamic_cast<Item*> (cols->elem(i-1));
+         r.item_l_drul_[LEFT] = dynamic_cast<Item*> (cols->elem (i-1));
          r.item_l_drul_[RIGHT] = dynamic_cast<Item*> (cols->elem (i+1));
 
          r.add_to_cols ();
@@ -266,16 +264,16 @@ Spacing_spanner::prune_loose_columns (Grob*me,Link_array<Grob> *cols, Rational s
 void
 Spacing_spanner::set_explicit_neighbor_columns (Link_array<Grob> cols)
 {
-  for (int i=0; i < cols.size(); i++)
+  for (int i = 0; i < cols.size (); i++)
     {
       SCM right_neighbors = SCM_EOL;
       int min_rank = 100000;   // inf.
 
 
-      SCM wishes=  cols[i]->get_property ("spacing-wishes");
-      for (SCM s =wishes; gh_pair_p (s); s = gh_cdr (s))
+      SCM wishes =  cols[i]->get_property ("spacing-wishes");
+      for (SCM s = wishes; scm_is_pair (s); s = scm_cdr (s))
        {
-         Item * wish = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
+         Item * wish = dynamic_cast<Item*> (unsmob_grob (scm_car (s)));
 
          Item * lc = wish->get_column ();
          Grob * right = Note_spacing::right_column (wish);
@@ -290,25 +288,25 @@ Spacing_spanner::set_explicit_neighbor_columns (Link_array<Grob> cols)
 
          /*
            update the left column.
-          */
+         */
          if (right_rank <= min_rank)
            {
              if (right_rank < min_rank)
-               right_neighbors  =SCM_EOL;
+               right_neighbors  = SCM_EOL;
              
              min_rank = right_rank;
-             right_neighbors = gh_cons (wish->self_scm (), right_neighbors);
+             right_neighbors = scm_cons (wish->self_scm (), right_neighbors);
            }
 
          /*
            update the right column of the wish.
-          */
+         */
          int maxrank = 0;
          SCM left_neighs = rc->get_property ("left-neighbors");
-         if (gh_pair_p (left_neighs)
-             && unsmob_grob (gh_car (left_neighs)))
+         if (scm_is_pair (left_neighs)
+             && unsmob_grob (scm_car (left_neighs)))
            {
-             Item * it = dynamic_cast<Item*> (unsmob_grob (gh_car (left_neighs)));
+             Item * it = dynamic_cast<Item*> (unsmob_grob (scm_car (left_neighs)));
              maxrank = Paper_column::get_rank (it->get_column ());
            }
 
@@ -317,12 +315,12 @@ Spacing_spanner::set_explicit_neighbor_columns (Link_array<Grob> cols)
              if (left_rank > maxrank)
                left_neighs = SCM_EOL;
 
-             left_neighs = gh_cons (wish->self_scm (), left_neighs);
+             left_neighs = scm_cons (wish->self_scm (), left_neighs);
              rc->set_property ("left-neighbors", right_neighbors);
            }
        }
 
-      if (gh_pair_p (right_neighbors))
+      if (scm_is_pair (right_neighbors))
        {
          cols[i]->set_property ("right-neighbors", right_neighbors);
        }
@@ -346,28 +344,31 @@ Spacing_spanner::set_implicit_neighbor_columns (Link_array<Grob> cols)
 
       /*
        sloppy with typnig left/right-neighbors should take list, but paper-column found instead.
-       */
+      */
       SCM ln = cols[i] ->get_property ("left-neighbors");
-      if (!gh_pair_p (ln) && i ) 
+      if (!scm_is_pair (ln) && i ) 
        {
-         cols[i]->set_property ("left-neighbors", gh_cons (cols[i-1]->self_scm(), SCM_EOL));
+         cols[i]->set_property ("left-neighbors", scm_cons (cols[i-1]->self_scm (), SCM_EOL));
        }
 
       SCM rn = cols[i] ->get_property ("right-neighbors");
-      if (!gh_pair_p (rn) && i < cols.size () - 1) 
+      if (!scm_is_pair (rn) && i < cols.size () - 1) 
        {
-         cols[i]->set_property ("right-neighbors", gh_cons (cols[i + 1]->self_scm(), SCM_EOL));
+         cols[i]->set_property ("right-neighbors", scm_cons (cols[i + 1]->self_scm (), SCM_EOL));
        }
     }
 }
 
 
-MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs,1);
+MAKE_SCHEME_CALLBACK (Spacing_spanner, set_springs, 1);
 SCM
 Spacing_spanner::set_springs (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
 
+  /*
+    can't use get_system() ? --hwn.
+  */
   Link_array<Grob> all (me->pscore_->system_->columns ());
 
   set_explicit_neighbor_columns (all);
@@ -381,10 +382,8 @@ Spacing_spanner::set_springs (SCM smob)
   else
     {
       global_shortest = find_shortest (me, all);
-      if (verbose_global_b)
-       {
-         progress_indication (_f("Global shortest duration is %s\n", global_shortest.to_string ())); 
-       }
+      if (be_verbose_global)
+       progress_indication (_f ("Global shortest duration is %s", global_shortest.to_string ()) + "\n");
     }
   prune_loose_columns (me, &all, global_shortest);
   set_implicit_neighbor_columns (all);
@@ -421,14 +420,14 @@ Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
 {
   /*
     ascending in duration
-   */
+  */
   Array<Rational> durations; 
   Array<int> counts;
   
   Rational shortest_in_measure;
   shortest_in_measure.set_infinite (1);
   
-  for (int i =0 ; i < cols.size (); i++)  
+  for (int i = 0 ; i < cols.size (); i++)  
     {
       if (Paper_column::is_musical (cols[i]))
        {
@@ -442,14 +441,14 @@ Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
          
          SCM  st = cols[i]->get_property ("shortest-starter-duration");
          Moment this_shortest = *unsmob_moment (st);
-         assert (this_shortest.to_bool());
+         assert (this_shortest.to_bool ());
          shortest_in_measure = shortest_in_measure <? this_shortest.main_part_;
        }
       else if (!shortest_in_measure.is_infinity ()
               && Item::is_breakable (cols[i]))
        {
          int j = 0;
-         for (; j < durations.size(); j++)
+         for (; j < durations.size (); j++)
            {
              if (durations[j] > shortest_in_measure)
                {
@@ -464,19 +463,19 @@ Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
                }
            }
 
-         if (durations.size() == j)
+         if (durations.size () == j)
            {
              durations.push (shortest_in_measure);
              counts.push (1);
            }
 
-         shortest_in_measure.set_infinite(1); 
+         shortest_in_measure.set_infinite (1); 
        }
     }
 
   int max_idx = -1;
   int max_count = 0;
-  for (int i =durations.size(); i--;)
+  for (int i = durations.size (); i--;)
     {
       if (counts[i] >= max_count)
        {
@@ -488,7 +487,7 @@ Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
     }
 
   SCM  bsd = me->get_property ("base-shortest-duration");
-  Rational d = Rational (1,8);
+  Rational d = Rational (1, 8);
   if (Moment *m = unsmob_moment (bsd))
     d = m->main_part_;
   
@@ -505,11 +504,12 @@ Spacing_spanner::find_shortest (Grob *me, Link_array<Grob> const &cols)
   (different time sigs) than others, and should be spaced differently.
  */
 void
-Spacing_spanner::do_measure (Rational global_shortest, Grob*me, Link_array<Grob> *cols) 
+Spacing_spanner::do_measure (Rational global_shortest, Grob*me,
+                            Link_array<Grob> *cols) 
 {
 
   Real headwid = robust_scm2double (me->get_property ("spacing-increment"), 1);
-  for (int i= 0; i < cols->size () - 1; i++)
+  for (int i = 0; i < cols->size () - 1; i++)
     {
       Item * l = dynamic_cast<Item*> (cols->elem (i));
       Item * r =  dynamic_cast<Item*> (cols->elem (i+1));
@@ -532,24 +532,22 @@ Spacing_spanner::do_measure (Rational global_shortest, Grob*me, Link_array<Grob>
          Item *rb = r->find_prebroken_piece (LEFT);
          
          if (lb)
-           breakable_column_spacing (me, lb,r, global_shortest);
+           breakable_column_spacing (me, lb, r, global_shortest);
 
          if (rb)
            breakable_column_spacing (me, l, rb, global_shortest);
          if (lb && rb)
            breakable_column_spacing (me, lb, rb, global_shortest);
-         
-         continue ; 
        }
-
-
-      musical_column_spacing (me, lc, rc, headwid, global_shortest);
-      if (Item *rb = r->find_prebroken_piece (LEFT))
-       musical_column_spacing (me, lc, rb, headwid, global_shortest);
-    }    
+      else
+       {
+         musical_column_spacing (me, lc, rc, headwid, global_shortest);
+         if (Item *rb = r->find_prebroken_piece (LEFT))
+           musical_column_spacing (me, lc, rb, headwid, global_shortest);
+       }    
+    }
 }
 
-
 /*
   Generate the space between two musical columns LC and RC, given
   spacing parameters INCR and SHORTEST.
@@ -571,9 +569,9 @@ Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real inc
     happens after the current note (this is set in the grob
     property SPACING-SEQUENCE.
   */
-  for (SCM s = seq; gh_pair_p (s); s = ly_cdr (s))
+  for (SCM s = seq; scm_is_pair (s); s = scm_cdr (s))
     {
-      Grob * wish = unsmob_grob (gh_car (s));
+      Grob * wish = unsmob_grob (scm_car (s));
 
       Item *wish_rcol = Note_spacing::right_column (wish);
       if (Note_spacing::left_column (wish) != lc
@@ -585,8 +583,8 @@ Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real inc
        music.  */
       if (Note_spacing::has_interface (wish))
        {
-         Real space =0.0;
-         Real fixed =0.0;
+         Real space = 0.0;
+         Real fixed = 0.0;
          
          Note_spacing::get_spacing (wish, rc, base_note_space, increment, &space, &fixed);
 
@@ -627,7 +625,7 @@ Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real inc
   */
   compound_fixed_note_space = compound_fixed_note_space <? compound_note_space;
 
-  bool packed = to_boolean (me->get_paper ()->get_scmvar ("packed"));
+  bool packed = to_boolean (me->get_layout ()->c_variable ("packed"));
   Real strength, distance;
 
   /*
@@ -653,9 +651,7 @@ Spacing_spanner::musical_column_spacing (Grob *me, Item * lc, Item *rc, Real inc
       distance = compound_note_space;
     }
 
-  //  Spaceable_grob::add_spring (lc, rc, distance, strength, expand_only);
-
-  Spaceable_grob::add_spring (lc, rc, distance, strength, false);  
+  Spaceable_grob::add_spring (lc, rc, distance, strength);  
 }
 
 
@@ -670,7 +666,7 @@ Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
 {
   *fixed = 0.0;
   Direction d = LEFT;
-  Drul_array<Item*> cols(l,r);
+  Drul_array<Item*> cols (l, r);
   
   do
     {
@@ -703,7 +699,7 @@ Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
     {
       Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
 
-      if (dt == Moment (0,0))
+      if (dt == Moment (0, 0))
        {
          /*
            In this case, Staff_spacing should handle the job,
@@ -724,7 +720,7 @@ Spacing_spanner::standard_breakable_column_spacing (Grob * me, Item*l, Item*r,
   Read hints from L and generate springs.
 */
 void
-Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shortest)
+Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r, Moment shortest)
 {
   Real compound_fixed = 0.0;
   Real compound_space = 0.0;
@@ -732,12 +728,12 @@ Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shor
 
   Moment dt = Paper_column::when_mom (r) - Paper_column::when_mom (l);
 
-  if (dt == Moment (0,0))
+  if (dt == Moment (0, 0))
     {
       for (SCM s = l->get_property ("spacing-wishes");
-          gh_pair_p (s); s = gh_cdr (s))
+          scm_is_pair (s); s = scm_cdr (s))
        {
-         Item * spacing_grob = dynamic_cast<Item*> (unsmob_grob (gh_car (s)));
+         Item * spacing_grob = dynamic_cast<Item*> (unsmob_grob (scm_car (s)));
 
          if (!spacing_grob || !Staff_spacing::has_interface (spacing_grob))
            continue;
@@ -765,7 +761,6 @@ Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shor
              space *= 0.8;
            }
 
-
          compound_space += space;
          compound_fixed += fixed_space;
          wish_count ++ ;
@@ -802,7 +797,7 @@ Spacing_spanner::breakable_column_spacing (Grob*me, Item* l, Item *r,Moment shor
    */
   Real strength = 1 / (compound_space - compound_fixed);
   Real distance = compound_space;
-  Spaceable_grob::add_spring (l, r, distance, strength, false);
+  Spaceable_grob::add_spring (l, r, distance, strength);
 }
 
 
@@ -840,7 +835,7 @@ Spacing_spanner::get_duration_space (Grob*me, Moment d, Rational shortest, bool
   else
     {
       /*
-         John S. Gourlay. ``Spacing a Line of Music,'' Technical
+         John S. Gourlay. ``Spacing a Line of Music, '' Technical
          Report OSU-CISRC-10/87-TR35, Department of Computer and
          Information Science, The Ohio State University, 1987.
        */
@@ -927,7 +922,7 @@ Spacing_spanner::note_spacing (Grob*me, Grob *lc, Grob *rc,
 
 
 
-ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface",
+ADD_INTERFACE (Spacing_spanner, "spacing-spanner-interface",
 "The space taken by a note is dependent on its duration. Doubling a\n"
 "duration adds spacing-increment to the space. The most common shortest\n"
 "note gets @code{shortest-duration-space}. Notes that are even shorter are\n"
@@ -942,7 +937,7 @@ ADD_INTERFACE (Spacing_spanner,"spacing-spanner-interface",
 
 
 
-ADD_INTERFACE (Spacing_interface,"spacing-interface",
+ADD_INTERFACE (Spacing_interface, "spacing-interface",
   "Something to do with line breaking and spacing. Kill this one after determining line breaks.",
   "");