]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/staff-spacing.cc
* The grand 2005-2006 replace.
[lilypond.git] / lily / staff-spacing.cc
index 8d7a5db7c37cf33dadf996103ab8d88798a26ead..a4cf1d368a4f7721dbe4b17a7344a17783c3e641 100644 (file)
@@ -1,90 +1,93 @@
-/*   
-     staff-spacing.cc --  implement Staff_spacing
-
-     source file of the GNU LilyPond music typesetter
+/*
+  staff-spacing.cc -- implement Staff_spacing
 
-     (c) 2001--2002  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  source file of the GNU LilyPond music typesetter
 
+  (c) 2001--2006  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
-#include <stdio.h>
 
-#include "paper-column.hh" 
-#include "separation-item.hh"
-#include "item.hh"
 #include "staff-spacing.hh"
-#include "grob.hh"
+
+#include <cstdio>
+using namespace std;
+
+#include "paper-column.hh"
+#include "separation-item.hh"
 #include "warn.hh"
 #include "bar-line.hh"
 #include "staff-symbol-referencer.hh"
 #include "note-column.hh"
 #include "stem.hh"
-
-bool
-Staff_spacing::has_interface (Grob* g)
-{
-  return g && g->has_interface (ly_symbol2scm ("staff-spacing-interface"));
-}
+#include "accidental-placement.hh"
+#include "pointer-group-interface.hh"
+#include "directional-element-interface.hh"
 
 /*
   Insert some more space for the next note, in case it has a stem in
   the wrong direction
-
- */
-Real
-Staff_spacing::next_note_correction (Grob * me,
-                                    Grob * g,
-                                    Interval bar_size)
+*/
+void
+Staff_spacing::next_note_correction (Grob *me,
+                                    Grob *g,
+                                    Interval bar_size,
+                                    Real *space,
+                                    Real *fix)
 {
+  (void)space;
+  
   if (!g || !Note_column::has_interface (g))
-    return 0.0;
+    return ;
 
-  Item *col =dynamic_cast<Item*> (g)->column_l ();
-  Real max_corr = 0. >? (- g->extent (col, X_AXIS)[LEFT]);
+  Item *col = dynamic_cast<Item *> (g)->get_column ();
+  Real max_corr = max (0., (- g->extent (col, X_AXIS)[LEFT]));
 
   /*
     Duh. If this gets out of hand, we should invent something more generic.
-   */
-  if (Grob * a = Note_column::accidentals (g))
-    {
-      max_corr = max_corr >? (- a->extent (col, X_AXIS)[LEFT]);
-    }
-  if (Grob* a = unsmob_grob (g->get_grob_property ("arpeggio")))
+  */
+  if (Grob *a = Note_column::accidentals (g))
     {
-      max_corr = max_corr >? (- a->extent (col, X_AXIS)[LEFT]);
+      Interval v;
+      if (Accidental_placement::has_interface (a))
+       v = Accidental_placement::get_relevant_accidental_extent (a, col, me);
+      else
+       v = a->extent (col, X_AXIS);
+
+      max_corr = max (max_corr, (- v[LEFT]));
     }
-  
+  if (Grob *a = unsmob_grob (g->get_object ("arpeggio")))
+    max_corr = max (max_corr, - a->extent (col, X_AXIS)[LEFT]);
+
   /*
     Let's decrease the space a little if the problem is not located
     after a barline.
   */
-  if (bar_size.empty_b ())
+  if (bar_size.is_empty ())
     max_corr *= 0.75;
-  
-  if (!bar_size.empty_b())
-    if (Grob *stem = Note_column::stem_l  (g))
+
+  if (!bar_size.is_empty ())
+    if (Grob *stem = Note_column::get_stem (g))
       {
-       Direction d = Stem::get_direction (stem);
+       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 (stem_start <? stem_end,
-                                stem_end >? stem_start);
+           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 = abs (stem_posns.length ()/7.) <? 1.0;
-           corr *=
-             gh_scm2double (me->get_grob_property ("stem-spacing-correction"));
+           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_corr >? corr;
+           max_corr = max (max_corr, corr);
          }
       }
-  return max_corr;
-}
 
