]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/grob.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / grob.cc
index ce3e41c76dbcbf826d9191c9e27511edd23f1209..86ec7e4c6be40b7bc16cf7c3a58b6b631d705049 100644 (file)
@@ -1,16 +1,29 @@
 /*
-  grob.cc -- implement Grob
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "grob.hh"
 
 #include <cstring>
+#include <set>
 
 #include "align-interface.hh"
+#include "axis-group-interface.hh"
 #include "input.hh"
 #include "international.hh"
 #include "item.hh"
@@ -23,6 +36,7 @@
 #include "stencil.hh"
 #include "stream-event.hh"
 #include "system.hh"
+#include "unpure-pure-container.hh"
 #include "warn.hh"
 
 #include "ly-smobs.icc"
@@ -33,9 +47,9 @@ Grob::clone () const
   return new Grob (*this);
 }
 
-Grob::Grob (SCM basicprops)        
+Grob::Grob (SCM basicprops)
 {
-  
+
   /* FIXME: default should be no callback.  */
   self_scm_ = SCM_EOL;
   layout_ = 0;
@@ -44,7 +58,7 @@ Grob::Grob (SCM basicprops)
   immutable_property_alist_ = basicprops;
   mutable_property_alist_ = SCM_EOL;
   object_alist_ = SCM_EOL;
-  
+
   /* We do smobify_self () as the first step.  Since the object lives
      on the heap, none of its SCM variables are protected from
      GC. After smobify_self (), they are.  */
@@ -57,32 +71,48 @@ Grob::Grob (SCM basicprops)
 
       SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta);
       if (scm_is_pair (object_cbs))
-       {
-         for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s))
-           set_object (scm_caar (s), scm_cdar (s)); 
-       }
+        {
+          for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s))
+            set_object (scm_caar (s), scm_cdar (s));
+        }
     }
-  
+
   if (get_property_data ("X-extent") == SCM_EOL)
     set_property ("X-extent", Grob::stencil_width_proc);
   if (get_property_data ("Y-extent") == SCM_EOL)
-    set_property ("Y-extent", Grob::stencil_height_proc);
+    set_property ("Y-extent",
+                  ly_make_unpure_pure_container (Grob::stencil_height_proc,
+                                                 Grob::pure_stencil_height_proc));
+  if (get_property_data ("vertical-skylines") == SCM_EOL)
+    set_property ("vertical-skylines",
+                  ly_make_unpure_pure_container (Grob::simple_vertical_skylines_from_extents_proc,
+                                                 Grob::pure_simple_vertical_skylines_from_extents_proc));
+  if (get_property_data ("horizontal-skylines") == SCM_EOL)
+    set_property ("horizontal-skylines",
+                  ly_make_unpure_pure_container (Grob::simple_horizontal_skylines_from_extents_proc,
+                                                 Grob::pure_simple_horizontal_skylines_from_extents_proc));
 }
 
 Grob::Grob (Grob const &s)
-  : dim_cache_ (s.dim_cache_)
 {
   original_ = (Grob *) & s;
   self_scm_ = SCM_EOL;
 
   immutable_property_alist_ = s.immutable_property_alist_;
-  mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
+  mutable_property_alist_ = SCM_EOL;
+
+  for (Axis a = X_AXIS; a < NO_AXES; incr (a))
+      dim_cache_ [a] = s.dim_cache_ [a];
+
   interfaces_ = s.interfaces_;
   object_alist_ = SCM_EOL;
 
   layout_ = 0;
 
   smobify_self ();
+
+  mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
+
 }
 
 Grob::~Grob ()
