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)end && !end_of_line_visible)
 281         continue;
 282       if (!footnote_grobs_[i]->is_live ())
 283         continue;
 284
 285       out.push_back (footnote_grobs_[i]);
 286     }
 287 }
 288
 289 vector<Stencil *>
 290 System::get_footnotes_in_range (vsize start, vsize end)
 291 {
 292   vector<Grob *> footnote_grobs;
 293   get_footnote_grobs_in_range (footnote_grobs, start, end);
 294   vector<Stencil *> out;
 295
 296   for (vsize i = 0; i < footnote_grobs.size (); i++)
 297     {
 298       SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
 299
 300       if (!Text_interface::is_markup (footnote_markup))
 301         continue;
 302
 303       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 304                               pscore_->layout ()->self_scm ());
 305
 306       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 307                                                            props, footnote_markup);
 308
 309       Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
 310       out.push_back (footnote_stencil);
 311     }
 312
 313   return out;
 314 }
 315
 316 Stencil
 317 System::make_footnote_stencil (Real padding)
 318 {
 319   Stencil mol;
 320
 321   for (vsize i = 0; i < footnote_grobs_.size (); i++)
 322     {
 323       SCM footnote_markup = footnote_grobs_[i]->get_property ("footnote-text");
 324       if (Spanner *orig = dynamic_cast<Spanner *>(footnote_grobs_[i]))
 325         if (orig->is_broken ())
 326           footnote_markup = orig->broken_intos_[0]->get_property ("footnote-text");
 327
 328       if (!Text_interface::is_markup (footnote_markup))
 329         continue;
 330
 331       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 332                               pscore_->layout ()->self_scm ());
 333
 334       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 335                                                            props, footnote_markup);
 336
 337       mol.add_at_edge (Y_AXIS, DOWN, *unsmob_stencil (footnote_stl), padding);
 338     }
 339
 340   return mol;
 341 }
 342
 343 void
 344 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 345 {
 346   for (vsize i = 0; i < breaking.size (); i++)
 347     {
 348       System *system = dynamic_cast<System *> (clone ());
 349       system->rank_ = broken_intos_.size ();
 350
 351       vector<Grob *> c (breaking[i].cols_);
 352       pscore_->typeset_system (system);
 353
 354       int st = Paper_column::get_rank (c[0]);
 355       int end = Paper_column::get_rank (c.back ());
 356       Interval iv (pure_height (this, st, end));
 357       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 358
 359       get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
 360
 361       system->set_bound (LEFT, c[0]);
 362       system->set_bound (RIGHT, c.back ());
 363       SCM system_labels = SCM_EOL;
 364       for (vsize j = 0; j < c.size (); j++)
 365         {
 366           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 367           dynamic_cast<Paper_column *> (c[j])->set_system (system);
 368           /* collect the column labels */
 369           collect_labels (c[j], &system_labels);
 370         }
 371       /*
 372         Collect labels from any loose columns too: theses will be set on
 373         an empty bar line or a column which is otherwise unused mid-line
 374       */
 375       vector<Grob *> loose (breaking[i].loose_cols_);
 376       for (vsize j = 0; j < loose.size (); j++)
 377         collect_labels (loose[j], &system_labels);
 378
 379       system->set_property ("labels", system_labels);
 380
 381       set_loose_columns (system, &breaking[i]);
 382       broken_intos_.push_back (system);
 383     }
 384 }
 385
 386 void
 387 System::collect_labels (Grob const *col, SCM *labels)
 388 {
 389   SCM col_labels = col->get_property ("labels");
 390   if (scm_is_pair (col_labels))
 391     *labels = scm_append (scm_list_2 (col_labels, *labels));
 392 }
 393
 394 void
 395 System::add_column (Paper_column *p)
 396 {
 397   Grob *me = this;
 398   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 399   if (!ga)
 400     {
 401       SCM scm_ga = Grob_array::make_array ();
 402       me->set_object ("columns", scm_ga);
 403       ga = unsmob_grob_array (scm_ga);
 404     }
 405
 406   p->set_rank (ga->size ());
 407
 408   ga->add (p);
 409   Axis_group_interface::add_element (this, p);
 410 }
 411
 412 void
 413 System::pre_processing ()
 414 {
 415   for (vsize i = 0; i < all_elements_->size (); i++)
 416     all_elements_->grob (i)->discretionary_processing ();
 417
 418   if (be_verbose_global)
 419     message (_f ("Grob count %d", element_count ()));
 420
 421   /*
 422     order is significant: broken grobs are added to the end of the
 423     array, and should be processed before the original is potentially
 424     killed.
 425   */
 426   for (vsize i = all_elements_->size (); i--;)
 427     all_elements_->grob (i)->handle_prebroken_dependencies ();
 428
 429   fixup_refpoints (all_elements_->array ());
 430
 431   for (vsize i = 0; i < all_elements_->size (); i++)
 432     {
 433       Grob *g = all_elements_->grob (i);
 434       (void) g->get_property ("before-line-breaking");
 435     }
 436
 437   for (vsize i = 0; i < all_elements_->size (); i++)
 438     {
 439       Grob *e = all_elements_->grob (i);
 440       (void) e->get_property ("springs-and-rods");
 441     }
 442 }
 443
 444 void
 445 System::post_processing ()
 446 {
 447   Interval iv (extent (this, Y_AXIS));
 448   if (iv.is_empty ())
 449     programming_error ("system with empty extent");
 450   else
 451     translate_axis (-iv[MAX], Y_AXIS);
 452
 453   /* Generate all stencils to trigger font loads.
 454      This might seem inefficient, but Stencils are cached per grob
 455      anyway. */
 456
 457   vector<Grob *> all_elts_sorted (all_elements_->array ());
 458   vector_sort (all_elts_sorted, std::less<Grob *> ());
 459   uniq (all_elts_sorted);
 460   this->get_stencil ();
 461   for (vsize i = all_elts_sorted.size (); i--;)
 462     {
 463       Grob *g = all_elts_sorted[i];
 464       g->get_stencil ();
 465     }
 466 }
 467
 468 struct Layer_entry
 469 {
 470   Grob *grob_;
 471   int layer_;
 472 };
 473
 474 bool
 475 operator< (Layer_entry  const &a,
 476            Layer_entry  const &b)
 477 {
 478   return a.layer_ < b.layer_;
 479 }
 480
 481 SCM
 482 System::get_paper_system ()
 483 {
 484   SCM exprs = SCM_EOL;
 485   SCM *tail = &exprs;
 486
 487   post_processing ();
 488
 489   vector<Layer_entry> entries;
 490   for (vsize j = 0; j < all_elements_->size (); j++)
 491     {
 492       Layer_entry e;
 493       e.grob_ = all_elements_->grob (j);
 494       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
 495
 496       entries.push_back (e);
 497     }
 498
 499   vector_sort (entries, std::less<Layer_entry> ());
 500   for (vsize j = 0; j < entries.size (); j++)
 501     {
 502       Grob *g = entries[j].grob_;
 503       Stencil st = g->get_print_stencil ();
 504
 505       if (st.expr () == SCM_EOL)
 506         continue;
 507
 508       Offset o;
 509       for (int a = X_AXIS; a < NO_AXES; a++)
 510         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 511
 512       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 513                                         Offset (0, 0))
 514         * Staff_symbol_referencer::staff_space (g);
 515
 516       /* Must copy the stencil, for we cannot change the stencil
 517          cached in G.  */
 518
 519       st.translate (o + extra);
 520
 521       *tail = scm_cons (st.expr (), SCM_EOL);
 522       tail = SCM_CDRLOC (*tail);
 523     }
 524
 525   if (Stencil *me = get_stencil ())
 526     exprs = scm_cons (me->expr (), exprs);
 527
 528   Interval x (extent (this, X_AXIS));
 529   Interval y (extent (this, Y_AXIS));
 530   Stencil sys_stencil (Box (x, y),
 531                        scm_cons (ly_symbol2scm ("combine-stencil"),
 532                                  exprs));
 533   if (debug_skylines)
 534     {
 535       Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
 536       if (skylines)
 537         {
 538           Stencil up
 539             = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
 540           Stencil down
 541             = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
 542           sys_stencil.add_stencil (up.in_color (255, 0, 0));
 543           sys_stencil.add_stencil (down.in_color (0, 255, 0));
 544         }
 545     }
 546
 547   Grob *left_bound = this->get_bound (LEFT);
 548   SCM prop_init = left_bound->get_property ("line-break-system-details");
 549   Prob *pl = make_paper_system (prop_init);
 550   paper_system_set_stencil (pl, sys_stencil);
 551
 552   /* information that the page breaker might need */
 553   Grob *right_bound = this->get_bound (RIGHT);
 554   pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
 555   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 556   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 557   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 558   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 559
 560   Interval staff_refpoints;
 561   if (Grob *align = get_vertical_alignment ())
 562     {
 563       extract_grob_set (align, "elements", staves);
 564       for (vsize i = 0; i < staves.size (); i++)
 565         if (staves[i]->is_live ()
 566             && Page_layout_problem::is_spaceable (staves[i]))
 567           staff_refpoints.add_point (staves[i]->relative_coordinate (this,
 568                                                                      Y_AXIS));
 569     }
 570
 571   pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
 572   pl->set_property ("system-grob", this->self_scm ());
 573
 574   return pl->unprotect ();
 575 }
 576
 577 vector<Item *>
 578 System::broken_col_range (Item const *left, Item const *right) const
 579 {
 580   vector<Item *> ret;
 581
 582   left = left->get_column ();
 583   right = right->get_column ();
 584
 585   extract_grob_set (this, "columns", cols);
 586
 587   vsize i = Paper_column::get_rank (left);
 588   int end_rank = Paper_column::get_rank (right);
 589   if (i < cols.size ())
 590     i++;
 591
 592   while (i < cols.size ()
 593          && Paper_column::get_rank (cols[i]) < end_rank)
 594     {
 595       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 596       if (Paper_column::is_breakable (c) && !c->get_system ())
 597         ret.push_back (c);
 598       i++;
 599     }
 600
 601   return ret;
 602 }
 603
 604 /** Return all columns, but filter out any unused columns , since they might
 605     disrupt the spacing problem. */
 606 vector<Grob *>
 607 System::used_columns () const
 608 {
 609   extract_grob_set (this, "columns", ro_columns);
 610
 611   int last_breakable = ro_columns.size ();
 612
 613   while (last_breakable--)
 614     {
 615       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 616         break;
 617     }
 618
 619   vector<Grob *> columns;
 620   for (int i = 0; i <= last_breakable; i++)
 621     {
 622       if (Paper_column::is_used (ro_columns[i]))
 623         columns.push_back (ro_columns[i]);
 624     }
 625
 626   return columns;
 627 }
 628
 629 Paper_column *
 630 System::column (vsize which) const
 631 {
 632   extract_grob_set (this, "columns", columns);
 633   if (which >= columns.size ())
 634     return 0;
 635
 636   return dynamic_cast<Paper_column *> (columns[which]);
 637 }
 638
 639 Paper_score *
 640 System::paper_score () const
 641 {
 642   return pscore_;
 643 }
 644
 645 int
 646 System::get_rank () const
 647 {
 648   return rank_;
 649 }
 650
 651 System *
 652 get_root_system (Grob *me)
 653 {
 654   Grob *system_grob = me;
 655
 656   while (system_grob->get_parent (Y_AXIS))
 657     system_grob = system_grob->get_parent (Y_AXIS);
 658
 659   return dynamic_cast<System *> (system_grob);
 660 }
 661
 662 Grob *
 663 System::get_vertical_alignment ()
 664 {
 665   extract_grob_set (this, "elements", elts);
 666   Grob *ret = 0;
 667   for (vsize i = 0; i < elts.size (); i++)
 668     if (Align_interface::has_interface (elts[i]))
 669       {
 670         if (ret)
 671           programming_error ("found multiple vertical alignments in this system");
 672         ret = elts[i];
 673       }
 674
 675   if (!ret)
 676     programming_error ("didn't find a vertical alignment in this system");
 677   return ret;
 678 }
 679
 680 // Finds the furthest staff in the given direction whose x-extent
 681 // overlaps with the given interval.
 682 Grob *
 683 System::get_extremal_staff (Direction dir, Interval const &iv)
 684 {
 685   Grob *align = get_vertical_alignment ();
 686   if (!align)
 687     return 0;
 688
 689   extract_grob_set (align, "elements", elts);
 690   vsize start = (dir == UP) ? 0 : elts.size () - 1;
 691   vsize end = (dir == UP) ? elts.size () : VPOS;
 692   for (vsize i = start; i != end; i += dir)
 693     {
 694       if (Hara_kiri_group_spanner::has_interface (elts[i]))
 695         Hara_kiri_group_spanner::consider_suicide (elts[i]);
 696
 697       Interval intersection = elts[i]->extent (this, X_AXIS);
 698       intersection.intersect (iv);
 699       if (elts[i]->is_live () && !intersection.is_empty ())
 700         return elts[i];
 701     }
 702   return 0;
 703 }
 704
 705 Interval
 706 System::pure_refpoint_extent (vsize start, vsize end)
 707 {
 708   Interval ret;
 709   Grob *alignment = get_vertical_alignment ();
 710   if (!alignment)
 711     return Interval ();
 712
 713   extract_grob_set (alignment, "elements", staves);
 714   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 715
 716   for (vsize i = 0; i < offsets.size (); ++i)
 717     if (Page_layout_problem::is_spaceable (staves[i]))
 718       {
 719         ret[UP] = offsets[i];
 720         break;
 721       }
 722
 723   for (vsize i = offsets.size (); i--;)
 724     if (Page_layout_problem::is_spaceable (staves[i]))
 725       {
 726         ret[DOWN] = offsets[i];
 727         break;
 728       }
 729
 730   return ret;
 731 }
 732
 733 Interval
 734 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
 735 {
 736   Grob *alignment = get_vertical_alignment ();
 737   if (!alignment)
 738     return Interval ();
 739
 740   extract_grob_set (alignment, "elements", staves);
 741   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 742
 743   Interval ret;
 744   for (vsize i = 0; i < staves.size (); ++i)
 745     {
 746       Interval iv = begin
 747         ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
 748         : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
 749       if (i < offsets.size ())
 750         iv.translate (offsets[i]);
 751       ret.unite (iv);
 752     }
 753
 754   Interval other_elements = begin
 755     ? Axis_group_interface::begin_of_line_pure_height (this, start)
 756     : Axis_group_interface::rest_of_line_pure_height (this, start, end);
 757
 758   ret.unite (other_elements);
 759
 760   return ret;
 761 }
 762
 763 Interval
 764 System::begin_of_line_pure_height (vsize start, vsize end)
 765 {
 766   return part_of_line_pure_height (start, end, true);
 767 }
 768
 769 Interval
 770 System::rest_of_line_pure_height (vsize start, vsize end)
 771 {
 772   return part_of_line_pure_height (start, end, false);
 773 }
 774
 775 // This differs from Axis_group_interface::calc_pure_relevant_grobs
 776 // because here, we are only interested in those few elements that aren't
 777 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
 778 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
 779 SCM
 780 System::calc_pure_relevant_grobs (SCM smob)
 781 {
 782   Grob *me = unsmob_grob (smob);
 783
 784   extract_grob_set (me, "elements", elts);
 785   vector<Grob *> relevant_grobs;
 786   SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
 787
 788   for (vsize i = 0; i < elts.size (); ++i)
 789     {
 790       if (!Axis_group_interface::has_interface (elts[i]))
 791         {
 792           if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
 793             relevant_grobs.push_back (elts[i]);
 794
 795           if (Item *it = dynamic_cast<Item*> (elts[i]))
 796             {
 797               Direction d = LEFT;
 798               do
 799                 {
 800                   Item *piece = it->find_prebroken_piece (d);
 801                   if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
 802                     relevant_grobs.push_back (piece);
 803                 }
 804               while (flip (&d) != LEFT);
 805             }
 806         }
 807     }
 808
 809   SCM grobs_scm = Grob_array::make_array ();
 810
 811   unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
 812   return grobs_scm;
 813 }
 814
 815 MAKE_SCHEME_CALLBACK (System, height, 1);
 816 SCM
 817 System::height (SCM smob)
 818 {
 819   return Axis_group_interface::height (smob);
 820 }
 821
 822 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
 823 SCM
 824 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
 825 {
 826   System *me = dynamic_cast<System *> (unsmob_grob (smob));
 827   int start = scm_to_int (start_scm);
 828   int end = scm_to_int (end_scm);
 829
 830   Interval begin = me->begin_of_line_pure_height (start, end);
 831   Interval rest = me->rest_of_line_pure_height (start, end);
 832   begin.unite (rest);
 833
 834   return ly_interval2scm (begin);
 835 }
 836
 837 Grob*
 838 System::get_pure_bound (Direction d, int start, int end)
 839 {
 840   vector<vsize> ranks = pscore_->get_break_ranks ();
 841   vector<vsize> indices = pscore_->get_break_indices ();
 842   vector<Grob*> cols = pscore_->get_columns ();
 843
 844   vsize target_rank = (d == LEFT ? start : end);
 845   vector<vsize>::const_iterator i =
 846     lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
 847
 848   if (i != ranks.end () && (*i) == target_rank)
 849     return cols[indices[i - ranks.begin ()]];
 850   else
 851     return 0;
 852 }
 853
 854 Grob*
 855 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
 856 {
 857   return pure ? get_pure_bound (d, start, end) : get_bound (d);
 858 }
 859
 860 ADD_INTERFACE (System,
 861                "This is the top-level object: Each object in a score"
 862                " ultimately has a @code{System} object as its X and"
 863                " Y@tie{}parent.",
 864
 865                /* properties */
 866                "all-elements "
 867                "columns "
 868                "labels "
 869                "pure-Y-extent "
 870                "skyline-horizontal-padding "
 871                );