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 "break-align-interface.hh"
26 #include "grob-array.hh"
27 #include "hara-kiri-group-spanner.hh"
28 #include "international.hh"
31 #include "output-def.hh"
32 #include "page-layout-problem.hh"
33 #include "paper-column.hh"
34 #include "paper-score.hh"
35 #include "paper-system.hh"
36 #include "pointer-group-interface.hh"
37 #include "skyline-pair.hh"
38 #include "staff-symbol-referencer.hh"
39 #include "text-interface.hh"
42 System::System (System const &src)
48 checked_footnotes_ = false;
52 System::System (SCM s)
57 checked_footnotes_ = false;
62 System::init_elements ()
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);
71 System::clone () const
73 return new System (*this);
77 System::element_count () const
79 return all_elements_->size ();
83 System::spanner_count () const
86 for (vsize i = all_elements_->size (); i--;)
87 if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
93 System::typeset_grob (Grob *elem)
96 programming_error ("adding element twice");
99 elem->layout_ = pscore_->layout ();
100 all_elements_->add (elem);
106 System::derived_mark () const
108 if (!all_elements_->empty ())
110 Grob **ptr = &all_elements_->array_reference ()[0];
111 Grob **end = ptr + all_elements_->size ();
114 scm_gc_mark ((*ptr)->self_scm ());
120 scm_gc_mark (pscore_->self_scm ());
122 Spanner::derived_mark ();
126 fixup_refpoints (vector<Grob *> const &grobs)
128 for (vsize i = grobs.size (); i--;)
129 grobs[i]->fixup_refpoint ();
133 System::do_break_substitution_and_fixup_refpoints ()
135 for (vsize i = 0; i < all_elements_->size (); i++)
137 Grob *g = all_elements_->grob (i);
138 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
141 Kill no longer needed grobs.
143 Item *it = dynamic_cast<Item *> (g);
144 if (it && Item::is_non_musical (it))
146 it->find_prebroken_piece (LEFT)->suicide ();
147 it->find_prebroken_piece (RIGHT)->suicide ();
151 else if (g->is_live ())
152 g->do_break_processing ();
156 fixups must be done in broken line_of_scores, because new elements
157 are put over there. */
159 for (vsize i = 0; i < broken_intos_.size (); i++)
161 Grob *se = broken_intos_[i];
163 extract_grob_set (se, "all-elements", all_elts);
164 for (vsize j = 0; j < all_elts.size (); j++)
166 Grob *g = all_elts[j];
167 g->fixup_refpoint ();
170 count += all_elts.size ();
174 needed for doing items.
176 fixup_refpoints (all_elements_->array ());
178 for (vsize i = 0; i < all_elements_->size (); i++)
179 all_elements_->grob (i)->handle_broken_dependencies ();
181 handle_broken_dependencies ();
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++)
190 System *child = dynamic_cast<System *> (broken_intos_[i]);
191 child->all_elements_->remove_duplicates ();
192 for (vsize j = 0; j < child->all_elements_->size (); j++)
194 Grob *g = child->all_elements_->grob (j);
196 (void) g->get_property ("after-line-breaking");
200 debug_output (_f ("Element count %d", count + element_count ()) + "\n");
204 System::get_broken_system_grobs ()
207 for (vsize i = 0; i < broken_intos_.size (); i++)
208 ret = scm_cons (broken_intos_[i]->self_scm (), ret);
209 return scm_reverse (ret);
213 System::get_paper_systems ()
215 SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
216 for (vsize i = 0; i < broken_intos_.size (); i++)
218 debug_output ("[", false);
220 System *system = dynamic_cast<System *> (broken_intos_[i]);
222 scm_vector_set_x (lines, scm_from_int (i),
223 system->get_paper_system ());
225 debug_output (to_string (i) + "]", false);
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++)
235 if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
236 footnote_grobs_.push_back (all_elts[i]);
238 sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
239 checked_footnotes_ = true;
243 System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
245 if (!checked_footnotes_)
246 populate_footnote_grob_vector ();
248 for (vsize i = 0; i < footnote_grobs_.size (); i++)
250 int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
251 bool end_of_line_visible = true;
252 if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
254 Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
255 if (spanner_placement == CENTER)
256 spanner_placement = LEFT;
258 pos = s->spanned_rank_interval ()[spanner_placement];
261 if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
263 if (!Item::break_visible (item))
265 // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
266 end_of_line_visible = (LEFT == item->break_status_dir ());
269 if (pos < int (start))
273 if (pos == int (start) && end_of_line_visible)
275 if (pos == int (end) && !end_of_line_visible)
277 if (!footnote_grobs_[i]->is_live ())
280 out.push_back (footnote_grobs_[i]);
285 System::get_footnotes_in_range (vsize start, vsize end)
287 vector<Grob *> footnote_grobs;
288 get_footnote_grobs_in_range (footnote_grobs, start, end);
289 vector<Stencil *> out;
291 for (vsize i = 0; i < footnote_grobs.size (); i++)
293 SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
295 if (!Text_interface::is_markup (footnote_markup))
298 SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
299 pscore_->layout ()->self_scm ());
301 SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
302 props, footnote_markup);
304 Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
305 out.push_back (footnote_stencil);
312 System::num_footnotes ()
314 return footnote_grobs_.size ();
318 System::footnote_grobs ()
320 return &footnote_grobs_;
324 System::break_into_pieces (vector<Column_x_positions> const &breaking)
326 for (vsize i = 0; i < breaking.size (); i++)
328 System *system = dynamic_cast<System *> (clone ());
329 system->rank_ = broken_intos_.size ();
331 vector<Grob *> c (breaking[i].cols_);
332 pscore_->typeset_system (system);
334 int st = Paper_column::get_rank (c[0]);
335 int end = Paper_column::get_rank (c.back ());
336 Interval iv (pure_height (this, st, end));
337 system->set_property ("pure-Y-extent", ly_interval2scm (iv));
339 get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
341 system->set_bound (LEFT, c[0]);
342 system->set_bound (RIGHT, c.back ());
343 SCM system_labels = SCM_EOL;
344 for (vsize j = 0; j < c.size (); j++)
346 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
347 dynamic_cast<Paper_column *> (c[j])->set_system (system);
348 /* collect the column labels */
349 collect_labels (c[j], &system_labels);
352 Collect labels from any loose columns too: theses will be set on
353 an empty bar line or a column which is otherwise unused mid-line
355 vector<Grob *> loose (breaking[i].loose_cols_);
356 for (vsize j = 0; j < loose.size (); j++)
357 collect_labels (loose[j], &system_labels);
359 system->set_property ("labels", system_labels);
361 set_loose_columns (system, &breaking[i]);
362 broken_intos_.push_back (system);
367 System::collect_labels (Grob const *col, SCM *labels)
369 SCM col_labels = col->get_property ("labels");
370 if (scm_is_pair (col_labels))
371 *labels = scm_append (scm_list_2 (col_labels, *labels));
375 System::add_column (Paper_column *p)
378 Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
381 SCM scm_ga = Grob_array::make_array ();
382 me->set_object ("columns", scm_ga);
383 ga = unsmob_grob_array (scm_ga);
386 p->set_rank (ga->size ());
389 Axis_group_interface::add_element (this, p);
393 System::pre_processing ()
395 for (vsize i = 0; i < all_elements_->size (); i++)
396 all_elements_->grob (i)->discretionary_processing ();
398 debug_output (_f ("Grob count %d", element_count ()));
401 order is significant: broken grobs are added to the end of the
402 array, and should be processed before the original is potentially
405 for (vsize i = all_elements_->size (); i--;)
406 all_elements_->grob (i)->handle_prebroken_dependencies ();
408 fixup_refpoints (all_elements_->array ());
410 for (vsize i = 0; i < all_elements_->size (); i++)
412 Grob *g = all_elements_->grob (i);
413 (void) g->get_property ("before-line-breaking");
416 for (vsize i = 0; i < all_elements_->size (); i++)
418 Grob *e = all_elements_->grob (i);
419 (void) e->get_property ("springs-and-rods");
424 System::post_processing ()
426 Interval iv (extent (this, Y_AXIS));
428 programming_error ("system with empty extent");
430 translate_axis (-iv[MAX], Y_AXIS);
432 /* Generate all stencils to trigger font loads.
433 This might seem inefficient, but Stencils are cached per grob
436 vector<Grob *> all_elts_sorted (all_elements_->array ());
437 vector_sort (all_elts_sorted, std::less<Grob *> ());
438 uniq (all_elts_sorted);
439 this->get_stencil ();
440 for (vsize i = all_elts_sorted.size (); i--;)
442 Grob *g = all_elts_sorted[i];
454 operator < (Layer_entry const &a,
455 Layer_entry const &b)
457 return a.layer_ < b.layer_;
461 System::get_paper_system ()
468 vector<Layer_entry> entries;
469 for (vsize j = 0; j < all_elements_->size (); j++)
472 e.grob_ = all_elements_->grob (j);
473 e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
475 entries.push_back (e);
478 vector_sort (entries, std::less<Layer_entry> ());
479 for (vsize j = 0; j < entries.size (); j++)
481 Grob *g = entries[j].grob_;
482 Stencil st = g->get_print_stencil ();
484 if (st.expr () == SCM_EOL)
488 for (int a = X_AXIS; a < NO_AXES; a++)
489 o[Axis (a)] = g->relative_coordinate (this, Axis (a));
491 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
493 * Staff_symbol_referencer::staff_space (g);
495 /* Must copy the stencil, for we cannot change the stencil
498 st.translate (o + extra);
500 *tail = scm_cons (st.expr (), SCM_EOL);
501 tail = SCM_CDRLOC (*tail);
504 if (Stencil *me = get_stencil ())
505 exprs = scm_cons (me->expr (), exprs);
507 Interval x (extent (this, X_AXIS));
508 Interval y (extent (this, Y_AXIS));
509 Stencil sys_stencil (Box (x, y),
510 scm_cons (ly_symbol2scm ("combine-stencil"),
514 Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
518 = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
520 = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
521 sys_stencil.add_stencil (up.in_color (255, 0, 0));
522 sys_stencil.add_stencil (down.in_color (0, 255, 0));
526 Grob *left_bound = this->get_bound (LEFT);
527 SCM prop_init = left_bound->get_property ("line-break-system-details");
528 Prob *pl = make_paper_system (prop_init);
529 paper_system_set_stencil (pl, sys_stencil);
531 /* information that the page breaker might need */
532 Grob *right_bound = this->get_bound (RIGHT);
533 pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
534 pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
535 pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
536 pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
537 pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
539 Interval staff_refpoints;
540 if (Grob *align = get_vertical_alignment ())
542 extract_grob_set (align, "elements", staves);
543 for (vsize i = 0; i < staves.size (); i++)
544 if (staves[i]->is_live ()
545 && Page_layout_problem::is_spaceable (staves[i]))
546 staff_refpoints.add_point (staves[i]->relative_coordinate (this,
550 pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
551 pl->set_property ("system-grob", this->self_scm ());
553 return pl->unprotect ();
557 System::broken_col_range (Item const *left, Item const *right) const
561 left = left->get_column ();
562 right = right->get_column ();
564 extract_grob_set (this, "columns", cols);
566 vsize i = Paper_column::get_rank (left);
567 int end_rank = Paper_column::get_rank (right);
568 if (i < cols.size ())
571 while (i < cols.size ()
572 && Paper_column::get_rank (cols[i]) < end_rank)
574 Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
575 if (Paper_column::is_breakable (c) && !c->get_system ())
583 /** Return all columns, but filter out any unused columns , since they might
584 disrupt the spacing problem. */
586 System::used_columns () const
588 extract_grob_set (this, "columns", ro_columns);
590 int last_breakable = ro_columns.size ();
592 while (last_breakable--)
594 if (Paper_column::is_breakable (ro_columns [last_breakable]))
598 vector<Grob *> columns;
599 for (int i = 0; i <= last_breakable; i++)
601 if (Paper_column::is_used (ro_columns[i]))
602 columns.push_back (ro_columns[i]);
609 System::column (vsize which) const
611 extract_grob_set (this, "columns", columns);
612 if (which >= columns.size ())
615 return dynamic_cast<Paper_column *> (columns[which]);
619 System::paper_score () const
625 System::get_rank () const
631 get_root_system (Grob *me)
633 Grob *system_grob = me;
635 while (system_grob->get_parent (Y_AXIS))
636 system_grob = system_grob->get_parent (Y_AXIS);
638 return dynamic_cast<System *> (system_grob);
642 System::get_vertical_alignment ()
644 extract_grob_set (this, "elements", elts);
646 for (vsize i = 0; i < elts.size (); i++)
647 if (Align_interface::has_interface (elts[i]))
650 programming_error ("found multiple vertical alignments in this system");
655 programming_error ("didn't find a vertical alignment in this system");
659 // Finds the furthest staff in the given direction whose x-extent
660 // overlaps with the given interval.
662 System::get_extremal_staff (Direction dir, Interval const &iv)
664 Grob *align = get_vertical_alignment ();
668 extract_grob_set (align, "elements", elts);
669 vsize start = (dir == UP) ? 0 : elts.size () - 1;
670 vsize end = (dir == UP) ? elts.size () : VPOS;
671 for (vsize i = start; i != end; i += dir)
673 if (Hara_kiri_group_spanner::has_interface (elts[i]))
674 Hara_kiri_group_spanner::consider_suicide (elts[i]);
676 Interval intersection = elts[i]->extent (this, X_AXIS);
677 intersection.intersect (iv);
678 if (elts[i]->is_live () && !intersection.is_empty ())
685 System::pure_refpoint_extent (vsize start, vsize end)
688 Grob *alignment = get_vertical_alignment ();
692 extract_grob_set (alignment, "elements", staves);
693 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
695 for (vsize i = 0; i < offsets.size (); ++i)
696 if (Page_layout_problem::is_spaceable (staves[i]))
698 ret[UP] = offsets[i];
702 for (vsize i = offsets.size (); i--;)
703 if (Page_layout_problem::is_spaceable (staves[i]))
705 ret[DOWN] = offsets[i];
713 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
715 Grob *alignment = get_vertical_alignment ();
719 extract_grob_set (alignment, "elements", staves);
720 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
723 for (vsize i = 0; i < staves.size (); ++i)
726 ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
727 : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
728 if (i < offsets.size ())
729 iv.translate (offsets[i]);
733 Interval other_elements = begin
734 ? Axis_group_interface::begin_of_line_pure_height (this, start)
735 : Axis_group_interface::rest_of_line_pure_height (this, start, end);
737 ret.unite (other_elements);
743 System::begin_of_line_pure_height (vsize start, vsize end)
745 return part_of_line_pure_height (start, end, true);
749 System::rest_of_line_pure_height (vsize start, vsize end)
751 return part_of_line_pure_height (start, end, false);
754 // This differs from Axis_group_interface::calc_pure_relevant_grobs
755 // because here, we are only interested in those few elements that aren't
756 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
757 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
759 System::calc_pure_relevant_grobs (SCM smob)
761 Grob *me = unsmob_grob (smob);
763 extract_grob_set (me, "elements", elts);
764 vector<Grob *> relevant_grobs;
765 SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
767 for (vsize i = 0; i < elts.size (); ++i)
769 if (!Axis_group_interface::has_interface (elts[i]))
771 if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
772 relevant_grobs.push_back (elts[i]);
774 if (Item *it = dynamic_cast<Item *> (elts[i]))
779 Item *piece = it->find_prebroken_piece (d);
780 if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
781 relevant_grobs.push_back (piece);
783 while (flip (&d) != LEFT);
788 SCM grobs_scm = Grob_array::make_array ();
790 unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
794 MAKE_SCHEME_CALLBACK (System, height, 1);
796 System::height (SCM smob)
798 return Axis_group_interface::height (smob);
801 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
803 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
805 System *me = dynamic_cast<System *> (unsmob_grob (smob));
806 int start = scm_to_int (start_scm);
807 int end = scm_to_int (end_scm);
809 Interval begin = me->begin_of_line_pure_height (start, end);
810 Interval rest = me->rest_of_line_pure_height (start, end);
813 return ly_interval2scm (begin);
817 System::get_pure_bound (Direction d, int start, int end)
819 vector<vsize> ranks = pscore_->get_break_ranks ();
820 vector<vsize> indices = pscore_->get_break_indices ();
821 vector<Grob *> cols = pscore_->get_columns ();
823 vsize target_rank = (d == LEFT ? start : end);
824 vector<vsize>::const_iterator i
825 = lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
827 if (i != ranks.end () && (*i) == target_rank)
828 return cols[indices[i - ranks.begin ()]];
834 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
836 return pure ? get_pure_bound (d, start, end) : get_bound (d);
839 ADD_INTERFACE (System,
840 "This is the top-level object: Each object in a score"
841 " ultimately has a @code{System} object as its X and"
849 "skyline-horizontal-padding "