+  *fix += max_corr;
+}
 
 /*
   Y-positions that are covered by BAR_GROB, in the case that it is a
@@ -93,18 +96,18 @@ Interval
 Staff_spacing::bar_y_positions (Grob *bar_grob)
 {
   Interval bar_size;
-  bar_size.set_empty();
+  bar_size.set_empty ();
   if (Bar_line::has_interface (bar_grob))
     {
-      SCM glyph = bar_grob->get_grob_property ("glyph");
-      
-      String glyph_str = gh_string_p (glyph) ? ly_scm2string (glyph) : "";
-      if (glyph_str.left_str (1) == "|" || glyph_str.left_str (1) == ".")
+      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) == ".")
        {
-         SCM sz = Bar_line::get_staff_bar_size (bar_grob->self_scm());
-         bar_size = Interval (-1,1);
-         bar_size *= gh_scm2double (sz)
-           / Staff_symbol_referencer::staff_space (bar_grob);
+         Grob *common = bar_grob->common_refpoint (staff_sym, Y_AXIS);
+         Interval bar_size = bar_grob->extent (common, Y_AXIS);
+         bar_size *= 1.0 / Staff_symbol_referencer::staff_space (bar_grob);
        }
     }
   return bar_size;
@@ -116,81 +119,70 @@ Staff_spacing::bar_y_positions (Grob *bar_grob)
   This is slightly convoluted, since the staffspacing grob gets
   pointers to the separation-items, not the note-columns or
   note-spacings.
-  
- */
-Real
-Staff_spacing::next_notes_correction (Grob *me, Grob * last_grob)
+*/
+void
+Staff_spacing::next_notes_correction (Grob *me, Grob *last_grob,
+                                     Real *compound_space, Real *compound_fixed
+                                     )
 {
   Interval bar_size = bar_y_positions (last_grob);
-  Real max_corr =0.0;
-  for (SCM s = me->get_grob_property ("right-items");
-       gh_pair_p (s);  s = gh_cdr (s))
-    {
-      Grob * g = unsmob_grob (gh_car (s));
-      max_corr = max_corr >?  next_note_correction (me, g,  bar_size);
-      for (SCM t = g->get_grob_property ("elements");
-          gh_pair_p (t); t  = gh_cdr (t))
-       max_corr = max_corr >? next_note_correction (me, unsmob_grob (gh_car (t)), bar_size);
-      
-    }
-  return max_corr;
-}
 
-/*
-  Try to find the break-aligned symbol in SEPARATION_ITEM that is
-  sticking out at direction D. The x size is put in LAST_EXT
-*/
-Grob*
-Staff_spacing::extremal_break_aligned_grob (Grob *separation_item, Direction d,
-                                  Interval * last_ext)
-{
-  Grob *left_col = dynamic_cast<Item*> (separation_item)->column_l ();
-  last_ext->set_empty ();
-  Grob *last_grob = 0;
-  for (SCM s = separation_item->get_grob_property ("elements");
-       gh_pair_p (s); s = gh_cdr (s))
+  extract_grob_set (me, "right-items", right_items);
+
+  *compound_fixed = 0.0;
+  *compound_space = 0.0;
+  int wish_count = 0;
+  
+  for (int i = right_items.size (); i--;)
     {
-      Grob * break_item = unsmob_grob (gh_car (s));
-      
-      if (!gh_symbol_p (break_item->get_grob_property ("break-align-symbol")))
-       continue;
+      Grob *g = right_items[i];
 
-      Interval ext = break_item->extent (left_col, X_AXIS);
+      Real space = 0.0;
+      Real fixed = 0.0;
 
-      if (ext.empty_b ())
-       continue;
-      if (!last_grob
-         || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0) )
+      next_note_correction (me, g, bar_size, &space, &fixed);
+
+      *compound_space += space;
+      *compound_fixed += fixed; 
+      wish_count ++;
+      
+      extract_grob_set (g, "elements", elts);
+      for (int j = elts.size (); j--;)
        {
-         *last_ext = ext;
-         last_grob = break_item; 
+         Real space = 0.0;
+         Real fixed = 0.0;
+         next_note_correction (me, elts[j], bar_size, &space, &fixed);
+         *compound_fixed += fixed;
+         *compound_space += space;
+         wish_count ++;
        }
     }
 
-  return last_grob;  
+  if (wish_count)
+    {
+      *compound_space /= wish_count;
+      *compound_fixed /= wish_count;
+    }
 }
 
-/*
-*/
 void