@@ -111,37 +141,60 @@ Grob::get_print_stencil () const
   if (Stencil *m = unsmob_stencil (stil))
     {
       retval = *m;
-      if (to_boolean (get_property ("transparent")))
-       retval = Stencil (m->extent_box (), SCM_EOL);
+      bool transparent = to_boolean (get_property ("transparent"));
+
+      if (transparent)
+        retval = Stencil (m->extent_box (), SCM_EOL);
       else
-       {
-         SCM expr = m->expr ();
-         expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
-                            self_scm (), expr);
+        {
+          SCM expr = m->expr ();
+          expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
+                             self_scm (), expr);
 
-         retval = Stencil (m->extent_box (), expr);
-       }
+          retval = Stencil (m->extent_box (), expr);
+        }
 
       SCM rot = get_property ("rotation");
       if (scm_is_pair (rot))
-       {
-         Real angle = scm_to_double (scm_car (rot));
-         Real x = scm_to_double (scm_cadr (rot));
-         Real y = scm_to_double (scm_caddr (rot));
+        {
+          Real angle = scm_to_double (scm_car (rot));
+          Real x = scm_to_double (scm_cadr (rot));
+          Real y = scm_to_double (scm_caddr (rot));
 
-         retval.rotate_degrees (angle, Offset (x, y));
-       }
+          retval.rotate_degrees (angle, Offset (x, y));
+        }
 
       /* color support... see interpret_stencil_expression () for more... */
       SCM color = get_property ("color");
       if (scm_is_pair (color))
-       {
-         SCM expr = scm_list_3 (ly_symbol2scm ("color"),
-                                color,
-                                retval.expr ());
-
-         retval = Stencil (retval.extent_box (), expr);
-       }
+        {
+          SCM expr = scm_list_3 (ly_symbol2scm ("color"),
+                                 color,
+                                 retval.expr ());
+
+          retval = Stencil (retval.extent_box (), expr);
+        }
+
+      /* process whiteout */
+      /* a grob has to be visible, otherwise the whiteout property has no effect */
+      if (!transparent && to_boolean (get_property ("whiteout")))
+        {
+          /* Call the scheme procedure stencil-whiteout in scm/stencils.scm */
+          /* to add a round-filled-box stencil to the stencil list */
+          retval
+            = *unsmob_stencil (scm_call_1 (ly_lily_module_constant ("stencil-whiteout"),
+                                           retval.smobbed_copy ()));
+        }
+
+      SCM id = get_property ("id");
+      if (scm_is_string (id))
+        {
+          SCM expr = scm_list_3 (ly_symbol2scm ("id"),
+                                 id,
+                                 retval.expr ());
+
+          retval = Stencil (retval.extent_box (), expr);
+        }
 
     }
 
@@ -167,6 +220,16 @@ Grob::get_system () const
   return 0;
 }
 
+/* This version of get_system is more reliable than this->get_system ()
+   before line-breaking has been done, at which point there is only
+   one system in the whole score and we can find it just by following
+   parent pointers. */
+System *
+Grob::get_system (Grob *me)
+{
+  Grob *p = me->get_parent (X_AXIS);
+  return p ? get_system (p) : dynamic_cast<System *>(me);
+}
 
 void
 Grob::handle_broken_dependencies ()
@@ -181,7 +244,7 @@ Grob::handle_broken_dependencies ()
        properties, and a special function fixes FOO  */
     {
       for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s))
-       sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
+        sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
     }
   System *system = get_system ();
 
@@ -230,7 +293,7 @@ Grob::handle_prebroken_dependencies ()
     {
       Item *it = dynamic_cast<Item *> (this);
       substitute_object_links (scm_from_int (it->break_status_dir ()),
-                              original ()->object_alist_);
+                               original ()->object_alist_);
     }
 }
 
