]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-spacing.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / note-spacing.cc
index f8924576e2699bed1a183bef8e55e1cd7eaeab9a..8586cc5f4cd209d6dd508117795eb587d61600d3 100644 (file)
@@ -1,13 +1,15 @@
-/*   
+/*
   note-spacing.cc -- implement Note_spacing
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2001--2006  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "note-spacing.hh"
 
+#include "directional-element-interface.hh"
+#include "grob-array.hh"
 #include "paper-column.hh"
 #include "moment.hh"
 #include "note-column.hh"
 #include "staff-spacing.hh"
 #include "accidental-placement.hh"
 #include "output-def.hh"
+#include "pointer-group-interface.hh"
 
 /*
-
-TODO: detect hshifts due to collisions, and account for them in
-spacing?
-
-*/ 
+  TODO: detect hshifts due to collisions, and account for them in
+  spacing?
+*/
 
 void
-Note_spacing::get_spacing (Grob *me, Itemright_col,
+Note_spacing::get_spacing (Grob *me, Item *right_col,
                           Real base_space, Real increment, Real *space, Real *fixed)
 {
-
-  Drul_array<SCM> props (me->get_property ("left-items"),
-                       me->get_property ("right-items"));
+  Drul_array<SCM> props (me->get_object ("left-items"),
+                        me->get_object ("right-items"));
   Direction d = LEFT;
-  Direction col_dir =  right_col->break_status_dir ();
+  Direction col_dir = right_col->break_status_dir ();
   Drul_array<Interval> extents;
 
-  Interval left_head_wid; 
+  Interval left_head_wid;
   do
     {
-      for (SCM  s = props[d]; scm_is_pair (s); s = scm_cdr (s))
+      vector<Grob*> const &items (ly_scm2link_array (props [d]));
+      for (vsize i = items.size (); i--;)
        {
-         Item * it = dynamic_cast<Item*> (unsmob_grob (scm_car (s)));
-         
+         Item *it = dynamic_cast<Item *> (items[i]);
+
          if (d == RIGHT && it->break_status_dir () != col_dir)
-           {
-             it = it -> find_prebroken_piece (col_dir);
+           it = it->find_prebroken_piece (col_dir);
 
-           }
          /*
            some kind of mismatch, eg. a note column, that is behind a
            linebreak.
-          */
+         */
          if (!it)
-           continue; 
+           continue;
 
          Item *it_col = it->get_column ();
          if (d == RIGHT && right_col != it_col)
            continue;
-         
+
          if (Separation_item::has_interface (it))
            {
              extents[d].unite (Separation_item::width (it));
@@ -67,33 +66,41 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
 
          if (d == LEFT)
            {
-             SCM r = it->get_property ("rest");
-             Grob * g = unsmob_grob (r);
+             SCM r = it->get_object ("rest");
+             Grob *g = unsmob_grob (r);
              if (!g)
-               g =  Note_column::first_head (it);
+               g = Note_column::first_head (it);
 
              /*
                Ugh. If Stem is switched off, we don't know what the
                first note head will be.
-              */
+             */
              if (g)
-               left_head_wid = g->extent (it_col, X_AXIS);
+               {
+                 if (g->common_refpoint (it_col, X_AXIS) != it_col)
+                   programming_error ("Note_spacing::get_spacing(): Common refpoint incorrect");
+                 else
+                   left_head_wid = g->extent (it_col, X_AXIS);
+               }
            }
-         
+
          extents[d].unite (it->extent (it_col, X_AXIS));
          if (d == RIGHT)
            {
-             Grob * accs = Note_column::accidentals (it);
+             Grob *accs = Note_column::accidentals (it);
              if (!accs)
                accs = Note_column::accidentals (it->get_parent (X_AXIS));
-             
+
              if (accs)
                {
-                 Interval v =
-                   Accidental_placement::get_relevant_accidental_extent (accs, it_col, me);
-                   
+                 Interval v
+                   Accidental_placement::get_relevant_accidental_extent (accs, it_col, me);
+
                  extents[d].unite (v);
                }
+
+             if (Grob *arpeggio = Note_column::arpeggio (it))
+               extents[d].unite (arpeggio->extent (it_col, X_AXIS));
            }
        }
 
@@ -102,9 +109,9 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
     }
   while (flip (&d) != LEFT);
 
-
   /*
     We look at the width of the note head, since smaller heads get less space
+
     eg. a quarter rest gets almost 0.5 ss less horizontal space than a note.
 
     What is sticking out of the note head (eg. a flag), doesn't get
@@ -112,34 +119,46 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
 
     FIXED also includes the left part of the right object.
   */
-  *fixed =
-    (left_head_wid.is_empty () ? increment :
-     /*
-       Size of the head:
-      */
-     (left_head_wid[RIGHT]+
-
-      /*
-       What's sticking out of the head, eg. a flag: 
-      */
-      (extents[LEFT][RIGHT] - left_head_wid[RIGHT])/2))
+  *fixed
+    = (left_head_wid.is_empty () ? increment
+       :        /*
+                 Size of the head:
+               */
+       (left_head_wid[RIGHT]+
+
+       /*
+         What's sticking out of the head, eg. a flag:
+       */
+       (extents[LEFT][RIGHT] - left_head_wid[RIGHT]) / 2))
 
     /*
-      What is sticking out of the right note:
-     */
-    + (extents[RIGHT].is_empty () ?  0.0 : - extents[RIGHT][LEFT] / 2);
+      What is sticking out on the left side of the right note:
+    */
+    + (extents[RIGHT].is_empty ()
+       ? 0.0
+       : ((- extents[RIGHT][LEFT] / 2)
+
+         /*
+           Add that which sticks out a lot.
+         */
+         + max (0.0, -extents[RIGHT][LEFT] - (base_space - 0.5 * increment))));
 
   /*
     We don't do complicated stuff: (base_space - increment) is the
     normal amount of white, which also determines the amount of
     stretch. Upon (extreme) stretching, notes with accidentals should
     stretch as much as notes without accidentals.
-   */
-  *space = (base_space - increment) + *fixed ;
+  */
+  *space = (base_space - increment) + *fixed;
 
+#if 0
+  /*
+    The below situation is now handled by the "sticks out a lot" case
+    above. However we keep around the code for a few releases before
+    we drop it.
+   */
   if (!extents[RIGHT].is_empty ()
-      && (Item::is_breakable (right_col)
-         || right_col->original_))
+      && (Paper_column::is_breakable (right_col)))
     {
       /*
        This is for the situation
@@ -149,11 +168,12 @@ Note_spacing::get_spacing (Grob *me, Item* right_col,
        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] / 2;
       *fixed += -extents[RIGHT][LEFT] / 2;
     }
+#endif
   
   stem_dir_correction (me, right_col, increment, space, fixed);
 }
@@ -163,33 +183,32 @@ Note_spacing::left_column (Grob *me)
 {
   if (!me->is_live ())
     return 0;
-  
-  return dynamic_cast<Item*> (me)->get_column ();
+
+  return dynamic_cast<Item *> (me)->get_column ();
 }
 
 /*
   Compute the column of the right-items.  This is a big function,
-since RIGHT-ITEMS may span more columns (eg. if a clef if inserted,
-this will add a new columns to RIGHT-ITEMS. Here we look at the
-columns, and return the left-most. If there are multiple columns, we
-prune RIGHT-ITEMS.
-   
- */
+  since RIGHT-ITEMS may span more columns (eg. if a clef if inserted,
+  this will add a new columns to RIGHT-ITEMS. Here we look at the
+  columns, and return the left-most. If there are multiple columns, we
+  prune RIGHT-ITEMS.
+*/
 Item *
-Note_spacing::right_column (Grob*me)
+Note_spacing::right_column (Grob *me)
 {
   if (!me->is_live ())
     return 0;
-  
-  SCM right = me->get_property ("right-items");
+
+  Grob_array *a = unsmob_grob_array (me->get_object ("right-items"));
   Item *mincol = 0;
   int min_rank = INT_MAX;
   bool prune = false;
-  for (SCM s = right ; scm_is_pair (s) ; s = scm_cdr (s))
+  for (vsize i = 0; a && i < a->size (); i++)
     {
-      Item * ri = unsmob_item (scm_car (s));
+      Item *ri = a->item (i);
+      Item *col = ri->get_column ();
 
-      Item * col = ri->get_column ();
       int rank = Paper_column::get_rank (col);
 
       if (rank < min_rank)
@@ -201,29 +220,19 @@ Note_spacing::right_column (Grob*me)
          mincol = col;
        }
     }
-  
-  if (prune)
+
+  if (prune && a)
     {
-      // I'm a lazy bum. We could do this in-place.
-      SCM newright  = SCM_EOL;
-      for (SCM s = right ; scm_is_pair (s) ; s = scm_cdr (s))
+      vector<Grob*> &right = a->array_reference ();
+      for (vsize i = right.size (); i--;)
        {
-         if (unsmob_item (scm_car (s))->get_column () == mincol)
-           newright = scm_cons (scm_car (s), newright);
+         if (dynamic_cast<Item *> (right[i])->get_column () != mincol)
+           right.erase (right.begin () + i);
        }
-
-      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));
-      */
 
-      return 0;
-    }
+  if (!mincol)
+    return 0;
 
   return mincol;
 }
@@ -234,40 +243,40 @@ Note_spacing::right_column (Grob*me)
    down-stem + up-stem less.
 
    TODO: have to check wether the stems are in the same staff.
-
 */
 void
-Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
+Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
                                   Real increment,
-                                  Real * space, Real *fixed)  
+                                  Real *space, Real *fixed)
 {
   Drul_array<Direction> stem_dirs (CENTER, CENTER);
   Drul_array<Interval> stem_posns;
-  Drul_array<Interval> head_posns;  
-  Drul_array<SCM> props (me->get_property ("left-items"),
-                       me->get_property ("right-items"));
+  Drul_array<Interval> head_posns;
+  Drul_array<SCM> props (me->get_object ("left-items"),
+                        me->get_object ("right-items"));
+
+  Drul_array<Spanner *> beams_drul (0, 0);
+  Drul_array<Grob *> stems_drul (0, 0);
 
-  Drul_array<Spanner*> beams_drul (0, 0);
-  Drul_array<Grob*> stems_drul (0, 0);
-  
   stem_dirs[LEFT] = stem_dirs[RIGHT] = CENTER;
   Interval intersect;
   Interval bar_xextent;
-  Interval bar_yextent;  
-  
+  Interval bar_yextent;
+
   bool correct_stem_dirs = true;
   Direction d = LEFT;
   bool acc_right = false;
-  
+
   do
     {
-      for (SCM  s = props[d]; scm_is_pair (s); s = scm_cdr (s))
+      vector<Grob*> const &items (ly_scm2link_array (props [d]));
+      for (vsize i = 0; i < items.size (); i++)
        {
-         Item * it = dynamic_cast<Item*> (unsmob_grob (scm_car (s)));
+         Item *it = dynamic_cast<Item *> (items[i]);
 
          if (d == RIGHT)
            acc_right = acc_right || Note_column::accidentals (it);
-         
+
          Grob *stem = Note_column::get_stem (it);
 
          if (!stem || !stem->is_live ())
@@ -275,10 +284,8 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
              if (d == RIGHT && Separation_item::has_interface (it))
                {
                  if (it->get_column () != rcolumn)
-                   {
-                     it = it->find_prebroken_piece (rcolumn->break_status_dir ());
-                   }
-                 
+                   it = it->find_prebroken_piece (rcolumn->break_status_dir ());
+
                  Grob *last = Separation_item::extremal_break_aligned_grob (it, LEFT, &bar_xextent);
 
                  if (last)
@@ -287,9 +294,9 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
                  break;
                }
 
-             return ;
+             return;
            }
-         
+
          if (Stem::is_invisible (stem))
            {
              correct_stem_dirs = false;
@@ -298,8 +305,8 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
 
          stems_drul[d] = stem;
          beams_drul[d] = Stem::get_beam (stem);
-         
-         Direction sd = Stem::get_direction (stem);
+
+         Direction sd = get_grob_direction (stem);
          if (stem_dirs[d] && stem_dirs[d] != sd)
            {
              correct_stem_dirs = false;
@@ -310,52 +317,49 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
          /*
            Correction doesn't seem appropriate  when there is a large flag
            hanging from the note.
-          */
+         */
          if (d == LEFT
-             && Stem::duration_log (stem) > 2  && !Stem::get_beam (stem))
-           {
-             correct_stem_dirs = false;
-           }
-         
-         Interval hp  = Stem::head_positions (stem);
-         if (!hp.is_empty())
+             && Stem::duration_log (stem) > 2 && !Stem::get_beam (stem))
+           correct_stem_dirs = false;
+
+         Interval hp = Stem::head_positions (stem);
+         if (!hp.is_empty ())
            {
-             Real chord_start = hp[sd];          
+             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 (min (chord_start, stem_end), max (chord_start, stem_end));
              head_posns[d].unite (hp);
            }
        }
     }
   while (flip (&d) != LEFT);
-  
 
   /*
     don't correct if accidentals are sticking out of the right side.
   */
   if (acc_right)
-    return ;
+    return;
 
   Real correction = 0.0;
 
   if (!bar_yextent.is_empty ())
     {
-      stem_dirs[RIGHT] = - stem_dirs[LEFT];
+      stem_dirs[RIGHT] = -stem_dirs[LEFT];
       stem_posns[RIGHT] = bar_yextent;
     }
-  
-  if (correct_stem_dirs && stem_dirs[LEFT] *stem_dirs[RIGHT] == -1)
+
+  if (correct_stem_dirs && stem_dirs[LEFT] * stem_dirs[RIGHT] == -1)
     {
       if (beams_drul[LEFT] && beams_drul[LEFT] == beams_drul[RIGHT])
        {
-         
+
          /*
            this is a knee: maximal correction.
          */
          Real note_head_width = increment;
-         Grob * st = stems_drul[RIGHT];
-         Grob * head = st ? Stem::support_head (st)  : 0;
+         Grob *st = stems_drul[RIGHT];
+         Grob *head = st ? Stem::support_head (st) : 0;
 
          Interval head_extent;
          if (head)
@@ -373,13 +377,13 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
                }
            }
 
-         correction = note_head_width* stem_dirs[LEFT];
+         correction = note_head_width * stem_dirs[LEFT];
          correction *= robust_scm2double (me->get_property ("knee-spacing-correction"), 0);
          *fixed += correction;
        }
       else
        {
-         intersect = stem_posns[LEFT];  
+         intersect = stem_posns[LEFT];
          intersect.intersect (stem_posns[RIGHT]);
          correct_stem_dirs = correct_stem_dirs && !intersect.is_empty ();
 
@@ -387,57 +391,53 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
            {
              correction = abs (intersect.length ());
 
-      
              /*
                Ugh. 7 is hardcoded.
              */
-             correction = (correction/7) <? 1.0;
-             correction *= stem_dirs[LEFT] ;
-             correction *=
-               robust_scm2double (me->get_property ("stem-spacing-correction"), 0);
+             correction = min (correction / 7, 1.0);
+             correction *= stem_dirs[LEFT];
+             correction
+               *= robust_scm2double (me->get_property ("stem-spacing-correction"), 0);
            }
-         
+
          if (!bar_yextent.is_empty ())
-           {
-             correction *= 0.5;
-           }
+           correction *= 0.5;
        }
     }
