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