@@ -249,14 +312,14 @@ Grob::translate_axis (Real y, Axis a)
 {
   if (isinf (y) || isnan (y))
     {
-      programming_error (_ ("Infinity or NaN encountered"));
-      return ;
+      programming_error ("Infinity or NaN encountered");
+      return;
     }
-  
+
   if (!dim_cache_[a].offset_)
     dim_cache_[a].offset_ = new Real (y);
   else
-    *dim_cache_[a].offset_ += y;  
+    *dim_cache_[a].offset_ += y;
 }
 
 /* Find the offset relative to D.  If D equals THIS, then it is 0.
@@ -275,7 +338,7 @@ Grob::relative_coordinate (Grob const *refp, Axis a) const
   Real off = get_offset (a);
   if (refp == dim_cache_[a].parent_)
     return off;
-  
+
   off += dim_cache_[a].parent_->relative_coordinate (refp, a);
 
   return off;
@@ -292,7 +355,7 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
   if (dim_cache_[Y_AXIS].offset_)
     {
       if (to_boolean (get_property ("pure-Y-offset-in-progress")))
-       programming_error ("cyclic chain in pure-Y-offset callbacks");
+        programming_error ("cyclic chain in pure-Y-offset callbacks");
 
       off = *dim_cache_[Y_AXIS].offset_;
     }
@@ -303,9 +366,9 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
       dim_cache_[Y_AXIS].offset_ = new Real (0.0);
       set_property ("pure-Y-offset-in-progress", SCM_BOOL_T);
       off = robust_scm2double (call_pure_function (proc,
-                                                  scm_list_1 (self_scm ()),
-                                                  start, end),
-                              0.0);
+                                                   scm_list_1 (self_scm ()),
+                                                   start, end),
+                               0.0);
       del_property ("pure-Y-offset-in-progress");
       delete dim_cache_[Y_AXIS].offset_;
       dim_cache_[Y_AXIS].offset_ = 0;
@@ -320,7 +383,7 @@ Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
     {
       Real trans = 0;
       if (Align_interface::has_interface (p) && !dim_cache_[Y_AXIS].offset_)
-       trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
+        trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
 
       return off + trans + p->pure_relative_y_coordinate (refp, start, end);
     }
@@ -360,7 +423,7 @@ Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int
   if (pure && a != Y_AXIS)
     programming_error ("tried to get pure X-offset");
   return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end)
-    : relative_coordinate (refp, a);
+         : relative_coordinate (refp, a);
 }
 
 /****************************************************************
@@ -373,18 +436,17 @@ Grob::flush_extent_cache (Axis axis)
   if (dim_cache_[axis].extent_)
     {
       /*
-       Ugh, this is not accurate; will flush property, causing
-       callback to be called if.
+        Ugh, this is not accurate; will flush property, causing
+        callback to be called if.
        */
       del_property ((axis == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"));
       delete dim_cache_[axis].extent_;
       dim_cache_[axis].extent_ = 0;
       if (get_parent (axis))
-       get_parent (axis)->flush_extent_cache (axis);
+        get_parent (axis)->flush_extent_cache (axis);
     }
 }
 
