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