]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-spacing.cc
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / lily / staff-spacing.cc
index 495458eb77824616ef9e192ef65f16d22df0642e..79e70286445b3844169be78dea600fa7261defe7 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 2001--2007  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "staff-spacing.hh"
@@ -30,65 +30,100 @@ void
 Staff_spacing::next_note_correction (Grob *me,
                                     Grob *g,
                                     Interval bar_size,
+                                    Real current_space, Real current_fixed,
                                     Real *space,
-                                    Real *fix)
+                                    Real *fix,
+                                    int *wish_count)
 {
-  (void)space;
-  
+  (void) current_fixed; 
   if (!g || !Note_column::has_interface (g))
     return ;
 
   Item *col = dynamic_cast<Item *> (g)->get_column ();
-  Real max_corr = max (0., (- g->extent (col, X_AXIS)[LEFT]));
+  Real left_stickout_correction = max (0., (- g->extent (col, X_AXIS)[LEFT]));
+
+  /* staff space -> positions */
+  bar_size *= 2;
 
   /*
     Duh. If this gets out of hand, we should invent something more generic.
   */
-  if (Grob *a = Note_column::accidentals (g))
+  Grob *accs = Note_column::accidentals (g);
+  if (accs)
     {
       Interval v;
-      if (Accidental_placement::has_interface (a))
-       v = Accidental_placement::get_relevant_accidental_extent (a, col, me);
+      if (Accidental_placement::has_interface (accs))
+       v = Accidental_placement::get_relevant_accidental_extent (accs, col, me);
       else
-       v = a->extent (col, X_AXIS);
-
-      max_corr = max (max_corr, (- v[LEFT]));
+       v = accs->extent (col, X_AXIS);
+      
+      left_stickout_correction = max (left_stickout_correction, (- v[LEFT]));
     }
-  if (Grob *a = unsmob_grob (g->get_object ("arpeggio")))
-    max_corr = max (max_corr, - a->extent (col, X_AXIS)[LEFT]);
+  Grob *arpeggio = unsmob_grob (g->get_object ("arpeggio"));
+  if (arpeggio)
+    left_stickout_correction = max (left_stickout_correction, - arpeggio->extent (col, X_AXIS)[LEFT]);
 
+  
   /*
     Let's decrease the space a little if the problem is not located
     after a barline.
   */
   if (bar_size.is_empty ())
-    max_corr *= 0.75;
-
-  if (!bar_size.is_empty ())
-    if (Grob *stem = Note_column::get_stem (g))
-      {
-       Direction d = get_grob_direction (stem);
-       if (d == DOWN)
-         {
-           Real stem_start = Stem::head_positions (stem) [DOWN];
-           Real stem_end = Stem::stem_end_position (stem);
-           Interval stem_posns (min (stem_start, stem_end),
-                                max (stem_end, stem_start));
-
-           stem_posns.intersect (bar_size);
-
-           Real corr = min (abs (stem_posns.length () / 7.0), 1.0);
-           corr *= robust_scm2double (me->get_property ("stem-spacing-correction"), 1);
-
-           if (d != DOWN)
-             corr = 0.0;
-           max_corr = max (max_corr, corr);
-         }
-      }
-
-  *fix += max_corr;
-}
+    left_stickout_correction *= 0.75;
+
+  /*
+    We want 0.3 ss before the sticking-out object.
+    
+    current_fixed/2 is our guess at (right side of left object + 0.3)
+   */
+  left_stickout_correction += current_fixed/2 - current_space;
+  left_stickout_correction = max (left_stickout_correction, 0.0);
 
+  
+  Real optical_corr = 0.0;
+  Grob *stem = Note_column::get_stem (g);
+  if (!bar_size.is_empty ()
+      && !arpeggio
+      && !accs
+      && stem)
+    {
+      Direction d = get_grob_direction (stem);
+      if (Stem::is_normal_stem (stem) && d == DOWN)
+       {
+
+         /*
+           can't look at stem-end-position, since that triggers
+           beam slope computations.
+         */
+         Real stem_start = Stem::head_positions (stem) [d];
+         Real stem_end = stem_start + 
+           d * robust_scm2double (stem->get_property ("length"), 7);
+         
+         Interval stem_posns (min (stem_start, stem_end),
+                              max (stem_end, stem_start));
+
+         stem_posns.intersect (bar_size);
+
+         optical_corr = min (abs (stem_posns.length () / 7.0), 1.0);
+         optical_corr *= robust_scm2double (me->get_property ("stem-spacing-correction"), 1);
+       }
+    }
+
+
+  Real correction = optical_corr + left_stickout_correction;
+  if (correction)
+    {
+      (*wish_count) ++; 
+
+      /*
+       This minute adjustments don't make sense for widely spaced scores.
+       Hence, we need to keep the stretchable (that is, space - fix)
+       distance equal.
+      */
+      *space += correction;
+      *fix += correction;
+    }
+}
 /*
   Y-positions that are covered by BAR_GROB, in the case that it is a
   barline.  */