-Staff_spacing::get_spacing_params (Grob *me, Real * space, Real * fixed)
+Staff_spacing::get_spacing_params (Grob *me, Real *space, Real *fixed)
 {
   *space = 1.0;
   *fixed = 1.0;
 
-  Grob * separation_item=0;
-  Item * me_item  = dynamic_cast<Item*> (me);
-    
-  for (SCM s = me->get_grob_property ("left-items");
-       gh_pair_p (s); s = gh_cdr(s))
+  Grob *separation_item = 0;
+  Item *me_item = dynamic_cast<Item *> (me);
+
+  extract_grob_set (me, "left-items", items);
+  for (int i = items.size (); i--;)
     {
-      Grob * cand = unsmob_grob(gh_car (s));
+      Grob *cand = items[i];
       if (cand && Separation_item::has_interface (cand))
-       separation_item = cand ;
+       separation_item = cand;
     }
 
-  //  printf ("doing col %d\n" , Paper_column::rank_i(left_col));
-
+  //  printf ("doing col %d\n" , Paper_column::get_rank (left_col));
   if (!separation_item)
     {
       programming_error ("no sep item");
@@ -198,51 +190,83 @@ Staff_spacing::get_spacing_params (Grob *me, Real * space, Real * fixed)
     }
 
   Interval last_ext;
-  Grob *last_grob = extremal_break_aligned_grob (separation_item, RIGHT,
-                                                &last_ext);
+  Grob *last_grob = Separation_item::extremal_break_aligned_grob (separation_item, RIGHT,
+                                                                 &last_ext);
   if (!last_grob)
     {
-      programming_error ("empty break column? --fixme");
-      return ;
+      /*
+       TODO:
+
+       Should  insert a adjustable space here? For excercises, you might want to
+       use a staff without a clef in the beginning.
+      */
+
+      /*
+       we used to have a warning here, but it generates a lot of
+       spurious error messages.
+      */
+      return;
     }
 
   *fixed = last_ext[RIGHT];
   *space = *fixed + 1.0;
-  
-  SCM alist = last_grob->get_grob_property ("space-alist");
+
+  SCM alist = last_grob->get_property ("space-alist");
   if (!scm_list_p (alist))
-    return ;
+    return;
 
-  
   SCM space_def = scm_sloppy_assq (ly_symbol2scm ("first-note"), alist);
   if (me_item->break_status_dir () == CENTER)
     {
       SCM nndef = scm_sloppy_assq (ly_symbol2scm ("next-note"), alist);
-      if (gh_pair_p (nndef ))
+      if (scm_is_pair (nndef))
        space_def = nndef;
     }
 
-  if (!gh_pair_p (space_def))
+  if (!scm_is_pair (space_def))
     {
-      programming_error ("Unknown prefatory spacing. "); 
-      return; 
+      programming_error ("unknown prefatory spacing");
+      return;
     }
 
-  space_def = gh_cdr (space_def);
-  Real distance = gh_scm2double (gh_cdr (space_def));
-  SCM type = gh_car (space_def) ;
+  space_def = scm_cdr (space_def);
+  Real distance = scm_to_double (scm_cdr (space_def));
+  SCM type = scm_car (space_def);
 
   *fixed = last_ext[RIGHT];
-  if (type == ly_symbol2scm ("extra-space"))
+  if (type == ly_symbol2scm ("fixed-space"))
+    {
+      *fixed += distance;
+      *space = *fixed;
+    }
+  else if (type == ly_symbol2scm ("extra-space"))
     *space = *fixed + distance;
-  else if (type == ly_symbol2scm("minimum-space"))
-    *space = last_ext[LEFT] + (last_ext.length () >? distance);
-
+  else if (type == ly_symbol2scm ("semi-fixed-space"))
+    {
+      *fixed += distance / 2;
+      *space = *fixed + distance / 2;
+    }
+  else if (type == ly_symbol2scm ("minimum-space"))
+    *space = last_ext[LEFT] + max (last_ext.length (), distance);
+  else if (type == ly_symbol2scm ("minimum-fixed-space"))
+    {
+      *space = last_ext[LEFT] + max (last_ext.length (), distance);
+      *fixed = *space;
+    }
 
-  *space += next_notes_correction (me, last_grob);
+  Real correction_fixed, correction_space;
+  next_notes_correction (me, last_grob, &correction_space, &correction_fixed );
+  *space += correction_space;
+  *fixed += correction_fixed;
 }
 
+ADD_INTERFACE (Staff_spacing, "staff-spacing-interface",
+              "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.",
 
-ADD_INTERFACE (Staff_spacing,"staff-spacing-interface",
-  "",
-  "left-items right-items");
+              /* properties */
+              "stem-spacing-correction "
+              "left-items "
+              "right-items "
+              );