]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/note-spacing.cc
Merge branch 'master' into jneeman
[lilypond.git] / lily / note-spacing.cc
index c04ac2bee34a4a17e9406ba74de72d7b08a5a669..61af354f4cb1ebc161c289437a86e0333156db2a 100644 (file)
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 2001--2006  Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 2001--2007  Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "note-spacing.hh"
@@ -16,6 +16,7 @@
 #include "warn.hh"
 #include "stem.hh"
 #include "separation-item.hh"
+#include "spacing-interface.hh"
 #include "staff-spacing.hh"
 #include "accidental-placement.hh"
 #include "output-def.hh"
   spacing?
 */
 
-void
+Spring
 Note_spacing::get_spacing (Grob *me, Item *right_col,
-                          Real base_space, Real increment, Real *space, Real *fixed)
+                          Real base_space, Real increment)
 {
-  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 ();
-  Drul_array<Interval> extents;
+  vector<Item*> note_columns = Spacing_interface::left_note_columns (me);
+  Real left_head_end = 0;
 
-  Interval left_head_wid;
-  do
+  for (vsize i = 0; i < note_columns.size (); i++)
     {
-      Link_array<Grob> const &items (ly_scm2link_array (props [d]));
-      for (int i = items.size (); i--;)
-       {
-         Item *it = dynamic_cast<Item *> (items[i]);
-
-         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_object ("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);
-             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);
-
-                 extents[d].unite (v);
-               }
-
-             if (Grob *arpeggio = Note_column::arpeggio (it))
-               extents[d].unite (arpeggio->extent (it_col, X_AXIS));
-           }
-       }
-
-      if (extents[d].is_empty ())
-       extents[d] = Interval (0, 0);
+       SCM r = note_columns[i]->get_object ("rest");
+       Grob *g = unsmob_grob (r);
+       Grob *col = note_columns[i]->get_column ();
+
+       if (!g)
+        g = Note_column::first_head (note_columns[i]);
+
+       /*
+        Ugh. If Stem is switched off, we don't know what the
+        first note head will be.
+       */
+       if (g)
+        {
+          if (g->common_refpoint (col, X_AXIS) != col)
+            programming_error ("Note_spacing::get_spacing (): Common refpoint incorrect");
+          else
+            left_head_end = g->extent (col, X_AXIS)[RIGHT];
+        }
     }
-  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
-    the full amount of space.
-
-    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))
-
-    /*
-      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 - increment))));
+    The main factor that determines the amount of space is the width of the
+    note head (or the rest). For example, a quarter rest gets almost 0.5 ss
+    less horizontal space than a note.
 
-  /*
-    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.
+    The other parts of a note column (eg. flags, accidentals, etc.) don't get
+    the full amount of space. We give them half the amount of space, but then
+    adjust things so there are no collisions.
   */
-  *space = (base_space - increment) + *fixed;
+  Drul_array<Skyline> skys = Spacing_interface::skylines (me, right_col);
+  Real min_dist = max (0.0, skys[LEFT].distance (skys[RIGHT]));
+  Real min_desired_space = left_head_end + (min_dist - left_head_end) / 2;
 
-#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 ()))
-    {
-      /*
-       This is for the situation
+  /* if the right object sticks out a lot, include a bit of extra space.
+     But only for non-musical-columns; this shouldn't apply to accidentals */
+  if (!Paper_column::is_musical (right_col))
+    min_desired_space = max (min_desired_space,
+                            left_head_end + LEFT * skys[RIGHT].max_height ());
 
-       rest | 3/4 (eol)
+  Real ideal = base_space - increment + min_desired_space;
 
-       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:
-      */
+  stem_dir_correction (me, right_col, increment, &ideal, &min_desired_space);
 
-      *space += -extents[RIGHT][LEFT] / 2;
-      *fixed += -extents[RIGHT][LEFT] / 2;
-    }
-#endif
-  
-  stem_dir_correction (me, right_col, increment, space, fixed);
+  Spring ret (ideal, min_dist);
+  ret.set_inverse_compress_strength (max (0.0, ideal - max (min_dist, min_desired_space)));
+  ret.set_inverse_stretch_strength (max (0.1, base_space - increment));
+  return ret;
 }
 
