]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/separation-item.cc
Merge branch 'master' of ssh://jneem@git.sv.gnu.org/srv/git/lilypond into tmp
[lilypond.git] / lily / separation-item.cc
index 20de8fbbd57b6816723815e66c71753dbddd78b0..4a9eec3ea6291915d455a046a39792fccf69d0b0 100644 (file)
@@ -3,16 +3,21 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #include "separation-item.hh"
 
-#include "skyline.hh"
+#include "accidental-placement.hh"
+#include "axis-group-interface.hh"
+#include "lookup.hh"
+#include "note-column.hh"
+#include "note-head.hh"
 #include "paper-column.hh"
-#include "warn.hh"
 #include "pointer-group-interface.hh"
-#include "accidental-placement.hh"
+#include "skyline-pair.hh"
+#include "stencil.hh"
+#include "warn.hh"
 
 void
 Separation_item::add_item (Grob *s, Item *i)
@@ -27,126 +32,88 @@ Separation_item::add_conditional_item (Grob *me, Grob *e)
   Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
 }
 
-void
-Separation_item::set_skyline_distance (Drul_array<Item *> items,
-                                      Real padding)
+Real
+Separation_item::set_distance (Item *l, Item *r, Real padding)
 {
-  Drul_array<Skyline*> lines;
-  Direction d = LEFT;
-
-  do
-    {
-      SCM prop = items[d]->get_property ("skylines");
-      lines[d] = Skyline::unsmob (index_get_cell (prop, -d));
-    }
-  while (flip (&d) != LEFT);
-
-  Real dist = padding + lines[LEFT]->distance (*lines[RIGHT]);
+  Drul_array<Skyline_pair*> lines (Skyline_pair::unsmob (l->get_property ("horizontal-skylines")),
+                                  Skyline_pair::unsmob (r->get_property ("horizontal-skylines")));
+  Skyline right = conditional_skyline (r, l);
+  right.merge ((*lines[RIGHT])[LEFT]);
+  
+  Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
   if (dist > 0)
     {
       Rod rod;
 
-      rod.item_drul_ = items;
+      rod.item_drul_ = Drul_array<Item*> (l, r);
 
       rod.distance_ = dist;
       rod.add_to_cols ();
-    }  
+    }
+
+  return max (dist, 0.0);
 }
 
 bool
-Separation_item::set_distance (Drul_array<Item *> items,
-                              Real padding)
+Separation_item::is_empty (Grob *me)
 {
-  if (!Item::is_non_musical (items[LEFT])
-      && !Item::is_non_musical (items[RIGHT]))
-    {
-      set_skyline_distance (items, padding);
-      return true;
-    }
-  
-  Interval li (Separation_item::width (items[LEFT]));
-  Interval ri (Separation_item::conditional_width (items[RIGHT], items[LEFT]));
-  if (!li.is_empty () && !ri.is_empty ())
-    {
-      Rod rod;
-
-      rod.item_drul_ = items;
-
-      rod.distance_ = li[RIGHT] - ri[LEFT] + padding;
-
-      if (rod.distance_  > 0)
-       rod.add_to_cols ();
-      return true;
-    }
-  return false;
+  Skyline_pair *sky = Skyline_pair::unsmob (me->get_property ("horizontal-skylines"));
+  return (!sky || sky->is_empty ());
 }
 
 /*
   Return the width of ME given that we are considering the object on
   the LEFT.
 */
