lily/system.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2015 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 "system-start-delimiter.hh"
  40 #include "text-interface.hh"
  41 #include "warn.hh"
  42 #include "unpure-pure-container.hh"
  43 #include "lily-imports.hh"
  44
  45 System::System (System const &src)
  46   : Spanner (src)
  47 {
  48   all_elements_ = 0;
  49   pscore_ = 0;
  50   rank_ = 0;
  51   init_elements ();
  52 }
  53
  54 System::System (SCM s)
  55   : Spanner (s)
  56 {
  57   all_elements_ = 0;
  58   rank_ = 0;
  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 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
 194       for (vsize j = 0; j < child->all_elements_->size (); j++)
 195         {
 196           Grob *g = child->all_elements_->grob (j);
 197
 198           (void) g->get_property ("after-line-breaking");
 199         }
 200     }
 201
 202   debug_output (_f ("Element count %d", count + element_count ()) + "\n");
 203 }
 204
 205 SCM
 206 System::get_broken_system_grobs ()
 207 {
 208   SCM ret = SCM_EOL;
 209   for (vsize i = 0; i < broken_intos_.size (); i++)
 210     ret = scm_cons (broken_intos_[i]->self_scm (), ret);
 211   return scm_reverse_x (ret, SCM_EOL);
 212 }
 213
 214 SCM
 215 System::get_paper_systems ()
 216 {
 217   SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
 218   for (vsize i = 0; i < broken_intos_.size (); i++)
 219     {
 220       debug_output ("[", false);
 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       debug_output (::to_string (i) + "]", false);
 228     }
 229   return lines;
 230 }
 231
 232 vector<Grob *>
 233 System::get_footnote_grobs_in_range (vsize start, vsize end)
 234 {
 235   vector<Grob *> out;
 236   extract_grob_set (this, "footnotes-before-line-breaking", footnote_grobs);
 237   for (vsize i = 0; i < footnote_grobs.size (); i++)
 238     {
 239       Grob *at_bat = footnote_grobs[i];
 240       int pos = at_bat->spanned_rank_interval ()[LEFT];
 241       bool end_of_line_visible = true;
 242       if (Spanner *s = dynamic_cast<Spanner *>(at_bat))
 243         {
 244           Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
 245           if (spanner_placement == CENTER)
 246             spanner_placement = LEFT;
 247
 248           pos = s->spanned_rank_interval ()[spanner_placement];
 249           if (s->original ())
 250             {
 251               Spanner *orig = dynamic_cast<Spanner *>(s->original ());
 252               at_bat = spanner_placement == LEFT ? orig->broken_intos_[0] : orig->broken_intos_.back ();
 253               pos = at_bat->spanned_rank_interval ()[RIGHT];
 254             }
 255         }
 256
 257       if (Item *item = dynamic_cast<Item *>(at_bat))
 258         {
 259           /*
 260             We use this to weed out grobs that fall at the end
 261             of the line when we want grobs at the beginning.
 262           */
 263           end_of_line_visible = item->break_status_dir () == LEFT;
 264
 265           if (!Item::break_visible (item))
 266             continue;
 267           // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
 268           if (pos == int (start) && item->break_status_dir () != RIGHT)
 269             continue;
 270           if (pos == int (end) && item->break_status_dir () != LEFT)
 271             continue;
 272           if (pos != int (end) && pos != int (start) && item->break_status_dir () != CENTER)
 273             continue;
 274         }
 275
 276       if (pos < int (start))
 277         continue;
 278       if (pos > int (end))
 279         continue;
 280       if (pos == int (start) && end_of_line_visible)
 281         continue;
 282       if (pos == int (end) && !end_of_line_visible)
 283         continue;
 284       if (!at_bat->is_live ())
 285         continue;
 286       /*
 287         TODO
 288         Sometimes, there are duplicate entries in the all_elements_
 289         list. In a separate patch, this practice should be squashed
 290         so that the check below can be eliminated.
 291       */
 292       if (find (out.begin (), out.end (), at_bat) != out.end ())
 293         continue;
 294
 295       out.push_back (at_bat);
 296     }
 297   return out;
 298 }
 299
 300 vector<Real>
 301 System::get_footnote_heights_in_range (vsize start, vsize end)
 302 {
 303   return internal_get_note_heights_in_range (start, end, true);
 304 }
 305
 306 vector<Real>
 307 System::get_in_note_heights_in_range (vsize start, vsize end)
 308 {
 309   return internal_get_note_heights_in_range (start, end, false);
 310 }
 311
 312 vector<Real>
 313 System::internal_get_note_heights_in_range (vsize start, vsize end, bool foot)
 314 {
 315   vector<Grob *> footnote_grobs = get_footnote_grobs_in_range (start, end);
 316   vector<Real> out;
 317
 318   for (vsize i = footnote_grobs.size (); i--;)
 319     if (foot
 320         ? !to_boolean (footnote_grobs[i]->get_property ("footnote"))
 321         : to_boolean (footnote_grobs[i]->get_property ("footnote")))
 322       footnote_grobs.erase (footnote_grobs.begin () + i);
 323
 324   for (vsize i = 0; i < footnote_grobs.size (); i++)
 325     {
 326       SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
 327
 328       if (!Text_interface::is_markup (footnote_markup))
 329         continue;
 330
 331       SCM props =
 332         Lily::layout_extract_page_properties (pscore_->layout ()->self_scm ());
 333
 334       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 335                                                            props, footnote_markup);
 336
 337       Stencil *footnote_stencil = unsmob<Stencil> (footnote_stl);
 338       out.push_back (footnote_stencil->extent (Y_AXIS).length ());
 339     }
 340
 341   return out;
 342 }
 343
 344 vsize
 345 System::num_footnotes ()
 346 {
 347   extract_grob_set (this, "footnotes-after-line-breaking", footnote_grobs);
 348   return footnote_grobs.size ();
 349 }
 350
 351 bool
 352 grob_2D_less (Grob *g1, Grob *g2)
 353 {
 354   int sri[] = {0, 0};
 355   Grob *gs[] = {g1, g2};
 356
 357   for (int i = 0; i < 2; i++)
 358     {
 359       sri[i] = gs[i]->spanned_rank_interval ()[LEFT];
 360       if (Spanner *s = dynamic_cast<Spanner *> (gs[i]))
 361         {
 362           if (s->broken_intos_.size ())
 363             s = (scm_to_int (s->broken_intos_[0]->get_property ("spanner-placement")) == LEFT
 364                  ? s->broken_intos_[0]
 365                  : s->broken_intos_.back ());
 366           gs[i] = s;
 367           if (robust_scm2double (s->get_property ("X-offset"), 0.0) > 0)
 368             sri[i] = s->spanned_rank_interval ()[RIGHT];
 369         }
 370     }
 371
 372   if (sri[0] == sri[1])
 373     return Grob::vertical_less (gs[0], gs[1]);
 374
 375   return sri[0] < sri[1];
 376 }
 377
 378 MAKE_SCHEME_CALLBACK (System, footnotes_before_line_breaking, 1);
 379 SCM
 380 System::footnotes_before_line_breaking (SCM smob)
 381 {
 382   Grob *me = unsmob<Grob> (smob);
 383   vector<Grob *> footnotes;
 384   SCM grobs_scm = Grob_array::make_array ();
 385   extract_grob_set (me, "all-elements", elts);
 386   for (vsize i = 0; i < elts.size (); i++)
 387     if (elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
 388       footnotes.push_back (elts[i]);
 389
 390   unsmob<Grob_array> (grobs_scm)->set_array (footnotes);
 391   return grobs_scm;
 392 }
 393
 394 MAKE_SCHEME_CALLBACK (System, footnotes_after_line_breaking, 1);
 395 SCM
 396 System::footnotes_after_line_breaking (SCM smob)
 397 {
 398   Spanner *sys_span = unsmob<Spanner> (smob);
 399   System *sys = dynamic_cast<System *> (sys_span);
 400   Interval_t<int> sri = sys->spanned_rank_interval ();
 401   vector<Grob *> footnote_grobs = sys->get_footnote_grobs_in_range (sri[LEFT], sri[RIGHT]);
 402   vector_sort (footnote_grobs, grob_2D_less);
 403
 404   SCM grobs_scm = Grob_array::make_array ();
 405   unsmob<Grob_array> (grobs_scm)->set_array (footnote_grobs);
 406   return grobs_scm;
 407 }
 408
 409 MAKE_SCHEME_CALLBACK (System, vertical_skyline_elements, 1);
 410 SCM
 411 System::vertical_skyline_elements (SCM smob)
 412 {
 413   Grob *me_grob = unsmob<Grob> (smob);
 414   vector<Grob *> vertical_skyline_grobs;
 415   extract_grob_set (me_grob, "elements", my_elts);
 416   for (vsize i = 0; i < my_elts.size (); i++)
 417     if (has_interface<System_start_delimiter> (my_elts[i]))
 418       vertical_skyline_grobs.push_back (my_elts[i]);
 419
 420   System *me = dynamic_cast<System *> (me_grob);
 421   Grob *align = unsmob<Grob> (me->get_object ("vertical-alignment"));
 422   if (!align)
 423     {
 424       SCM grobs_scm = Grob_array::make_array ();
 425       unsmob<Grob_array> (grobs_scm)->set_array (vertical_skyline_grobs);
 426       return grobs_scm;
 427     }
 428
 429   extract_grob_set (align, "elements", elts);
 430
 431   for (vsize i = 0; i < elts.size (); i++)
 432     if (has_interface<Hara_kiri_group_spanner> (elts[i]))
 433       vertical_skyline_grobs.push_back (elts[i]);
 434
 435   SCM grobs_scm = Grob_array::make_array ();
 436   unsmob<Grob_array> (grobs_scm)->set_array (vertical_skyline_grobs);
 437   return grobs_scm;
 438 }
 439
 440 void
 441 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 442 {
 443   for (vsize i = 0; i < breaking.size (); i++)
 444     {
 445       System *system = dynamic_cast<System *> (clone ());
 446       system->rank_ = broken_intos_.size ();
 447
 448       vector<Grob *> c (breaking[i].cols_);
 449       pscore_->typeset_system (system);
 450
 451       int st = Paper_column::get_rank (c[0]);
 452       int end = Paper_column::get_rank (c.back ());
 453       Interval iv (pure_y_extent (this, st, end));
 454       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 455
 456       system->set_bound (LEFT, c[0]);
 457       system->set_bound (RIGHT, c.back ());
 458       SCM system_labels = SCM_EOL;
 459       for (vsize j = 0; j < c.size (); j++)
 460         {
 461           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 462           dynamic_cast<Paper_column *> (c[j])->set_system (system);
 463           /* collect the column labels */
 464           collect_labels (c[j], &system_labels);
 465         }
 466       /*
 467         Collect labels from any loose columns too: theses will be set on
 468         an empty bar line or a column which is otherwise unused mid-line
 469       */
 470       vector<Grob *> loose (breaking[i].loose_cols_);
 471       for (vsize j = 0; j < loose.size (); j++)
 472         collect_labels (loose[j], &system_labels);
 473
 474       system->set_property ("labels", system_labels);
 475
 476       set_loose_columns (system, &breaking[i]);
 477       broken_intos_.push_back (system);
 478     }
 479 }
 480
 481 void
 482 System::collect_labels (Grob const *col, SCM *labels)
 483 {
 484   SCM col_labels = col->get_property ("labels");
 485   if (scm_is_pair (col_labels))
 486     *labels = scm_append (scm_list_2 (col_labels, *labels));
 487 }
 488
 489 void
 490 System::add_column (Paper_column *p)
 491 {
 492   Grob *me = this;
 493   Grob_array *ga = unsmob<Grob_array> (me->get_object ("columns"));
 494   if (!ga)
 495     {
 496       SCM scm_ga = Grob_array::make_array ();
 497       me->set_object ("columns", scm_ga);
 498       ga = unsmob<Grob_array> (scm_ga);
 499     }
 500
 501   p->set_rank (ga->size ());
 502
 503   ga->add (p);
 504   Axis_group_interface::add_element (this, p);
 505 }
 506
 507 void
 508 System::pre_processing ()
 509 {
 510   for (vsize i = 0; i < all_elements_->size (); i++)
 511     all_elements_->grob (i)->discretionary_processing ();
 512
 513   debug_output (_f ("Grob count %d", element_count ()));
 514
 515   /*
 516     order is significant: broken grobs are added to the end of the
 517     array, and should be processed before the original is potentially
 518     killed.
 519   */
 520   for (vsize i = all_elements_->size (); i--;)
 521     all_elements_->grob (i)->handle_prebroken_dependencies ();
 522
 523   fixup_refpoints (all_elements_->array ());
 524
 525   for (vsize i = 0; i < all_elements_->size (); i++)
 526     {
 527       Grob *g = all_elements_->grob (i);
 528       (void) g->get_property ("before-line-breaking");
 529     }
 530
 531   for (vsize i = 0; i < all_elements_->size (); i++)
 532     {
 533       Grob *e = all_elements_->grob (i);
 534       (void) e->get_property ("springs-and-rods");
 535     }
 536 }
 537
 538 void
 539 System::post_processing ()
 540 {
 541   Interval iv (extent (this, Y_AXIS));
 542   if (iv.is_empty ())
 543     programming_error ("system with empty extent");
 544   else
 545     translate_axis (-iv[MAX], Y_AXIS);
 546
 547   /* Generate all stencils to trigger font loads.
 548      This might seem inefficient, but Stencils are cached per grob
 549      anyway. */
 550
 551   vector<Grob *> all_elts_sorted (all_elements_->array ());
 552   uniquify (all_elts_sorted);
 553   get_stencil ();
 554   for (vsize i = all_elts_sorted.size (); i--;)
 555     {
 556       Grob *g = all_elts_sorted[i];
 557       g->get_stencil ();
 558     }
 559 }
 560
 561 struct Layer_entry
 562 {
 563   Grob *grob_;
 564   int layer_;
 565 };
 566
 567 bool
 568 operator < (Layer_entry const &a,
 569             Layer_entry const &b)
 570 {
 571   return a.layer_ < b.layer_;
 572 }
 573
 574 SCM
 575 System::get_paper_system ()
 576 {
 577   SCM exprs = SCM_EOL;
 578   SCM *tail = &exprs;
 579
 580   post_processing ();
 581
 582   vector<Layer_entry> entries;
 583   for (vsize j = 0; j < all_elements_->size (); j++)
 584     {
 585       Layer_entry e;
 586       e.grob_ = all_elements_->grob (j);
 587       e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
 588
 589       entries.push_back (e);
 590     }
 591
 592   vector_sort (entries, std::less<Layer_entry> ());
 593   for (vsize j = 0; j < entries.size (); j++)
 594     {
 595       Grob *g = entries[j].grob_;
 596       Stencil st = g->get_print_stencil ();
 597
 598       if (scm_is_null (st.expr ()))
 599         continue;
 600
 601       Offset o;
 602       for (int a = X_AXIS; a < NO_AXES; a++)
 603         o[Axis (a)] = g->relative_coordinate (this, Axis (a));
 604
 605       Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
 606                                         Offset (0, 0))
 607                      * Staff_symbol_referencer::staff_space (g);
 608
 609       /* Must copy the stencil, for we cannot change the stencil
 610          cached in G.  */
 611
 612       st.translate (o + extra);
 613
 614       *tail = scm_cons (st.expr (), SCM_EOL);
 615       tail = SCM_CDRLOC (*tail);
 616     }
 617
 618   if (Stencil *me = get_stencil ())
 619     exprs = scm_cons (me->expr (), exprs);
 620
 621   Interval x (extent (this, X_AXIS));
 622   Interval y (extent (this, Y_AXIS));
 623   Stencil sys_stencil (Box (x, y),
 624                        scm_cons (ly_symbol2scm ("combine-stencil"),
 625                                  exprs));
 626   if (debug_skylines)
 627     {
 628       Skyline_pair *skylines = unsmob<Skyline_pair> (get_property ("vertical-skylines"));
 629       if (skylines)
 630         {
 631           Stencil up
 632             = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
 633           Stencil down
 634             = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
 635           sys_stencil.add_stencil (up.in_color (255, 0, 0));
 636           sys_stencil.add_stencil (down.in_color (0, 255, 0));
 637         }
 638     }
 639
 640   Grob *left_bound = get_bound (LEFT);
 641   SCM prop_init = left_bound->get_property ("line-break-system-details");
 642   Prob *pl = make_paper_system (prop_init);
 643   paper_system_set_stencil (pl, sys_stencil);
 644
 645   /* information that the page breaker might need */
 646   Grob *right_bound = get_bound (RIGHT);
 647   pl->set_property ("vertical-skylines", get_property ("vertical-skylines"));
 648   pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
 649   pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
 650   pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
 651   pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
 652
 653   if (right_bound->original () == dynamic_cast<System *> (original ())->get_bound (RIGHT))
 654     pl->set_property ("last-in-score", SCM_BOOL_T);
 655
 656   Interval staff_refpoints;
 657   if (Grob *align = unsmob<Grob> (get_object ("vertical-alignment")))
 658     {
 659       extract_grob_set (align, "elements", staves);
 660       for (vsize i = 0; i < staves.size (); i++)
 661         if (staves[i]->is_live ()
 662             && Page_layout_problem::is_spaceable (staves[i]))
 663           staff_refpoints.add_point (staves[i]->relative_coordinate (this,
 664                                                                      Y_AXIS));
 665     }
 666
 667   pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
 668   pl->set_property ("system-grob", self_scm ());
 669
 670   return pl->unprotect ();
 671 }
 672
 673 vector<Item *>
 674 System::broken_col_range (Item const *left, Item const *right) const
 675 {
 676   vector<Item *> ret;
 677
 678   left = left->get_column ();
 679   right = right->get_column ();
 680
 681   extract_grob_set (this, "columns", cols);
 682
 683   vsize i = Paper_column::get_rank (left);
 684   int end_rank = Paper_column::get_rank (right);
 685   if (i < cols.size ())
 686     i++;
 687
 688   while (i < cols.size ()
 689          && Paper_column::get_rank (cols[i]) < end_rank)
 690     {
 691       Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
 692       if (Paper_column::is_breakable (c) && !c->get_system ())
 693         ret.push_back (c);
 694       i++;
 695     }
 696
 697   return ret;
 698 }
 699
 700 /** Return all columns, but filter out any unused columns , since they might
 701     disrupt the spacing problem. */
 702 vector<Grob *>
 703 System::used_columns () const
 704 {
 705   extract_grob_set (this, "columns", ro_columns);
 706
 707   int last_breakable = ro_columns.size ();
 708
 709   while (last_breakable--)
 710     {
 711       if (Paper_column::is_breakable (ro_columns [last_breakable]))
 712         break;
 713     }
 714
 715   vector<Grob *> columns;
 716   for (int i = 0; i <= last_breakable; i++)
 717     {
 718       if (Paper_column::is_used (ro_columns[i]))
 719         columns.push_back (ro_columns[i]);
 720     }
 721
 722   return columns;
 723 }
 724
 725 Paper_column *
 726 System::column (vsize which) const
 727 {
 728   extract_grob_set (this, "columns", columns);
 729   if (which >= columns.size ())
 730     return 0;
 731
 732   return dynamic_cast<Paper_column *> (columns[which]);
 733 }
 734
 735 Paper_score *
 736 System::paper_score () const
 737 {
 738   return pscore_;
 739 }
 740
 741 int
 742 System::get_rank () const
 743 {
 744   return rank_;
 745 }
 746
 747 System *
 748 get_root_system (Grob *me)
 749 {
 750   Grob *system_grob = me;
 751
 752   while (system_grob->get_parent (Y_AXIS))
 753     system_grob = system_grob->get_parent (Y_AXIS);
 754
 755   return dynamic_cast<System *> (system_grob);
 756 }
 757
 758 MAKE_SCHEME_CALLBACK (System, get_vertical_alignment, 1);
 759 SCM
 760 System::get_vertical_alignment (SCM smob)
 761 {
 762   Grob *me = unsmob<Grob> (smob);
 763   extract_grob_set (me, "elements", elts);
 764   Grob *ret = 0;
 765   for (vsize i = 0; i < elts.size (); i++)
 766     if (has_interface<Align_interface> (elts[i]))
 767       {
 768         if (ret)
 769           me->programming_error ("found multiple vertical alignments in this system");
 770         ret = elts[i];
 771       }
 772
 773   if (!ret)
 774     {
 775       me->programming_error ("didn't find a vertical alignment in this system");
 776       return SCM_EOL;
 777     }
 778   return ret->self_scm ();
 779 }
 780
 781 // Finds the furthest staff in the given direction whose x-extent
 782 // overlaps with the given interval.
 783 Grob *
 784 System::get_extremal_staff (Direction dir, Interval const &iv)
 785 {
 786   Grob *align = unsmob<Grob> (get_object ("vertical-alignment"));
 787   if (!align)
 788     return 0;
 789
 790   extract_grob_set (align, "elements", elts);
 791   vsize start = (dir == UP) ? 0 : elts.size () - 1;
 792   vsize end = (dir == UP) ? elts.size () : VPOS;
 793   for (vsize i = start; i != end; i += dir)
 794     {
 795       if (has_interface<Hara_kiri_group_spanner> (elts[i]))
 796         Hara_kiri_group_spanner::consider_suicide (elts[i]);
 797
 798       Interval intersection = elts[i]->extent (this, X_AXIS);
 799       intersection.intersect (iv);
 800       if (elts[i]->is_live () && !intersection.is_empty ())
 801         return elts[i];
 802     }
 803   return 0;
 804 }
 805
 806 // Finds the neighboring staff in the given direction over bounds
 807 Grob *
 808 System::get_neighboring_staff (Direction dir, Grob *vertical_axis_group, Interval_t<int> bounds)
 809 {
 810   Grob *align = unsmob<Grob> (get_object ("vertical-alignment"));
 811   if (!align)
 812     return 0;
 813
 814   extract_grob_set (align, "elements", elts);
 815   vsize start = (dir == UP) ? 0 : elts.size () - 1;
 816   vsize end = (dir == UP) ? elts.size () : VPOS;
 817
 818   Grob *out = 0;
 819
 820   for (vsize i = start; i != end; i += dir)
 821     {
 822       if (elts[i] == vertical_axis_group)
 823         return out;
 824
 825       if (has_interface<Hara_kiri_group_spanner> (elts[i]))
 826         Hara_kiri_group_spanner::consider_suicide (elts[i]);
 827
 828       bounds.intersect (elts[i]->spanned_rank_interval ());
 829       if (elts[i]->is_live () && !bounds.is_empty ())
 830         out = elts[i];
 831     }
 832
 833   return 0;
 834 }
 835
 836 Interval
 837 System::pure_refpoint_extent (vsize start, vsize end)
 838 {
 839   Interval ret;
 840   Grob *alignment = unsmob<Grob> (get_object ("vertical-alignment"));
 841   if (!alignment)
 842     return Interval ();
 843
 844   extract_grob_set (alignment, "elements", staves);
 845   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 846
 847   for (vsize i = 0; i < offsets.size (); ++i)
 848     if (Page_layout_problem::is_spaceable (staves[i]))
 849       {
 850         ret[UP] = offsets[i];
 851         break;
 852       }
 853
 854   for (vsize i = offsets.size (); i--;)
 855     if (Page_layout_problem::is_spaceable (staves[i]))
 856       {
 857         ret[DOWN] = offsets[i];
 858         break;
 859       }
 860
 861   return ret;
 862 }
 863
 864 Interval
 865 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
 866 {
 867   Grob *alignment = unsmob<Grob> (get_object ("vertical-alignment"));
 868   if (!alignment)
 869     return Interval ();
 870
 871   extract_grob_set (alignment, "elements", staves);
 872   vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
 873
 874   Interval ret;
 875   for (vsize i = 0; i < staves.size (); ++i)
 876     {
 877       Interval iv = begin
 878                     ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
 879                     : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
 880       if (i < offsets.size ())
 881         iv.translate (offsets[i]);
 882       ret.unite (iv);
 883     }
 884
 885   Interval other_elements = begin
 886                             ? Axis_group_interface::begin_of_line_pure_height (this, start)
 887                             : Axis_group_interface::rest_of_line_pure_height (this, start, end);
 888
 889   ret.unite (other_elements);
 890
 891   return ret;
 892 }
 893
 894 Interval
 895 System::begin_of_line_pure_height (vsize start, vsize end)
 896 {
 897   return part_of_line_pure_height (start, end, true);
 898 }
 899
 900 Interval
 901 System::rest_of_line_pure_height (vsize start, vsize end)
 902 {
 903   return part_of_line_pure_height (start, end, false);
 904 }
 905
 906 // This differs from Axis_group_interface::calc_pure_relevant_grobs
 907 // because here, we are only interested in those few elements that aren't
 908 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
 909 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
 910 SCM
 911 System::calc_pure_relevant_grobs (SCM smob)
 912 {
 913   Grob *me = unsmob<Grob> (smob);
 914
 915   extract_grob_set (me, "elements", elts);
 916   vector<Grob *> relevant_grobs;
 917
 918   for (vsize i = 0; i < elts.size (); ++i)
 919     {
 920       if (!has_interface<Axis_group_interface> (elts[i]))
 921         {
 922           relevant_grobs.push_back (elts[i]);
 923
 924           if (Item *it = dynamic_cast<Item *> (elts[i]))
 925             {
 926               for (LEFT_and_RIGHT (d))
 927                 {
 928                   Item *piece = it->find_prebroken_piece (d);
 929                   if (piece && piece->is_live ())
 930                     relevant_grobs.push_back (piece);
 931                 }
 932             }
 933         }
 934     }
 935
 936   SCM grobs_scm = Grob_array::make_array ();
 937
 938   unsmob<Grob_array> (grobs_scm)->set_array (relevant_grobs);
 939   return grobs_scm;
 940 }
 941
 942 MAKE_SCHEME_CALLBACK (System, height, 1);
 943 SCM
 944 System::height (SCM smob)
 945 {
 946   return Axis_group_interface::height (smob);
 947 }
 948
 949 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
 950 SCM
 951 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
 952 {
 953   System *me = unsmob<System> (smob);
 954   int start = scm_to_int (start_scm);
 955   int end = scm_to_int (end_scm);
 956
 957   Interval begin = me->begin_of_line_pure_height (start, end);
 958   Interval rest = me->rest_of_line_pure_height (start, end);
 959   begin.unite (rest);
 960
 961   return ly_interval2scm (begin);
 962 }
 963
 964 Grob *
 965 System::get_pure_bound (Direction d, int start, int end)
 966 {
 967   vector<vsize> ranks = pscore_->get_break_ranks ();
 968   vector<vsize> indices = pscore_->get_break_indices ();
 969   vector<Grob *> cols = pscore_->get_columns ();
 970
 971   vsize target_rank = (d == LEFT ? start : end);
 972   vector<vsize>::const_iterator i
 973     = lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
 974
 975   if (i != ranks.end () && (*i) == target_rank)
 976     return cols[indices[i - ranks.begin ()]];
 977   else
 978     return 0;
 979 }
 980
 981 Grob *
 982 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
 983 {
 984   return pure ? get_pure_bound (d, start, end) : get_bound (d);
 985 }
 986
 987 enum
 988 {
 989   SPACEABLE_STAVES,
 990   NONSPACEABLE_STAVES,
 991   ALL_STAVES
 992 };
 993
 994 static SCM
 995 get_maybe_spaceable_staves (SCM smob, int filter)
 996 {
 997   System *me = unsmob<System> (smob);
 998   Grob *align = unsmob<Grob> (me->get_object ("vertical_alignment"));
 999   SCM ret = SCM_EOL;
1000
1001   if (align)
1002     {
1003       SCM *tail = &ret;
1004       extract_grob_set (align, "elements", staves);
1005
1006       for (vsize i = 0; i < staves.size (); ++i)
1007         {
1008           bool spaceable = Page_layout_problem::is_spaceable (staves[i]);
1009           if (staves[i]->is_live ()
1010               && ((filter == ALL_STAVES)
1011                   || (filter == SPACEABLE_STAVES && spaceable)
1012                   || (filter == NONSPACEABLE_STAVES && !spaceable)))
1013             {
1014               *tail = scm_cons (staves[i]->self_scm (), SCM_EOL);
1015               tail = SCM_CDRLOC (*tail);
1016             }
1017         }
1018     }
1019
1020   return ret;
1021 }
1022
1023 MAKE_SCHEME_CALLBACK (System, get_staves, 1)
1024 SCM
1025 System::get_staves (SCM smob)
1026 {
1027   return get_maybe_spaceable_staves (smob, ALL_STAVES);
1028 }
1029
1030 MAKE_SCHEME_CALLBACK (System, get_spaceable_staves, 1)
1031 SCM
1032 System::get_spaceable_staves (SCM smob)
1033 {
1034   return get_maybe_spaceable_staves (smob, SPACEABLE_STAVES);
1035 }
1036
1037 MAKE_SCHEME_CALLBACK (System, get_nonspaceable_staves, 1)
1038 SCM
1039 System::get_nonspaceable_staves (SCM smob)
1040 {
1041   return get_maybe_spaceable_staves (smob, NONSPACEABLE_STAVES);
1042 }
1043
1044 ADD_INTERFACE (System,
1045                "This is the top-level object: Each object in a score"
1046                " ultimately has a @code{System} object as its X and"
1047                " Y@tie{}parent.",
1048
1049                /* properties */
1050                "all-elements "
1051                "columns "
1052                "footnote-stencil "
1053                "footnotes-before-line-breaking "
1054                "footnotes-after-line-breaking "
1055                "in-note-direction "
1056                "in-note-padding "
1057                "in-note-stencil "
1058                "labels "
1059                "pure-Y-extent "
1060                "vertical-alignment "
1061               );