2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1996--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
22 #include "align-interface.hh"
23 #include "all-font-metrics.hh"
24 #include "axis-group-interface.hh"
25 #include "grob-array.hh"
26 #include "hara-kiri-group-spanner.hh"
27 #include "international.hh"
30 #include "output-def.hh"
31 #include "page-layout-problem.hh"
32 #include "paper-column.hh"
33 #include "paper-score.hh"
34 #include "paper-system.hh"
35 #include "pointer-group-interface.hh"
36 #include "skyline-pair.hh"
37 #include "staff-symbol-referencer.hh"
38 #include "text-interface.hh"
41 System::System (System const &src)
50 System::System (SCM s)
59 System::init_elements ()
61 SCM scm_arr = Grob_array::make_array ();
62 all_elements_ = unsmob_grob_array (scm_arr);
63 all_elements_->set_ordered (false);
64 set_object ("all-elements", scm_arr);
68 System::clone () const
70 return new System (*this);
74 System::element_count () const
76 return all_elements_->size ();
80 System::spanner_count () const
83 for (vsize i = all_elements_->size (); i--;)
84 if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
90 System::typeset_grob (Grob *elem)
93 programming_error ("adding element twice");
96 elem->layout_ = pscore_->layout ();
97 all_elements_->add (elem);
103 System::derived_mark () const
105 if (!all_elements_->empty ())
107 Grob **ptr = &all_elements_->array_reference ()[0];
108 Grob **end = ptr + all_elements_->size ();
111 scm_gc_mark ((*ptr)->self_scm ());
117 scm_gc_mark (pscore_->self_scm ());
119 Spanner::derived_mark ();
123 fixup_refpoints (vector<Grob *> const &grobs)
125 for (vsize i = grobs.size (); i--;)
126 grobs[i]->fixup_refpoint ();
130 System::do_break_substitution_and_fixup_refpoints ()
132 for (vsize i = 0; i < all_elements_->size (); i++)
134 Grob *g = all_elements_->grob (i);
135 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
138 Kill no longer needed grobs.
140 Item *it = dynamic_cast<Item *> (g);
141 if (it && Item::is_non_musical (it))
143 it->find_prebroken_piece (LEFT)->suicide ();
144 it->find_prebroken_piece (RIGHT)->suicide ();
148 else if (g->is_live ())
149 g->do_break_processing ();
153 fixups must be done in broken line_of_scores, because new elements
154 are put over there. */
156 for (vsize i = 0; i < broken_intos_.size (); i++)
158 Grob *se = broken_intos_[i];
160 extract_grob_set (se, "all-elements", all_elts);
161 for (vsize j = 0; j < all_elts.size (); j++)
163 Grob *g = all_elts[j];
164 g->fixup_refpoint ();
167 count += all_elts.size ();
171 needed for doing items.
173 fixup_refpoints (all_elements_->array ());
175 for (vsize i = 0; i < all_elements_->size (); i++)
176 all_elements_->grob (i)->handle_broken_dependencies ();
178 handle_broken_dependencies ();
180 /* Because the this->get_property (all-elements) contains items in 3
181 versions, handle_broken_dependencies () will leave duplicated
182 items in all-elements. Strictly speaking this is harmless, but
183 it leads to duplicated symbols in the output. uniq makes sure
184 that no duplicates are in the list. */
185 for (vsize i = 0; i < broken_intos_.size (); i++)
187 System *child = dynamic_cast<System *> (broken_intos_[i]);
188 child->all_elements_->remove_duplicates ();
189 for (vsize j = 0; j < child->all_elements_->size (); j++)
191 Grob *g = child->all_elements_->grob (j);
193 (void) g->get_property ("after-line-breaking");
197 if (be_verbose_global)
198 message (_f ("Element count %d", count + element_count ()) + "\n");
202 System::get_broken_system_grobs ()
205 for (vsize i = 0; i < broken_intos_.size (); i++)
206 ret = scm_cons (broken_intos_[i]->self_scm (), ret);
207 return scm_reverse (ret);
211 System::get_paper_systems ()
213 SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
214 for (vsize i = 0; i < broken_intos_.size (); i++)
216 if (be_verbose_global)
217 progress_indication ("[");
219 System *system = dynamic_cast<System *> (broken_intos_[i]);
221 scm_vector_set_x (lines, scm_from_int (i),
222 system->get_paper_system ());
224 if (be_verbose_global)
225 progress_indication (to_string (i) + "]");
231 System::populate_footnote_grob_vector ()
233 extract_grob_set (this, "all-elements", all_elts);
234 for (vsize i = 0; i < all_elts.size (); i++)
236 if ((all_elts[i]->name () == "Footnote") || (all_elts[i]->name () == "FootnoteSpanner"))
237 footnote_grobs_.push_back (all_elts[i]);
239 sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
244 System::get_footnotes_in_range (vsize st, vsize end)
246 vector<Stencil *> out;
247 if (footnote_grobs_.size () == 0)
248 populate_footnote_grob_vector ();
250 for (vsize j = 0; j < footnote_grobs_.size (); j++)
252 if (footnote_grobs_[j]->spanned_rank_interval ()[LEFT] < (int)st)
254 if (footnote_grobs_[j]->spanned_rank_interval ()[LEFT] >= (int)end)
256 SCM footnote_markup = footnote_grobs_[j]->get_property ("footnote-text");
258 if (!Text_interface::is_markup (footnote_markup))
261 SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
262 pscore_->layout ()->self_scm ());
264 SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
265 props, footnote_markup);
267 Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
268 out.push_back (footnote_stencil);
275 System::make_footnote_stencil (Real padding)
279 for (vsize i = 0; i < footnotes_.size (); i++)
280 mol.add_at_edge (Y_AXIS, DOWN, *footnotes_[i], padding);
286 System::break_into_pieces (vector<Column_x_positions> const &breaking)
288 for (vsize i = 0; i < breaking.size (); i++)
290 System *system = dynamic_cast<System *> (clone ());
291 system->rank_ = broken_intos_.size ();
293 vector<Grob *> c (breaking[i].cols_);
294 pscore_->typeset_system (system);
296 int st = Paper_column::get_rank (c[0]);
297 int end = Paper_column::get_rank (c.back ());
298 Interval iv (pure_height (this, st, end));
299 system->set_property ("pure-Y-extent", ly_interval2scm (iv));
301 system->footnotes_ = get_footnotes_in_range (st, end);
303 system->set_bound (LEFT, c[0]);
304 system->set_bound (RIGHT, c.back ());
305 SCM system_labels = SCM_EOL;
306 for (vsize j = 0; j < c.size (); j++)
308 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
309 dynamic_cast<Paper_column *> (c[j])->set_system (system);
310 /* collect the column labels */
311 collect_labels (c[j], &system_labels);
314 Collect labels from any loose columns too: theses will be set on
315 an empty bar line or a column which is otherwise unused mid-line
317 vector<Grob *> loose (breaking[i].loose_cols_);
318 for (vsize j = 0; j < loose.size (); j++)
319 collect_labels (loose[j], &system_labels);
321 system->set_property ("labels", system_labels);
323 set_loose_columns (system, &breaking[i]);
324 broken_intos_.push_back (system);
329 System::collect_labels (Grob const *col, SCM *labels)
331 SCM col_labels = col->get_property ("labels");
332 if (scm_is_pair (col_labels))
333 *labels = scm_append (scm_list_2 (col_labels, *labels));
337 System::add_column (Paper_column *p)
340 Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
343 SCM scm_ga = Grob_array::make_array ();
344 me->set_object ("columns", scm_ga);
345 ga = unsmob_grob_array (scm_ga);
348 p->set_rank (ga->size ());
351 Axis_group_interface::add_element (this, p);
355 System::pre_processing ()
357 for (vsize i = 0; i < all_elements_->size (); i++)
358 all_elements_->grob (i)->discretionary_processing ();
360 if (be_verbose_global)
361 message (_f ("Grob count %d", element_count ()));
364 order is significant: broken grobs are added to the end of the
365 array, and should be processed before the original is potentially
368 for (vsize i = all_elements_->size (); i--;)
369 all_elements_->grob (i)->handle_prebroken_dependencies ();
371 fixup_refpoints (all_elements_->array ());
373 for (vsize i = 0; i < all_elements_->size (); i++)
375 Grob *g = all_elements_->grob (i);
376 (void) g->get_property ("before-line-breaking");
379 for (vsize i = 0; i < all_elements_->size (); i++)
381 Grob *e = all_elements_->grob (i);
382 (void) e->get_property ("springs-and-rods");
387 System::post_processing ()
389 Interval iv (extent (this, Y_AXIS));
391 programming_error ("system with empty extent");
393 translate_axis (-iv[MAX], Y_AXIS);
395 /* Generate all stencils to trigger font loads.
396 This might seem inefficient, but Stencils are cached per grob
399 vector<Grob *> all_elts_sorted (all_elements_->array ());
400 vector_sort (all_elts_sorted, std::less<Grob *> ());
401 uniq (all_elts_sorted);
402 this->get_stencil ();
403 for (vsize i = all_elts_sorted.size (); i--;)
405 Grob *g = all_elts_sorted[i];
417 operator< (Layer_entry const &a,
418 Layer_entry const &b)
420 return a.layer_ < b.layer_;
424 System::get_paper_system ()
431 vector<Layer_entry> entries;
432 for (vsize j = 0; j < all_elements_->size (); j++)
435 e.grob_ = all_elements_->grob (j);
436 e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
438 entries.push_back (e);
441 vector_sort (entries, std::less<Layer_entry> ());
442 for (vsize j = 0; j < entries.size (); j++)
444 Grob *g = entries[j].grob_;
445 Stencil st = g->get_print_stencil ();
447 if (st.expr () == SCM_EOL)
451 for (int a = X_AXIS; a < NO_AXES; a++)
452 o[Axis (a)] = g->relative_coordinate (this, Axis (a));
454 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
456 * Staff_symbol_referencer::staff_space (g);
458 /* Must copy the stencil, for we cannot change the stencil
461 st.translate (o + extra);
463 *tail = scm_cons (st.expr (), SCM_EOL);
464 tail = SCM_CDRLOC (*tail);
467 if (Stencil *me = get_stencil ())
468 exprs = scm_cons (me->expr (), exprs);
470 Interval x (extent (this, X_AXIS));
471 Interval y (extent (this, Y_AXIS));
472 Stencil sys_stencil (Box (x, y),
473 scm_cons (ly_symbol2scm ("combine-stencil"),
477 Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
481 = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
483 = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
484 sys_stencil.add_stencil (up.in_color (255, 0, 0));
485 sys_stencil.add_stencil (down.in_color (0, 255, 0));
489 Grob *left_bound = this->get_bound (LEFT);
490 SCM prop_init = left_bound->get_property ("line-break-system-details");
491 Prob *pl = make_paper_system (prop_init);
492 paper_system_set_stencil (pl, sys_stencil);
494 /* information that the page breaker might need */
495 Grob *right_bound = this->get_bound (RIGHT);
496 pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
497 pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
498 pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
499 pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
500 pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
502 Interval staff_refpoints;
503 if (Grob *align = get_vertical_alignment ())
505 extract_grob_set (align, "elements", staves);
506 for (vsize i = 0; i < staves.size (); i++)
507 if (staves[i]->is_live ()
508 && Page_layout_problem::is_spaceable (staves[i]))
509 staff_refpoints.add_point (staves[i]->relative_coordinate (this,
513 pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
514 pl->set_property ("system-grob", this->self_scm ());
516 return pl->unprotect ();
520 System::broken_col_range (Item const *left, Item const *right) const
524 left = left->get_column ();
525 right = right->get_column ();
527 extract_grob_set (this, "columns", cols);
529 vsize i = Paper_column::get_rank (left);
530 int end_rank = Paper_column::get_rank (right);
531 if (i < cols.size ())
534 while (i < cols.size ()
535 && Paper_column::get_rank (cols[i]) < end_rank)
537 Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
538 if (Paper_column::is_breakable (c) && !c->get_system ())
546 /** Return all columns, but filter out any unused columns , since they might
547 disrupt the spacing problem. */
549 System::used_columns () const
551 extract_grob_set (this, "columns", ro_columns);
553 int last_breakable = ro_columns.size ();
555 while (last_breakable--)
557 if (Paper_column::is_breakable (ro_columns [last_breakable]))
561 vector<Grob *> columns;
562 for (int i = 0; i <= last_breakable; i++)
564 if (Paper_column::is_used (ro_columns[i]))
565 columns.push_back (ro_columns[i]);
572 System::column (vsize which) const
574 extract_grob_set (this, "columns", columns);
575 if (which >= columns.size ())
578 return dynamic_cast<Paper_column *> (columns[which]);
582 System::paper_score () const
588 System::get_rank () const
594 get_root_system (Grob *me)
596 Grob *system_grob = me;
598 while (system_grob->get_parent (Y_AXIS))
599 system_grob = system_grob->get_parent (Y_AXIS);
601 return dynamic_cast<System *> (system_grob);
605 System::get_vertical_alignment ()
607 extract_grob_set (this, "elements", elts);
609 for (vsize i = 0; i < elts.size (); i++)
610 if (Align_interface::has_interface (elts[i]))
613 programming_error ("found multiple vertical alignments in this system");
618 programming_error ("didn't find a vertical alignment in this system");
622 // Finds the furthest staff in the given direction whose x-extent
623 // overlaps with the given interval.
625 System::get_extremal_staff (Direction dir, Interval const &iv)
627 Grob *align = get_vertical_alignment ();
631 extract_grob_set (align, "elements", elts);
632 vsize start = (dir == UP) ? 0 : elts.size () - 1;
633 vsize end = (dir == UP) ? elts.size () : VPOS;
634 for (vsize i = start; i != end; i += dir)
636 if (Hara_kiri_group_spanner::has_interface (elts[i]))
637 Hara_kiri_group_spanner::consider_suicide (elts[i]);
639 Interval intersection = elts[i]->extent (this, X_AXIS);
640 intersection.intersect (iv);
641 if (elts[i]->is_live () && !intersection.is_empty ())
648 System::pure_refpoint_extent (vsize start, vsize end)
651 Grob *alignment = get_vertical_alignment ();
655 extract_grob_set (alignment, "elements", staves);
656 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
658 for (vsize i = 0; i < offsets.size (); ++i)
659 if (Page_layout_problem::is_spaceable (staves[i]))
661 ret[UP] = offsets[i];
665 for (vsize i = offsets.size (); i--;)
666 if (Page_layout_problem::is_spaceable (staves[i]))
668 ret[DOWN] = offsets[i];
676 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
678 Grob *alignment = get_vertical_alignment ();
682 extract_grob_set (alignment, "elements", staves);
683 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
686 for (vsize i = 0; i < staves.size (); ++i)
689 ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
690 : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
691 if (i < offsets.size ())
692 iv.translate (offsets[i]);
696 Interval other_elements = begin
697 ? Axis_group_interface::begin_of_line_pure_height (this, start)
698 : Axis_group_interface::rest_of_line_pure_height (this, start, end);
700 ret.unite (other_elements);
706 System::begin_of_line_pure_height (vsize start, vsize end)
708 return part_of_line_pure_height (start, end, true);
712 System::rest_of_line_pure_height (vsize start, vsize end)
714 return part_of_line_pure_height (start, end, false);
717 // This differs from Axis_group_interface::calc_pure_relevant_grobs
718 // because here, we are only interested in those few elements that aren't
719 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
720 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
722 System::calc_pure_relevant_grobs (SCM smob)
724 Grob *me = unsmob_grob (smob);
726 extract_grob_set (me, "elements", elts);
727 vector<Grob *> relevant_grobs;
728 SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
730 for (vsize i = 0; i < elts.size (); ++i)
732 if (!Axis_group_interface::has_interface (elts[i]))
734 if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
735 relevant_grobs.push_back (elts[i]);
737 if (Item *it = dynamic_cast<Item*> (elts[i]))
742 Item *piece = it->find_prebroken_piece (d);
743 if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
744 relevant_grobs.push_back (piece);
746 while (flip (&d) != LEFT);
751 SCM grobs_scm = Grob_array::make_array ();
753 unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
757 MAKE_SCHEME_CALLBACK (System, height, 1);
759 System::height (SCM smob)
761 return Axis_group_interface::height (smob);
764 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
766 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
768 System *me = dynamic_cast<System *> (unsmob_grob (smob));
769 int start = scm_to_int (start_scm);
770 int end = scm_to_int (end_scm);
772 Interval begin = me->begin_of_line_pure_height (start, end);
773 Interval rest = me->rest_of_line_pure_height (start, end);
776 return ly_interval2scm (begin);
780 System::get_pure_bound (Direction d, int start, int end)
782 vector<vsize> ranks = pscore_->get_break_ranks ();
783 vector<vsize> indices = pscore_->get_break_indices ();
784 vector<Grob*> cols = pscore_->get_columns ();
786 vsize target_rank = (d == LEFT ? start : end);
787 vector<vsize>::const_iterator i =
788 lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
790 if (i != ranks.end () && (*i) == target_rank)
791 return cols[indices[i - ranks.begin ()]];
797 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
799 return pure ? get_pure_bound (d, start, end) : get_bound (d);
802 ADD_INTERFACE (System,
803 "This is the top-level object: Each object in a score"
804 " ultimately has a @code{System} object as its X and"
812 "skyline-horizontal-padding "