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