-Interval
-Separation_item::conditional_width (Grob *me, Grob *left)
+Skyline
+Separation_item::conditional_skyline (Grob *me, Grob *left)
 {
-  Interval w = width (me);
-
-  Item *item = dynamic_cast<Item *> (me);
-  Paper_column *pc = item->get_column ();
-
-  extract_grob_set (me, "conditional-elements", elts);
-  for (vsize i = 0; i < elts.size (); i++)
-    {
-      Item *il = dynamic_cast<Item *> (elts[i]);
-      if (pc != il->get_column ())
-       {
-         programming_error ("Separation_item element from wrong column");
-         continue;
-       }
-
-      if (to_boolean (il->get_property ("no-spacing-rods")))
-       continue;
-
-      if (Accidental_placement::has_interface (il))
-       w.unite (Accidental_placement::get_relevant_accidental_extent (il, pc, left));
-    }
-
-  SCM pad = me->get_property ("padding");
-
-  w.widen (robust_scm2double (pad, 0.0));
-  return w;
+  vector<Box> bs = boxes (me, left);
+  return Skyline (bs, 0.1, Y_AXIS, LEFT);
 }
 
 
-MAKE_SCHEME_CALLBACK(Separation_item,calc_skylines,1);
+MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines,1);
 SCM
 Separation_item::calc_skylines (SCM smob)
 {
   Item *me = unsmob_item (smob);
-  SCM lines = scm_cons (SCM_BOOL_F,SCM_BOOL_F);
-
-  Direction d = LEFT;
-  vector<Box> bs = boxes (me);
-  do
-    {
-      /* todo: the horizon_padding is somewhat arbitrary */
-      Skyline l (bs, 0.1, Y_AXIS, d);
-      index_set_cell (lines, d, l.smobbed_copy ());
-    }
-  while (flip (&d) != LEFT);
-
-  return lines;
+  vector<Box> bs = boxes (me, 0);
+  /* todo: the horizon_padding is somewhat arbitrary */
+  return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
 }
 
-
+/* if left is non-NULL, get the boxes corresponding to the
+   conditional-elements (conditioned on the grob LEFT). This
+   sounds more general than it is: conditional-elements are
+   always accidentals attached to a tied note.
+*/
 vector<Box>
-Separation_item::boxes (Grob *me)
+Separation_item::boxes (Grob *me, Grob *left)
 {
   Item *item = dynamic_cast<Item *> (me);
 
   int very_large = INT_MAX;
   Paper_column *pc = item->get_column ();
   vector<Box> out;
-  extract_grob_set (me, "elements", elts);
+  extract_grob_set (me, left ? "conditional-elements" : "elements", read_only_elts);
+  vector<Grob*> elts;
+
+  if (left)
+    elts = Accidental_placement::get_relevant_accidentals (read_only_elts, left);
+  else
+    {
+      elts = read_only_elts;
+
+      /* This is a special-case for NoteColumn: we want to include arpeggio in its
+        skyline (so spacing takes it into account) but we don't want to include it
+        in the NoteColumn's extent because some spanners (eg. Hairpin) bound themselves
+        on the NoteColumn and we don't want them to include arpeggios in their bounds.
+      */
+      if (Grob *a = Note_column::arpeggio (me)) {
+       elts.push_back (a);
+      }
+    }
 
   Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
   
@@ -154,115 +121,61 @@ Separation_item::boxes (Grob *me)
     {
       Item *il = dynamic_cast<Item *> (elts[i]);
       if (pc != il->get_column ())
-       {
-         continue;
-       }
+       continue;
 
-      if (to_boolean (il->get_property ("no-spacing-rods")))
+      /* ugh. We want to exclude groups of grobs (so that we insert each grob
+        individually into the skyline instead of adding a single box that
+        bounds all of them). However, we can't exclude an axis-group that
+        adds to its childrens' stencil. Currently, this is just TrillPitchGroup;
+        hence the check for note-head-interface. */
+      if (Axis_group_interface::has_interface (il)
+         && !Note_head::has_interface (il))
        continue;
 
       Interval y (il->pure_height (ycommon, 0, very_large));
-      Box b (il->extent (pc, X_AXIS), y);
-
-      out.push_back (b);
+      Interval x (il->extent (pc, X_AXIS));
+
+      Interval extra_width = robust_scm2interval (elts[i]->get_property ("extra-spacing-width"),
+                                                 Interval (-0.1, 0.1));
+      Interval extra_height = robust_scm2interval (elts[i]->get_property ("extra-spacing-height"),
+                                                  Interval (-0.1, 0.1));
+
+      x[LEFT] += extra_width[LEFT];
+      x[RIGHT] += extra_width[RIGHT];
+      y[DOWN] += extra_height[DOWN];
+      y[UP] += extra_height[UP];
+      if (!x.is_empty () && !y.is_empty ())
+       out.push_back (Box (x, y));
     }
 
   return out;      
 }
 
