lily/system.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1996--2012 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
  44 System::System (System const &src)
  45   : Spanner (src)
  46 {
  47   all_elements_ = 0;
  48   pscore_ = 0;
  49   rank_ = 0;
  50   init_elements ();
  51 }
  52
  53 System::System (SCM s)
  54   : Spanner (s)
  55 {
  56   all_elements_ = 0;
  57   rank_ = 0;
  58   init_elements ();
  59 }
  60
  61 void
  62 System::init_elements ()
  63 {
  64   SCM scm_arr = Grob_array::make_array ();
  65   all_elements_ = unsmob_grob_array (scm_arr);
  66   all_elements_->set_ordered (false);
  67   set_object ("all-elements", scm_arr);
  68 }
  69
  70 Grob *
  71 System::clone () const
  72 {
  73   return new System (*this);
  74 }
  75
  76 int
  77 System::element_count () const
  78 {
  79   return all_elements_->size ();
  80 }
  81
  82 int
  83 System::spanner_count () const
  84 {
  85   int k = 0;
  86   for (vsize i = all_elements_->size (); i--;)
  87     if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
  88       k++;
  89   return k;
  90 }
  91
  92 void
  93 System::typeset_grob (Grob *elem)
  94 {
  95   if (elem->layout_)
  96     programming_error ("adding element twice");
  97   else
  98     {
  99       elem->layout_ = pscore_->layout ();
 100       all_elements_->add (elem);
 101       elem->unprotect ();
 102     }
 103 }
 104
 105 void
 106 System::derived_mark () const
 107 {
 108   if (!all_elements_->empty ())
 109     {
 110       Grob **ptr = &all_elements_->array_reference ()[0];
 111       Grob **end = ptr + all_elements_->size ();
 112       while (ptr < end)
 113         {
 114           scm_gc_mark ((*ptr)->self_scm ());
 115           ptr++;
 116         }
 117     }
 118
 119   if (pscore_)
 120     scm_gc_mark (pscore_->self_scm ());
 121
 122   Spanner::derived_mark ();
 123 }
 124
 125 static void
 126 fixup_refpoints (vector<Grob *> const &grobs)
 127 {
 128   for (vsize i = grobs.size (); i--;)
 129     grobs[i]->fixup_refpoint ();
 130 }
 131
 132 void
 133 System::do_break_substitution_and_fixup_refpoints ()
 134 {
 135   for (vsize i = 0; i < all_elements_->size (); i++)
 136     {
 137       Grob *g = all_elements_->grob (i);
 138       if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
 139         {
 140           /*
 141             Kill no longer needed grobs.
 142           */
 143           Item *it = dynamic_cast<Item *> (g);
 144           if (it && Item::is_non_musical (it))
 145             {
 146               it->find_prebroken_piece (LEFT)->suicide ();
 147               it->find_prebroken_piece (RIGHT)->suicide ();
 148             }
 149           g->suicide ();
 150         }
 151       else if (g->is_live ())
 152         g->do_break_processing ();
 153     }
 154
 155   /*
 156     fixups must be done in broken line_of_scores, because new elements
 157     are put over there.  */
 158   int count = 0;
 159   for (vsize i = 0; i < broken_intos_.size (); i++)
 160     {
 161       Grob *se = broken_intos_[i];
 162
 163       extract_grob_set (se, "all-elements", all_elts);
 164       for (vsize j = 0; j < all_elts.size (); j++)
 165         {
 166           Grob *g = all_elts[j];
 167           g->fixup_refpoint ();
 168         }
 169
 170       count += all_elts.size ();
 171     }
 172
 173   /*
 174     needed for doing items.
 175   */
 176   fixup_refpoints (all_elements_->array ());
 177
 178   for (vsize i = 0; i < all_elements_->size (); i++)
 179     all_elements_->grob (i)->handle_broken_dependencies ();
 180
 181   handle_broken_dependencies ();
 182
 183   /* Because the this->get_property (all-elements) contains items in 3
 184      versions, handle_broken_dependencies () will leave duplicated
 185      items in all-elements.  Strictly speaking this is harmless, but
 186      it leads to duplicated symbols in the output.  uniq makes sure
 187      that no duplicates are in the list.  */
 188   for (vsize i = 0; i < broken_intos_.size (); i++)
 189     {
 190       System *child = dynamic_cast<System *> (broken_intos_[i]);
 191       child->all_elements_->remove_duplicates ();
 192
 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_x (ret, SCM_EOL);
 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 vector<Grob *>
 232 System::get_footnote_grobs_in_range (vsize start, vsize end)
 233 {
 234   vector<Grob *> out;
 235   extract_grob_set (this, "footnotes-before-line-breaking", footnote_grobs);
 236   for (vsize i = 0; i < footnote_grobs.size (); i++)
 237     {
 238       Grob *at_bat = footnote_grobs[i];
 239       int pos = at_bat->spanned_rank_interval ()[LEFT];
 240       bool end_of_line_visible = true;
 241       if (Spanner *s = dynamic_cast<Spanner *>(at_bat))
 242         {
 243           Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
 244           if (spanner_placement == CENTER)
 245             spanner_placement = LEFT;
 246
 247           pos = s->spanned_rank_interval ()[spanner_placement];
 248           if (s->original ())
 249             {
 250               Spanner *orig = dynamic_cast<Spanner *>(s->original ());
 251               at_bat = spanner_placement == LEFT ? orig->broken_intos_[0] : orig->broken_intos_.back ();
 252               pos = at_bat->spanned_rank_interval ()[RIGHT];
 253             }
 254         }
 255
 256       if (Item *item = dynamic_cast<Item *>(at_bat))
 257         {
 258           /*
 259             We use this to weed out grobs that fall at the end
 260             of the line when we want grobs at the beginning.
 261           */
 262           end_of_line_visible = item->break_status_dir () == LEFT;
 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           if (pos == int (start) && item->break_status_dir () != RIGHT)
 268             continue;
 269           if (pos == int (end) && item->break_status_dir () != LEFT)
 270             continue;
 271           if (pos != int (end) && pos != int (start) && item->break_status_dir () != CENTER)
 272             continue;
 273         }
 274
 275       if (pos < int (start))
 276         continue;
 277       if (pos > int (end))
 278         continue;
 279       if (pos == int (start) && end_of_line_visible)
 280         continue;
 281       if (pos == int (end) && !end_of_line_visible)
 282         continue;
 283       if (!at_bat->is_live ())
 284         continue;
 285       /*
 286         TODO
 287         Sometimes, there are duplicate entries in the all_elements_
 288         list. In a separate patch, this practice should be squashed
 289         so that the check below can be eliminated.
 290       */
 291       if (find (out.begin (), out.end (), at_bat) != out.end ())
 292         continue;
 293
 294       out.push_back (at_bat);
 295     }
 296   return out;
 297 }
 298
 299 vector<Real>
 300 System::get_footnote_heights_in_range (vsize start, vsize end)
 301 {
 302   return internal_get_note_heights_in_range (start, end, true);
 303 }
 304
 305 vector<Real>
 306 System::get_in_note_heights_in_range (vsize start, vsize end)
 307 {
 308   return internal_get_note_heights_in_range (start, end, false);
 309 }
 310
 311 vector<Real>
 312 System::internal_get_note_heights_in_range (vsize start, vsize end, bool foot)
 313 {
 314   vector<Grob *> footnote_grobs = get_footnote_grobs_in_range (start, end);
 315   vector<Real> out;
 316
 317   for (vsize i = footnote_grobs.size (); i--;)
 318     if (foot
 319         ? !to_boolean (footnote_grobs[i]->get_property ("footnote"))
 320         : to_boolean (footnote_grobs[i]->get_property ("footnote")))
 321       footnote_grobs.erase (footnote_grobs.begin () + i);
 322
 323   for (vsize i = 0; i < footnote_grobs.size (); i++)
 324     {
 325       SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
 326
 327       if (!Text_interface::is_markup (footnote_markup))
 328         continue;
 329
 330       SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
 331                               pscore_->layout ()->self_scm ());
 332
 333       SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
 334                                                            props, footnote_markup);
 335
 336       Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
 337       out.push_back (footnote_stencil->extent (Y_AXIS).length ());
 338     }
 339
 340   return out;
 341 }
 342
 343 vsize
 344 System::num_footnotes ()
 345 {
 346   extract_grob_set (this, "footnotes-after-line-breaking", footnote_grobs);
 347   return footnote_grobs.size ();
 348 }
 349
 350 bool
 351 grob_2D_less (Grob *g1, Grob *g2)
 352 {
 353   int sri[] = {0, 0};
 354   Grob *gs[] = {g1, g2};
 355
 356   for (int i = 0; i < 2; i++)
 357     {
 358       sri[i] = gs[i]->spanned_rank_interval ()[LEFT];
 359       if (Spanner *s = dynamic_cast<Spanner *> (gs[i]))
 360         {
 361           if (s->broken_intos_.size ())
 362             s = (scm_to_int (s->broken_intos_[0]->get_property ("spanner-placement")) == LEFT
 363                  ? s->broken_intos_[0]
 364                  : s->broken_intos_.back ());
 365           gs[i] = s;
 366           if (robust_scm2double (s->get_property ("X-offset"), 0.0) > 0)
 367             sri[i] = s->spanned_rank_interval ()[RIGHT];
 368         }
 369     }
 370
 371   if (sri[0] == sri[1])
 372     return Grob::vertical_less (gs[0], gs[1]);
 373
 374   return sri[0] < sri[1];
 375 }
 376
 377 MAKE_SCHEME_CALLBACK (System, footnotes_before_line_breaking, 1);
 378 SCM
 379 System::footnotes_before_line_breaking (SCM smob)
 380 {
 381   Grob *me = unsmob_grob (smob);
 382   vector<Grob *> footnotes;
 383   SCM grobs_scm = Grob_array::make_array ();
 384   extract_grob_set (me, "all-elements", elts);
 385   for (vsize i = 0; i < elts.size (); i++)
 386     if (elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
 387       footnotes.push_back (elts[i]);
 388
 389   unsmob_grob_array (grobs_scm)->set_array (footnotes);
 390   return grobs_scm;
 391 }
 392
 393 MAKE_SCHEME_CALLBACK (System, footnotes_after_line_breaking, 1);
 394 SCM
 395 System::footnotes_after_line_breaking (SCM smob)
 396 {
 397   Spanner *sys_span = unsmob_spanner (smob);
 398   System *sys = dynamic_cast<System *> (sys_span);
 399   Interval_t<int> sri = sys->spanned_rank_interval ();
 400   vector<Grob *> footnote_grobs = sys->get_footnote_grobs_in_range (sri[LEFT], sri[RIGHT]);
 401   vector_sort (footnote_grobs, grob_2D_less);
 402
 403   SCM grobs_scm = Grob_array::make_array ();
 404   unsmob_grob_array (grobs_scm)->set_array (footnote_grobs);
 405   return grobs_scm;
 406 }
 407
 408 MAKE_SCHEME_CALLBACK (System, vertical_skyline_elements, 1);
 409 SCM
 410 System::vertical_skyline_elements (SCM smob)
 411 {
 412   Grob *me_grob = unsmob_grob (smob);
 413   vector<Grob *> vertical_skyline_grobs;
 414   extract_grob_set (me_grob, "elements", my_elts);
 415   for (vsize i = 0; i < my_elts.size (); i++)
 416     if (System_start_delimiter::has_interface (my_elts[i]))
 417       vertical_skyline_grobs.push_back (my_elts[i]);
 418
 419   System *me = dynamic_cast<System *> (me_grob);
 420   Grob *align = unsmob_grob (me->get_object ("vertical-alignment"));
 421   if (!align)
 422     {
 423       SCM grobs_scm = Grob_array::make_array ();
 424       unsmob_grob_array (grobs_scm)->set_array (vertical_skyline_grobs);
 425       return grobs_scm;
 426     }
 427
 428   extract_grob_set (align, "elements", elts);
 429
 430   for (vsize i = 0; i < elts.size (); i++)
 431     if (Hara_kiri_group_spanner::has_interface (elts[i]))
 432       vertical_skyline_grobs.push_back (elts[i]);
 433
 434   SCM grobs_scm = Grob_array::make_array ();
 435   unsmob_grob_array (grobs_scm)->set_array (vertical_skyline_grobs);
 436   return grobs_scm;
 437 }
 438
 439 void
 440 System::break_into_pieces (vector<Column_x_positions> const &breaking)
 441 {
 442   for (vsize i = 0; i < breaking.size (); i++)
 443     {
 444       System *system = dynamic_cast<System *> (clone ());
 445       system->rank_ = broken_intos_.size ();
 446
 447       vector<Grob *> c (breaking[i].cols_);
 448       pscore_->typeset_system (system);
 449
 450       int st = Paper_column::get_rank (c[0]);
 451       int end = Paper_column::get_rank (c.back ());
 452       Interval iv (pure_height (this, st, end));
 453       system->set_property ("pure-Y-extent", ly_interval2scm (iv));
 454
 455       system->set_bound (LEFT, c[0]);
 456       system->set_bound (RIGHT, c.back ());
 457       SCM system_labels = SCM_EOL;
 458       for (vsize j = 0; j < c.size (); j++)
 459         {
 460           c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
 461           dynamic_cast<Paper_column *> (c[j])->set_system (system);
 462           /* collect the column labels */
 463           collect_labels (c[j], &system_labels);
 464         }
 465       /*
 466         Collect labels from any loose columns too: theses will be set on
 467         an empty bar line or a column which is otherwise unused mid-line
 468       */
 469       vector<Grob *> loose (breaking[i].loose_cols_);
 470       for (vsize j = 0; j < loose.size (); j++)
 471         collect_labels (loose[j], &system_labels);
 472
 473       system->set_property ("labels", system_labels);
 474
 475       set_loose_columns (system, &breaking[i]);
 476       broken_intos_.push_back (system);
 477     }
 478 }
 479
 480 void
 481 System::collect_labels (Grob const *col, SCM *labels)
 482 {
 483   SCM col_labels = col->get_property ("labels");
 484   if (scm_is_pair (col_labels))
 485     *labels = scm_append (scm_list_2 (col_labels, *labels));
 486 }
 487
 488 void
 489 System::add_column (Paper_column *p)
 490 {
 491   Grob *me = this;
 492   Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
 493   if (!ga)
 494     {
 495       SCM scm_ga = Grob_array::make_array ();
 496       me->set_object ("columns", scm_ga);
 497       ga = unsmob_grob_array (scm_ga);
 498     }
 499
 500   p->set_rank (ga->size ());
 501
 502   ga->add (p);
 503   Axis_group_interface::add_element (this, p);
 504 }
 505
 506 void
 507 System::pre_processing ()
 508 {
 509   for (vsize i = 0; i < all_elements_->size (); i++)
 510     all_elements_->grob (i)->discretionary_processing ();
 511
 512   debug_output (_f ("Grob count %d", element_count ()));
 513
 514   /*
 515     order is significant: broken grobs are added to the end of the
 516     array, and should be processed before the original is potentially
 517     killed.
 518   */
 519   for (vsize i = all_elements_->size (); i--;)
 520     all_elements_->grob (i)->handle_prebroken_dependencies ();
 521
 522   fixup_refpoints (all_elements_->array ());
 523
 524   for (vsize i = 0; i < all_elements_->size (); i++)
 525     {
 526       Grob *g = all_elements_->grob (i);
 527       (void) g->get_property ("before-line-breaking");
 528     }
 529
 530   for (vsize i = 0; i < all_elements_->size (); i++)
 531     {
 532       Grob *e = all_elements_->grob (i);
 533       (void) e->get_property ("springs-and-rods");
 534     }
 535 }
 536
 537 void
 538 System::post_processing ()
 539 {
 540   Interval iv (extent (this, Y_AXIS));
 541   if (iv.is_empty ())
 542     programming_error ("system with empty extent");
 543   else
 544     translate_axis (-iv[MAX], Y_AXIS);
 545
 546   /* Generate all stencils to trigger font loads.
 547      This might seem inefficient, but Stencils are cached per grob
 548      anyway. */
 549
 550   vector<Grob *> all_elts_sorted (all_elements_->array ());
 551   vector_sort (all_elts_sorted, std::less<Grob *> ());
 552   uniq (all_elts_sorted);
 553   this->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 (st.expr () == SCM_EOL)
 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 = Skyline_pair::unsmob (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 = this->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 = this->get_bound (RIGHT);
 647   pl->set_property ("vertical-skylines", this->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", this->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 (Align_interface::has_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 (Hara_kiri_group_spanner::has_interface (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 (Hara_kiri_group_spanner::has_interface (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   SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
 918
 919   for (vsize i = 0; i < elts.size (); ++i)
 920     {
 921       if (!Axis_group_interface::has_interface (elts[i]))
 922         {
 923           if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
 924             relevant_grobs.push_back (elts[i]);
 925
 926           if (Item *it = dynamic_cast<Item *> (elts[i]))
 927             {
 928               for (LEFT_and_RIGHT (d))
 929                 {
 930                   Item *piece = it->find_prebroken_piece (d);
 931                   if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
 932                     relevant_grobs.push_back (piece);
 933                 }
 934             }
 935         }
 936     }
 937
 938   SCM grobs_scm = Grob_array::make_array ();
 939
 940   unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
 941   return grobs_scm;
 942 }
 943
 944 MAKE_SCHEME_CALLBACK (System, height, 1);
 945 SCM
 946 System::height (SCM smob)
 947 {
 948   return Axis_group_interface::height (smob);
 949 }
 950
 951 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
 952 SCM
 953 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
 954 {
 955   System *me = dynamic_cast<System *> (unsmob_grob (smob));
 956   int start = scm_to_int (start_scm);
 957   int end = scm_to_int (end_scm);
 958
 959   Interval begin = me->begin_of_line_pure_height (start, end);
 960   Interval rest = me->rest_of_line_pure_height (start, end);
 961   begin.unite (rest);
 962
 963   return ly_interval2scm (begin);
 964 }
 965
 966 Grob *
 967 System::get_pure_bound (Direction d, int start, int end)
 968 {
 969   vector<vsize> ranks = pscore_->get_break_ranks ();
 970   vector<vsize> indices = pscore_->get_break_indices ();
 971   vector<Grob *> cols = pscore_->get_columns ();
 972
 973   vsize target_rank = (d == LEFT ? start : end);
 974   vector<vsize>::const_iterator i
 975     = lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
 976
 977   if (i != ranks.end () && (*i) == target_rank)
 978     return cols[indices[i - ranks.begin ()]];
 979   else
 980     return 0;
 981 }
 982
 983 Grob *
 984 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
 985 {
 986   return pure ? get_pure_bound (d, start, end) : get_bound (d);
 987 }
 988
 989 enum
 990 {
 991   SPACEABLE_STAVES,
 992   NONSPACEABLE_STAVES,
 993   ALL_STAVES
 994 };
 995
 996 static SCM
 997 get_maybe_spaceable_staves (SCM smob, int filter)
 998 {
 999   System *me = dynamic_cast<System *> (unsmob_grob (smob));
1000   Grob *align = unsmob_grob (me->get_object ("vertical_alignment"));
1001   SCM ret = SCM_EOL;
1002
1003   if (align)
1004     {
1005       SCM *tail = &ret;
1006       extract_grob_set (align, "elements", staves);
1007
1008       for (vsize i = 0; i < staves.size (); ++i)
1009         {
1010           bool spaceable = Page_layout_problem::is_spaceable (staves[i]);
1011           if (staves[i]->is_live ()
1012               && ((filter == ALL_STAVES)
1013                   || (filter == SPACEABLE_STAVES && spaceable)
1014                   || (filter == NONSPACEABLE_STAVES && !spaceable)))
1015             {
1016               *tail = scm_cons (staves[i]->self_scm (), SCM_EOL);
1017               tail = SCM_CDRLOC (*tail);
1018             }
1019         }
1020     }
1021
1022   return ret;
1023 }
1024
1025 MAKE_SCHEME_CALLBACK (System, get_staves, 1)
1026 SCM
1027 System::get_staves (SCM smob)
1028 {
1029   return get_maybe_spaceable_staves (smob, ALL_STAVES);
1030 }
1031
1032 MAKE_SCHEME_CALLBACK (System, get_spaceable_staves, 1)
1033 SCM
1034 System::get_spaceable_staves (SCM smob)
1035 {
1036   return get_maybe_spaceable_staves (smob, SPACEABLE_STAVES);
1037 }
1038
1039 MAKE_SCHEME_CALLBACK (System, get_nonspaceable_staves, 1)
1040 SCM
1041 System::get_nonspaceable_staves (SCM smob)
1042 {
1043   return get_maybe_spaceable_staves (smob, NONSPACEABLE_STAVES);
1044 }
1045
1046 ADD_INTERFACE (System,
1047                "This is the top-level object: Each object in a score"
1048                " ultimately has a @code{System} object as its X and"
1049                " Y@tie{}parent.",
1050
1051                /* properties */
1052                "all-elements "
1053                "columns "
1054                "footnote-stencil "
1055                "footnotes-before-line-breaking "
1056                "footnotes-after-line-breaking "
1057                "in-note-direction "
1058                "in-note-padding "
1059                "in-note-stencil "
1060                "labels "
1061                "pure-Y-extent "
1062                "vertical-alignment "
1063               );