-
 Interval
 Grob::extent (Grob *refp, Axis a) const
 {
@@ -397,41 +459,43 @@ Grob::extent (Grob *refp, Axis a) const
   else
     {
       /*
-       Order is significant: ?-extent may trigger suicide.
+        Order is significant: ?-extent may trigger suicide.
        */
-      SCM ext_sym =
-       (a == X_AXIS)
-       ? ly_symbol2scm ("X-extent")
-       : ly_symbol2scm ("Y-extent");
-       
+      SCM ext_sym
+        = (a == X_AXIS)
+          ? ly_symbol2scm ("X-extent")
+          : ly_symbol2scm ("Y-extent");
+
       SCM ext = internal_get_property (ext_sym);
       if (is_number_pair (ext))
-       real_ext.unite (ly_scm2interval (ext));
+        real_ext.unite (ly_scm2interval (ext));
 
-      SCM min_ext_sym =
-       (a == X_AXIS)
-       ? ly_symbol2scm ("minimum-X-extent")
-       : ly_symbol2scm ("minimum-Y-extent");
+      SCM min_ext_sym
+        = (a == X_AXIS)
+          ? ly_symbol2scm ("minimum-X-extent")
+          : ly_symbol2scm ("minimum-Y-extent");
       SCM min_ext = internal_get_property (min_ext_sym);
       if (is_number_pair (min_ext))
-       real_ext.unite (ly_scm2interval (min_ext));
+        real_ext.unite (ly_scm2interval (min_ext));
 
-      ((Grob*)this)->dim_cache_[a].extent_ = new Interval (real_ext);  
+      ((Grob *)this)->dim_cache_[a].extent_ = new Interval (real_ext);
     }
-  
-  real_ext.translate (offset);
-  
+
+  // We never want nan, so we avoid shifting infinite values.
+    if(!isinf (offset))
+      real_ext.translate(offset);
+    else
+      this->warning(_f ("ignored infinite %s-offset",
+                        a == X_AXIS ? "X" : "Y"));
+
   return real_ext;
 }
 
 Interval
 Grob::pure_height (Grob *refp, int start, int end)
 {
-  SCM proc = get_property_data (ly_symbol2scm ("Y-extent"));
-  SCM iv_scm = call_pure_function (proc,
-                                  scm_list_1 (self_scm ()),
-                                  start, end);
-  Interval iv = robust_scm2interval (iv_scm, Interval (0, 0));
+  SCM iv_scm = get_pure_property ("Y-extent", start, end);
+  Interval iv = robust_scm2interval (iv_scm, Interval ());
   Real offset = pure_relative_y_coordinate (refp, start, end);
 
   SCM min_ext = get_property ("minimum-Y-extent");
@@ -450,8 +514,6 @@ Grob::pure_height (Grob *refp, int start, int end)
 Interval
 Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
 {
-  if (pure && a != Y_AXIS)
-    programming_error ("tried to get pure width");
   return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a);
 }
 
@@ -461,6 +523,19 @@ Grob::spanned_rank_interval () const
   return Interval_t<int> (-1, 0);
 }
 
+bool
+Grob::pure_is_visible (int /* start */, int /* end */) const
+{
+  return true;
+}
+
+/* Sort grobs according to their starting column. */
+bool
+Grob::less (Grob *g1, Grob *g2)
+{
+  return g1->spanned_rank_interval ()[LEFT] < g2->spanned_rank_interval ()[LEFT];
+}
+
 /****************************************************************
   REFPOINTS
 ****************************************************************/
@@ -469,15 +544,39 @@ Grob::spanned_rank_interval () const
 Grob *
 Grob::common_refpoint (Grob const *s, Axis a) const
 {
-  /* I don't like the quadratic aspect of this code, but I see no
-     other way.  The largest chain of parents might be 10 high or so,
-     so it shouldn't be a real issue.  */
-  for (Grob const *c = this; c; c = c->dim_cache_[a].parent_)
-    for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
-      if (d == c)
-       return (Grob *) d;
 
-  return 0;
+  /* Catching the trivial cases is likely costlier than just running
+     through: one can't avoid going to the respective chain ends
+     anyway.  We might save the second run through when the chain ends
+     differ, but keeping track of the ends makes the loop more costly.
+  */
+
+  int balance = 0;
+  Grob const *c;
+  Grob const *d;
+
+  for (c = this; c; ++balance)
+    c = c->dim_cache_[a].parent_;
+
+  for (d = s; d; --balance)
+    d = d->dim_cache_[a].parent_;
+
+  /* Cut down ancestry to same size */
+
+  for (c = this; balance > 0; --balance)
+    c = c->dim_cache_[a].parent_;
+
+  for (d = s; balance < 0; ++balance)
+    d = d->dim_cache_[a].parent_;
+
+  /* Now find point where our lineages converge */
+  while (c != d)
+    {
+      c = c->dim_cache_[a].parent_;
+      d = d->dim_cache_[a].parent_;
+    }
+
+  return (Grob *) c;
 }
 
 void
@@ -492,7 +591,6 @@ Grob::get_parent (Axis a) const
   return dim_cache_[a].parent_;
 }
 
