2 system.cc -- implement System
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "align-interface.hh"
12 #include "all-font-metrics.hh"
13 #include "axis-group-interface.hh"
14 #include "grob-array.hh"
15 #include "international.hh"
17 #include "output-def.hh"
18 #include "paper-column.hh"
19 #include "paper-score.hh"
20 #include "paper-system.hh"
21 #include "pointer-group-interface.hh"
22 #include "spacing-interface.hh"
23 #include "staff-symbol-referencer.hh"
24 #include "tweak-registration.hh"
28 extern bool debug_skylines;
30 System::System (System const &src, int count)
31 : Spanner (src, count)
39 System::System (SCM s, Object_key const *key)
48 System::init_elements ()
50 SCM scm_arr = Grob_array::make_array ();
51 all_elements_ = unsmob_grob_array (scm_arr);
52 all_elements_->set_ordered (false);
53 set_object ("all-elements", scm_arr);
57 System::clone (int index) const
59 return new System (*this, index);
63 System::element_count () const
65 return all_elements_->size ();
69 System::spanner_count () const
72 for (vsize i = all_elements_->size (); i--;)
73 if (dynamic_cast<Spanner *> (all_elements_->grob (i)))
79 System::typeset_grob (Grob *elem)
82 programming_error ("adding element twice");
85 elem->layout_ = pscore_->layout ();
86 all_elements_->add (elem);
92 System::derived_mark () const
94 if (!all_elements_->empty ())
96 Grob **ptr = &all_elements_->array_reference ()[0];
97 Grob **end = ptr + all_elements_->size ();
100 scm_gc_mark ((*ptr)->self_scm ());
106 scm_gc_mark (pscore_->self_scm ());
108 Spanner::derived_mark ();
112 fixup_refpoints (vector<Grob*> const &grobs)
114 for (vsize i = grobs.size (); i--;)
115 grobs[i]->fixup_refpoint ();
119 System::get_paper_systems ()
121 for (vsize i = 0; i < all_elements_->size (); i++)
123 Grob *g = all_elements_->grob (i);
124 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
127 Kill no longer needed grobs.
129 Item *it = dynamic_cast<Item *> (g);
130 if (it && Item::is_non_musical (it))
132 it->find_prebroken_piece (LEFT)->suicide ();
133 it->find_prebroken_piece (RIGHT)->suicide ();
137 else if (g->is_live ())
138 g->do_break_processing ();
142 fixups must be done in broken line_of_scores, because new elements
143 are put over there. */
145 for (vsize i = 0; i < broken_intos_.size (); i++)
147 Grob *se = broken_intos_[i];
149 extract_grob_set (se, "all-elements", all_elts);
150 for (vsize j = 0; j < all_elts.size (); j++)
152 Grob *g = all_elts[j];
153 g->fixup_refpoint ();
156 count += all_elts.size ();
160 needed for doing items.
162 fixup_refpoints (all_elements_->array ());
164 for (vsize i = 0; i < all_elements_->size (); i++)
165 all_elements_->grob (i)->handle_broken_dependencies ();
167 handle_broken_dependencies ();
169 /* Because the this->get_property (all-elements) contains items in 3
170 versions, handle_broken_dependencies () will leave duplicated
171 items in all-elements. Strictly speaking this is harmless, but
172 it leads to duplicated symbols in the output. uniq makes sure
173 that no duplicates are in the list. */
174 for (vsize i = 0; i < broken_intos_.size (); i++)
176 System *child = dynamic_cast<System*> (broken_intos_[i]);
177 child->all_elements_->remove_duplicates ();
180 if (be_verbose_global)
181 message (_f ("Element count %d.", count + element_count ()));
183 SCM lines = scm_c_make_vector (broken_intos_.size (), SCM_EOL);
184 for (vsize i = 0; i < broken_intos_.size (); i++)
186 if (be_verbose_global)
187 progress_indication ("[");
189 System *system = dynamic_cast<System *> (broken_intos_[i]);
191 system->post_processing ();
192 system->build_skylines ();
195 System *prev = dynamic_cast<System*> (broken_intos_[i-1]);
196 Real r = prev->skylines_[DOWN].distance (system->skylines_[UP]);
197 system->set_property ("skyline-distance", scm_from_double (r));
199 scm_vector_set_x (lines, scm_from_int (i),
200 system->get_paper_system ());
202 if (be_verbose_global)
203 progress_indication (to_string (i) + "]");
209 System::break_into_pieces (vector<Column_x_positions> const &breaking)
211 for (vsize i = 0; i < breaking.size (); i++)
213 System *system = dynamic_cast<System *> (clone (broken_intos_.size ()));
214 system->rank_ = broken_intos_.size ();
216 vector<Grob*> c (breaking[i].cols_);
217 pscore_->typeset_system (system);
219 int st = Paper_column::get_rank (c[0]);
220 int end = Paper_column::get_rank (c.back ());
221 Interval iv (pure_height (this, st, end));
222 system->set_property ("pure-Y-extent", ly_interval2scm (iv));
224 system->set_bound (LEFT, c[0]);
225 system->set_bound (RIGHT, c.back ());
226 for (vsize j = 0; j < c.size (); j++)
228 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
229 dynamic_cast<Paper_column *> (c[j])->system_ = system;
232 set_loose_columns (system, &breaking[i]);
233 broken_intos_.push_back (system);
238 System::add_column (Paper_column *p)
241 Grob_array *ga = unsmob_grob_array (me->get_object ("columns"));
244 SCM scm_ga = Grob_array::make_array ();
245 me->set_object ("columns", scm_ga);
246 ga = unsmob_grob_array (scm_ga);
249 p->rank_ = ga->size ();
252 Axis_group_interface::add_element (this, p);
256 apply_tweaks (Grob *g, bool broken)
258 if (bool (g->original ()) == broken)
260 SCM tweaks = global_registry_->get_tweaks (g);
261 for (SCM s = tweaks; scm_is_pair (s); s = scm_cdr (s))
263 SCM proc = scm_caar (s);
264 SCM rest = scm_cdar (s);
265 scm_apply_1 (proc, g->self_scm (), rest);
271 System::pre_processing ()
273 for (vsize i = 0; i < all_elements_->size (); i++)
274 all_elements_->grob (i)->discretionary_processing ();
276 if (be_verbose_global)
277 message (_f ("Grob count %d", element_count ()));
280 order is significant: broken grobs are added to the end of the
281 array, and should be processed before the original is potentially
284 for (vsize i = all_elements_->size (); i--;)
285 all_elements_->grob (i)->handle_prebroken_dependencies ();
287 fixup_refpoints (all_elements_->array ());
289 for (vsize i = 0; i < all_elements_->size (); i++)
290 apply_tweaks (all_elements_->grob (i), false);
292 for (vsize i = 0; i < all_elements_->size (); i++)
294 Grob *g = all_elements_->grob (i);
295 (void) g->get_property ("before-line-breaking");
298 for (vsize i = 0; i < all_elements_->size (); i++)
300 Grob *e = all_elements_->grob (i);
301 (void) e->get_property ("springs-and-rods");
306 System::post_processing ()
308 for (vsize i = 0; i < all_elements_->size (); i++)
310 Grob *g = all_elements_->grob (i);
312 apply_tweaks (g, true);
313 (void) g->get_property ("after-line-breaking");
316 Interval iv (extent (this, Y_AXIS));
318 programming_error ("system with empty extent");
320 translate_axis (-iv[MAX], Y_AXIS);
322 /* Generate all stencils to trigger font loads.
323 This might seem inefficient, but Stencils are cached per grob
326 vector<Grob*> all_elts_sorted (all_elements_->array ());
327 vector_sort (all_elts_sorted, std::less<Grob*> ());
328 uniq (all_elts_sorted);
329 this->get_stencil ();
330 for (vsize i = all_elts_sorted.size (); i--;)
332 Grob *g = all_elts_sorted[i];
344 operator< (Layer_entry const &a,
345 Layer_entry const &b)
347 return a.layer_ < b.layer_;
352 System::get_paper_system ()
357 vector<Layer_entry> entries;
358 for (vsize j = 0; j < all_elements_->size (); j++)
361 e.grob_ = all_elements_->grob (j);
362 e.layer_ = robust_scm2int (e.grob_->get_property ("layer"), 1);
364 entries.push_back (e);
367 vector_sort (entries, std::less<Layer_entry> ());
368 for (vsize j = 0; j < entries.size (); j++)
370 Grob *g = entries[j].grob_;
371 Stencil st = g->get_print_stencil ();
373 if (st.expr() == SCM_EOL)
377 for (int a = X_AXIS; a < NO_AXES; a++)
378 o[Axis (a)] = g->relative_coordinate (this, Axis (a));
380 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
382 * Staff_symbol_referencer::staff_space (g);
384 /* Must copy the stencil, for we cannot change the stencil
387 st.translate (o + extra);
389 *tail = scm_cons (st.expr (), SCM_EOL);
390 tail = SCM_CDRLOC (*tail);
393 if (Stencil *me = get_stencil ())
394 exprs = scm_cons (me->expr (), exprs);
396 Interval x (extent (this, X_AXIS));
397 Interval y (extent (this, Y_AXIS));
398 Stencil sys_stencil (Box (x, y),
399 scm_cons (ly_symbol2scm ("combine-stencil"),
403 sys_stencil.add_stencil (Lookup::points_to_line_stencil (0.1, skylines_[UP].to_points ()).in_color (255, 0, 0));
404 sys_stencil.add_stencil (Lookup::points_to_line_stencil (0.1, skylines_[DOWN].to_points ()).in_color (0, 255, 0));
407 Grob *left_bound = this->get_bound (LEFT);
408 SCM prop_init = left_bound->get_property ("line-break-system-details");
409 Prob *pl = make_paper_system (prop_init);
410 paper_system_set_stencil (pl, sys_stencil);
412 /* information that the page breaker might need */
413 Grob *right_bound = this->get_bound (RIGHT);
414 pl->set_property ("skyline-distance", get_property ("skyline-distance"));
415 pl->set_property ("page-break-permission", right_bound->get_property ("page-break-permission"));
416 pl->set_property ("page-turn-permission", right_bound->get_property ("page-turn-permission"));
417 pl->set_property ("page-break-penalty", right_bound->get_property ("page-break-penalty"));
418 pl->set_property ("page-turn-penalty", right_bound->get_property ("page-turn-penalty"));
420 if (!scm_is_pair (pl->get_property ("refpoint-Y-extent")))
422 Interval staff_refpoints;
423 staff_refpoints.set_empty ();
424 extract_grob_set (this, "spaceable-staves", staves);
425 for (vsize i = 0; i < staves.size (); i++)
428 staff_refpoints.add_point (g->relative_coordinate (this, Y_AXIS));
430 pl->set_property ("refpoint-Y-extent", ly_interval2scm (staff_refpoints));
433 pl->set_property ("system-grob", this->self_scm ());
435 return pl->unprotect ();
439 System::broken_col_range (Item const *left, Item const *right) const
443 left = left->get_column ();
444 right = right->get_column ();
447 extract_grob_set (this, "columns", cols);
449 vsize i = binary_search (cols, (Grob *) left,
450 Paper_column::less_than);
452 int end_rank = Paper_column::get_rank (right);
453 if (i < cols.size ())
456 while (i < cols.size ()
457 && Paper_column::get_rank (cols[i]) < end_rank)
459 Paper_column *c = dynamic_cast<Paper_column *> (cols[i]);
460 if (Paper_column::is_breakable (c) && !c->system_)
469 /** Return all columns, but filter out any unused columns , since they might
470 disrupt the spacing problem. */
472 System::columns () const
474 extract_grob_set (this, "columns", ro_columns);
476 int last_breakable = ro_columns.size ();
478 while (last_breakable--)
480 if (Paper_column::is_breakable (ro_columns [last_breakable]))
484 vector<Grob*> columns;
485 for (int i = 0; i <= last_breakable; i++)
487 if (Paper_column::is_used (ro_columns[i]))
488 columns.push_back (ro_columns[i]);
495 System::column (int which) const
497 extract_grob_set (this, "columns", columns);
498 for (vsize i = 0; i < columns.size (); i++)
499 if (dynamic_cast<Paper_column*> (columns[i])->get_rank () == which)
501 programming_error ("couldn't find the column of the requested index");
506 System::paper_score () const
512 System::get_rank () const
518 get_root_system (Grob *me)
520 Grob *system_grob = me;
522 while (system_grob->get_parent (Y_AXIS))
523 system_grob = system_grob->get_parent (Y_AXIS);
525 return dynamic_cast<System*> (system_grob);
529 System::build_skylines ()
532 for (vsize i = 0; i < all_elements_->size (); i++)
534 Grob *g = all_elements_->grob (i);
535 if (!unsmob_stencil (g->get_property ("stencil")))
538 Interval xiv = g->extent (this, X_AXIS);
539 Interval yiv = g->extent (this, Y_AXIS);
540 if (!xiv.is_empty () && !yiv.is_empty ())
541 boxes.push_back (Box (xiv, yiv));
544 SCM horizon_padding_scm = get_property ("skyline-horizontal-padding");
545 Real horizon_padding = robust_scm2double (horizon_padding_scm, 0);
546 skylines_[UP] = Skyline (boxes, horizon_padding, X_AXIS, UP);
547 skylines_[DOWN] = Skyline (boxes, horizon_padding, X_AXIS, DOWN);
551 ADD_INTERFACE (System,
552 "This is the toplevel object: each object in a score "
553 "ultimately has a System object as its X and Y parent. ",
561 "skyline-horizontal-padding "