]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-spacing.cc
2003 -> 2004
[lilypond.git] / lily / note-spacing.cc
index 4b0d784b18e3930335865c9c5ae310d42c41f039..1b60b1cec59bc725ffefa23d2b126d0bfc52d748 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2001--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
 #include "note-column.hh"
 #include "warn.hh"
 #include "stem.hh"
+#include "separation-item.hh"
+#include "staff-spacing.hh"
+#include "accidental-placement.hh"
+#include "paper-def.hh"
 
-bool
-Note_spacing::has_interface (Grob* g)
+void
+Note_spacing::get_spacing (Grob *me, Item* right_col,
+                          Real base_space, Real increment, Real *space, Real *fixed)
 {
-  return g && g->has_interface (ly_symbol2scm ("note-spacing-interface"));
-}
 
-Real
-Note_spacing::get_spacing (Grob *me)
-{
   Drul_array<SCM> props(me->get_grob_property ("left-items"),
                        me->get_grob_property ("right-items"));
   Direction d = LEFT;
+  Direction col_dir =  right_col->break_status_dir ();
   Drul_array<Interval> extents;
+
+  Interval left_head_wid; 
   do
     {
       for (SCM  s = props[d]; gh_pair_p (s); s = gh_cdr (s))
        {
          Item * it= dynamic_cast<Item*> (unsmob_grob (gh_car(s)));
-         extents[d].unite (it->extent (it->column_l (), X_AXIS));
+         
+         if (d == RIGHT && it->break_status_dir () != 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; 
+
+         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));
+             continue;
+           }
+
+         if (d == LEFT)
+           {
+             SCM r = it->get_grob_property ("rest");
+             Grob * g = unsmob_grob (r);
+             if (!g)
+               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);
+           }
+         
+         extents[d].unite (it->extent (it_col, X_AXIS));
          if (d == RIGHT)
            {
              Grob * accs = Note_column::accidentals (it);
@@ -43,32 +83,78 @@ Note_spacing::get_spacing (Grob *me)
                accs = Note_column::accidentals (it->get_parent (X_AXIS));
              
              if (accs)
-               extents[d].unite (accs->extent (it->column_l (), X_AXIS));
+               {
+                 Interval v =
+                   Accidental_placement::get_relevant_accidental_extent (accs, it_col, me);
+                   
+                 extents[d].unite (v);
+               }
            }
        }
 
-      if (extents[d].empty_b ())
+      if (extents[d].is_empty ())
        extents[d] = Interval (0,0);
     }
   while (flip (&d) != LEFT);
 
+
   /*
-    
-    What's sticking out at the left of the right side has less
-    influence.
+    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
+    the full amount of space.
 
+    FIXED also includes the left part of the right object.
   */
-  Real dx= extents[LEFT][RIGHT] - 0.5 * extents[RIGHT][LEFT];
-  return dx;
+  *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);
+
+  /*
+    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 ;
+
+  if (Item::breakable_b (right_col)
+      || right_col->original_)
+    {
+      /*
+       This is for the situation
+
+       rest | 3/4 (eol)
+       
+       */
+      *space += -extents[RIGHT][LEFT];
+      *fixed += -extents[RIGHT][LEFT];
+    }
+  
+  stem_dir_correction (me, right_col, increment, space, fixed);
 }
 
 Item *
 Note_spacing::left_column (Grob *me)
 {
-  if (me->immutable_property_alist_ == SCM_EOL)
+  if (!me->live())
     return 0;
   
-  return dynamic_cast<Item*> (me)->column_l ();
+  return dynamic_cast<Item*> (me)->get_column ();
 }
 
 /*
@@ -82,10 +168,7 @@ prune RIGHT-ITEMS.
 Item *
 Note_spacing::right_column (Grob*me)
 {
-  /*
-    ugh. should have generic is_live() method?
-   */
-  if (me->immutable_property_alist_ == SCM_EOL)
+  if (!me->live())
     return 0;
   
   SCM right = me->get_grob_property ("right-items");