-Item *
-Note_spacing::left_column (Grob *me)
-{
-  if (!me->is_live ())
-    return 0;
-
-  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.
-*/
-Item *
-Note_spacing::right_column (Grob *me)
-{
-  if (!me->is_live ())
-    return 0;
-
-  Grob_array *a = unsmob_grob_array (me->get_object ("right-items"));
-  Item *mincol = 0;
-  int min_rank = INT_MAX;
-  bool prune = false;
-  for (int i = 0; a && i < a->size (); i++)
-    {
-      Item *ri = a->item (i);
-      Item *col = ri->get_column ();
-
-      int rank = Paper_column::get_rank (col);
-
-      if (rank < min_rank)
-       {
-         min_rank = rank;
-         if (mincol)
-           prune = true;
-
-         mincol = col;
-       }
-    }
-
-  if (prune && a)
-    {
-      Link_array<Grob> &right = a->array_reference ();
-      for (int i = right.size (); i--;)
-       {
-         if (dynamic_cast<Item *> (right[i])->get_column () != mincol)
-           right.del (i);
-       }
-    }
-
-  if (!mincol)
-    return 0;
-
-  return mincol;
-}
 
 /**
    Correct for optical illusions. See [Wanske] p. 138. The combination
    up-stem + down-stem should get extra space, the combination
    down-stem + up-stem less.
 
-   TODO: have to check wether the stems are in the same staff.
+   TODO: have to check whether the stems are in the same staff.
 */
 void
 Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
@@ -264,8 +118,8 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
 
   do
     {
-      Link_array<Grob> const &items (ly_scm2link_array (props [d]));
-      for (int i = 0; i < items.size (); i++)
+      vector<Grob*> const &items (ly_scm2link_array (props [d]));
+      for (vsize i = 0; i < items.size (); i++)
        {
          Item *it = dynamic_cast<Item *> (items[i]);
 
@@ -301,13 +155,13 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
          stems_drul[d] = stem;
          beams_drul[d] = Stem::get_beam (stem);
 
-         Direction sd = get_grob_direction (stem);
-         if (stem_dirs[d] && stem_dirs[d] != sd)
+         Direction stem_dir = get_grob_direction (stem);
+         if (stem_dirs[d] && stem_dirs[d] != stem_dir)
            {
              correct_stem_dirs = false;
              continue;
            }
-         stem_dirs[d] = sd;
+         stem_dirs[d] = stem_dir;
 
          /*
            Correction doesn't seem appropriate  when there is a large flag
@@ -318,12 +172,20 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
            correct_stem_dirs = false;
 
          Interval hp = Stem::head_positions (stem);
-         if (!hp.is_empty ())
+         if (correct_stem_dirs
+             && !hp.is_empty ())
            {
-             Real chord_start = hp[sd];
-             Real stem_end = Stem::stem_end_position (stem);
+             Real chord_start = hp[stem_dir];
 
-             stem_posns[d] = Interval (min (chord_start, stem_end), max (chord_start, stem_end));
+             /*
+               can't look at stem-end-position, since that triggers
+               beam slope computations.
+             */
+             Real stem_end = hp[stem_dir] +
+               stem_dir * robust_scm2double (stem->get_property ("length"), 7);
+
+             stem_posns[d] = Interval (min (chord_start, stem_end),
+                                       max (chord_start, stem_end));
              head_posns[d].unite (hp);
            }
        }
@@ -342,6 +204,7 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
     {
       stem_dirs[RIGHT] = -stem_dirs[LEFT];
       stem_posns[RIGHT] = bar_yextent;
+      stem_posns[RIGHT] *= 2;
     }
 
   if (correct_stem_dirs && stem_dirs[LEFT] * stem_dirs[RIGHT] == -1)
@@ -364,12 +227,7 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
              if (!head_extent.is_empty ())
                note_head_width = head_extent[RIGHT];
 
-             if (st)
-               {
-                 Real thick = Stem::thickness (st);
-
-                 note_head_width -= thick;
-               }
+             note_head_width -= Stem::thickness (st);
            }
 
          correction = note_head_width * stem_dirs[LEFT];
@@ -442,7 +300,15 @@ Note_spacing::stem_dir_correction (Grob *me, Item *rcolumn,
   */
 }
 
-ADD_INTERFACE (Note_spacing, "note-spacing-interface",
+ADD_INTERFACE (Note_spacing,
               "This object calculates spacing wishes for individual voices.",
-              "left-items right-items stem-spacing-correction same-direction-correction knee-spacing-correction");
+
+              
+              "knee-spacing-correction "
+              "left-items "
+              "right-items "
+              "same-direction-correction "
+              "stem-spacing-correction "
+
+              );