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 #include "unpure-pure-container.hh"
  42
  43 System::System (System const &src)
  44   : Spanner (src)
  45 {
  46   all_elements_ = 0;
  47   pscore_ = 0;
  48   rank_ = 0;
  49   checked_footnotes_ = false;
  50   init_elements ();
  51 }
  52
  53 System::System (SCM s)
  54   : Spanner (s)
  55 {
  56   all_elements_ = 0;
  57   rank_ = 0;
  58   checked_footnotes_ = false;
  59   init_elements ();
  60 }
  61
  62 void
  63 System::init_elements ()
  64 {
  65   SCM scm_arr = Grob_array::make_array ();
  66   all_elements_ = unsmob_grob_array (scm_arr);
  67   all_elements_->set_ordered (false);
  68   set_object ("all-elements", scm_arr);
  69 }
  70
  71 Grob *
  72 System::clone () const
  73 {
  74   return new System (*this);
  75 }
  76
  77 int
  78 System::element_count () const
  79 {
  80   return all_elements_->size ();
  81 }
  82
  83 int
  84 System::spanner_count () const
  85 {
  86   int k = 0;
  87   for (vsize i = all_elements_->size (); i--;)
  88     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  89       k++;
  90   return k;
  91 }
  92
  93 void
  94 System::typeset_grob (Grob *elem)
  95 {
  96   if (elem->layout_)
  97     programming_error ("adding element twice");
  98   else
  99     {
 100       elem->layout_ = pscore_->layout ();
 101       all_elements_->add (elem);
 102       elem->unprotect ();
 103     }
 104 }
 105
 106 void
 107 System::derived_mark () const
 108 {
 109   if (!all_elements_->empty ())
 110     {
 111       Grob **ptr = &all_elements_->array_reference ()[0];
 112       Grob **end = ptr + all_elements_->size ();
 113       while (ptr < end)
 114         {
 115           scm_gc_mark ((*ptr)->self_scm ());
 116           ptr++;
 117         }
 118     }
 119
 120   if (pscore_)
 121     scm_gc_mark (pscore_->self_scm ());
 122
 123   Spanner::derived_mark ();
 124 }
 125
 126 static void
 127 fixup_refpoints (vector<Grob *> const &grobs)
 128 {
 129   for (vsize i = grobs.size (); i--;)
 130     grobs[i]->fixup_refpoint ();
 131 }
 132
 133 void
 134 System::do_break_substitution_and_fixup_refpoints ()
 135 {
 136   for (vsize i = 0; i < all_elements_->size (); i++)
 137     {
 138       Grob *g = all_elements_->grob (i);
 139       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 140         {
 141           /*
 142             Kill no longer needed grobs.
 143           */
 144           Item *it = dynamic_cast<Item *> (g);
 145           if (it && Item::is_non_musical (it))
 146             {
 147               it->find_prebroken_piece (LEFT)->suicide ();
 148               it->find_prebroken_piece (RIGHT)->suicide ();
 149             }
 150           g->suicide ();
 151         }
 152       else if (g->is_live ())
 153         g->do_break_processing ();
 154     }
 155
 156   /*
 157     fixups must be done in broken line_of_scores, because new elements
 158     are put over there.  */
 159   int count = 0;
 160   for (vsize i = 0; i < broken_intos_.size (); i++)
 161     {
 162       Grob *se = broken_intos_[i];
 163
 164       extract_grob_set (se, "all-elements", all_elts);
 165       for (vsize j = 0; j < all_elts.size (); j++)
 166         {
 167           Grob *g = all_elts[j];
 168           g->fixup_refpoint ();
 169         }
 170
 171       count += all_elts.size ();
 172     }
 173
 174   /*
 175     needed for doing items.
 176   */
 177   fixup_refpoints (all_elements_->array ());
 178
 179   for (vsize i = 0; i < all_elements_->size (); i++)
 180     all_elements_->grob (i)->handle_broken_dependencies ();
 181
 182   handle_broken_dependencies ();
 183
 184   /* Because the this->get_property (all-elements) contains items in 3
 185      versions, handle_broken_dependencies () will leave duplicated
 186      items in all-elements.  Strictly speaking this is harmless, but
 187      it leads to duplicated symbols in the output.  uniq makes sure
 188      that no duplicates are in the list.  */
 189   for (vsize i = 0; i < broken_intos_.size (); i++)
 190     {
 191       System *child = dynamic_cast<System *> (broken_intos_[i]);
 192       child->all_elements_->remove_duplicates ();
 193       for (vsize j = 0; j < child->all_elements_->size (); j++)
 194         {
 195           Grob *g = child->all_elements_->grob (j);
 196
 197           (void) g->get_property ("after-line-breaking");
 198         }
 199     }
 200
 201   debug_output (_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       debug_output ("[", false);
 220
 221       System *system = dynamic_cast<System *> (broken_intos_[i]);
 222
 223       scm_vector_set_x (lines, scm_from_int (i),
 224                         system->get_paper_system ());
 225
 226       debug_output (to_string (i) + "]", false);
 227     }
 228   return lines;
 229 }
 230
 231 void
 232 System::populate_footnote_grob_vector ()
 233 {
 234   extract_grob_set (this, "all-elements", all_elts);
 235   for (vsize i = 0; i < all_elts.size (); i++)
 236     if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
 237       footnote_grobs_.push_back (all_elts[i]);
 238
 239   sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
 240   checked_footnotes_ = true;
 241 }
 242
 243 void
 244 System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
 245 {
 246   if (!checked_footnotes_)
 247     populate_footnote_grob_vector ();
 248
 249   for (vsize i = 0; i < footnote_grobs_.size (); i++)
 250     {
 251       int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
 252       bool end_of_line_visible = true;
 253       if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
 254         {
 255           Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
 256           if (spanner_placement == CENTER)
 257             spanner_placement = LEFT;
 258
 259           pos = s->spanned_rank_interval ()[spanner_placement];
 260         }
 261
 262       if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
 263         {
 264           if (!Item::break_visible (item))
 265             continue;
 266           // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
 267           end_of_line_visible = (LEFT == item->break_status_dir ());
 268         }
 269
 270       if (pos < int (start))
 271         continue;
 272       if (pos > int (end))
 273         break;
 274       if (pos == int (start) && end_of_line_visible)
 275         continue;
 276       if (pos == int (end) && !end_of_line_visible)
 277         continue;
 278       if (!footnote_grobs_[i]->is_live ())
 279         continue;
 280
 281       out.push_back (footnote_grobs_[i]);
 282     }
 283 }
 284
 285 vector<Stencil *>
 286 System::get_footnotes_in_range (vsize start, vsize end)
 287 {
 288   vector<Grob *> footnote_grobs;
 289   get_footnote_grobs_in_range (footnote_grobs, start, end);
 290   vector<Stencil *> out;
 291
 292   for (vsize i = 0; i < footnote_grobs.size (); i++)
 293     {
 294       SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
 295
 296       if (!Text_interface::is_markup (footnote_markup))
 297         continue;
 298
 299       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 300                               pscore_->layout ()->self_scm ());
 301
 302       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 303                                                            props, footnote_markup);
 304
 305       Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
 306       out.push_back (footnote_stencil);
 307     }
 308
 309   return out;
 310 }
 311
 312 vsize
 313 System::num_footnotes ()
 314 {
 315   return footnote_grobs_.size ();
 316 }
 317
 318 vector<Grob *>*
 319 System::footnote_grobs ()
 320 {
 321   return &footnote_grobs_;
 322 }
 323
 324 void
 325 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 326 {
 327   for (vsize i = 0; i < breaking.size (); i++)
 328     {
 329       System *system = dynamic_cast<System *> (clone ());
 330       system->rank_ = broken_intos_.size ();
 331
 332       vector<Grob *> c (breaking[i].cols_);
 333       pscore_->typeset_system (system);
 334
 335       int st = Paper_column::get_rank (c[0]);
 336       int end = Paper_column::get_rank (c.back ());
 337       Interval iv (pure_height (this, st, end));
 338       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 339
 340       get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
 341
 342       system->set_bound (LEFT, c[0]);
 343       system->set_bound (RIGHT, c.back ());
 344       SCM system_labels = SCM_EOL;
 345       for (vsize j = 0; j < c.size (); j++)
 346         {
 347           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 348           dynamic_cast<Paper_column *> (c[j])->set_system (system);
 349           /* collect the column labels */
 350           collect_labels (c[j], &system_labels);
 351         }
 352       /*
 353         Collect labels from any loose columns too: theses will be set on
 354         an empty bar line or a column which is otherwise unused mid-line
 355       */
 356       vector<Grob *> loose (breaking[i].loose_cols_);
 357       for (vsize j = 0; j < loose.size (); j++)
 358         collect_labels (loose[j], &system_labels);
 359
 360       system->set_property ("labels", system_labels);
 361
 362       set_loose_columns (system, &breaking[i]);
 363       broken_intos_.push_back (system);
 364     }
 365 }
 366
 367 void
 368 System::collect_labels (Grob const *col, SCM *labels)
 369 {
 370   SCM col_labels = col->get_property ("labels");
 371   if (scm_is_pair (col_labels))
 372     *labels = scm_append (scm_list_2 (col_labels, *labels));
 373 }
 374
 375 void
 376 System::add_column (Paper_column *p)
 377 {
 378   Grob *me = this;
 379   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 380   if (!ga)
 381     {
 382       SCM scm_ga = Grob_array::make_array ();
 383       me->set_object ("columns", scm_ga);
 384       ga = unsmob_grob_array (scm_ga);
 385     }
 386
 387   p->set_rank (ga->size ());
 388
 389   ga->add (p);
 390   Axis_group_interface::add_element (this, p);
 391 }
 392
 393 void
 394 System::pre_processing ()
 395 {
 396   for (vsize i = 0; i < all_elements_->size (); i++)
 397     all_elements_->grob (i)->discretionary_processing ();
 398
 399   debug_output (_f ("Grob count %d", element_count ()));
 400
 401   /*
 402     order is significant: broken grobs are added to the end of the
 403     array, and should be processed before the original is potentially
 404     killed.
 405   */
 406   for (vsize i = all_elements_->size (); i--;)
 407     all_elements_->grob (i)->handle_prebroken_dependencies ();
 408
 409   fixup_refpoints (all_elements_->array ());
 410
 411   for (vsize i = 0; i < all_elements_->size (); i++)
 412     {
 413       Grob *g = all_elements_->grob (i);
 414       (void) g->get_property ("before-line-breaking");
 415     }
 416
 417   for (vsize i = 0; i < all_elements_->size (); i++)
 418     {
 419       Grob *e = all_elements_->grob (i);
 420       (void) e->get_property ("springs-and-rods");
 421     }
 422 }
 423
 424 void
 425 System::post_processing ()
 426 {
 427   Interval iv (extent (this, Y_AXIS));
 428   if (iv.is_empty ())
 429     programming_error ("system with empty extent");
 430   else
 431     translate_axis (-iv[MAX], Y_AXIS);
 432
 433   /* Generate all stencils to trigger font loads.
 434      This might seem inefficient, but Stencils are cached per grob
 435      anyway. */
 436
 437   vector<Grob *> all_elts_sorted (all_elements_->array ());
 438   vector_sort (all_elts_sorted, std::less<Grob *> ());
 439   uniq (all_elts_sorted);
 440   this->get_stencil ();
 441   for (vsize i = all_elts_sorted.size (); i--;)
 442     {
 443       Grob *g = all_elts_sorted[i];
 444       g->get_stencil ();
 445     }
 446 }
 447
 448 struct Layer_entry
 449 {
 450   Grob *grob_;
 451   int layer_;
 452 };
 453
 454 bool
 455 operator < (Layer_entry const &a,
 456             Layer_entry const &b)
 457 {
 458   return a.layer_ < b.layer_;
 459 }
 460
 461 SCM
 462 System::get_paper_system ()
 463 {
 464   SCM exprs = SCM_EOL;
 465   SCM *tail = &exprs;
 466
 467   post_processing ();
 468
 469   vector<Layer_entry> entries;
 470   for (vsize j = 0; j < all_elements_->size (); j++)
 471     {
 472       Layer_entry e;
 473       e.grob_ = all_elements_->grob (j);
 474       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
 475
 476       entries.push_back (e);
 477     }
 478
 479   vector_sort (entries, std::less<Layer_entry> ());
 480   for (vsize j = 0; j < entries.size (); j++)
 481     {
 482       Grob *g = entries[j].grob_;
 483       Stencil st = g->get_print_stencil ();
 484
 485       if (st.expr () == SCM_EOL)
 486         continue;
 487
 488       Offset o;
 489       for (int a = X_AXIS; a < NO_AXES; a++)
 490         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 491
 492       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 493                                         Offset (0, 0))
 494                      * Staff_symbol_referencer::staff_space (g);
 495
 496       /* Must copy the stencil, for we cannot change the stencil
 497          cached in G.  */
 498
 499       st.translate (o + extra);
 500
 501       *tail = scm_cons (st.expr (), SCM_EOL);
 502       tail = SCM_CDRLOC (*tail);
 503     }
 504
 505   if (Stencil *me = get_stencil ())
 506     exprs = scm_cons (me->expr (), exprs);
 507
 508   Interval x (extent (this, X_AXIS));
 509   Interval y (extent (this, Y_AXIS));
 510   Stencil sys_stencil (Box (x, y),
 511                        scm_cons (ly_symbol2scm ("combine-stencil"),
 512                                  exprs));
 513   if (debug_skylines)
 514     {
 515       Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
 516       if (skylines)
 517         {
 518           Stencil up
 519             = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
 520           Stencil down
 521             = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
 522           sys_stencil.add_stencil (up.in_color (255, 0, 0));
 523           sys_stencil.add_stencil (down.in_color (0, 255, 0));
 524         }
 525     }
 526
 527   Grob *left_bound = this->get_bound (LEFT);
 528   SCM prop_init = left_bound->get_property ("line-break-system-details");
 529   Prob *pl = make_paper_system (prop_init);
 530   paper_system_set_stencil (pl, sys_stencil);
 531
 532   /* information that the page breaker might need */
 533   Grob *right_bound = this->get_bound (RIGHT);
 534   pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
 535   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 536   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 537   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 538   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 539
 540   if (right_bound->original () == dynamic_cast<System*> (original ())->get_bound (RIGHT))
 541     pl->set_property ("last-in-score", SCM_BOOL_T);
 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 enum {
 844   SPACEABLE_STAVES,
 845   NONSPACEABLE_STAVES,
 846   ALL_STAVES
 847 };
 848
 849 static SCM
 850 get_maybe_spaceable_staves (SCM smob, int filter)
 851 {
 852   System *me = dynamic_cast<System*> (unsmob_grob (smob));
 853   Grob *align = me->get_vertical_alignment ();
 854   SCM ret = SCM_EOL;
 855
 856   if (align)
 857     {
 858       SCM *tail = &ret;
 859       extract_grob_set (align, "elements", staves);
 860
 861       for (vsize i = 0; i < staves.size (); ++i)
 862         {
 863           bool spaceable = Page_layout_problem::is_spaceable (staves[i]);
 864           if (staves[i]->is_live () &&
 865               ((filter == ALL_STAVES)
 866                || (filter == SPACEABLE_STAVES && spaceable)
 867                || (filter == NONSPACEABLE_STAVES && !spaceable)))
 868             {
 869               *tail = scm_cons (staves[i]->self_scm (), SCM_EOL);
 870               tail = SCM_CDRLOC (*tail);
 871             }
 872         }
 873     }
 874
 875   return ret;
 876 }
 877
 878 MAKE_SCHEME_CALLBACK (System, get_staves, 1)
 879 SCM
 880 System::get_staves (SCM smob)
 881 {
 882   return get_maybe_spaceable_staves (smob, ALL_STAVES);
 883 }
 884
 885 MAKE_SCHEME_CALLBACK (System, get_spaceable_staves, 1)
 886 SCM
 887 System::get_spaceable_staves (SCM smob)
 888 {
 889   return get_maybe_spaceable_staves (smob, SPACEABLE_STAVES);
 890 }
 891
 892 MAKE_SCHEME_CALLBACK (System, get_nonspaceable_staves, 1)
 893 SCM
 894 System::get_nonspaceable_staves (SCM smob)
 895 {
 896   return get_maybe_spaceable_staves (smob, NONSPACEABLE_STAVES);
 897 }
 898
 899
 900 ADD_INTERFACE (System,
 901                "This is the top-level object: Each object in a score"
 902                " ultimately has a @code{System} object as its X and"
 903                " Y@tie{}parent.",
 904
 905                /* properties */
 906                "all-elements "
 907                "columns "
 908                "labels "
 909                "pure-Y-extent "
 910                "skyline-horizontal-padding "
 911               );