-
 void
 Grob::fixup_refpoint ()
 {
@@ -502,155 +600,241 @@ Grob::fixup_refpoint ()
       Grob *parent = get_parent (ax);
 
       if (!parent)
-       continue;
+        continue;
 
       if (parent->get_system () != get_system () && get_system ())
-       {
-         Grob *newparent = parent->find_broken_piece (get_system ());
-         set_parent (newparent, ax);
-       }
+        {
+          Grob *newparent = parent->find_broken_piece (get_system ());
+          set_parent (newparent, ax);
+        }
 
       if (Item *i = dynamic_cast<Item *> (this))
-       {
-         Item *parenti = dynamic_cast<Item *> (parent);
-
-         if (parenti && i)
-           {
-             Direction my_dir = i->break_status_dir ();
-             if (my_dir != parenti->break_status_dir ())
-               {
-                 Item *newparent = parenti->find_prebroken_piece (my_dir);
-                 set_parent (newparent, ax);
-               }
-           }
-       }
+        {
+          Item *parenti = dynamic_cast<Item *> (parent);
+
+          if (parenti && i)
+            {
+              Direction my_dir = i->break_status_dir ();
+              if (my_dir != parenti->break_status_dir ())
+                {
+                  Item *newparent = parenti->find_prebroken_piece (my_dir);
+                  set_parent (newparent, ax);
+                }
+            }
+        }
     }
 }
 
+/****************************************************************
+  VERTICAL ORDERING
+****************************************************************/
+
+Grob *
+get_maybe_root_vertical_alignment (Grob *g, Grob *maybe)
+{
+  if (!g)
+    return maybe;
+  if (Align_interface::has_interface (g))
+    return get_maybe_root_vertical_alignment (g->get_parent (Y_AXIS), g);
+  return get_maybe_root_vertical_alignment (g->get_parent (Y_AXIS), maybe);
+
+}
+
+Grob *
+Grob::get_root_vertical_alignment (Grob *g)
+{
+  return get_maybe_root_vertical_alignment (g, 0);
+}
+
+Grob *
+Grob::get_vertical_axis_group (Grob *g)
+{
+  if (!g)
+    return 0;
+  if (!g->get_parent (Y_AXIS))
+    return 0;
+  if (Axis_group_interface::has_interface (g)
+      && Align_interface::has_interface (g->get_parent (Y_AXIS)))
+    return g;
+  return get_vertical_axis_group (g->get_parent (Y_AXIS));
+
+}
+
+int
+Grob::get_vertical_axis_group_index (Grob *g)
+{
+  Grob *val = get_root_vertical_alignment (g);
+  if (!val)
+    return -1;
+  Grob *vax = get_vertical_axis_group (g);
+  extract_grob_set (val, "elements", elts);
+  for (vsize i = 0; i < elts.size (); i++)
+    if (elts[i] == vax)
+      return (int) i;
+  g->programming_error ("could not find this grob's vertical axis group in the vertical alignment");
+  return -1;
+}
+
+bool
+Grob::vertical_less (Grob *g1, Grob *g2)
+{
+  return internal_vertical_less (g1, g2, false);
+}
+
+bool
+Grob::pure_vertical_less (Grob *g1, Grob *g2)
+{
+  return internal_vertical_less (g1, g2, true);
+}
+
+bool
+Grob::internal_vertical_less (Grob *g1, Grob *g2, bool pure)
+{
+  Grob *vag = get_root_vertical_alignment (g1);
+  if (!vag)
+    {
+      g1->programming_error ("grob does not belong to a VerticalAlignment?");
+      return false;
+    }
+
+  Grob *ag1 = get_vertical_axis_group (g1);
+  Grob *ag2 = get_vertical_axis_group (g2);
+
+  extract_grob_set (vag, "elements", elts);
+
+  if (ag1 == ag2 && !pure)
+    {
+      Grob *common = g1->common_refpoint (g2, Y_AXIS);
+      return g1->relative_coordinate (common, Y_AXIS) > g2->relative_coordinate (common, Y_AXIS);
+    }
+
+  for (vsize i = 0; i < elts.size (); i++)
+    {
+      if (elts[i] == ag1)
+        return true;
+      if (elts[i] == ag2)
+        return false;
+    }
+
+  g1->programming_error ("could not place this grob in its axis group");
+  return false;
+}
 
 /****************************************************************
   MESSAGES
 ****************************************************************/
 void
