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"
41 #include "unpure-pure-container.hh"
43 System::System (System const &src)
49 checked_footnotes_ = false;
53 System::System (SCM s)
58 checked_footnotes_ = false;
63 System::init_elements ()
65 SCM scm_arr = Grob_array::make_array ();
66 all_elements_ = unsmob_grob_array (scm_arr);
67 all_elements_->set_ordered (false);
68 set_object ("all-elements", scm_arr);
72 System::clone () const
74 return new System (*this);
78 System::element_count () const
80 return all_elements_->size ();
84 System::spanner_count () const
87 for (vsize i = all_elements_->size (); i--;)
88 if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
94 System::typeset_grob (Grob *elem)
97 programming_error ("adding element twice");
100 elem->layout_ = pscore_->layout ();
101 all_elements_->add (elem);
107 System::derived_mark () const
109 if (!all_elements_->empty ())
111 Grob **ptr = &all_elements_->array_reference ()[0];
112 Grob **end = ptr + all_elements_->size ();
115 scm_gc_mark ((*ptr)->self_scm ());
121 scm_gc_mark (pscore_->self_scm ());
123 Spanner::derived_mark ();
127 fixup_refpoints (vector<Grob *> const &grobs)
129 for (vsize i = grobs.size (); i--;)
130 grobs[i]->fixup_refpoint ();
134 System::do_break_substitution_and_fixup_refpoints ()
136 for (vsize i = 0; i < all_elements_->size (); i++)
138 Grob *g = all_elements_->grob (i);
139 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
142 Kill no longer needed grobs.
144 Item *it = dynamic_cast<Item *> (g);
145 if (it && Item::is_non_musical (it))
147 it->find_prebroken_piece (LEFT)->suicide ();
148 it->find_prebroken_piece (RIGHT)->suicide ();
152 else if (g->is_live ())
153 g->do_break_processing ();
157 fixups must be done in broken line_of_scores, because new elements
158 are put over there. */
160 for (vsize i = 0; i < broken_intos_.size (); i++)
162 Grob *se = broken_intos_[i];
164 extract_grob_set (se, "all-elements", all_elts);
165 for (vsize j = 0; j < all_elts.size (); j++)
167 Grob *g = all_elts[j];
168 g->fixup_refpoint ();
171 count += all_elts.size ();
175 needed for doing items.
177 fixup_refpoints (all_elements_->array ());
179 for (vsize i = 0; i < all_elements_->size (); i++)
180 all_elements_->grob (i)->handle_broken_dependencies ();
182 handle_broken_dependencies ();
184 /* Because the this->get_property (all-elements) contains items in 3
185 versions, handle_broken_dependencies () will leave duplicated
186 items in all-elements. Strictly speaking this is harmless, but
187 it leads to duplicated symbols in the output. uniq makes sure
188 that no duplicates are in the list. */
189 for (vsize i = 0; i < broken_intos_.size (); i++)
191 System *child = dynamic_cast<System *> (broken_intos_[i]);
192 child->all_elements_->remove_duplicates ();
193 for (vsize j = 0; j < child->all_elements_->size (); j++)
195 Grob *g = child->all_elements_->grob (j);
197 (void) g->get_property ("after-line-breaking");
201 debug_output (_f ("Element count %d", count + element_count ()) + "\n");
205 System::get_broken_system_grobs ()
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);
214 System::get_paper_systems ()
216 SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
217 for (vsize i = 0; i < broken_intos_.size (); i++)
219 debug_output ("[", false);
221 System *system = dynamic_cast<System *> (broken_intos_[i]);
223 scm_vector_set_x (lines, scm_from_int (i),
224 system->get_paper_system ());
226 debug_output (to_string (i) + "]", false);
232 System::populate_footnote_grob_vector ()
234 extract_grob_set (this, "all-elements", all_elts);
235 for (vsize i = 0; i < all_elts.size (); i++)
236 if (all_elts[i]->internal_has_interface (ly_symbol2scm ("footnote-interface")))
237 footnote_grobs_.push_back (all_elts[i]);
239 sort (footnote_grobs_.begin (), footnote_grobs_.end (), Grob::less);
240 checked_footnotes_ = true;
244 System::get_footnote_grobs_in_range (vector<Grob *> &out, vsize start, vsize end)
246 if (!checked_footnotes_)
247 populate_footnote_grob_vector ();
249 for (vsize i = 0; i < footnote_grobs_.size (); i++)
251 int pos = footnote_grobs_[i]->spanned_rank_interval ()[LEFT];
252 bool end_of_line_visible = true;
253 if (Spanner *s = dynamic_cast<Spanner *>(footnote_grobs_[i]))
255 Direction spanner_placement = robust_scm2dir (s->get_property ("spanner-placement"), LEFT);
256 if (spanner_placement == CENTER)
257 spanner_placement = LEFT;
259 pos = s->spanned_rank_interval ()[spanner_placement];
262 if (Item *item = dynamic_cast<Item *>(footnote_grobs_[i]))
264 if (!Item::break_visible (item))
266 // safeguard to bring down the column rank so that end of line footnotes show up on the correct line
267 end_of_line_visible = (LEFT == item->break_status_dir ());
270 if (pos < int (start))
274 if (pos == int (start) && end_of_line_visible)
276 if (pos == int (end) && !end_of_line_visible)
278 if (!footnote_grobs_[i]->is_live ())
281 out.push_back (footnote_grobs_[i]);
286 System::get_footnotes_in_range (vsize start, vsize end)
288 vector<Grob *> footnote_grobs;
289 get_footnote_grobs_in_range (footnote_grobs, start, end);
290 vector<Stencil *> out;
292 for (vsize i = 0; i < footnote_grobs.size (); i++)
294 SCM footnote_markup = footnote_grobs[i]->get_property ("footnote-text");
296 if (!Text_interface::is_markup (footnote_markup))
299 SCM props = scm_call_1 (ly_lily_module_constant ("layout-extract-page-properties"),
300 pscore_->layout ()->self_scm ());
302 SCM footnote_stl = Text_interface::interpret_markup (pscore_->layout ()->self_scm (),
303 props, footnote_markup);
305 Stencil *footnote_stencil = unsmob_stencil (footnote_stl);
306 out.push_back (footnote_stencil);
313 System::num_footnotes ()
315 return footnote_grobs_.size ();
319 System::footnote_grobs ()
321 return &footnote_grobs_;
325 System::break_into_pieces (vector<Column_x_positions> const &breaking)
327 for (vsize i = 0; i < breaking.size (); i++)
329 System *system = dynamic_cast<System *> (clone ());
330 system->rank_ = broken_intos_.size ();
332 vector<Grob *> c (breaking[i].cols_);
333 pscore_->typeset_system (system);
335 int st = Paper_column::get_rank (c[0]);
336 int end = Paper_column::get_rank (c.back ());
337 Interval iv (pure_height (this, st, end));
338 system->set_property ("pure-Y-extent", ly_interval2scm (iv));
340 get_footnote_grobs_in_range (system->footnote_grobs_, st, end);
342 system->set_bound (LEFT, c[0]);
343 system->set_bound (RIGHT, c.back ());
344 SCM system_labels = SCM_EOL;
345 for (vsize j = 0; j < c.size (); j++)
347 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
348 dynamic_cast<Paper_column *> (c[j])->set_system (system);
349 /* collect the column labels */
350 collect_labels (c[j], &system_labels);
353 Collect labels from any loose columns too: theses will be set on
354 an empty bar line or a column which is otherwise unused mid-line
356 vector<Grob *> loose (breaking[i].loose_cols_);
357 for (vsize j = 0; j < loose.size (); j++)
358 collect_labels (loose[j], &system_labels);
360 system->set_property ("labels", system_labels);
362 set_loose_columns (system, &breaking[i]);
363 broken_intos_.push_back (system);
368 System::collect_labels (Grob const *col, SCM *labels)
370 SCM col_labels = col->get_property ("labels");
371 if (scm_is_pair (col_labels))
372 *labels = scm_append (scm_list_2 (col_labels, *labels));
376 System::add_column (Paper_column *p)
379 Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
382 SCM scm_ga = Grob_array::make_array ();
383 me->set_object ("columns", scm_ga);
384 ga = unsmob_grob_array (scm_ga);
387 p->set_rank (ga->size ());
390 Axis_group_interface::add_element (this, p);
394 System::pre_processing ()
396 for (vsize i = 0; i < all_elements_->size (); i++)
397 all_elements_->grob (i)->discretionary_processing ();
399 debug_output (_f ("Grob count %d", element_count ()));
402 order is significant: broken grobs are added to the end of the
403 array, and should be processed before the original is potentially
406 for (vsize i = all_elements_->size (); i--;)
407 all_elements_->grob (i)->handle_prebroken_dependencies ();
409 fixup_refpoints (all_elements_->array ());
411 for (vsize i = 0; i < all_elements_->size (); i++)
413 Grob *g = all_elements_->grob (i);
414 (void) g->get_property ("before-line-breaking");
417 for (vsize i = 0; i < all_elements_->size (); i++)
419 Grob *e = all_elements_->grob (i);
420 (void) e->get_property ("springs-and-rods");
425 System::post_processing ()
427 Interval iv (extent (this, Y_AXIS));
429 programming_error ("system with empty extent");
431 translate_axis (-iv[MAX], Y_AXIS);
433 /* Generate all stencils to trigger font loads.
434 This might seem inefficient, but Stencils are cached per grob
437 vector<Grob *> all_elts_sorted (all_elements_->array ());
438 vector_sort (all_elts_sorted, std::less<Grob *> ());
439 uniq (all_elts_sorted);
440 this->get_stencil ();
441 for (vsize i = all_elts_sorted.size (); i--;)
443 Grob *g = all_elts_sorted[i];
455 operator < (Layer_entry const &a,
456 Layer_entry const &b)
458 return a.layer_ < b.layer_;
462 System::get_paper_system ()
469 vector<Layer_entry> entries;
470 for (vsize j = 0; j < all_elements_->size (); j++)
473 e.grob_ = all_elements_->grob (j);
474 e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
476 entries.push_back (e);
479 vector_sort (entries, std::less<Layer_entry> ());
480 for (vsize j = 0; j < entries.size (); j++)
482 Grob *g = entries[j].grob_;
483 Stencil st = g->get_print_stencil ();
485 if (st.expr () == SCM_EOL)
489 for (int a = X_AXIS; a < NO_AXES; a++)
490 o[Axis (a)] = g->relative_coordinate (this, Axis (a));
492 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
494 * Staff_symbol_referencer::staff_space (g);
496 /* Must copy the stencil, for we cannot change the stencil
499 st.translate (o + extra);
501 *tail = scm_cons (st.expr (), SCM_EOL);
502 tail = SCM_CDRLOC (*tail);
505 if (Stencil *me = get_stencil ())
506 exprs = scm_cons (me->expr (), exprs);
508 Interval x (extent (this, X_AXIS));
509 Interval y (extent (this, Y_AXIS));
510 Stencil sys_stencil (Box (x, y),
511 scm_cons (ly_symbol2scm ("combine-stencil"),
515 Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
519 = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
521 = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
522 sys_stencil.add_stencil (up.in_color (255, 0, 0));
523 sys_stencil.add_stencil (down.in_color (0, 255, 0));
527 Grob *left_bound = this->get_bound (LEFT);
528 SCM prop_init = left_bound->get_property ("line-break-system-details");
529 Prob *pl = make_paper_system (prop_init);
530 paper_system_set_stencil (pl, sys_stencil);
532 /* information that the page breaker might need */
533 Grob *right_bound = this->get_bound (RIGHT);
534 pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
535 pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
536 pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
537 pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
538 pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
540 Interval staff_refpoints;
541 if (Grob *align = get_vertical_alignment ())
543 extract_grob_set (align, "elements", staves);
544 for (vsize i = 0; i < staves.size (); i++)
545 if (staves[i]->is_live ()
546 && Page_layout_problem::is_spaceable (staves[i]))
547 staff_refpoints.add_point (staves[i]->relative_coordinate (this,
551 pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
552 pl->set_property ("system-grob", this->self_scm ());
554 return pl->unprotect ();
558 System::broken_col_range (Item const *left, Item const *right) const
562 left = left->get_column ();
563 right = right->get_column ();
565 extract_grob_set (this, "columns", cols);
567 vsize i = Paper_column::get_rank (left);
568 int end_rank = Paper_column::get_rank (right);
569 if (i < cols.size ())
572 while (i < cols.size ()
573 && Paper_column::get_rank (cols[i]) < end_rank)
575 Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
576 if (Paper_column::is_breakable (c) && !c->get_system ())
584 /** Return all columns, but filter out any unused columns , since they might
585 disrupt the spacing problem. */
587 System::used_columns () const
589 extract_grob_set (this, "columns", ro_columns);
591 int last_breakable = ro_columns.size ();
593 while (last_breakable--)
595 if (Paper_column::is_breakable (ro_columns [last_breakable]))
599 vector<Grob *> columns;
600 for (int i = 0; i <= last_breakable; i++)
602 if (Paper_column::is_used (ro_columns[i]))
603 columns.push_back (ro_columns[i]);
610 System::column (vsize which) const
612 extract_grob_set (this, "columns", columns);
613 if (which >= columns.size ())
616 return dynamic_cast<Paper_column *> (columns[which]);
620 System::paper_score () const
626 System::get_rank () const
632 get_root_system (Grob *me)
634 Grob *system_grob = me;
636 while (system_grob->get_parent (Y_AXIS))
637 system_grob = system_grob->get_parent (Y_AXIS);
639 return dynamic_cast<System *> (system_grob);
643 System::get_vertical_alignment ()
645 extract_grob_set (this, "elements", elts);
647 for (vsize i = 0; i < elts.size (); i++)
648 if (Align_interface::has_interface (elts[i]))
651 programming_error ("found multiple vertical alignments in this system");
656 programming_error ("didn't find a vertical alignment in this system");
660 // Finds the furthest staff in the given direction whose x-extent
661 // overlaps with the given interval.
663 System::get_extremal_staff (Direction dir, Interval const &iv)
665 Grob *align = get_vertical_alignment ();
669 extract_grob_set (align, "elements", elts);
670 vsize start = (dir == UP) ? 0 : elts.size () - 1;
671 vsize end = (dir == UP) ? elts.size () : VPOS;
672 for (vsize i = start; i != end; i += dir)
674 if (Hara_kiri_group_spanner::has_interface (elts[i]))
675 Hara_kiri_group_spanner::consider_suicide (elts[i]);
677 Interval intersection = elts[i]->extent (this, X_AXIS);
678 intersection.intersect (iv);
679 if (elts[i]->is_live () && !intersection.is_empty ())
686 System::pure_refpoint_extent (vsize start, vsize end)
689 Grob *alignment = get_vertical_alignment ();
693 extract_grob_set (alignment, "elements", staves);
694 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
696 for (vsize i = 0; i < offsets.size (); ++i)
697 if (Page_layout_problem::is_spaceable (staves[i]))
699 ret[UP] = offsets[i];
703 for (vsize i = offsets.size (); i--;)
704 if (Page_layout_problem::is_spaceable (staves[i]))
706 ret[DOWN] = offsets[i];
714 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
716 Grob *alignment = get_vertical_alignment ();
720 extract_grob_set (alignment, "elements", staves);
721 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
724 for (vsize i = 0; i < staves.size (); ++i)
727 ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
728 : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
729 if (i < offsets.size ())
730 iv.translate (offsets[i]);
734 Interval other_elements = begin
735 ? Axis_group_interface::begin_of_line_pure_height (this, start)
736 : Axis_group_interface::rest_of_line_pure_height (this, start, end);
738 ret.unite (other_elements);
744 System::begin_of_line_pure_height (vsize start, vsize end)
746 return part_of_line_pure_height (start, end, true);
750 System::rest_of_line_pure_height (vsize start, vsize end)
752 return part_of_line_pure_height (start, end, false);
755 // This differs from Axis_group_interface::calc_pure_relevant_grobs
756 // because here, we are only interested in those few elements that aren't
757 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
758 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
760 System::calc_pure_relevant_grobs (SCM smob)
762 Grob *me = unsmob_grob (smob);
764 extract_grob_set (me, "elements", elts);
765 vector<Grob *> relevant_grobs;
766 SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
768 for (vsize i = 0; i < elts.size (); ++i)
770 if (!Axis_group_interface::has_interface (elts[i]))
772 if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
773 relevant_grobs.push_back (elts[i]);
775 if (Item *it = dynamic_cast<Item *> (elts[i]))
780 Item *piece = it->find_prebroken_piece (d);
781 if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
782 relevant_grobs.push_back (piece);
784 while (flip (&d) != LEFT);
789 SCM grobs_scm = Grob_array::make_array ();
791 unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
795 MAKE_SCHEME_CALLBACK (System, height, 1);
797 System::height (SCM smob)
799 return Axis_group_interface::height (smob);
802 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
804 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
806 System *me = dynamic_cast<System *> (unsmob_grob (smob));
807 int start = scm_to_int (start_scm);
808 int end = scm_to_int (end_scm);
810 Interval begin = me->begin_of_line_pure_height (start, end);
811 Interval rest = me->rest_of_line_pure_height (start, end);
814 return ly_interval2scm (begin);
818 System::get_pure_bound (Direction d, int start, int end)
820 vector<vsize> ranks = pscore_->get_break_ranks ();
821 vector<vsize> indices = pscore_->get_break_indices ();
822 vector<Grob *> cols = pscore_->get_columns ();
824 vsize target_rank = (d == LEFT ? start : end);
825 vector<vsize>::const_iterator i
826 = lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
828 if (i != ranks.end () && (*i) == target_rank)
829 return cols[indices[i - ranks.begin ()]];
835 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
837 return pure ? get_pure_bound (d, start, end) : get_bound (d);
840 ADD_INTERFACE (System,
841 "This is the top-level object: Each object in a score"
842 " ultimately has a @code{System} object as its X and"
850 "skyline-horizontal-padding "