lily/system.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--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 "system.hh"
  21
  22 #include "align-interface.hh"
  23 #include "all-font-metrics.hh"
  24 #include "axis-group-interface.hh"
  25 #include "break-align-interface.hh"
  26 #include "grob-array.hh"
  27 #include "hara-kiri-group-spanner.hh"
  28 #include "international.hh"
  29 #include "lookup.hh"
  30 #include "main.hh"
  31 #include "output-def.hh"
  32 #include "page-layout-problem.hh"
  33 #include "paper-column.hh"
  34 #include "paper-score.hh"
  35 #include "paper-system.hh"
  36 #include "pointer-group-interface.hh"
  37 #include "skyline-pair.hh"
  38 #include "staff-symbol-referencer.hh"
  39 #include "text-interface.hh"
  40 #include "warn.hh"
  41
  42 System::System (System const &src)
  43   : Spanner (src)
  44 {
  45   all_elements_ = 0;
  46   pscore_ = 0;
  47   rank_ = 0;
  48   checked_footnotes_ = false;
  49   init_elements ();
  50 }
  51
  52 System::System (SCM s)
  53   : Spanner (s)
  54 {
  55   all_elements_ = 0;
  56   rank_ = 0;
  57   checked_footnotes_ = false;
  58   init_elements ();
  59 }
  60
  61 void
  62 System::init_elements ()
  63 {
  64   SCM scm_arr = Grob_array::make_array ();
  65   all_elements_ = unsmob_grob_array (scm_arr);
  66   all_elements_->set_ordered (false);
  67   set_object ("all-elements", scm_arr);
  68 }
  69
  70 Grob *
  71 System::clone () const
  72 {
  73   return new System (*this);
  74 }
  75
  76 int
  77 System::element_count () const
  78 {
  79   return all_elements_->size ();
  80 }
  81
  82 int
  83 System::spanner_count () const
  84 {
  85   int k = 0;
  86   for (vsize i = all_elements_->size (); i--;)
  87     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  88       k++;
  89   return k;
  90 }
  91
  92 void
  93 System::typeset_grob (Grob *elem)
  94 {
  95   if (elem->layout_)
  96     programming_error ("adding element twice");
  97   else
  98     {
  99       elem->layout_ = pscore_->layout ();
 100       all_elements_->add (elem);
 101       elem->unprotect ();
 102     }
 103 }
 104
 105 void
 106 System::derived_mark () const
 107 {
 108   if (!all_elements_->empty ())
 109     {
 110       Grob **ptr = &all_elements_->array_reference ()[0];
 111       Grob **end = ptr + all_elements_->size ();
 112       while (ptr < end)
 113         {
 114           scm_gc_mark ((*ptr)->self_scm ());
 115           ptr++;
 116         }
 117     }
 118
 119   if (pscore_)
 120     scm_gc_mark (pscore_->self_scm ());
 121
 122   Spanner::derived_mark ();
 123 }
 124
 125 static void
 126 fixup_refpoints (vector<Grob *> const &grobs)
 127 {
 128   for (vsize i = grobs.size (); i--;)
 129     grobs[i]->fixup_refpoint ();
 130 }
 131
 132 void
 133 System::do_break_substitution_and_fixup_refpoints ()
 134 {
 135   for (vsize i = 0; i < all_elements_->size (); i++)
 136     {
 137       Grob *g = all_elements_->grob (i);
 138       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 139         {
 140           /*
 141             Kill no longer needed grobs.
 142           */
 143           Item *it = dynamic_cast<Item *> (g);
 144           if (it && Item::is_non_musical (it))
 145             {
 146               it->find_prebroken_piece (LEFT)->suicide ();
 147               it->find_prebroken_piece (RIGHT)->suicide ();
 148             }
 149           g->suicide ();
 150         }
 151       else if (g->is_live ())
 152         g->do_break_processing ();
 153     }
 154
 155   /*
 156     fixups must be done in broken line_of_scores, because new elements
 157     are put over there.  */
 158   int count = 0;
 159   for (vsize i = 0; i < broken_intos_.size (); i++)
 160     {
 161       Grob *se = broken_intos_[i];
 162
 163       extract_grob_set (se, "all-elements", all_elts);
 164       for (vsize j = 0; j < all_elts.size (); j++)
 165         {
 166           Grob *g = all_elts[j];
 167           g->fixup_refpoint ();
 168         }
 169
 170       count += all_elts.size ();
 171     }
 172
 173   /*
 174     needed for doing items.
 175   */
 176   fixup_refpoints (all_elements_->array ());
 177
 178   for (vsize i = 0; i < all_elements_->size (); i++)
 179     all_elements_->grob (i)->handle_broken_dependencies ();
 180
 181   handle_broken_dependencies ();
 182
 183   /* Because the this->get_property (all-elements) contains items in 3
 184      versions, handle_broken_dependencies () will leave duplicated
 185      items in all-elements.  Strictly speaking this is harmless, but
 186      it leads to duplicated symbols in the output.  uniq makes sure
 187      that no duplicates are in the list.  */
 188   for (vsize i = 0; i < broken_intos_.size (); i++)
 189     {
 190       System *child = dynamic_cast<System *> (broken_intos_[i]);
 191       child->all_elements_->remove_duplicates ();
 192       for (vsize j = 0; j < child->all_elements_->size (); j++)
 193         {
 194           Grob *g = child->all_elements_->grob (j);
 195
 196           (void) g->get_property ("after-line-breaking");
 197         }
 198     }
 199
 200   if (be_verbose_global)
 201     message (_f ("Element count %d", count + element_count ()) + "\n");
 202 }
 203
 204 SCM
 205 System::get_broken_system_grobs ()
 206 {
 207   SCM ret = SCM_EOL;
 208   for (vsize i = 0; i < broken_intos_.size (); i++)
 209     ret = scm_cons (broken_intos_[i]->self_scm (), ret);
 210   return scm_reverse (ret);
 211 }
 212
 213 SCM
 214 System::get_paper_systems ()
 215 {
 216   SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
 217   for (vsize i = 0; i < broken_intos_.size (); i++)
 218     {
 219       if (be_verbose_global)
 220         progress_indication ("[");
 221
 222       System *system = dynamic_cast<System *> (broken_intos_[i]);
 223
 224       scm_vector_set_x (lines, scm_from_int (i),
 225                         system->get_paper_system ());
 226
 227       if (be_verbose_global)
 228         progress_indication (to_string (i) + "]");
 229     }
 230   return lines;
 231 }
 232
 233 void
 234 System::populate_footnote_grob_vector ()
 235 {
 236   extract_grob_set (this, "all-elements", all_elts);
 237   for (vsize i = 0; i < all_elts.size (); i++)
 238     if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
 239       footnote_grobs_.push_back (all_elts[i]);
 240
 241   sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
 242   checked_footnotes_ = true;
 243 }
 244
 245 void
 246 System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
 247 {
 248   if (!checked_footnotes_)
 249     populate_footnote_grob_vector ();
 250
 251   for (vsize i = 0; i < footnote_grobs_.size (); i++)
 252     {
 253       int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
 254       bool end_of_line_visible = true;
 255       if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
 256         {
 257           Real spanner_placement = robust_scm2double (s->get_property ("spanner-placement"), -1.0);
 258           if (spanner_placement < -1.0)
 259             spanner_placement = -1.0;
 260           if (spanner_placement > 1.0)
 261             spanner_placement = 1.0;
 262
 263           spanner_placement = (spanner_placement + 1.0) / 2.0;
 264           int rpos = s->spanned_rank_interval ()[RIGHT];
 265           pos = (int)((rpos - pos) * spanner_placement + pos + 0.5);
 266         }
 267
 268       if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
 269         {
 270           if (!Item::break_visible (item))
 271             continue;
 272           // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
 273           end_of_line_visible = (LEFT == item->break_status_dir ());
 274         }
 275
 276       if (pos < (int)start)
 277         continue;
 278       if (pos > (int)end)
 279         break;
 280       if (pos == (int)start && end_of_line_visible)
 281         continue;
 282       if (pos == (int)end && !end_of_line_visible)
 283         continue;
 284       if (!footnote_grobs_[i]->is_live ())
 285         continue;
 286
 287       out.push_back (footnote_grobs_[i]);
 288     }
 289 }
 290
 291 vector<Stencil *>
 292 System::get_footnotes_in_range (vsize start, vsize end)
 293 {
 294   vector<Grob *> footnote_grobs;
 295   get_footnote_grobs_in_range (footnote_grobs, start, end);
 296   vector<Stencil *> out;
 297
 298   for (vsize i = 0; i < footnote_grobs.size (); i++)
 299     {
 300       SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
 301
 302       if (!Text_interface::is_markup (footnote_markup))
 303         continue;
 304
 305       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 306                               pscore_->layout ()->self_scm ());
 307
 308       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 309                                                            props, footnote_markup);
 310
 311       Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
 312       out.push_back (footnote_stencil);
 313     }
 314
 315   return out;
 316 }
 317
 318 Stencil
 319 System::make_footnote_stencil (Real padding)
 320 {
 321   Stencil mol;
 322
 323   for (vsize i = 0; i < footnote_grobs_.size (); i++)
 324     {
 325       SCM footnote_markup = footnote_grobs_[i]->get_property ("footnote-text");
 326       if (Spanner *orig = dynamic_cast<Spanner *>(footnote_grobs_[i]))
 327         if (orig->is_broken ())
 328           footnote_markup = orig->broken_intos_[0]->get_property ("footnote-text");
 329
 330       if (!Text_interface::is_markup (footnote_markup))
 331         continue;
 332
 333       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 334                               pscore_->layout ()->self_scm ());
 335
 336       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 337                                                            props, footnote_markup);
 338
 339       mol.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (footnote_stl), padding);
 340     }
 341
 342   return mol;
 343 }
 344
 345 void
 346 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 347 {
 348   for (vsize i = 0; i < breaking.size (); i++)
 349     {
 350       System *system = dynamic_cast<System *> (clone ());
 351       system->rank_ = broken_intos_.size ();
 352
 353       vector<Grob *> c (breaking[i].cols_);
 354       pscore_->typeset_system (system);
 355
 356       int st = Paper_column::get_rank (c[0]);
 357       int end = Paper_column::get_rank (c.back ());
 358       Interval iv (pure_height (this, st, end));
 359       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 360
 361       get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
 362
 363       system->set_bound (LEFT, c[0]);
 364       system->set_bound (RIGHT, c.back ());
 365       SCM system_labels = SCM_EOL;
 366       for (vsize j = 0; j < c.size (); j++)
 367         {
 368           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 369           dynamic_cast<Paper_column *> (c[j])->set_system (system);
 370           /* collect the column labels */
 371           collect_labels (c[j], &system_labels);
 372         }
 373       /*
 374         Collect labels from any loose columns too: theses will be set on
 375         an empty bar line or a column which is otherwise unused mid-line
 376       */
 377       vector<Grob *> loose (breaking[i].loose_cols_);
 378       for (vsize j = 0; j < loose.size (); j++)
 379         collect_labels (loose[j], &system_labels);
 380
 381       system->set_property ("labels", system_labels);
 382
 383       set_loose_columns (system, &breaking[i]);
 384       broken_intos_.push_back (system);
 385     }
 386 }
 387
 388 void
 389 System::collect_labels (Grob const *col, SCM *labels)
 390 {
 391   SCM col_labels = col->get_property ("labels");
 392   if (scm_is_pair (col_labels))
 393     *labels = scm_append (scm_list_2 (col_labels, *labels));
 394 }
 395
 396 void
 397 System::add_column (Paper_column *p)
 398 {
 399   Grob *me = this;
 400   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 401   if (!ga)
 402     {
 403       SCM scm_ga = Grob_array::make_array ();
 404       me->set_object ("columns", scm_ga);
 405       ga = unsmob_grob_array (scm_ga);
 406     }
 407
 408   p->set_rank (ga->size ());
 409
 410   ga->add (p);
 411   Axis_group_interface::add_element (this, p);
 412 }
 413
 414 void
 415 System::pre_processing ()
 416 {
 417   for (vsize i = 0; i < all_elements_->size (); i++)
 418     all_elements_->grob (i)->discretionary_processing ();
 419
 420   if (be_verbose_global)
 421     message (_f ("Grob count %d", element_count ()));
 422
 423   /*
 424     order is significant: broken grobs are added to the end of the
 425     array, and should be processed before the original is potentially
 426     killed.
 427   */
 428   for (vsize i = all_elements_->size (); i--;)
 429     all_elements_->grob (i)->handle_prebroken_dependencies ();
 430
 431   fixup_refpoints (all_elements_->array ());
 432
 433   for (vsize i = 0; i < all_elements_->size (); i++)
 434     {
 435       Grob *g = all_elements_->grob (i);
 436       (void) g->get_property ("before-line-breaking");
 437     }
 438
 439   for (vsize i = 0; i < all_elements_->size (); i++)
 440     {
 441       Grob *e = all_elements_->grob (i);
 442       (void) e->get_property ("springs-and-rods");
 443     }
 444 }
 445
 446 void
 447 System::post_processing ()
 448 {
 449   Interval iv (extent (this, Y_AXIS));
 450   if (iv.is_empty ())
 451     programming_error ("system with empty extent");
 452   else
 453     translate_axis (-iv[MAX], Y_AXIS);
 454
 455   /* Generate all stencils to trigger font loads.
 456      This might seem inefficient, but Stencils are cached per grob
 457      anyway. */
 458
 459   vector<Grob *> all_elts_sorted (all_elements_->array ());
 460   vector_sort (all_elts_sorted, std::less<Grob *> ());
 461   uniq (all_elts_sorted);
 462   this->get_stencil ();
 463   for (vsize i = all_elts_sorted.size (); i--;)
 464     {
 465       Grob *g = all_elts_sorted[i];
 466       g->get_stencil ();
 467     }
 468 }
 469
 470 struct Layer_entry
 471 {
 472   Grob *grob_;
 473   int layer_;
 474 };
 475
 476 bool
 477 operator< (Layer_entry  const &a,
 478            Layer_entry  const &b)
 479 {
 480   return a.layer_ < b.layer_;
 481 }
 482
 483 SCM
 484 System::get_paper_system ()
 485 {
 486   SCM exprs = SCM_EOL;
 487   SCM *tail = &exprs;
 488
 489   post_processing ();
 490
 491   vector<Layer_entry> entries;
 492   for (vsize j = 0; j < all_elements_->size (); j++)
 493     {
 494       Layer_entry e;
 495       e.grob_ = all_elements_->grob (j);
 496       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
 497
 498       entries.push_back (e);
 499     }
 500
 501   vector_sort (entries, std::less<Layer_entry> ());
 502   for (vsize j = 0; j < entries.size (); j++)
 503     {
 504       Grob *g = entries[j].grob_;
 505       Stencil st = g->get_print_stencil ();
 506
 507       if (st.expr () == SCM_EOL)
 508         continue;
 509
 510       Offset o;
 511       for (int a = X_AXIS; a < NO_AXES; a++)
 512         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 513
 514       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 515                                         Offset (0, 0))
 516         * Staff_symbol_referencer::staff_space (g);
 517
 518       /* Must copy the stencil, for we cannot change the stencil
 519          cached in G.  */
 520
 521       st.translate (o + extra);
 522
 523       *tail = scm_cons (st.expr (), SCM_EOL);
 524       tail = SCM_CDRLOC (*tail);
 525     }
 526
 527   if (Stencil *me = get_stencil ())
 528     exprs = scm_cons (me->expr (), exprs);
 529
 530   Interval x (extent (this, X_AXIS));
 531   Interval y (extent (this, Y_AXIS));
 532   Stencil sys_stencil (Box (x, y),
 533                        scm_cons (ly_symbol2scm ("combine-stencil"),
 534                                  exprs));
 535   if (debug_skylines)
 536     {
 537       Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
 538       if (skylines)
 539         {
 540           Stencil up
 541             = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
 542           Stencil down
 543             = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
 544           sys_stencil.add_stencil (up.in_color (255, 0, 0));
 545           sys_stencil.add_stencil (down.in_color (0, 255, 0));
 546         }
 547     }
 548
 549   Grob *left_bound = this->get_bound (LEFT);
 550   SCM prop_init = left_bound->get_property ("line-break-system-details");
 551   Prob *pl = make_paper_system (prop_init);
 552   paper_system_set_stencil (pl, sys_stencil);
 553
 554   /* information that the page breaker might need */
 555   Grob *right_bound = this->get_bound (RIGHT);
 556   pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
 557   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 558   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 559   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 560   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 561
 562   Interval staff_refpoints;
 563   if (Grob *align = get_vertical_alignment ())
 564     {
 565       extract_grob_set (align, "elements", staves);
 566       for (vsize i = 0; i < staves.size (); i++)
 567         if (staves[i]->is_live ()
 568             && Page_layout_problem::is_spaceable (staves[i]))
 569           staff_refpoints.add_point (staves[i]->relative_coordinate (this,
 570                                                                      Y_AXIS));
 571     }
 572
 573   pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
 574   pl->set_property ("system-grob", this->self_scm ());
 575
 576   return pl->unprotect ();
 577 }
 578
 579 vector<Item *>
 580 System::broken_col_range (Item const *left, Item const *right) const
 581 {
 582   vector<Item *> ret;
 583
 584   left = left->get_column ();
 585   right = right->get_column ();
 586
 587   extract_grob_set (this, "columns", cols);
 588
 589   vsize i = Paper_column::get_rank (left);
 590   int end_rank = Paper_column::get_rank (right);
 591   if (i < cols.size ())
 592     i++;
 593
 594   while (i < cols.size ()
 595          && Paper_column::get_rank (cols[i]) < end_rank)
 596     {
 597       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 598       if (Paper_column::is_breakable (c) && !c->get_system ())
 599         ret.push_back (c);
 600       i++;
 601     }
 602
 603   return ret;
 604 }
 605
 606 /** Return all columns, but filter out any unused columns , since they might
 607     disrupt the spacing problem. */
 608 vector<Grob *>
 609 System::used_columns () const
 610 {
 611   extract_grob_set (this, "columns", ro_columns);
 612
 613   int last_breakable = ro_columns.size ();
 614
 615   while (last_breakable--)
 616     {
 617       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 618         break;
 619     }
 620
 621   vector<Grob *> columns;
 622   for (int i = 0; i <= last_breakable; i++)
 623     {
 624       if (Paper_column::is_used (ro_columns[i]))
 625         columns.push_back (ro_columns[i]);
 626     }
 627
 628   return columns;
 629 }
 630
 631 Paper_column *
 632 System::column (vsize which) const
 633 {
 634   extract_grob_set (this, "columns", columns);
 635   if (which >= columns.size ())
 636     return 0;
 637
 638   return dynamic_cast<Paper_column *> (columns[which]);
 639 }
 640
 641 Paper_score *
 642 System::paper_score () const
 643 {
 644   return pscore_;
 645 }
 646
 647 int
 648 System::get_rank () const
 649 {
 650   return rank_;
 651 }
 652
 653 System *
 654 get_root_system (Grob *me)
 655 {
 656   Grob *system_grob = me;
 657
 658   while (system_grob->get_parent (Y_AXIS))
 659     system_grob = system_grob->get_parent (Y_AXIS);
 660
 661   return dynamic_cast<System *> (system_grob);
 662 }
 663
 664 Grob *
 665 System::get_vertical_alignment ()
 666 {
 667   extract_grob_set (this, "elements", elts);
 668   Grob *ret = 0;
 669   for (vsize i = 0; i < elts.size (); i++)
 670     if (Align_interface::has_interface (elts[i]))
 671       {
 672         if (ret)
 673           programming_error ("found multiple vertical alignments in this system");
 674         ret = elts[i];
 675       }
 676
 677   if (!ret)
 678     programming_error ("didn't find a vertical alignment in this system");
 679   return ret;
 680 }
 681
 682 // Finds the furthest staff in the given direction whose x-extent
 683 // overlaps with the given interval.
 684 Grob *
 685 System::get_extremal_staff (Direction dir, Interval const &iv)
 686 {
 687   Grob *align = get_vertical_alignment ();
 688   if (!align)
 689     return 0;
 690
 691   extract_grob_set (align, "elements", elts);
 692   vsize start = (dir == UP) ? 0 : elts.size () - 1;
 693   vsize end = (dir == UP) ? elts.size () : VPOS;
 694   for (vsize i = start; i != end; i += dir)
 695     {
 696       if (Hara_kiri_group_spanner::has_interface (elts[i]))
 697         Hara_kiri_group_spanner::consider_suicide (elts[i]);
 698
 699       Interval intersection = elts[i]->extent (this, X_AXIS);
 700       intersection.intersect (iv);
 701       if (elts[i]->is_live () && !intersection.is_empty ())
 702         return elts[i];
 703     }
 704   return 0;
 705 }
 706
 707 Interval
 708 System::pure_refpoint_extent (vsize start, vsize end)
 709 {
 710   Interval ret;
 711   Grob *alignment = get_vertical_alignment ();
 712   if (!alignment)
 713     return Interval ();
 714
 715   extract_grob_set (alignment, "elements", staves);
 716   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 717
 718   for (vsize i = 0; i < offsets.size (); ++i)
 719     if (Page_layout_problem::is_spaceable (staves[i]))
 720       {
 721         ret[UP] = offsets[i];
 722         break;
 723       }
 724
 725   for (vsize i = offsets.size (); i--;)
 726     if (Page_layout_problem::is_spaceable (staves[i]))
 727       {
 728         ret[DOWN] = offsets[i];
 729         break;
 730       }
 731
 732   return ret;
 733 }
 734
 735 Interval
 736 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
 737 {
 738   Grob *alignment = get_vertical_alignment ();
 739   if (!alignment)
 740     return Interval ();
 741
 742   extract_grob_set (alignment, "elements", staves);
 743   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 744
 745   Interval ret;
 746   for (vsize i = 0; i < staves.size (); ++i)
 747     {
 748       Interval iv = begin
 749         ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
 750         : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
 751       if (i < offsets.size ())
 752         iv.translate (offsets[i]);
 753       ret.unite (iv);
 754     }
 755
 756   Interval other_elements = begin
 757     ? Axis_group_interface::begin_of_line_pure_height (this, start)
 758     : Axis_group_interface::rest_of_line_pure_height (this, start, end);
 759
 760   ret.unite (other_elements);
 761
 762   return ret;
 763 }
 764
 765 Interval
 766 System::begin_of_line_pure_height (vsize start, vsize end)
 767 {
 768   return part_of_line_pure_height (start, end, true);
 769 }
 770
 771 Interval
 772 System::rest_of_line_pure_height (vsize start, vsize end)
 773 {
 774   return part_of_line_pure_height (start, end, false);
 775 }
 776
 777 // This differs from Axis_group_interface::calc_pure_relevant_grobs
 778 // because here, we are only interested in those few elements that aren't
 779 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
 780 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
 781 SCM
 782 System::calc_pure_relevant_grobs (SCM smob)
 783 {
 784   Grob *me = unsmob_grob (smob);
 785
 786   extract_grob_set (me, "elements", elts);
 787   vector<Grob *> relevant_grobs;
 788   SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
 789
 790   for (vsize i = 0; i < elts.size (); ++i)
 791     {
 792       if (!Axis_group_interface::has_interface (elts[i]))
 793         {
 794           if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
 795             relevant_grobs.push_back (elts[i]);
 796
 797           if (Item *it = dynamic_cast<Item*> (elts[i]))
 798             {
 799               Direction d = LEFT;
 800               do
 801                 {
 802                   Item *piece = it->find_prebroken_piece (d);
 803                   if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
 804                     relevant_grobs.push_back (piece);
 805                 }
 806               while (flip (&d) != LEFT);
 807             }
 808         }
 809     }
 810
 811   SCM grobs_scm = Grob_array::make_array ();
 812
 813   unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
 814   return grobs_scm;
 815 }
 816
 817 MAKE_SCHEME_CALLBACK (System, height, 1);
 818 SCM
 819 System::height (SCM smob)
 820 {
 821   return Axis_group_interface::height (smob);
 822 }
 823
 824 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
 825 SCM
 826 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
 827 {
 828   System *me = dynamic_cast<System *> (unsmob_grob (smob));
 829   int start = scm_to_int (start_scm);
 830   int end = scm_to_int (end_scm);
 831
 832   Interval begin = me->begin_of_line_pure_height (start, end);
 833   Interval rest = me->rest_of_line_pure_height (start, end);
 834   begin.unite (rest);
 835
 836   return ly_interval2scm (begin);
 837 }
 838
 839 Grob*
 840 System::get_pure_bound (Direction d, int start, int end)
 841 {
 842   vector<vsize> ranks = pscore_->get_break_ranks ();
 843   vector<vsize> indices = pscore_->get_break_indices ();
 844   vector<Grob*> cols = pscore_->get_columns ();
 845
 846   vsize target_rank = (d == LEFT ? start : end);
 847   vector<vsize>::const_iterator i =
 848     lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
 849
 850   if (i != ranks.end () && (*i) == target_rank)
 851     return cols[indices[i - ranks.begin ()]];
 852   else
 853     return 0;
 854 }
 855
 856 Grob*
 857 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
 858 {
 859   return pure ? get_pure_bound (d, start, end) : get_bound (d);
 860 }
 861
 862 ADD_INTERFACE (System,
 863                "This is the top-level object: Each object in a score"
 864                " ultimately has a @code{System} object as its X and"
 865                " Y@tie{}parent.",
 866
 867                /* properties */
 868                "all-elements "
 869                "columns "
 870                "labels "
 871                "pure-Y-extent "
 872                "skyline-horizontal-padding "
 873                );