@@ -96,8 +179,8 @@ Note_spacing::right_column (Grob*me)
     {
       Item * ri = unsmob_item (gh_car (s));
 
-      Item * col = ri->column_l ();
-      int rank = Paper_column::rank_i (col);
+      Item * col = ri->get_column ();
+      int rank = Paper_column::get_rank (col);
 
       if (rank < min_rank)
        {
@@ -115,7 +198,7 @@ Note_spacing::right_column (Grob*me)
       SCM newright  = SCM_EOL;
       for (SCM s = right ; gh_pair_p (s) ; s =gh_cdr (s))
        {
-         if (unsmob_item (gh_car (s))->column_l () == mincol)
+         if (unsmob_item (gh_car (s))->get_column () == mincol)
            newright = gh_cons (gh_car (s), newright);
        }
 
@@ -125,7 +208,7 @@ Note_spacing::right_column (Grob*me)
   if (!mincol)
     {
       /*
-      int r = Paper_column::rank_i (dynamic_cast<Item*>(me)->column_l ());
+      int r = Paper_column::get_rank (dynamic_cast<Item*>(me)->get_column ());
       programming_error (_f("Spacing wish column %d has no right item.", r));
       */
 
@@ -142,69 +225,221 @@ Note_spacing::right_column (Grob*me)
 
    TODO: have to check wether the stems are in the same staff.
 
-   TODO: also correct for bar lines in RIGHT-ITEMS.  Should check if
-   the barline is the leftmost object of the break alignment.
-
 */
-Real
-Note_spacing::stem_dir_correction (Grob*me) 
+void
+Note_spacing::stem_dir_correction (Grob*me, Item * rcolumn,
+                                  Real increment,
+                                  Real * space, Real *fixed)  
 {
   Drul_array<Direction> stem_dirs(CENTER,CENTER);
-  Drul_array<Interval> posns;
+  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<Grob*> beams_drul(0,0);
+  Drul_array<Grob*> stems_drul(0,0);
+  
   stem_dirs[LEFT] = stem_dirs[RIGHT] = CENTER;
   Interval intersect;
-  bool correct = true;
+  Interval bar_xextent;
+  Interval bar_yextent;  
+  
+  bool correct_stem_dirs = true;
   Direction d = LEFT;
+  bool acc_right = false;
+  
   do
     {
       for (SCM  s = props[d]; gh_pair_p (s); s = gh_cdr (s))
        {
          Item * it= dynamic_cast<Item*> (unsmob_grob (gh_car(s)));
 
-         Grob *stem = Note_column::stem_l (it);
+         if (d == RIGHT)
+           acc_right = acc_right || Note_column::accidentals (it);
+         
+         Grob *stem = Note_column::get_stem (it);
 
-         if (!stem || Stem::invisible_b (stem))
+         if (!stem || !stem->live ())
            {
-             correct = false;
-             goto exit_loop ;
+             if (d == RIGHT && Separation_item::has_interface (it))
+               {
+                 if (it->get_column () != rcolumn)
+                   {
+                     it = it->find_prebroken_piece (rcolumn->break_status_dir ());
+                   }
+                 
+                 Grob *last = Separation_item::extremal_break_aligned_grob (it, LEFT, &bar_xextent);
+
+                 if (last)
+                   bar_yextent = Staff_spacing::bar_y_positions (last);
+
+                 break;
+               }
+
+             return ;
+           }
+         
+         if(Stem::invisible_b (stem))
+           {
+             correct_stem_dirs = false;
+             continue;
            }
 
+         stems_drul[d] = stem;
+         beams_drul[d] = Stem::get_beam (stem);
+           
+         
          Direction sd = Stem::get_direction (stem);
          if (stem_dirs[d] && stem_dirs[d] != sd)
            {
-             correct = false;
-             goto exit_loop;
+             correct_stem_dirs = false;
+             continue;
            }
          stem_dirs[d] = sd;
 
-         Real chord_start = Stem::head_positions (stem)[sd];
+         /*
+           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);
+         Real chord_start = hp[sd];      
          Real stem_end = Stem::stem_end_position (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);
        }
     }
   while (flip (&d) != LEFT);
   
-  intersect = posns[LEFT];  
-  intersect.intersect(posns[RIGHT]);
-  correct = correct && !intersect.empty_b ();
-  correct = correct && (stem_dirs[LEFT] *stem_dirs[RIGHT] == -1);
-  
- exit_loop:
-  if(!correct)
-    return 0.0;
 
   /*
-    Ugh. 7 is hardcoded.
-   */
-  Real correction = abs (intersect.length ());
-  correction = (correction/7) <? 1.0;
-  correction *= stem_dirs[LEFT] ;
-  correction *= gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+    don't correct if accidentals are sticking out of the right side.
+  */
+  if (acc_right)
+    return ;
+
+  Real correction = 0.0;
+
+  if (!bar_yextent.is_empty ())
+    {
+      stem_dirs[RIGHT] = - stem_dirs[LEFT];
+      stem_posns[RIGHT] = bar_yextent;
+    }
+  
+  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;
+
+         Interval head_extent;
+         if (head)
+           {
+             head_extent = head->extent (rcolumn, X_AXIS);
+
+             if (!head_extent.is_empty ())
+               note_head_width = head_extent[RIGHT];
+
+             if (st)
+               {
+                 Real thick = Stem::thickness (st);
+
+                 note_head_width -= thick;
+               }
+           }
+
+         correction = note_head_width* stem_dirs[LEFT];
+         correction *= robust_scm2double (me->get_grob_property ("knee-spacing-correction"), 0);
+         *fixed += correction;
+       }
+      else
+       {
+         intersect = stem_posns[LEFT];  
+         intersect.intersect(stem_posns[RIGHT]);
+         correct_stem_dirs = correct_stem_dirs && !intersect.is_empty ();
+
+         if (correct_stem_dirs)
+           {
+             correction =abs (intersect.length ());
+
+      
+             /*
+               Ugh. 7 is hardcoded.
+             */
+             correction = (correction/7) <? 1.0;
+             correction *= stem_dirs[LEFT] ;
+             correction *=
+               robust_scm2double (me->get_grob_property ("stem-spacing-correction"), 0);
+           }
+         
+         if (!bar_yextent.is_empty ())
+           {
+             correction *= 0.5;
+           }
+       }
+    }
+  else if (correct_stem_dirs && stem_dirs[LEFT] *stem_dirs[RIGHT] == UP)
+    {
+      /*
+       Correct for the following situation:
+
+        X      X
+       |      | 
+       |      |
+       |   X  |
+       |  |   |
+       ========
+
+           ^ 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]);
+      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 = robust_scm2double (me->get_grob_property ("stem-spacing-correction"), 0);
+      corr =  (delta <= 1) ? 0.0 : 0.25;
+      
+      correction=  -lowest * corr ;
+    }
+
+  *space += correction;
+
+  /* there used to be a correction for bar_xextent() here, but
+     it's unclear what that was good for ?
+  */
 
-  return correction;
 }
  
+
+
+
+ADD_INTERFACE (Note_spacing,"note-spacing-interface",
+  "",
+  "left-items right-items stem-spacing-correction knee-spacing-correction");
+