-Interval
-Separation_item::width (Grob *me)
-{
-  SCM sw = me->get_property ("X-extent");
-  if (is_number_pair (sw))
-    return ly_scm2interval (sw);
-
-  Item *item = dynamic_cast<Item *> (me);
-  Paper_column *pc = item->get_column ();
-  Interval w;
-
-  extract_grob_set (me, "elements", elts);
-  for (vsize i = 0; i < elts.size (); i++)
-    {
-      Item *il = dynamic_cast<Item *> (elts[i]);
-      if (pc != il->get_column ())
-       {
-         /* this shouldn't happen, but let's continue anyway. */
-         programming_error ("Separation_item:  I've been drinking too much");
-         continue;             /*UGH UGH*/
-       }
-
-      if (to_boolean (il->get_property ("no-spacing-rods")))
-       continue;
-
-      Interval iv (il->extent (pc, X_AXIS));
-      if (!iv.is_empty ())
-       w.unite (iv);
-    }
-
-  SCM pad = me->get_property ("padding");
-
-  w.widen (robust_scm2double (pad, 0.0));
-
-  me->set_property ("X-extent", ly_interval2scm (w));
-
-  return w;
-}
-
-Interval
-Separation_item::relative_width (Grob *me, Grob *common)
-{
-  Interval iv = width (me);
-
-  return dynamic_cast<Item *> (me)->get_column ()->relative_coordinate (common, X_AXIS) + iv;
-}
-
-/*
-  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 *
-Separation_item::extremal_break_aligned_grob (Grob *me,
-                                             Direction d,
-                                             Interval *last_ext)
+MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
+SCM
+Separation_item::print (SCM smob)
 {
-  Grob *col = dynamic_cast<Item *> (me)->get_column ();
-  last_ext->set_empty ();
-  Grob *last_grob = 0;
+  if (!debug_skylines)
+    return SCM_BOOL_F;
 
-  extract_grob_set (me, "elements", elts);
-  for (vsize i = elts.size (); i--;)
+  Grob *me = unsmob_grob (smob);
+  Stencil ret;
+  if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")))
     {
-      Grob *break_item = elts[i];
-      if (!scm_is_symbol (break_item->get_property ("break-align-symbol")))
-       continue;
-
-      if (!scm_is_pair (break_item->get_property ("space-alist")))
-       continue;
-
-      Interval ext = break_item->extent (col, X_AXIS);
-
-      if (ext.is_empty ())
-       continue;
-
-      if (!last_grob
-         || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0))
-       {
-         *last_ext = ext;
-         last_grob = break_item;
-       }
+      ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[LEFT].to_points (Y_AXIS)).in_color (255, 255, 0));
+      ret.add_stencil (Lookup::points_to_line_stencil (0.1, (*s)[RIGHT].to_points (Y_AXIS)).in_color (0, 255, 255));
     }
-
-  return last_grob;
+  return ret.smobbed_copy ();
 }
 
 ADD_INTERFACE (Separation_item,
-              "Item that computes widths to generate spacing rods. "
-              "This is done in concert with @ref{separating-group-spanner-interface}.",
+              "Item that computes widths to generate spacing rods.",
 
+              /* properties */
               "X-extent "
               "conditional-elements "
               "elements "
               "padding "
-              "skylines "
+              "horizontal-skylines "
               );