2 system.cc -- implement System
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "axis-group-interface.hh"
15 #include "paper-column.hh"
16 #include "paper-def.hh"
17 #include "paper-outputter.hh"
18 #include "paper-score.hh"
22 #include "all-font-metrics.hh"
23 #include "spacing-interface.hh"
24 #include "staff-symbol-referencer.hh"
25 #include "paper-book.hh"
26 #include "paper-line.hh"
28 System::System (SCM s)
35 System::element_count () const
37 return scm_ilength (get_property ("all-elements"));
41 System::spanner_count () const
44 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
45 if (dynamic_cast<Spanner*> (unsmob_grob (ly_car (s))))
51 System::typeset_grob (Grob * elem)
54 programming_error ("Adding element twice.");
57 elem->pscore_ = pscore_;
58 Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"), elem);
59 scm_gc_unprotect_object (elem->self_scm ());
65 fixup_refpoints (SCM s)
67 for (; ly_c_pair_p (s); s = ly_cdr (s))
69 Grob::fixup_refpoint (ly_car (s));
76 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
78 Grob *g = unsmob_grob (ly_car (s));
79 if (g->internal_has_interface (ly_symbol2scm ("only-prebreak-interface")))
82 Kill no longer needed grobs.
84 Item * it = dynamic_cast<Item*> (g);
85 if (it && Item::is_breakable (it))
87 it->find_prebroken_piece (LEFT)->suicide ();
88 it->find_prebroken_piece (RIGHT)->suicide ();
93 g->do_break_processing ();
97 fixups must be done in broken line_of_scores, because new elements
98 are put over there. */
100 for (int i=0; i < broken_intos_.size (); i++)
102 Grob *se = broken_intos_[i];
103 SCM all = se->get_property ("all-elements");
104 for (SCM s = all; ly_c_pair_p (s); s = ly_cdr (s))
105 fixup_refpoint (ly_car (s));
106 count += scm_ilength (all);
110 needed for doing items.
112 fixup_refpoints (get_property ("all-elements"));
114 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
115 unsmob_grob (ly_car (s))->handle_broken_dependencies ();
116 handle_broken_dependencies ();
118 #if 0 /* don't do this: strange side effects. */
120 /* Because the this->get_property (all-elements) contains items in 3
121 versions, handle_broken_dependencies () will leave duplicated
122 items in all-elements. Strictly speaking this is harmless, but
123 it leads to duplicated symbols in the output. ly_list_qsort_uniq_x ()
124 makes sure that no duplicates are in the list. */
125 for (int i = 0; i < line_count; i++)
127 SCM all = broken_intos_[i]->get_property ("all-elements");
128 all = ly_list_qsort_uniq_x(all);
132 if (verbose_global_b)
133 progress_indication (_f ("Element count %d.", count + element_count ()));
135 int line_count = broken_intos_.size ();
136 SCM lines = scm_c_make_vector (line_count, SCM_UNDEFINED);
138 for (int i = 0; i < line_count; i++)
140 if (verbose_global_b)
141 progress_indication ("[");
143 System *system = dynamic_cast<System*> (broken_intos_[i]);
144 system->post_processing ();
145 scm_vector_set_x (lines, scm_int2num (i), system->get_line ());
147 if (verbose_global_b)
148 progress_indication (to_string (i) + "]");
153 /* Find the loose columns in POSNS, and drape them around the columns
154 specified in BETWEEN-COLS. */
156 set_loose_columns (System* which, Column_x_positions const *posns)
158 int loose_col_count = posns->loose_cols_.size ();
159 for (int i = 0; i < loose_col_count; i++)
162 Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
163 Paper_column* col = dynamic_cast<Paper_column*> (loose);
172 SCM between = loose->get_property ("between-cols");
173 if (!ly_c_pair_p (between))
176 Item *le = dynamic_cast<Item*> (unsmob_grob (ly_car (between)));
177 Item *re = dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
184 left = le->get_column ();
185 if (!left->get_system ())
186 left = left->find_prebroken_piece (RIGHT);
190 loose = right = re->get_column ();
193 if (!right->get_system ())
194 right = right->find_prebroken_piece (LEFT);
196 /* Divide the remaining space of the column over the left and
197 right side. At the moment, FIXME */
198 Grob *common = right->common_refpoint (left, X_AXIS);
200 Real rx = right->extent (common, X_AXIS)[LEFT];
201 Real lx = left->extent (common, X_AXIS)[RIGHT];
202 Real total_dx = rx - lx;
203 Interval cval =col->extent (col, X_AXIS);
205 /* Put it in the middle. This is not an ideal solution -- the
206 break alignment code inserts a fixed space before the clef
207 (about 1 SS), while the space following the clef is flexible.
208 In tight situations, the clef will almost be on top of the
210 Real dx = rx - lx - cval.length ();
211 if (total_dx < 2* cval.length ())
213 /* TODO: this is discontinuous. I'm too tired to
214 invent a sliding mechanism. Duh. */
220 col->system_ = which;
221 col->translate_axis (-col->relative_coordinate (common, X_AXIS), X_AXIS);
222 col->translate_axis (lx + dx - cval[LEFT], X_AXIS);
228 System::break_into_pieces (Array<Column_x_positions> const &breaking)
230 for (int i = 0; i < breaking.size (); i++)
232 System *system = dynamic_cast <System*> (clone ());
235 Link_array<Grob> c (breaking[i].cols_);
236 pscore_->typeset_line (system);
238 system->set_bound (LEFT,c[0]);
239 system->set_bound (RIGHT,c.top ());
240 for (int j = 0; j < c.size (); j++)
242 c[j]->translate_axis (breaking[i].config_[j], X_AXIS);
243 dynamic_cast<Paper_column*> (c[j])->system_ = system;
245 set_loose_columns (system, &breaking[i]);
246 broken_intos_.push (system);
251 System::add_column (Paper_column*p)
254 SCM cs = me->get_property ("columns");
255 Grob *prev = ly_c_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
257 p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
259 me->set_property ("columns", scm_cons (p->self_scm (), cs));
261 Axis_group_interface::add_element (me, p);
265 System::pre_processing ()
267 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
268 unsmob_grob (ly_car (s))->discretionary_processing ();
270 if (verbose_global_b)
271 progress_indication (_f ("Grob count %d", element_count ()));
274 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
275 unsmob_grob (ly_car (s))->handle_prebroken_dependencies ();
277 fixup_refpoints (get_property ("all-elements"));
279 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
281 Grob* sc = unsmob_grob (ly_car (s));
282 sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
285 progress_indication ("\n" + _ ("Calculating line breaks...") + " ");
286 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
288 Grob *e = unsmob_grob (ly_car (s));
289 SCM proc = e->get_property ("spacing-procedure");
290 if (ly_c_procedure_p (proc))
291 scm_call_1 (proc, e->self_scm ());
296 System::post_processing ()
298 for (SCM s = get_property ("all-elements"); ly_c_pair_p (s); s = ly_cdr (s))
300 Grob *g = unsmob_grob (ly_car (s));
301 g->calculate_dependencies (POSTCALCED, POSTCALCING,
302 ly_symbol2scm ("after-line-breaking-callback"));
305 Interval iv (extent (this, Y_AXIS));
307 programming_error ("System with zero extent.");
309 translate_axis (-iv[MAX], Y_AXIS);
311 /* Generate all stencils to trigger font loads.
312 This might seem inefficient, but Stencils are cached per grob
314 SCM all = get_property ("all-elements");
315 all = ly_list_qsort_uniq_x (all);
317 this->get_stencil ();
318 for (SCM s = all; ly_c_pair_p (s); s = ly_cdr (s))
320 Grob *g = unsmob_grob (ly_car (s));
328 static int const LAYER_COUNT = 3;
330 SCM stencils = SCM_EOL;
331 if (Stencil *me = get_stencil ())
332 stencils = scm_cons (me->smobbed_copy (), stencils);
334 /* Output stencils in three layers: 0, 1, 2. Default layer: 1.
336 Start with layer 3, since scm_cons prepends to list. */
337 SCM all = get_property ("all-elements");
340 for (int i = LAYER_COUNT; i--;)
341 for (SCM s = all; ly_c_pair_p (s); s = ly_cdr (s))
343 Grob *g = unsmob_grob (ly_car (s));
344 Stencil *stil = g->get_stencil ();
346 /* Skip empty stencils and grobs that are not in this layer. */
348 || robust_scm2int (g->get_property ("layer"), 1) != i)
351 Offset o (g->relative_coordinate (this, X_AXIS),
352 g->relative_coordinate (this, Y_AXIS));
354 Offset extra = robust_scm2offset (g->get_property ("extra-offset"),
356 * Staff_symbol_referencer::staff_space (g);
358 /* Must copy the stencil, for we cannot change the stencil
360 SCM my_stencil = stil->smobbed_copy ();
361 unsmob_stencil (my_stencil)->translate (o + extra);
362 stencils = scm_cons (my_stencil, stencils);
366 if (Item *it = dynamic_cast <Item*> (g))
368 Grob *col = it->get_column ();
369 SCM s = col->get_property ("page-penalty");
370 // FIXME; page breaking is not discrete at +-10000
371 if (ly_c_number_p (s)) // && fabs (ly_scm2double (s)) < 10000)
372 penalty += ly_scm2double (s);
377 Interval x (extent (this, X_AXIS));
378 Interval y (extent (this, Y_AXIS));
379 Paper_line *pl = new Paper_line (Offset (x.length (), y.length ()),
382 return scm_gc_unprotect_object (pl->self_scm ());
386 System::broken_col_range (Item const *left, Item const *right) const
388 Link_array<Item> ret;
390 left = left->get_column ();
391 right = right->get_column ();
392 SCM s = get_property ("columns");
394 while (ly_c_pair_p (s) && ly_car (s) != right->self_scm ())
400 while (ly_c_pair_p (s) && ly_car (s) != left->self_scm ())
402 Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
403 if (Item::is_breakable (c) && !c->system_)
413 /** Return all columns, but filter out any unused columns , since they might
414 disrupt the spacing problem. */
416 System::columns () const
419 = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
421 for (int i = acs.size (); i--;)
423 bool brb = Item::is_breakable (acs[i]);
424 found = found || brb;
427 the last column should be breakable. Weed out any columns that
428 seem empty. We need to retain breakable columns, in case
429 someone forced a breakpoint.
431 if (!found || !Paper_column::is_used (acs[i]))
437 ADD_INTERFACE (System,"system-interface",
438 "This is the toplevel object: each object in a score "
439 "ultimately has a System object as its X and Y parent. ",
440 "all-elements columns")