Doc-es: update Changes.
[lilypond/patrick.git] / lily / system.cc
blob3b3daa0216ef163325d6bfc14f38632400f39264
1 /*
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/>.
20 #include "system.hh"
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"
28 #include "lookup.hh"
29 #include "main.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 "warn.hh"
40 System::System (System const &src)
41 : Spanner (src)
43 all_elements_ = 0;
44 pscore_ = 0;
45 rank_ = 0;
46 init_elements ();
49 System::System (SCM s)
50 : Spanner (s)
52 all_elements_ = 0;
53 rank_ = 0;
54 init_elements ();
57 void
58 System::init_elements ()
60 SCM scm_arr = Grob_array::make_array ();
61 all_elements_ = unsmob_grob_array (scm_arr);
62 all_elements_->set_ordered (false);
63 set_object ("all-elements", scm_arr);
66 Grob *
67 System::clone () const
69 return new System (*this);
72 int
73 System::element_count () const
75 return all_elements_->size ();
78 int
79 System::spanner_count () const
81 int k = 0;
82 for (vsize i = all_elements_->size (); i--;)
83 if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
84 k++;
85 return k;
88 void
89 System::typeset_grob (Grob *elem)
91 if (elem->layout_)
92 programming_error ("adding element twice");
93 else
95 elem->layout_ = pscore_->layout ();
96 all_elements_->add (elem);
97 elem->unprotect ();
101 void
102 System::derived_mark () const
104 if (!all_elements_->empty ())
106 Grob **ptr = &all_elements_->array_reference ()[0];
107 Grob **end = ptr + all_elements_->size ();
108 while (ptr < end)
110 scm_gc_mark ((*ptr)->self_scm ());
111 ptr++;
115 if (pscore_)
116 scm_gc_mark (pscore_->self_scm ());
118 Spanner::derived_mark ();
121 static void
122 fixup_refpoints (vector<Grob *> const &grobs)
124 for (vsize i = grobs.size (); i--;)
125 grobs[i]->fixup_refpoint ();
128 void
129 System::do_break_substitution_and_fixup_refpoints ()
131 for (vsize i = 0; i < all_elements_->size (); i++)
133 Grob *g = all_elements_->grob (i);
134 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
137 Kill no longer needed grobs.
139 Item *it = dynamic_cast<Item *> (g);
140 if (it && Item::is_non_musical (it))
142 it->find_prebroken_piece (LEFT)->suicide ();
143 it->find_prebroken_piece (RIGHT)->suicide ();
145 g->suicide ();
147 else if (g->is_live ())
148 g->do_break_processing ();
152 fixups must be done in broken line_of_scores, because new elements
153 are put over there. */
154 int count = 0;
155 for (vsize i = 0; i < broken_intos_.size (); i++)
157 Grob *se = broken_intos_[i];
159 extract_grob_set (se, "all-elements", all_elts);
160 for (vsize j = 0; j < all_elts.size (); j++)
162 Grob *g = all_elts[j];
163 g->fixup_refpoint ();
166 count += all_elts.size ();
170 needed for doing items.
172 fixup_refpoints (all_elements_->array ());
174 for (vsize i = 0; i < all_elements_->size (); i++)
175 all_elements_->grob (i)->handle_broken_dependencies ();
177 handle_broken_dependencies ();
179 /* Because the this->get_property (all-elements) contains items in 3
180 versions, handle_broken_dependencies () will leave duplicated
181 items in all-elements. Strictly speaking this is harmless, but
182 it leads to duplicated symbols in the output. uniq makes sure
183 that no duplicates are in the list. */
184 for (vsize i = 0; i < broken_intos_.size (); i++)
186 System *child = dynamic_cast<System *> (broken_intos_[i]);
187 child->all_elements_->remove_duplicates ();
188 for (vsize j = 0; j < child->all_elements_->size (); j++)
190 Grob *g = child->all_elements_->grob (j);
192 (void) g->get_property ("after-line-breaking");
196 if (be_verbose_global)
197 message (_f ("Element count %d", count + element_count ()) + "\n");
201 System::get_broken_system_grobs ()
203 SCM ret = SCM_EOL;
204 for (vsize i = 0; i < broken_intos_.size (); i++)
205 ret = scm_cons (broken_intos_[i]->self_scm (), ret);
206 return scm_reverse (ret);
210 System::get_paper_systems ()
212 SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
213 for (vsize i = 0; i < broken_intos_.size (); i++)
215 if (be_verbose_global)
216 progress_indication ("[");
218 System *system = dynamic_cast<System *> (broken_intos_[i]);
220 scm_vector_set_x (lines, scm_from_int (i),
221 system->get_paper_system ());
223 if (be_verbose_global)
224 progress_indication (to_string (i) + "]");
226 return lines;
229 void
230 System::break_into_pieces (vector<Column_x_positions> const &breaking)
232 for (vsize i = 0; i < breaking.size (); i++)
234 System *system = dynamic_cast<System *> (clone ());
235 system->rank_ = broken_intos_.size ();
237 vector<Grob *> c (breaking[i].cols_);
238 pscore_->typeset_system (system);
240 int st = Paper_column::get_rank (c[0]);
241 int end = Paper_column::get_rank (c.back ());
242 Interval iv (pure_height (this, st, end));
243 system->set_property ("pure-Y-extent", ly_interval2scm (iv));
245 system->set_bound (LEFT, c[0]);
246 system->set_bound (RIGHT, c.back ());
247 SCM system_labels = SCM_EOL;
248 for (vsize j = 0; j < c.size (); j++)
250 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
251 dynamic_cast<Paper_column *> (c[j])->set_system (system);
252 /* collect the column labels */
253 SCM col_labels = c[j]->get_property ("labels");
254 if (scm_is_pair (col_labels))
255 system_labels = scm_append (scm_list_2 (col_labels, system_labels));
257 system->set_property ("labels", system_labels);
259 set_loose_columns (system, &breaking[i]);
260 broken_intos_.push_back (system);
264 void
265 System::add_column (Paper_column *p)
267 Grob *me = this;
268 Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
269 if (!ga)
271 SCM scm_ga = Grob_array::make_array ();
272 me->set_object ("columns", scm_ga);
273 ga = unsmob_grob_array (scm_ga);
276 p->set_rank (ga->size ());
278 ga->add (p);
279 Axis_group_interface::add_element (this, p);
282 void
283 System::pre_processing ()
285 for (vsize i = 0; i < all_elements_->size (); i++)
286 all_elements_->grob (i)->discretionary_processing ();
288 if (be_verbose_global)
289 message (_f ("Grob count %d", element_count ()));
292 order is significant: broken grobs are added to the end of the
293 array, and should be processed before the original is potentially
294 killed.
296 for (vsize i = all_elements_->size (); i--;)
297 all_elements_->grob (i)->handle_prebroken_dependencies ();
299 fixup_refpoints (all_elements_->array ());
301 for (vsize i = 0; i < all_elements_->size (); i++)
303 Grob *g = all_elements_->grob (i);
304 (void) g->get_property ("before-line-breaking");
307 for (vsize i = 0; i < all_elements_->size (); i++)
309 Grob *e = all_elements_->grob (i);
310 (void) e->get_property ("springs-and-rods");
314 void
315 System::post_processing ()
317 Interval iv (extent (this, Y_AXIS));
318 if (iv.is_empty ())
319 programming_error ("system with empty extent");
320 else
321 translate_axis (-iv[MAX], Y_AXIS);
323 /* Generate all stencils to trigger font loads.
324 This might seem inefficient, but Stencils are cached per grob
325 anyway. */
327 vector<Grob *> all_elts_sorted (all_elements_->array ());
328 vector_sort (all_elts_sorted, std::less<Grob *> ());
329 uniq (all_elts_sorted);
330 this->get_stencil ();
331 for (vsize i = all_elts_sorted.size (); i--;)
333 Grob *g = all_elts_sorted[i];
334 g->get_stencil ();
338 struct Layer_entry
340 Grob *grob_;
341 int layer_;
344 bool
345 operator< (Layer_entry const &a,
346 Layer_entry const &b)
348 return a.layer_ < b.layer_;
352 System::get_paper_system ()
354 SCM exprs = SCM_EOL;
355 SCM *tail = &exprs;
357 post_processing ();
359 vector<Layer_entry> entries;
360 for (vsize j = 0; j < all_elements_->size (); j++)
362 Layer_entry e;
363 e.grob_ = all_elements_->grob (j);
364 e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
366 entries.push_back (e);
369 vector_sort (entries, std::less<Layer_entry> ());
370 for (vsize j = 0; j < entries.size (); j++)
372 Grob *g = entries[j].grob_;
373 Stencil st = g->get_print_stencil ();
375 if (st.expr () == SCM_EOL)
376 continue;
378 Offset o;
379 for (int a = X_AXIS; a < NO_AXES; a++)
380 o[Axis (a)] = g->relative_coordinate (this, Axis (a));
382 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
383 Offset (0, 0))
384 * Staff_symbol_referencer::staff_space (g);
386 /* Must copy the stencil, for we cannot change the stencil
387 cached in G. */
389 st.translate (o + extra);
391 *tail = scm_cons (st.expr (), SCM_EOL);
392 tail = SCM_CDRLOC (*tail);
395 if (Stencil *me = get_stencil ())
396 exprs = scm_cons (me->expr (), exprs);
398 Interval x (extent (this, X_AXIS));
399 Interval y (extent (this, Y_AXIS));
400 Stencil sys_stencil (Box (x, y),
401 scm_cons (ly_symbol2scm ("combine-stencil"),
402 exprs));
403 if (debug_skylines)
405 Skyline_pair *skylines = Skyline_pair::unsmob (get_property ("vertical-skylines"));
406 if (skylines)
408 Stencil up
409 = Lookup::points_to_line_stencil (0.1, (*skylines)[UP].to_points (X_AXIS));
410 Stencil down
411 = Lookup::points_to_line_stencil (0.1, (*skylines)[DOWN].to_points (X_AXIS));
412 sys_stencil.add_stencil (up.in_color (255, 0, 0));
413 sys_stencil.add_stencil (down.in_color (0, 255, 0));
417 Grob *left_bound = this->get_bound (LEFT);
418 SCM prop_init = left_bound->get_property ("line-break-system-details");
419 Prob *pl = make_paper_system (prop_init);
420 paper_system_set_stencil (pl, sys_stencil);
422 /* information that the page breaker might need */
423 Grob *right_bound = this->get_bound (RIGHT);
424 pl->set_property ("vertical-skylines", this->get_property ("vertical-skylines"));
425 pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
426 pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
427 pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
428 pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
430 Interval staff_refpoints;
431 if (Grob *align = get_vertical_alignment ())
433 extract_grob_set (align, "elements", staves);
434 for (vsize i = 0; i < staves.size (); i++)
435 if (staves[i]->is_live ()
436 && Page_layout_problem::is_spaceable (staves[i]))
437 staff_refpoints.add_point (staves[i]->relative_coordinate (this,
438 Y_AXIS));
441 pl->set_property ("staff-refpoint-extent", ly_interval2scm (staff_refpoints));
442 pl->set_property ("system-grob", this->self_scm ());
444 return pl->unprotect ();
447 vector<Item *>
448 System::broken_col_range (Item const *left, Item const *right) const
450 vector<Item *> ret;
452 left = left->get_column ();
453 right = right->get_column ();
455 extract_grob_set (this, "columns", cols);
457 vsize i = Paper_column::get_rank (left);
458 int end_rank = Paper_column::get_rank (right);
459 if (i < cols.size ())
460 i++;
462 while (i < cols.size ()
463 && Paper_column::get_rank (cols[i]) < end_rank)
465 Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
466 if (Paper_column::is_breakable (c) && !c->get_system ())
467 ret.push_back (c);
468 i++;
471 return ret;
474 /** Return all columns, but filter out any unused columns , since they might
475 disrupt the spacing problem. */
476 vector<Grob *>
477 System::used_columns () const
479 extract_grob_set (this, "columns", ro_columns);
481 int last_breakable = ro_columns.size ();
483 while (last_breakable--)
485 if (Paper_column::is_breakable (ro_columns [last_breakable]))
486 break;
489 vector<Grob *> columns;
490 for (int i = 0; i <= last_breakable; i++)
492 if (Paper_column::is_used (ro_columns[i]))
493 columns.push_back (ro_columns[i]);
496 return columns;
499 Paper_column *
500 System::column (vsize which) const
502 extract_grob_set (this, "columns", columns);
503 if (which >= columns.size ())
504 return 0;
506 return dynamic_cast<Paper_column *> (columns[which]);
509 Paper_score *
510 System::paper_score () const
512 return pscore_;
516 System::get_rank () const
518 return rank_;
521 System *
522 get_root_system (Grob *me)
524 Grob *system_grob = me;
526 while (system_grob->get_parent (Y_AXIS))
527 system_grob = system_grob->get_parent (Y_AXIS);
529 return dynamic_cast<System *> (system_grob);
532 Grob *
533 System::get_vertical_alignment ()
535 extract_grob_set (this, "elements", elts);
536 Grob *ret = 0;
537 for (vsize i = 0; i < elts.size (); i++)
538 if (Align_interface::has_interface (elts[i]))
540 if (ret)
541 programming_error ("found multiple vertical alignments in this system");
542 ret = elts[i];
545 if (!ret)
546 programming_error ("didn't find a vertical alignment in this system");
547 return ret;
550 // Finds the furthest staff in the given direction whose x-extent
551 // overlaps with the given interval.
552 Grob *
553 System::get_extremal_staff (Direction dir, Interval const &iv)
555 Grob *align = get_vertical_alignment ();
556 if (!align)
557 return 0;
559 extract_grob_set (align, "elements", elts);
560 vsize start = (dir == UP) ? 0 : elts.size () - 1;
561 vsize end = (dir == UP) ? elts.size () : VPOS;
562 for (vsize i = start; i != end; i += dir)
564 if (Hara_kiri_group_spanner::has_interface (elts[i]))
565 Hara_kiri_group_spanner::consider_suicide (elts[i]);
567 Interval intersection = elts[i]->extent (this, X_AXIS);
568 intersection.intersect (iv);
569 if (elts[i]->is_live () && !intersection.is_empty ())
570 return elts[i];
572 return 0;
575 Interval
576 System::pure_refpoint_extent (vsize start, vsize end)
578 Interval ret;
579 Grob *alignment = get_vertical_alignment ();
580 if (!alignment)
581 return Interval ();
583 extract_grob_set (alignment, "elements", staves);
584 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
586 for (vsize i = 0; i < offsets.size (); ++i)
587 if (Page_layout_problem::is_spaceable (staves[i]))
589 ret[UP] = offsets[i];
590 break;
593 for (vsize i = offsets.size (); i--;)
594 if (Page_layout_problem::is_spaceable (staves[i]))
596 ret[DOWN] = offsets[i];
597 break;
600 return ret;
603 Interval
604 System::part_of_line_pure_height (vsize start, vsize end, bool begin)
606 Grob *alignment = get_vertical_alignment ();
607 if (!alignment)
608 return Interval ();
610 extract_grob_set (alignment, "elements", staves);
611 vector<Real> offsets = Align_interface::get_pure_minimum_translations (alignment, staves, Y_AXIS, start, end);
613 Interval ret;
614 for (vsize i = 0; i < staves.size (); ++i)
616 Interval iv = begin
617 ? Axis_group_interface::begin_of_line_pure_height (staves[i], start)
618 : Axis_group_interface::rest_of_line_pure_height (staves[i], start, end);
619 if (i < offsets.size ())
620 iv.translate (offsets[i]);
621 ret.unite (iv);
624 Interval other_elements = begin
625 ? Axis_group_interface::begin_of_line_pure_height (this, start)
626 : Axis_group_interface::rest_of_line_pure_height (this, start, end);
628 ret.unite (other_elements);
630 return ret;
633 Interval
634 System::begin_of_line_pure_height (vsize start, vsize end)
636 return part_of_line_pure_height (start, end, true);
639 Interval
640 System::rest_of_line_pure_height (vsize start, vsize end)
642 return part_of_line_pure_height (start, end, false);
645 // This differs from Axis_group_interface::calc_pure_relevant_grobs
646 // because here, we are only interested in those few elements that aren't
647 // descended from VerticalAlignment (ie. things like RehearsalMark, BarLine).
648 MAKE_SCHEME_CALLBACK (System, calc_pure_relevant_grobs, 1);
650 System::calc_pure_relevant_grobs (SCM smob)
652 Grob *me = unsmob_grob (smob);
654 extract_grob_set (me, "elements", elts);
655 vector<Grob *> relevant_grobs;
656 SCM pure_relevant_p = ly_lily_module_constant ("pure-relevant?");
658 for (vsize i = 0; i < elts.size (); ++i)
660 if (!Axis_group_interface::has_interface (elts[i]))
662 if (to_boolean (scm_apply_1 (pure_relevant_p, elts[i]->self_scm (), SCM_EOL)))
663 relevant_grobs.push_back (elts[i]);
665 if (Item *it = dynamic_cast<Item*> (elts[i]))
667 Direction d = LEFT;
670 Item *piece = it->find_prebroken_piece (d);
671 if (piece && to_boolean (scm_apply_1 (pure_relevant_p, piece->self_scm (), SCM_EOL)))
672 relevant_grobs.push_back (piece);
674 while (flip (&d) != LEFT);
679 SCM grobs_scm = Grob_array::make_array ();
681 unsmob_grob_array (grobs_scm)->set_array (relevant_grobs);
682 return grobs_scm;
685 MAKE_SCHEME_CALLBACK (System, height, 1);
687 System::height (SCM smob)
689 return Axis_group_interface::height (smob);
692 MAKE_SCHEME_CALLBACK (System, calc_pure_height, 3);
694 System::calc_pure_height (SCM smob, SCM start_scm, SCM end_scm)
696 System *me = dynamic_cast<System *> (unsmob_grob (smob));
697 int start = scm_to_int (start_scm);
698 int end = scm_to_int (end_scm);
700 Interval begin = me->begin_of_line_pure_height (start, end);
701 Interval rest = me->rest_of_line_pure_height (start, end);
702 begin.unite (rest);
704 return ly_interval2scm (begin);
707 Grob*
708 System::get_pure_bound (Direction d, int start, int end)
710 vector<vsize> ranks = pscore_->get_break_ranks ();
711 vector<vsize> indices = pscore_->get_break_indices ();
712 vector<Grob*> cols = pscore_->get_columns ();
714 vsize target_rank = (d == LEFT ? start : end);
715 vector<vsize>::const_iterator i =
716 lower_bound (ranks.begin (), ranks.end (), target_rank, std::less<vsize> ());
718 if (i != ranks.end () && (*i) == target_rank)
719 return cols[indices[i - ranks.begin ()]];
720 else
721 return 0;
724 Grob*
725 System::get_maybe_pure_bound (Direction d, bool pure, int start, int end)
727 return pure ? get_pure_bound (d, start, end) : get_bound (d);
730 ADD_INTERFACE (System,
731 "This is the top-level object: Each object in a score"
732 " ultimately has a @code{System} object as its X and"
733 " Y@tie{}parent.",
735 /* properties */
736 "all-elements "
737 "columns "
738 "labels "
739 "pure-Y-extent "
740 "skyline-horizontal-padding "