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