]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/separation-item.cc
Run `make grand-replace'.
[lilypond.git] / lily / separation-item.cc
index 8b59a919678891a412152655fb83b51ecc3b2bf4..2483bac0d67a6bbbd07ffdbde5b3e10a78b308f0 100644 (file)
-/*   
-     separation-item.cc --  implement Separation_item
-  
+/*
+  separation-item.cc -- implement Separation_item
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+
+  (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+*/
 
 #include "separation-item.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 "pointer-group-interface.hh"
+#include "skyline-pair.hh"
+#include "stencil.hh"
 #include "warn.hh"
-#include "group-interface.hh"
-#include "accidental-placement.hh"
 
 void
-Separation_item::add_item (Grob*s,Item* i)
+Separation_item::add_item (Grob *s, Item *i)
 {
   assert (i);
-  Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"),i);
-  s->add_dependency (i);
+  Pointer_group_interface::add_grob (s, ly_symbol2scm ("elements"), i);
 }
 
 void
-Separation_item::add_conditional_item (Grob* me , Grob *e)
+Separation_item::add_conditional_item (Grob *me, Grob *e)
 {
   Pointer_group_interface::add_grob (me, ly_symbol2scm ("conditional-elements"), e);
 }
 
-/*
-  Return the width of ME given that we are considering the object on
-  the LEFT.
- */
-Interval
-Separation_item::conditional_width (Grob * me, Grob * left)
+Real
+Separation_item::set_distance (Item *l, Item *r, Real padding)
 {
-  Interval w = width (me);
-  
-  Item *item = dynamic_cast<Item*> (me);
-  Paper_column * pc = item->get_column ();
+  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]);
   
-  
-  for (SCM s =  me->get_grob_property ("conditional-elements"); gh_pair_p (s); s = ly_cdr (s))
+  Real dist = padding + (*lines[LEFT])[RIGHT].distance (right);
+  if (dist > 0)
     {
-      SCM elt = ly_car (s);
-      if (!unsmob_grob (elt))
-       continue;
-      
-      Item *il = unsmob_item (elt);
-      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_grob_property ("no-spacing-rods")))
-       {
-         continue;
-       }
-
-      if (Accidental_placement::has_interface (il))
-       {
-         w.unite (Accidental_placement::get_relevant_accidental_extent (il, pc, left));
-       }
-    }
+      Rod rod;
 
-  SCM pad = me->get_grob_property ("padding");
+      rod.item_drul_ = Drul_array<Item*> (l, r);
 
-  if (gh_number_p (pad))
-    {
-      w[RIGHT] += gh_scm2double (pad)/2;
-      w[LEFT] -= gh_scm2double (pad)/2;    
+      rod.distance_ = dist;
+      rod.add_to_cols ();
     }
-  return w;
+
+  return max (dist, 0.0);
 }
 
-Interval
-Separation_item::width (Grob *me)
+bool
+Separation_item::is_empty (Grob *me)
 {
-  SCM sw = me->get_grob_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;
-  
-  for (SCM s =  me->get_grob_property ("elements"); gh_pair_p (s); s = ly_cdr (s))
-    {
-      SCM elt = ly_car (s);
-      if (!unsmob_grob (elt))
-       continue;
-
-      Item *il = unsmob_item (elt);
-      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_grob_property ("no-spacing-rods")))
-       {
-         continue;
-       }
-
-      Interval iv (il->extent (pc, X_AXIS));
-      if (!iv.is_empty ())
-       {
-         w.unite (iv);
-       }
-    }
+  Skyline_pair *sky = Skyline_pair::unsmob (me->get_property ("horizontal-skylines"));
+  return (!sky || sky->is_empty ());
+}
 
-  SCM pad = me->get_grob_property ("padding");
+/*
+  Return the width of ME given that we are considering the object on
+  the LEFT.
+*/
+Skyline
+Separation_item::conditional_skyline (Grob *me, Grob *left)
+{
+  vector<Box> bs = boxes (me, left);
+  return Skyline (bs, 0.1, Y_AXIS, LEFT);
+}
 
-  if (gh_number_p (pad))
-  {
-    w[RIGHT] += gh_scm2double (pad)/2;
-    w[LEFT] -= gh_scm2double (pad)/2;    
-  }
 
-  me->set_grob_property ("X-extent", ly_interval2scm (w));
-  
-  return w;
+MAKE_SCHEME_CALLBACK (Separation_item, calc_skylines,1);
+SCM
+Separation_item::calc_skylines (SCM smob)
+{
+  Item *me = unsmob_item (smob);
+  vector<Box> bs = boxes (me, 0);
+  /* todo: the horizon_padding is somewhat arbitrary */
+  return Skyline_pair (bs, 0.1, Y_AXIS).smobbed_copy ();
 }
 
-Interval
-Separation_item::relative_width (Grob * me, Grob * common)
+/* 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, Grob *left)
 {
-  Interval iv = width (me);
+  Item *item = dynamic_cast<Item *> (me);
 
-  return dynamic_cast<Item*>(me)->get_column ()->relative_coordinate (common, X_AXIS) + iv ;
-}
+  int very_large = INT_MAX;
+  Paper_column *pc = item->get_column ();
+  vector<Box> out;
+  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);
+      }
+    }
 
-/*
-  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 *separation_item, Direction d,
-                                           Interval * last_ext)
-{
-  Grob *col = dynamic_cast<Item*> (separation_item)->get_column ();
-  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))
+  Grob *ycommon = common_refpoint_of_array (elts, me, Y_AXIS);
+  
+  for (vsize i = 0; i < elts.size (); i++)
     {
-      Grob * break_item = unsmob_grob (gh_car (s));
-      
-      if (!gh_symbol_p (break_item->get_grob_property ("break-align-symbol")))
+      Item *il = dynamic_cast<Item *> (elts[i]);
+      if (pc != il->get_column ())
        continue;
 
-      Interval ext = break_item->extent (col, X_AXIS);
-
-      if (ext.is_empty ())
+      /* 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;
-      if (!last_grob
-         || (last_grob && d * (ext[d]- (*last_ext)[d]) > 0) )
-       {
-         *last_ext = ext;
-         last_grob = break_item; 
-       }
+
+      Interval y (il->pure_height (ycommon, 0, very_large));
+      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 last_grob;  
+  return out;      
 }
 
+MAKE_SCHEME_CALLBACK (Separation_item, print, 1)
+SCM
+Separation_item::print (SCM smob)
+{
+  if (!debug_skylines)
+    return SCM_BOOL_F;
 
+  Grob *me = unsmob_grob (smob);
+  Stencil ret;
+  if (Skyline_pair *s = Skyline_pair::unsmob (me->get_property ("horizontal-skylines")))
+    {
+      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 ret.smobbed_copy ();
+}
 
+ADD_INTERFACE (Separation_item,
+              "Item that computes widths to generate spacing rods.",
 
-
-ADD_INTERFACE (Separation_item,"separation-item-interface",
-  "Item that computes widths to generate spacing rods.\n"
-"\n"
-"Calculate dimensions for the Separating_group_spanner; this has to be "
-"an item to get dependencies correct.  "
-, "padding X-extent conditional-elements elements");
+              /* properties */
+              "X-extent "
+              "conditional-elements "
+              "elements "
+              "padding "
+              "horizontal-skylines "
+              );