]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-spacing.cc
* lily/staff-symbol-engraver.cc (acknowledge_grob): remove item ->
[lilypond.git] / lily / note-spacing.cc
index de08af4efa24fd4d97f761159e1321bd4a3d4a8f..54a391a881776862221b794e8f40d963ed677aa6 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2003  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2001--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
 #include "separation-item.hh"
 #include "staff-spacing.hh"
 #include "accidental-placement.hh"
-#include "paper-def.hh"
+#include "output-def.hh"
+
+
+/*
+
+TODO: detect hshifts due to collisions, and account for them in
+spacing?
+
+*/ 
 
 void
 Note_spacing::get_spacing (Grob *me, Item* right_col,
                           Real base_space, Real increment, Real *space, Real *fixed)
 {
 
-  Drul_array<SCM> props(me->get_grob_property ("left-items"),
-                       me->get_grob_property ("right-items"));
+  Drul_array<SCM> props (me->get_property ("left-items"),
+                       me->get_property ("right-items"));
   Direction d = LEFT;
   Direction col_dir =  right_col->break_status_dir ();
   Drul_array<Interval> extents;
@@ -34,9 +42,9 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
   Interval left_head_wid; 
   do
     {
-      for (SCM  s = props[d]; gh_pair_p (s); s = gh_cdr (s))
+      for (SCM  s = props[d]; ly_c_pair_p (s); s = ly_cdr (s))
        {
-         Item * it= dynamic_cast<Item*> (unsmob_grob (gh_car(s)));
+         Item * it= dynamic_cast<Item*> (unsmob_grob (ly_car (s)));
          
          if (d == RIGHT && it->break_status_dir () != col_dir)
            {
@@ -62,7 +70,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
 
          if (d == LEFT)
            {
-             SCM r = it->get_grob_property ("rest");
+             SCM r = it->get_property ("rest");
              Grob * g = unsmob_grob (r);
              if (!g)
                g =  Note_column::first_head (it);
@@ -72,7 +80,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
                first note head will be.
               */
              if (g)
-               left_head_wid = g->extent(it_col, X_AXIS);
+               left_head_wid = g->extent (it_col, X_AXIS);
            }
          
          extents[d].unite (it->extent (it_col, X_AXIS));
@@ -92,7 +100,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
            }
        }
 
-      if (extents[d].empty_b ())
+      if (extents[d].is_empty ())
        extents[d] = Interval (0,0);
     }
   while (flip (&d) != LEFT);
@@ -108,7 +116,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
     FIXED also includes the left part of the right object.
   */
   *fixed =
-    (left_head_wid.empty_b () ? increment :
+    (left_head_wid.is_empty () ? increment :
      /*
        Size of the head:
       */
@@ -122,7 +130,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
     /*
       What is sticking out of the right note:
      */
-    + (extents[RIGHT].empty_b() ?  0.0 : - extents[RIGHT][LEFT] / 2);
+    + (extents[RIGHT].is_empty () ?  0.0 : - extents[RIGHT][LEFT] / 2);
 
   /*
     We don't do complicated stuff: (base_space - increment) is the
@@ -132,17 +140,22 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
    */
   *space = (base_space - increment) + *fixed ;
 
-  if (Item::breakable_b (right_col)
-      || right_col->original_)
+  if (!extents[RIGHT].is_empty ()
+      && (Item::is_breakable (right_col)
+         || right_col->original_))
     {
       /*
        This is for the situation
 
        rest | 3/4 (eol)
-       
+
+       Since we only take half of the right-object space above, the
+       barline will bump into the notes preceding it, if the right
+       thing is big. We add the rest of the extents here:
        */
-      *space += -extents[RIGHT][LEFT];
-      *fixed += -extents[RIGHT][LEFT];
+      
+      *space += -extents[RIGHT][LEFT] / 2;
+      *fixed += -extents[RIGHT][LEFT] / 2;
     }
   
   stem_dir_correction (me, right_col, increment, space, fixed);
@@ -151,7 +164,7 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
 Item *
 Note_spacing::left_column (Grob *me)
 {
-  if (!me->live())
+  if (!me->is_live ())
     return 0;
   
   return dynamic_cast<Item*> (me)->get_column ();
@@ -168,16 +181,16 @@ prune RIGHT-ITEMS.
 Item *
 Note_spacing::right_column (Grob*me)
 {
-  if (!me->live())
+  if (!me->is_live ())
     return 0;
   
-  SCM right = me->get_grob_property ("right-items");
+  SCM right = me->get_property ("right-items");
   Item *mincol = 0;
   int min_rank = INT_MAX;
   bool prune = false;
-  for (SCM s = right ; gh_pair_p (s) ; s = gh_cdr (s))
+  for (SCM s = right ; ly_c_pair_p (s) ; s = ly_cdr (s))
     {
-      Item * ri = unsmob_item (gh_car (s));
+      Item * ri = unsmob_item (ly_car (s));
 
       Item * col = ri->get_column ();
       int rank = Paper_column::get_rank (col);
@@ -196,20 +209,20 @@ Note_spacing::right_column (Grob*me)
     {
       // I'm a lazy bum. We could do this in-place.
       SCM newright  = SCM_EOL;
-      for (SCM s = right ; gh_pair_p (s) ; s =gh_cdr (s))
+      for (SCM s = right ; ly_c_pair_p (s) ; s =ly_cdr (s))
        {
-         if (unsmob_item (gh_car (s))->get_column () == mincol)
-           newright = gh_cons (gh_car (s), newright);
+         if (unsmob_item (ly_car (s))->get_column () == mincol)
+           newright = scm_cons (ly_car (s), newright);
        }
 
-      me->set_grob_property ("right-items", newright);
+      me->set_property ("right-items", newright);
     }
   
   if (!mincol)
     {
       /*
       int r = Paper_column::get_rank (dynamic_cast<Item*>(me)->get_column ());
-      programming_error (_f("Spacing wish column %d has no right item.", r));
+      programming_error (_f ("Spacing wish column %d has no right item.", r));
       */
 
       return 0;
@@ -231,14 +244,14 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
                                   Real increment,
                                   Real * space, Real *fixed)  
 {
-  Drul_array<Direction> stem_dirs(CENTER,CENTER);
+  Drul_array<Direction> stem_dirs (CENTER,CENTER);
   Drul_array<Interval> stem_posns;
   Drul_array<Interval> head_posns;  
-  Drul_array<SCM> props(me->get_grob_property ("left-items"),
-                       me->get_grob_property ("right-items"));
+  Drul_array<SCM> props (me->get_property ("left-items"),
+                       me->get_property ("right-items"));
 
-  Drul_array<Grob*> beams_drul(0,0);
-  Drul_array<Grob*> stems_drul(0,0);
+  Drul_array<Grob*> beams_drul (0,0);
+  Drul_array<Grob*> stems_drul (0,0);
   
   stem_dirs[LEFT] = stem_dirs[RIGHT] = CENTER;
   Interval intersect;
@@ -251,16 +264,16 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
   
   do
     {
-      for (SCM  s = props[d]; gh_pair_p (s); s = gh_cdr (s))
+      for (SCM  s = props[d]; ly_c_pair_p (s); s = ly_cdr (s))
        {
-         Item * it= dynamic_cast<Item*> (unsmob_grob (gh_car(s)));
+         Item * it= dynamic_cast<Item*> (unsmob_grob (ly_car (s)));
 
          if (d == RIGHT)
            acc_right = acc_right || Note_column::accidentals (it);
          
          Grob *stem = Note_column::get_stem (it);
 
-         if (!stem || !stem->live ())
+         if (!stem || !stem->is_live ())
            {
              if (d == RIGHT && Separation_item::has_interface (it))
                {
@@ -269,7 +282,7 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
                      it = it->find_prebroken_piece (rcolumn->break_status_dir ());
                    }
                  
-                 Grob *last = Staff_spacing::extremal_break_aligned_grob (it, LEFT, &bar_xextent);
+                 Grob *last = Separation_item::extremal_break_aligned_grob (it, LEFT, &bar_xextent);
 
                  if (last)
                    bar_yextent = Staff_spacing::bar_y_positions (last);
@@ -280,7 +293,7 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
              return ;
            }
          
-         if(Stem::invisible_b (stem))
+         if (Stem::is_invisible (stem))
            {
              correct_stem_dirs = false;
              continue;
@@ -312,7 +325,7 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
          Real chord_start = hp[sd];      
          Real stem_end = Stem::stem_end_position (stem);
          
-         stem_posns[d] = Interval(chord_start<?stem_end, chord_start>? stem_end);
+         stem_posns[d] = Interval (chord_start<?stem_end, chord_start>? stem_end);
          head_posns[d].unite (hp);
        }
     }
@@ -327,7 +340,7 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
 
   Real correction = 0.0;
 
-  if (!bar_yextent.empty_b())
+  if (!bar_yextent.is_empty ())
     {
       stem_dirs[RIGHT] = - stem_dirs[LEFT];
       stem_posns[RIGHT] = bar_yextent;
@@ -350,27 +363,26 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
            {
              head_extent = head->extent (rcolumn, X_AXIS);
 
-             if (!head_extent.empty_b())
+             if (!head_extent.is_empty ())
                note_head_width = head_extent[RIGHT];
 
              if (st)
                {
-                 Real thick = gh_scm2double (st->get_grob_property ("thickness"))
-                   * st->get_paper ()->get_realvar (ly_symbol2scm ("linethickness"));
+                 Real thick = Stem::thickness (st);
 
                  note_head_width -= thick;
                }
            }
 
          correction = note_head_width* stem_dirs[LEFT];
-         correction *= gh_scm2double (me->get_grob_property ("knee-spacing-correction"));
+         correction *= robust_scm2double (me->get_property ("knee-spacing-correction"), 0);
          *fixed += correction;
        }
       else
        {
          intersect = stem_posns[LEFT];  
-         intersect.intersect(stem_posns[RIGHT]);
-         correct_stem_dirs = correct_stem_dirs && !intersect.empty_b ();
+         intersect.intersect (stem_posns[RIGHT]);
+         correct_stem_dirs = correct_stem_dirs && !intersect.is_empty ();
 
          if (correct_stem_dirs)
            {
@@ -383,10 +395,10 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
              correction = (correction/7) <? 1.0;
              correction *= stem_dirs[LEFT] ;
              correction *=
-               gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+               robust_scm2double (me->get_property ("stem-spacing-correction"), 0);
            }
          
-         if (!bar_yextent.empty_b())
+         if (!bar_yextent.is_empty ())
            {
              correction *= 0.5;
            }
@@ -416,14 +428,14 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
       
       Interval hp = head_posns[LEFT];
       hp.intersect  (head_posns[RIGHT]);
-      if (!hp.empty_b())
+      if (!hp.is_empty ())
        return ;
 
       Direction lowest =
        (head_posns[LEFT][DOWN] > head_posns[RIGHT][UP]) ? RIGHT : LEFT;
 
       Real delta = head_posns[-lowest][DOWN] - head_posns[lowest][UP] ;
-      Real corr = gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+      Real corr = robust_scm2double (me->get_property ("stem-spacing-correction"), 0);
       corr =  (delta <= 1) ? 0.0 : 0.25;
       
       correction=  -lowest * corr ;
@@ -431,7 +443,7 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
 
   *space += correction;
 
-  /* there used to be a correction for bar_xextent() here, but
+  /* there used to be a correction for bar_xextent () here, but
      it's unclear what that was good for ?
   */
 
@@ -441,6 +453,6 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
 
 
 ADD_INTERFACE (Note_spacing,"note-spacing-interface",
-  "",
+  "This object calculates spacing wishes for individual voices.",
   "left-items right-items stem-spacing-correction knee-spacing-correction");