-  else if (correct_stem_dirs && stem_dirs[LEFT] *stem_dirs[RIGHT] == UP)
+  else if (correct_stem_dirs && stem_dirs[LEFT] * stem_dirs[RIGHT] == UP)
     {
       /*
        Correct for the following situation:
 
-        X      X
-       |      | 
+       X      X
+       |      |
        |      |
        |   X  |
        |  |   |
        ========
 
-           ^ move the center one to the left.
-       
+       ^ move the center one to the left.
+
 
        this effect seems to be much more subtle than the
        stem-direction stuff (why?), and also does not scale with the
        difference in stem length.
-       
-       */
 
-      
+      */
+
       Interval hp = head_posns[LEFT];
-      hp.intersect  (head_posns[RIGHT]);
+      hp.intersect (head_posns[RIGHT]);
       if (!hp.is_empty ())
-       return ;
+       return;
+
+      Direction lowest
+       = (head_posns[LEFT][DOWN] > head_posns[RIGHT][UP]) ? RIGHT : LEFT;
 
-      Direction lowest =
-       (head_posns[LEFT][DOWN] > head_posns[RIGHT][UP]) ? RIGHT : LEFT;
+      Real delta = head_posns[-lowest][DOWN] - head_posns[lowest][UP];
+      Real corr = robust_scm2double (me->get_property ("same-direction-correction"), 0);
 
-      Real delta = head_posns[-lowest][DOWN] - head_posns[lowest][UP] ;
-      Real corr = robust_scm2double (me->get_property ("stem-spacing-correction"), 0);
-      corr =  (delta <= 1) ? 0.0 : 0.25;
-      
-      correction =  -lowest * corr ;
+      if (delta > 1)
+       correction = -lowest * corr;
     }
 
   *space += correction;
@@ -445,13 +445,9 @@ Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
   /* there used to be a correction for bar_xextent () here, but
      it's unclear what that was good for ?
   */
-
 }
-
-
 
 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");
+              "This object calculates spacing wishes for individual voices.",
+              "left-items right-items stem-spacing-correction same-direction-correction knee-spacing-correction");