-Grob::warning (string s) const
+Grob::programming_error (const string &s) const
 {
-  if (get_program_option ("warning-as-error"))
-    error (s);
-
   SCM cause = self_scm ();
   while (Grob *g = unsmob_grob (cause))
     cause = g->get_property ("cause");
 
   /* ES TODO: cause can't be Music*/
   if (Music *m = unsmob_music (cause))
-    m->origin ()->warning (s);
+    m->origin ()->programming_error (s);
   else if (Stream_event *ev = unsmob_stream_event (cause))
-    ev->origin ()->warning (s);
+    ev->origin ()->programming_error (s);
   else
-    ::warning (s);
-}
-
-
-string
-Grob::name () const
-{
-  SCM meta = get_property ("meta");
-  SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
-  nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
-  return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
+    ::programming_error (s);
 }
 
 void
-Grob::programming_error (string s) const
+Grob::warning (const string &s) const
 {
-  if (get_program_option ("warning-as-error"))
-    error (s);
-
   SCM cause = self_scm ();
   while (Grob *g = unsmob_grob (cause))
     cause = g->get_property ("cause");
 
-  s = _f ("programming error: %s", s);
-
   /* ES TODO: cause can't be Music*/
   if (Music *m = unsmob_music (cause))
-    m->origin ()->message (s);
+    m->origin ()->warning (s);
   else if (Stream_event *ev = unsmob_stream_event (cause))
-    ev->origin ()->message (s);
+    ev->origin ()->warning (s);
   else
-    ::message (s);
+    ::warning (s);
 }
 