@@ -102,11 +137,12 @@ Staff_spacing::bar_y_positions (Grob *bar_grob)
       SCM glyph = bar_grob->get_property ("glyph-name");
       Grob *staff_sym = Staff_symbol_referencer::get_staff_symbol (bar_grob);
 
-      String glyph_string = scm_is_string (glyph) ? ly_scm2string (glyph) : "";
-      if (glyph_string.left_string (1) == "|" || glyph_string.left_string (1) == ".")
+      string glyph_string = scm_is_string (glyph) ? ly_scm2string (glyph) : "";
+      if (glyph_string.substr (0, 1) == "|"
+         || glyph_string.substr (0, 1) == ".")
        {
          Grob *common = bar_grob->common_refpoint (staff_sym, Y_AXIS);
-         Interval bar_size = bar_grob->extent (common, Y_AXIS);
+         bar_size = bar_grob->extent (common, Y_AXIS);
          bar_size *= 1.0 / Staff_symbol_referencer::staff_space (bar_grob);
        }
     }
@@ -120,8 +156,10 @@ Staff_spacing::bar_y_positions (Grob *bar_grob)
   pointers to the separation-items, not the note-columns or
   note-spacings.
 */
+
 void
 Staff_spacing::next_notes_correction (Grob *me, Grob *last_grob,
+                                     Real current_space, Real current_fixed,
                                      Real *compound_space, Real *compound_fixed
                                      )
 {
@@ -131,37 +169,46 @@ Staff_spacing::next_notes_correction (Grob *me, Grob *last_grob,
 
   *compound_fixed = 0.0;
   *compound_space = 0.0;
-  int wishes;
-  
-  for (int i = right_items.size (); i--;)
+  int wish_count = 0;
+
+  for (vsize i = right_items.size (); i--;)
     {
       Grob *g = right_items[i];
-
-      Real space = 0.0;
-      Real fixed = 0.0;
-
-      next_note_correction (me, g, bar_size, &space, &fixed);
-
-      *compound_space += space;
-      *compound_fixed += fixed; 
-      wishes ++;
-      
-      extract_grob_set (g, "elements", elts);
-      for (int j = elts.size (); j--;)
+      if (Note_column::has_interface (right_items[i]))
        {
+         Grob *g = right_items[i];
+
          Real space = 0.0;
          Real fixed = 0.0;
-         next_note_correction (me, elts[j], bar_size, &space, &fixed);
-         *compound_fixed += fixed;
+      
+         next_note_correction (me, g, bar_size,
+                               current_space, current_fixed,
+                               &space, &fixed, &wish_count);
+      
          *compound_space += space;
-         wishes ++;
+         *compound_fixed += fixed; 
+       }
+      else
+       {
+         extract_grob_set (g, "elements", elts);
+         for (vsize j = elts.size (); j--;)
+           {
+             Real space = 0.0;
+             Real fixed = 0.0;
+             next_note_correction (me, elts[j], bar_size,
+                                   current_space, current_fixed,
+                                   &space, &fixed,
+                                   &wish_count);
+             *compound_fixed += fixed;
+             *compound_space += space;
+           }
        }
     }
-
-  if (wishes)
+  
+  if (wish_count > 1)
     {
-      *compound_space /= wishes;
-      *compound_fixed /= wishes;
+      *compound_space /= wish_count;
+      *compound_fixed /= wish_count;
     }
 }
 
@@ -175,7 +222,7 @@ Staff_spacing::get_spacing_params (Grob *me, Real *space, Real *fixed)
   Item *me_item = dynamic_cast<Item *> (me);
 
   extract_grob_set (me, "left-items", items);
-  for (int i = items.size (); i--;)
+  for (vsize i = items.size (); i--;)
     {
       Grob *cand = items[i];
       if (cand && Separation_item::has_interface (cand))
@@ -254,14 +301,22 @@ Staff_spacing::get_spacing_params (Grob *me, Real *space, Real *fixed)
       *fixed = *space;
     }
 
-  Real correction_fixed, correction_space;
-  next_notes_correction (me, last_grob, &correction_space, &correction_fixed );
+  Real correction_fixed = 0.0;
+  Real correction_space = 0.0;
+  next_notes_correction (me, last_grob,
+                        *space, *fixed,
+                        &correction_space, &correction_fixed );
   *space += correction_space;
   *fixed += correction_fixed;
 }
 
-ADD_INTERFACE (Staff_spacing, "staff-spacing-interface",
+ADD_INTERFACE (Staff_spacing,
               "This object calculates spacing details from a "
               " breakable symbol (left) to another object. For example, it takes care "
               " of  optical spacing from  a bar lines to a note.",
-              "stem-spacing-correction left-items right-items");
+
+              /* properties */
+              "stem-spacing-correction "
+              "left-items "
+              "right-items "
+              );