lily/grob.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "grob.hh"
  21
  22 #include <cstring>
  23
  24 #include "align-interface.hh"
  25 #include "axis-group-interface.hh"
  26 #include "input.hh"
  27 #include "international.hh"
  28 #include "item.hh"
  29 #include "main.hh"
  30 #include "misc.hh"
  31 #include "music.hh"
  32 #include "output-def.hh"
  33 #include "pointer-group-interface.hh"
  34 #include "program-option.hh"
  35 #include "stencil.hh"
  36 #include "stream-event.hh"
  37 #include "system.hh"
  38 #include "warn.hh"
  39
  40 #include "ly-smobs.icc"
  41
  42 Grob *
  43 Grob::clone () const
  44 {
  45   return new Grob (*this);
  46 }
  47
  48 Grob::Grob (SCM basicprops)
  49 {
  50
  51   /* FIXME: default should be no callback.  */
  52   self_scm_ = SCM_EOL;
  53   layout_ = 0;
  54   original_ = 0;
  55   interfaces_ = SCM_EOL;
  56   immutable_property_alist_ = basicprops;
  57   mutable_property_alist_ = SCM_EOL;
  58   object_alist_ = SCM_EOL;
  59
  60   /* We do smobify_self () as the first step.  Since the object lives
  61      on the heap, none of its SCM variables are protected from
  62      GC. After smobify_self (), they are.  */
  63   smobify_self ();
  64
  65   SCM meta = get_property ("meta");
  66   if (scm_is_pair (meta))
  67     {
  68       interfaces_ = scm_cdr (scm_assq (ly_symbol2scm ("interfaces"), meta));
  69
  70       SCM object_cbs = scm_assq (ly_symbol2scm ("object-callbacks"), meta);
  71       if (scm_is_pair (object_cbs))
  72         {
  73           for (SCM s = scm_cdr (object_cbs); scm_is_pair (s); s = scm_cdr (s))
  74             set_object (scm_caar (s), scm_cdar (s));
  75         }
  76     }
  77
  78   if (get_property_data ("X-extent") == SCM_EOL)
  79     set_property ("X-extent", Grob::stencil_width_proc);
  80   if (get_property_data ("Y-extent") == SCM_EOL)
  81     set_property ("Y-extent", Grob::stencil_height_proc);
  82 }
  83
  84 Grob::Grob (Grob const &s)
  85   : dim_cache_ (s.dim_cache_)
  86 {
  87   original_ = (Grob *) & s;
  88   self_scm_ = SCM_EOL;
  89
  90   immutable_property_alist_ = s.immutable_property_alist_;
  91   mutable_property_alist_ = SCM_EOL;
  92   interfaces_ = s.interfaces_;
  93   object_alist_ = SCM_EOL;
  94
  95   layout_ = 0;
  96
  97   smobify_self ();
  98
  99   mutable_property_alist_ = ly_deep_copy (s.mutable_property_alist_);
 100
 101 }
 102
 103 Grob::~Grob ()
 104 {
 105 }
 106 /****************************************************************
 107   STENCILS
 108 ****************************************************************/
 109
 110 Stencil *
 111 Grob::get_stencil () const
 112 {
 113   if (!is_live ())
 114     return 0;
 115
 116   SCM stil = get_property ("stencil");
 117   return unsmob_stencil (stil);
 118 }
 119
 120 Stencil
 121 Grob::get_print_stencil () const
 122 {
 123   SCM stil = get_property ("stencil");
 124
 125   Stencil retval;
 126   if (Stencil *m = unsmob_stencil (stil))
 127     {
 128       retval = *m;
 129       bool transparent = to_boolean (get_property ("transparent"));
 130
 131       if (transparent)
 132         retval = Stencil (m->extent_box (), SCM_EOL);
 133       else
 134         {
 135           SCM expr = m->expr ();
 136           expr = scm_list_3 (ly_symbol2scm ("grob-cause"),
 137                              self_scm (), expr);
 138
 139           retval = Stencil (m->extent_box (), expr);
 140         }
 141
 142       SCM rot = get_property ("rotation");
 143       if (scm_is_pair (rot))
 144         {
 145           Real angle = scm_to_double (scm_car (rot));
 146           Real x = scm_to_double (scm_cadr (rot));
 147           Real y = scm_to_double (scm_caddr (rot));
 148
 149           retval.rotate_degrees (angle, Offset (x, y));
 150         }
 151
 152       /* color support... see interpret_stencil_expression () for more... */
 153       SCM color = get_property ("color");
 154       if (scm_is_pair (color))
 155         {
 156           SCM expr = scm_list_3 (ly_symbol2scm ("color"),
 157                                  color,
 158                                  retval.expr ());
 159
 160           retval = Stencil (retval.extent_box (), expr);
 161         }
 162
 163       /* process whiteout */
 164       /* a grob has to be visible, otherwise the whiteout property has no effect */
 165       if (!transparent && to_boolean (get_property ("whiteout")))
 166         {
 167           /* Call the scheme procedure stencil-whiteout in scm/stencils.scm */
 168           /* to add a round-filled-box stencil to the stencil list */
 169           retval
 170             = *unsmob_stencil (scm_call_1 (ly_lily_module_constant ("stencil-whiteout"),
 171                                            retval.smobbed_copy ()));
 172         }
 173     }
 174
 175   return retval;
 176 }
 177
 178 /****************************************************************
 179   VIRTUAL STUBS
 180 ****************************************************************/
 181 void
 182 Grob::do_break_processing ()
 183 {
 184 }
 185
 186 void
 187 Grob::discretionary_processing ()
 188 {
 189 }
 190
 191 System *
 192 Grob::get_system () const
 193 {
 194   return 0;
 195 }
 196
 197 /* This version of get_system is more reliable than this->get_system ()
 198    before line-breaking has been done, at which point there is only
 199    one system in the whole score and we can find it just by following
 200    parent pointers. */
 201 System *
 202 Grob::get_system (Grob *me)
 203 {
 204   Grob *p = me->get_parent (X_AXIS);
 205   return p ? get_system (p) : dynamic_cast<System *>(me);
 206 }
 207
 208 void
 209 Grob::handle_broken_dependencies ()
 210 {
 211   Spanner *sp = dynamic_cast<Spanner *> (this);
 212   if (original () && sp)
 213     return;
 214
 215   if (sp)
 216     /* THIS, SP is the original spanner.  We use a special function
 217        because some Spanners have enormously long lists in their
 218        properties, and a special function fixes FOO  */
 219     {
 220       for (SCM s = object_alist_; scm_is_pair (s); s = scm_cdr (s))
 221         sp->substitute_one_mutable_property (scm_caar (s), scm_cdar (s));
 222     }
 223   System *system = get_system ();
 224
 225   if (is_live ()
 226       && system
 227       && common_refpoint (system, X_AXIS)
 228       && common_refpoint (system, Y_AXIS))
 229     substitute_object_links (system->self_scm (), object_alist_);
 230   else if (dynamic_cast<System *> (this))
 231     substitute_object_links (SCM_UNDEFINED, object_alist_);
 232   else
 233     /* THIS element is `invalid'; it has been removed from all
 234        dependencies, so let's junk the element itself.
 235
 236        Do not do this for System, since that would remove references
 237        to the originals of score-grobs, which get then GC'd (a bad
 238        thing).  */
 239     suicide ();
 240 }
 241
 242 /* Note that we still want references to this element to be
 243    rearranged, and not silently thrown away, so we keep pointers like
 244    {broken_into_{drul, array}, original}
 245 */
 246 void
 247 Grob::suicide ()
 248 {
 249   if (!is_live ())
 250     return;
 251
 252   for (int a = X_AXIS; a < NO_AXES; a++)
 253     dim_cache_[a].clear ();
 254
 255   mutable_property_alist_ = SCM_EOL;
 256   object_alist_ = SCM_EOL;
 257   immutable_property_alist_ = SCM_EOL;
 258   interfaces_ = SCM_EOL;
 259 }
 260
 261 void
 262 Grob::handle_prebroken_dependencies ()
 263 {
 264   /* Don't do this in the derived method, since we want to keep access to
 265      object_alist_ centralized.  */
 266   if (original ())
 267     {
 268       Item *it = dynamic_cast<Item *> (this);
 269       substitute_object_links (scm_from_int (it->break_status_dir ()),
 270                                original ()->object_alist_);
 271     }
 272 }
 273
 274 Grob *
 275 Grob::find_broken_piece (System *) const
 276 {
 277   return 0;
 278 }
 279
 280 /****************************************************************
 281    OFFSETS
 282 ****************************************************************/
 283
 284 void
 285 Grob::translate_axis (Real y, Axis a)
 286 {
 287   if (isinf (y) || isnan (y))
 288     {
 289       programming_error ("Infinity or NaN encountered");
 290       return;
 291     }
 292
 293   if (!dim_cache_[a].offset_)
 294     dim_cache_[a].offset_ = new Real (y);
 295   else
 296     *dim_cache_[a].offset_ += y;
 297 }
 298
 299 /* Find the offset relative to D.  If D equals THIS, then it is 0.
 300    Otherwise, it recursively defd as
 301
 302    OFFSET_ + PARENT_L_->relative_coordinate (D) */
 303 Real
 304 Grob::relative_coordinate (Grob const *refp, Axis a) const
 305 {
 306   /* eaa - hmmm, should we do a programming_error() here? */
 307   if ((this == NULL) || (refp == this))
 308     return 0.0;
 309
 310   /* We catch PARENT_L_ == nil case with this, but we crash if we did
 311      not ask for the absolute coordinate (ie. REFP == nil.)  */
 312   Real off = get_offset (a);
 313   if (refp == dim_cache_[a].parent_)
 314     return off;
 315
 316   off += dim_cache_[a].parent_->relative_coordinate (refp, a);
 317
 318   return off;
 319 }
 320
 321 Real
 322 Grob::pure_relative_y_coordinate (Grob const *refp, int start, int end)
 323 {
 324   if (refp == this)
 325     return 0.0;
 326
 327   Real off = 0;
 328
 329   if (dim_cache_[Y_AXIS].offset_)
 330     {
 331       if (to_boolean (get_property ("pure-Y-offset-in-progress")))
 332         programming_error ("cyclic chain in pure-Y-offset callbacks");
 333
 334       off = *dim_cache_[Y_AXIS].offset_;
 335     }
 336   else
 337     {
 338       SCM proc = get_property_data ("Y-offset");
 339
 340       dim_cache_[Y_AXIS].offset_ = new Real (0.0);
 341       set_property ("pure-Y-offset-in-progress", SCM_BOOL_T);
 342       off = robust_scm2double (call_pure_function (proc,
 343                                                    scm_list_1 (self_scm ()),
 344                                                    start, end),
 345                                0.0);
 346       del_property ("pure-Y-offset-in-progress");
 347       delete dim_cache_[Y_AXIS].offset_;
 348       dim_cache_[Y_AXIS].offset_ = 0;
 349     }
 350
 351   /* we simulate positioning-done if we are the child of a VerticalAlignment,
 352      but only if we don't have a cached offset. If we do have a cached offset,
 353      it probably means that the Alignment was fixed and it has already been
 354      calculated.
 355   */
 356   if (Grob *p = get_parent (Y_AXIS))
 357     {
 358       Real trans = 0;
 359       if (Align_interface::has_interface (p) && !dim_cache_[Y_AXIS].offset_)
 360         trans = Align_interface::get_pure_child_y_translation (p, this, start, end);
 361
 362       return off + trans + p->pure_relative_y_coordinate (refp, start, end);
 363     }
 364   return off;
 365 }
 366
 367 /* Invoke callbacks to get offset relative to parent.  */
 368 Real
 369 Grob::get_offset (Axis a) const
 370 {
 371   if (dim_cache_[a].offset_)
 372     return *dim_cache_[a].offset_;
 373
 374   Grob *me = (Grob *) this;
 375
 376   SCM sym = axis_offset_symbol (a);
 377   me->dim_cache_[a].offset_ = new Real (0.0);
 378
 379   /*
 380     UGH: can't fold next 2 statements together. Apparently GCC thinks
 381     dim_cache_[a].offset_ is unaliased.
 382   */
 383   Real off = robust_scm2double (internal_get_property (sym), 0.0);
 384   if (me->dim_cache_[a].offset_)
 385     {
 386       *me->dim_cache_[a].offset_ += off;
 387       me->del_property (sym);
 388       return *me->dim_cache_[a].offset_;
 389     }
 390   else
 391     return 0.0;
 392 }
 393
 394 Real
 395 Grob::maybe_pure_coordinate (Grob const *refp, Axis a, bool pure, int start, int end)
 396 {
 397   if (pure && a != Y_AXIS)
 398     programming_error ("tried to get pure X-offset");
 399   return (pure && a == Y_AXIS) ? pure_relative_y_coordinate (refp, start, end)
 400          : relative_coordinate (refp, a);
 401 }
 402
 403 /****************************************************************
 404   extents
 405 ****************************************************************/
 406
 407 void
 408 Grob::flush_extent_cache (Axis axis)
 409 {
 410   if (dim_cache_[axis].extent_)
 411     {
 412       /*
 413         Ugh, this is not accurate; will flush property, causing
 414         callback to be called if.
 415        */
 416       del_property ((axis == X_AXIS) ? ly_symbol2scm ("X-extent") : ly_symbol2scm ("Y-extent"));
 417       delete dim_cache_[axis].extent_;
 418       dim_cache_[axis].extent_ = 0;
 419       if (get_parent (axis))
 420         get_parent (axis)->flush_extent_cache (axis);
 421     }
 422 }
 423
 424 Interval
 425 Grob::extent (Grob *refp, Axis a) const
 426 {
 427   Real offset = relative_coordinate (refp, a);
 428   Interval real_ext;
 429   if (dim_cache_[a].extent_)
 430     {
 431       real_ext = *dim_cache_[a].extent_;
 432     }
 433   else
 434     {
 435       /*
 436         Order is significant: ?-extent may trigger suicide.
 437        */
 438       SCM ext_sym
 439         = (a == X_AXIS)
 440           ? ly_symbol2scm ("X-extent")
 441           : ly_symbol2scm ("Y-extent");
 442
 443       SCM ext = internal_get_property (ext_sym);
 444       if (is_number_pair (ext))
 445         real_ext.unite (ly_scm2interval (ext));
 446
 447       SCM min_ext_sym
 448         = (a == X_AXIS)
 449           ? ly_symbol2scm ("minimum-X-extent")
 450           : ly_symbol2scm ("minimum-Y-extent");
 451       SCM min_ext = internal_get_property (min_ext_sym);
 452       if (is_number_pair (min_ext))
 453         real_ext.unite (ly_scm2interval (min_ext));
 454
 455       ((Grob *)this)->dim_cache_[a].extent_ = new Interval (real_ext);
 456     }
 457
 458   real_ext.translate (offset);
 459
 460   return real_ext;
 461 }
 462
 463 Interval
 464 Grob::pure_height (Grob *refp, int start, int end)
 465 {
 466   SCM iv_scm = get_pure_property ("Y-extent", start, end);
 467   Interval iv = robust_scm2interval (iv_scm, Interval (0, 0));
 468   Real offset = pure_relative_y_coordinate (refp, start, end);
 469
 470   SCM min_ext = get_property ("minimum-Y-extent");
 471
 472   /* we don't add minimum-Y-extent if the extent is empty. This solves
 473      a problem with Hara-kiri spanners. They would request_suicide and
 474      return empty extents, but we would force them here to be large. */
 475   if (!iv.is_empty () && is_number_pair (min_ext))
 476     iv.unite (ly_scm2interval (min_ext));
 477
 478   if (!iv.is_empty ())
 479     iv.translate (offset);
 480   return iv;
 481 }
 482
 483 Interval
 484 Grob::maybe_pure_extent (Grob *refp, Axis a, bool pure, int start, int end)
 485 {
 486   if (pure && a != Y_AXIS)
 487     programming_error ("tried to get pure width");
 488   return (pure && a == Y_AXIS) ? pure_height (refp, start, end) : extent (refp, a);
 489 }
 490
 491 Interval_t<int>
 492 Grob::spanned_rank_interval () const
 493 {
 494   return Interval_t<int> (-1, 0);
 495 }
 496
 497 bool
 498 Grob::pure_is_visible (int /* start */, int /* end */) const
 499 {
 500   return true;
 501 }
 502
 503 /* Sort grobs according to their starting column. */
 504 bool
 505 Grob::less (Grob *g1, Grob *g2)
 506 {
 507   return g1->spanned_rank_interval ()[LEFT] < g2->spanned_rank_interval ()[LEFT];
 508 }
 509
 510 /****************************************************************
 511   REFPOINTS
 512 ****************************************************************/
 513
 514 /* Find the group-element which has both #this# and #s#  */
 515 Grob *
 516 Grob::common_refpoint (Grob const *s, Axis a) const
 517 {
 518   /* I don't like the quadratic aspect of this code, but I see no
 519      other way.  The largest chain of parents might be 10 high or so,
 520      so it shouldn't be a real issue.  */
 521   for (Grob const *c = this; c; c = c->dim_cache_[a].parent_)
 522     for (Grob const *d = s; d; d = d->dim_cache_[a].parent_)
 523       if (d == c)
 524         return (Grob *) d;
 525
 526   return 0;
 527 }
 528
 529 void
 530 Grob::set_parent (Grob *g, Axis a)
 531 {
 532   dim_cache_[a].parent_ = g;
 533 }
 534
 535 Grob *
 536 Grob::get_parent (Axis a) const
 537 {
 538   return dim_cache_[a].parent_;
 539 }
 540
 541 void
 542 Grob::fixup_refpoint ()
 543 {
 544   for (int a = X_AXIS; a < NO_AXES; a++)
 545     {
 546       Axis ax = (Axis)a;
 547       Grob *parent = get_parent (ax);
 548
 549       if (!parent)
 550         continue;
 551
 552       if (parent->get_system () != get_system () && get_system ())
 553         {
 554           Grob *newparent = parent->find_broken_piece (get_system ());
 555           set_parent (newparent, ax);
 556         }
 557
 558       if (Item *i = dynamic_cast<Item *> (this))
 559         {
 560           Item *parenti = dynamic_cast<Item *> (parent);
 561
 562           if (parenti && i)
 563             {
 564               Direction my_dir = i->break_status_dir ();
 565               if (my_dir != parenti->break_status_dir ())
 566                 {
 567                   Item *newparent = parenti->find_prebroken_piece (my_dir);
 568                   set_parent (newparent, ax);
 569                 }
 570             }
 571         }
 572     }
 573 }
 574
 575 /****************************************************************
 576   MESSAGES
 577 ****************************************************************/
 578 void
 579 Grob::programming_error (string s) const
 580 {
 581   SCM cause = self_scm ();
 582   while (Grob *g = unsmob_grob (cause))
 583     cause = g->get_property ("cause");
 584
 585   /* ES TODO: cause can't be Music*/
 586   if (Music *m = unsmob_music (cause))
 587     m->origin ()->programming_error (s);
 588   else if (Stream_event *ev = unsmob_stream_event (cause))
 589     ev->origin ()->programming_error (s);
 590   else
 591     ::programming_error (s);
 592 }
 593
 594 void
 595 Grob::warning (string s) const
 596 {
 597   SCM cause = self_scm ();
 598   while (Grob *g = unsmob_grob (cause))
 599     cause = g->get_property ("cause");
 600
 601   /* ES TODO: cause can't be Music*/
 602   if (Music *m = unsmob_music (cause))
 603     m->origin ()->warning (s);
 604   else if (Stream_event *ev = unsmob_stream_event (cause))
 605     ev->origin ()->warning (s);
 606   else
 607     ::warning (s);
 608 }
 609
 610 string
 611 Grob::name () const
 612 {
 613   SCM meta = get_property ("meta");
 614   SCM nm = scm_assq (ly_symbol2scm ("name"), meta);
 615   nm = (scm_is_pair (nm)) ? scm_cdr (nm) : SCM_EOL;
 616   return scm_is_symbol (nm) ? ly_symbol2string (nm) : this->class_name ();
 617 }
 618
 619 ADD_INTERFACE (Grob,
 620                "A grob represents a piece of music notation.\n"
 621                "\n"
 622                "All grobs have an X and Y@tie{}position on the page.  These"
 623                " X and Y@tie{}positions are stored in a relative format, thus"
 624                " they can easily be combined by stacking them, hanging one"
 625                " grob to the side of another, or coupling them into grouping"
 626                " objects.\n"
 627                "\n"
 628                "Each grob has a reference point (a.k.a.@: parent): The"
 629                " position of a grob is stored relative to that reference"
 630                " point.  For example, the X@tie{}reference point of a staccato"
 631                " dot usually is the note head that it applies to.  When the"
 632                " note head is moved, the staccato dot moves along"
 633                " automatically.\n"
 634                "\n"
 635                "A grob is often associated with a symbol, but some grobs do"
 636                " not print any symbols.  They take care of grouping objects."
 637                " For example, there is a separate grob that stacks staves"
 638                " vertically.  The @ref{NoteCollision} object is also an"
 639                " abstract grob: It only moves around chords, but doesn't print"
 640                " anything.\n"
 641                "\n"
 642                "Grobs have properties (Scheme variables) that can be read and"
 643                " set.  Two types of them exist: immutable and mutable."
 644                "  Immutable variables define the default style and behavior."
 645                "  They are shared between many objects.  They can be changed"
 646                " using @code{\\override} and @code{\\revert}.  Mutable"
 647                " properties are variables that are specific to one grob."
 648                "  Typically, lists of other objects, or results from"
 649                " computations are stored in mutable properties.  In"
 650                " particular, every call to @code{ly:grob-set-property!}"
 651                " (or its C++ equivalent) sets a mutable property.\n"
 652                "\n"
 653                "The properties @code{after-line-breaking} and"
 654                " @code{before-line-breaking} are dummies that are not"
 655                " user-serviceable.",
 656
 657                /* properties */
 658                "X-extent "
 659                "X-offset "
 660                "Y-extent "
 661                "Y-offset "
 662                "after-line-breaking "
 663                "avoid-slur "
 664                "axis-group-parent-X "
 665                "axis-group-parent-Y "
 666                "before-line-breaking "
 667                "cause "
 668                "color "
 669                "cross-staff "
 670                "extra-X-extent "
 671                "extra-Y-extent "
 672                "extra-offset "
 673                "interfaces "
 674                "layer "
 675                "meta "
 676                "minimum-X-extent "
 677                "minimum-Y-extent "
 678                "outside-staff-horizontal-padding "
 679                "outside-staff-padding "
 680                "outside-staff-priority "
 681                "pure-Y-offset-in-progress "
 682                "rotation "
 683                "springs-and-rods "
 684                "staff-symbol "
 685                "stencil "
 686                "transparent "
 687                "whiteout "
 688               );
 689
 690 /****************************************************************
 691   CALLBACKS
 692 ****************************************************************/
 693
 694 static SCM
 695 grob_stencil_extent (Grob *me, Axis a)
 696 {
 697   Stencil *m = me->get_stencil ();
 698   Interval e;
 699   if (m)
 700     e = m->extent (a);
 701   return ly_interval2scm (e);
 702 }
 703
 704 MAKE_SCHEME_CALLBACK (Grob, stencil_height, 1);
 705 SCM
 706 Grob::stencil_height (SCM smob)
 707 {
 708   Grob *me = unsmob_grob (smob);
 709   return grob_stencil_extent (me, Y_AXIS);
 710 }
 711
 712 MAKE_SCHEME_CALLBACK (Grob, y_parent_positioning, 1);
 713 SCM
 714 Grob::y_parent_positioning (SCM smob)
 715 {
 716   Grob *me = unsmob_grob (smob);
 717   Grob *par = me->get_parent (Y_AXIS);
 718   if (par)
 719     (void) par->get_property ("positioning-done");
 720
 721   return scm_from_double (0.0);
 722 }
 723
 724 MAKE_SCHEME_CALLBACK (Grob, x_parent_positioning, 1);
 725 SCM
 726 Grob::x_parent_positioning (SCM smob)
 727 {
 728   Grob *me = unsmob_grob (smob);
 729
 730   Grob *par = me->get_parent (X_AXIS);
 731   if (par)
 732     (void) par->get_property ("positioning-done");
 733
 734   return scm_from_double (0.0);
 735 }
 736
 737 MAKE_SCHEME_CALLBACK (Grob, stencil_width, 1);
 738 SCM
 739 Grob::stencil_width (SCM smob)
 740 {
 741   Grob *me = unsmob_grob (smob);
 742   return grob_stencil_extent (me, X_AXIS);
 743 }
 744
 745 Grob *
 746 common_refpoint_of_list (SCM elist, Grob *common, Axis a)
 747 {
 748   for (; scm_is_pair (elist); elist = scm_cdr (elist))
 749     if (Grob *s = unsmob_grob (scm_car (elist)))
 750       {
 751         if (common)
 752           common = common->common_refpoint (s, a);
 753         else
 754           common = s;
 755       }
 756
 757   return common;
 758 }
 759
 760 Grob *
 761 common_refpoint_of_array (vector<Grob *> const &arr, Grob *common, Axis a)
 762 {
 763   for (vsize i = 0; i < arr.size (); i++)
 764     if (common)
 765       common = common->common_refpoint (arr[i], a);
 766     else
 767       common = arr[i];
 768
 769   return common;
 770 }
 771
 772 Interval
 773 robust_relative_extent (Grob *me, Grob *refpoint, Axis a)
 774 {
 775   Interval ext = me->extent (refpoint, a);
 776   if (ext.is_empty ())
 777     ext.add_point (me->relative_coordinate (refpoint, a));
 778
 779   return ext;
 780 }
 781
 782 // Checks whether there is a vertical alignment in the chain of
 783 // parents between this and commony.
 784 bool
 785 Grob::check_cross_staff (Grob *commony)
 786 {
 787   if (Align_interface::has_interface (commony))
 788     return true;
 789
 790   for (Grob *g = this; g && g != commony; g = g->get_parent (Y_AXIS))
 791     if (Align_interface::has_interface (g))
 792       return true;
 793
 794   return false;
 795 }
 796