+string
+Grob::name () const
+{
+  SCM meta = get_property ("meta");
+  SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
+  nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
+  return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
+}
 
 ADD_INTERFACE (Grob,
-              "A grob represents a piece of music notation.\n"
-              "\n"
-              "All grobs have an X and Y@tie{}position on the page.  These"
-              " X and Y@tie{}positions are stored in a relative format, thus"
-              " they can easily be combined by stacking them, hanging one"
-              " grob to the side of another, or coupling them into grouping"
-              " objects.\n"
-              "\n"
-              "Each grob has a reference point (a.k.a.@: parent): The"
-              " position of a grob is stored relative to that reference"
-              " point.  For example, the X@tie{}reference point of a staccato"
-              " dot usually is the note head that it applies to.  When the"
-              " note head is moved, the staccato dot moves along"
-              " automatically.\n"
-              "\n"
-              "A grob is often associated with a symbol, but some grobs do"
-              " not print any symbols.  They take care of grouping objects."
-              " For example, there is a separate grob that stacks staves"
-              " vertically.  The @ref{NoteCollision} object is also an"
-              " abstract grob: It only moves around chords, but doesn't print"
-              " anything.\n"
-              "\n"
-              "Grobs have properties (Scheme variables) that can be read and"
-              " set.  Two types of them exist: immutable and mutable."
-              "  Immutable variables define the default style and behavior."
-              "  They are shared between many objects.  They can be changed"
-              " using @code{\\override} and @code{\\revert}.  Mutable"
-              " properties are variables that are specific to one grob."
-              "  Typically, lists of other objects, or results from"
-              " computations are stored in mutable properties.  In"
-              " particular, every call to @code{ly:grob-set-property!}"
-              " (or its C++ equivalent) sets a mutable property.\n"
-              "\n"
-              "The properties @code{after-line-breaking} and"
-              " @code{before-line-breaking} are dummies that are not"
-              " user-serviceable.",
-
-              /* properties */
-              "X-extent "
-              "X-offset "
-              "Y-extent "
-              "Y-offset "
-              "after-line-breaking "
-              "avoid-slur "
-              "axis-group-parent-X "
-              "axis-group-parent-Y "
-              "before-line-breaking "
-              "cause "
-              "color "
-              "cross-staff "
-              "extra-X-extent "
-              "extra-Y-extent "
-              "extra-offset "
-              "interfaces "
-              "layer "
-              "meta "
-              "minimum-X-extent "
-              "minimum-Y-extent "
-              "outside-staff-horizontal-padding "
-              "outside-staff-padding "
-              "outside-staff-priority "
-              "pure-Y-offset-in-progress "
-              "rotation "
-              "springs-and-rods "
-              "staff-symbol "
-              "stencil "
-              "transparent "
-              );
+               "A grob represents a piece of music notation.\n"
+               "\n"
+               "All grobs have an X and Y@tie{}position on the page.  These"
+               " X and Y@tie{}positions are stored in a relative format, thus"
+               " they can easily be combined by stacking them, hanging one"
+               " grob to the side of another, or coupling them into grouping"
+               " objects.\n"
+               "\n"
+               "Each grob has a reference point (a.k.a.@: parent): The"
+               " position of a grob is stored relative to that reference"
+               " point.  For example, the X@tie{}reference point of a staccato"
+               " dot usually is the note head that it applies to.  When the"
+               " note head is moved, the staccato dot moves along"
+               " automatically.\n"
+               "\n"
+               "A grob is often associated with a symbol, but some grobs do"
+               " not print any symbols.  They take care of grouping objects."
+               " For example, there is a separate grob that stacks staves"
+               " vertically.  The @ref{NoteCollision} object is also an"
+               " abstract grob: It only moves around chords, but doesn't print"
+               " anything.\n"
+               "\n"
+               "Grobs have properties (Scheme variables) that can be read and"
+               " set.  Two types of them exist: immutable and mutable."
+               "  Immutable variables define the default style and behavior."
+               "  They are shared between many objects.  They can be changed"
+               " using @code{\\override} and @code{\\revert}.  Mutable"
+               " properties are variables that are specific to one grob."
+               "  Typically, lists of other objects, or results from"
+               " computations are stored in mutable properties.  In"
+               " particular, every call to @code{ly:grob-set-property!}"
+               " (or its C++ equivalent) sets a mutable property.\n"
+               "\n"
+               "The properties @code{after-line-breaking} and"
+               " @code{before-line-breaking} are dummies that are not"
+               " user-serviceable.",
+
+               /* properties */
+               "X-extent "
+               "X-offset "
+               "Y-extent "
+               "Y-offset "
+               "after-line-breaking "
+               "avoid-slur "
+               "axis-group-parent-X "
+               "axis-group-parent-Y "
+               "before-line-breaking "
+               "cause "
+               "color "
+               "cross-staff "
+               "id "
+               "extra-offset "
+               "footnote-music "
+               "forced-spacing "
+               "horizontal-skylines "
+               "interfaces "
+               "layer "
+               "meta "
+               "minimum-X-extent "
+               "minimum-Y-extent "
+               "pure-Y-offset-in-progress "
+               "rotation "
+               "skyline-horizontal-padding "
+               "springs-and-rods "
+               "staff-symbol "
+               "stencil "
+               "transparent "
+               "vertical-skylines "
+               "whiteout "
+              );
 
 /****************************************************************
   CALLBACKS
@@ -666,7 +850,6 @@ grob_stencil_extent (Grob *me, Axis a)
   return ly_interval2scm (e);
 }
 
-
 MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1);
 SCM
 Grob::stencil_height (SCM smob)
@@ -675,6 +858,18 @@ Grob::stencil_height (SCM smob)
   return grob_stencil_extent (me, Y_AXIS);
 }
 
+MAKE_SCHEME_CALLBACK (Grob, pure_stencil_height, 3);
+SCM
+Grob::pure_stencil_height (SCM smob, SCM /* beg */, SCM /* end */)
+{
+  Grob *me = unsmob_grob (smob);
+  if (unsmob_stencil (me->get_property_data ("stencil")))
+    return grob_stencil_extent (me, Y_AXIS);
+
+  return ly_interval2scm (Interval ());
+
+}
+
 MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1);
 SCM
 Grob::y_parent_positioning (SCM smob)
@@ -687,13 +882,12 @@ Grob::y_parent_positioning (SCM smob)
   return scm_from_double (0.0);
 }
 
-
 MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1);
 SCM
 Grob::x_parent_positioning (SCM smob)
 {
   Grob *me = unsmob_grob (smob);
-  
+
   Grob *par = me->get_parent (X_AXIS);
   if (par)
     (void) par->get_property ("positioning-done");
@@ -709,24 +903,23 @@ Grob::stencil_width (SCM smob)
   return grob_stencil_extent (me, X_AXIS);
 }
 
-
 Grob *
 common_refpoint_of_list (SCM elist, Grob *common, Axis a)
 {
   for (; scm_is_pair (elist); elist = scm_cdr (elist))
     if (Grob *s = unsmob_grob (scm_car (elist)))
       {
-       if (common)
-         common = common->common_refpoint (s, a);
-       else
-         common = s;
+        if (common)
+          common = common->common_refpoint (s, a);
+        else
+          common = s;
       }
 
   return common;
 }
 
 Grob *
-common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
+common_refpoint_of_array (vector<Grob *> const &arr, Grob *common, Axis a)
 {
   for (vsize i = 0; i < arr.size (); i++)
     if (common)
@@ -737,6 +930,20 @@ common_refpoint_of_array (vector<Grob*> const &arr, Grob *common, Axis a)
   return common;
 }
 
+Grob *
+common_refpoint_of_array (set<Grob *> const &arr, Grob *common, Axis a)
+{
+  set<Grob *>::iterator it;
+
+  for (it = arr.begin (); it != arr.end (); it++)
+    if (common)
+      common = common->common_refpoint (*it, a);
+    else
+      common = *it;
+
+  return common;
+}
+
 Interval
 robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
 {
@@ -761,3 +968,51 @@ Grob::check_cross_staff (Grob *commony)
 
   return false;
 }
+
+static
+bool
+indirect_less (Grob **a, Grob **b)
+{
+  // Use original order as tie breaker.  That gives us a stable sort
+  // at the lower price tag of an unstable one, and we want a stable
+  // sort in order to reliably retain the first instance of a grob
+  // pointer.
+  return *a < *b || (*a == *b && a < b);
+}
+
+static
+bool
+indirect_eq (Grob **a, Grob **b)
+{
+  return *a == *b;
+}
+
+static
+bool
+direct_less (Grob **a, Grob **b)
+{
+  return a < b;
+}
+
+// uniquify uniquifies on the memory addresses of the Grobs, but then
+// uses the original order.  This makes results independent from the
+// memory allocation of Grobs.
+
+void
+uniquify (vector <Grob *> & grobs)
+{
+  vector <Grob **> vec (grobs.size ());
+  for (vsize i = 0; i < grobs.size (); i++)
+    vec[i] = &grobs[i];
+  vector_sort (vec, indirect_less);
+  vec.erase (unique (vec.begin (), vec.end (), indirect_eq), vec.end ());
+  vector_sort (vec, direct_less);
+
+  // Since the output is a sorted copy of the input with some elements
+  // removed, we can fill in the vector in-place if we do it starting
+  // from the front.
+  for (vsize i = 0; i < vec.size (); i++)
+    grobs[i] = *vec[i];
+  grobs.erase (grobs.begin () + vec.size (), grobs.end ());
+  return;
+}