2 system.cc -- implement System
4 source file of the GNU LilyPond music typesetter
6 (c) 1996--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "input-smob.hh"
10 #include "axis-group-interface.hh"
14 #include "paper-column.hh"
15 #include "paper-def.hh"
16 #include "paper-outputter.hh"
17 #include "paper-score.hh"
20 #include "dimensions.hh"
21 #include "molecule.hh"
22 #include "all-font-metrics.hh"
23 #include "spacing-interface.hh"
27 fixup_refpoints (SCM s)
29 for (; gh_pair_p (s); s = ly_cdr (s))
31 Grob::fixup_refpoint (ly_car (s));
36 System::System (SCM s)
43 System::element_count () const
45 return scm_ilength (get_grob_property ("all-elements"));
49 System::spanner_count () const
52 for (SCM s = get_grob_property ("all-elements");
53 gh_pair_p (s); s = ly_cdr (s))
55 if (dynamic_cast<Spanner*> (unsmob_grob (gh_car(s))))
65 System::typeset_grob (Grob * elem)
67 elem->pscore_ = pscore_;
68 Pointer_group_interface::add_grob (this, ly_symbol2scm ("all-elements"),elem);
69 scm_gc_unprotect_object (elem->self_scm ());
73 System::output_lines ()
75 for (SCM s = get_grob_property ("all-elements");
76 gh_pair_p (s); s = ly_cdr (s))
78 Grob * g = unsmob_grob (ly_car (s));
79 if (Spacing_interface::has_interface (g))
82 Kill no longer needed grobs.
84 Item * it = dynamic_cast<Item*> (g);
85 if (it && Item::breakable_b(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_grob_property ("all-elements");
104 for (SCM s = all; gh_pair_p (s); s = ly_cdr (s))
106 fixup_refpoint (ly_car (s));
108 count += scm_ilength (all);
112 needed for doing items.
114 fixup_refpoints (get_grob_property ("all-elements"));
117 for (SCM s = get_grob_property ("all-elements");
118 gh_pair_p (s); s = ly_cdr (s))
120 unsmob_grob (ly_car (s))->handle_broken_dependencies ();
122 handle_broken_dependencies ();
124 if (verbose_global_b)
125 progress_indication (_f ("Element count %d.", count + element_count ()));
128 for (int i=0; i < broken_intos_.size (); i++)
130 System *system = dynamic_cast<System*> (broken_intos_[i]);
132 if (verbose_global_b)
133 progress_indication ("[");
134 system->post_processing (i+1 == broken_intos_.size ());
136 if (verbose_global_b)
138 progress_indication (to_string (i));
139 progress_indication ("]");
142 if (i < broken_intos_.size () - 1)
144 SCM lastcol = ly_car (system->get_grob_property ("columns"));
145 Grob* e = unsmob_grob (lastcol);
147 SCM between = ly_symbol2scm ("between-system-string");
148 SCM inter = e->internal_get_grob_property (between);
149 if (gh_string_p (inter))
152 ->output_scheme (scm_list_n (between,
153 inter, SCM_UNDEFINED));
163 Find the loose columns in POSNS, and drape them around the columns
164 specified in BETWEEN-COLS. */
166 set_loose_columns (System* which, Column_x_positions const *posns)
168 for (int i = 0; i < posns->loose_cols_.size (); i++)
171 Item *loose = dynamic_cast<Item*> (posns->loose_cols_[i]);
172 Paper_column* col = dynamic_cast<Paper_column*> (loose);
182 SCM between = loose->get_grob_property ("between-cols");
183 if (!gh_pair_p (between))
187 Item * l=dynamic_cast<Item*> (unsmob_grob (ly_car (between)));
188 Item * r=dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
195 left = l->get_column ();
200 loose = right = r->get_column ();
206 Real rx = right->relative_coordinate (right->get_parent (X_AXIS), X_AXIS);
207 Real lx = left->relative_coordinate (left->get_parent (X_AXIS), X_AXIS);
210 divide space equally over loose columns.
216 SCM between = loose->get_grob_property ("between-cols");
217 if (!gh_pair_p (between))
220 Paper_column *thiscol = dynamic_cast<Paper_column*> (loose);
222 thiscol->system_ = which;
223 thiscol->translate_axis (lx + j*(rx - lx)/divide_over, X_AXIS);
226 loose = dynamic_cast<Item*> (unsmob_grob (ly_cdr (between)));
230 We divide the remaining space of the column over the left and
231 right side. At the moment, we
234 Grob * common = right->common_refpoint (left, X_AXIS);
236 Real rx = right->extent(common, X_AXIS)[LEFT];
237 Real lx = left->extent(common, X_AXIS)[RIGHT];
238 Real total_dx = rx - lx;
239 Interval cval =col->extent (col, X_AXIS);
243 We put it in the middle. This is not an ideal solution -- the
244 break alignment code inserts a fixed space before the clef
245 (about 1 SS), while the space following the clef is
246 flexible. In tight situations, the clef will almost be on top
247 of the following note.
250 Real dx = rx-lx - cval.length ();
251 if (total_dx < 2* cval.length ())
254 todo: this is discontinuous. I'm too tired to
255 invent a sliding mechanism. Duh.
264 col->system_ = which;
265 col->translate_axis (lx + dx - cval[LEFT], X_AXIS);
272 System::break_into_pieces (Array<Column_x_positions> const &breaking)
274 for (int i=0; i < breaking.size (); i++)
276 System *system = dynamic_cast <System*> (clone ());
279 Link_array<Grob> c (breaking[i].cols_);
280 pscore_->typeset_line (system);
282 system->set_bound (LEFT,c[0]);
283 system->set_bound (RIGHT,c.top ());
284 for (int j=0; j < c.size (); j++)
286 c[j]->translate_axis (breaking[i].config_[j],X_AXIS);
287 dynamic_cast<Paper_column*> (c[j])->system_ = system;
289 set_loose_columns (system, &breaking[i]);
290 broken_intos_.push (system);
296 System::output_molecule (SCM expr, Offset o)
301 if (!gh_pair_p (expr))
304 SCM head =ly_car (expr);
305 if (unsmob_input (head))
307 Input * ip = unsmob_input (head);
309 pscore_->outputter_->output_scheme (scm_list_n (ly_symbol2scm ("define-origin"),
310 scm_makfrom0str (ip->file_string ().to_str0 ()),
311 gh_int2scm (ip->line_number ()),
312 gh_int2scm (ip->column_number ()),
314 expr = ly_cadr (expr);
316 else if (head == ly_symbol2scm ("no-origin"))
318 pscore_->outputter_->output_scheme (scm_list_n (head, SCM_UNDEFINED));
319 expr = ly_cadr (expr);
321 else if (head == ly_symbol2scm ("translate-molecule"))
323 o += ly_scm2offset (ly_cadr (expr));
324 expr = ly_caddr (expr);
326 else if (head == ly_symbol2scm ("combine-molecule"))
328 output_molecule (ly_cadr (expr), o);
329 expr = ly_caddr (expr);
333 pscore_->outputter_->
334 output_scheme (scm_list_n (ly_symbol2scm ("placebox"),
335 gh_double2scm (o[X_AXIS]),
336 gh_double2scm (o[Y_AXIS]),
346 System::output_scheme (SCM s)
348 pscore_->outputter_->output_scheme (s);
352 System::add_column (Paper_column*p)
355 SCM cs = me->get_grob_property ("columns");
356 Grob * prev = gh_pair_p (cs) ? unsmob_grob (ly_car (cs)) : 0;
358 p->rank_ = prev ? Paper_column::get_rank (prev) + 1 : 0;
360 me->set_grob_property ("columns", gh_cons (p->self_scm (), cs));
362 Axis_group_interface::add_element (me, p);
366 System::pre_processing ()
368 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
369 unsmob_grob (ly_car (s))->discretionary_processing ();
371 if (verbose_global_b)
372 progress_indication (_f ("Grob count %d ", element_count ()));
375 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
376 unsmob_grob (ly_car (s))->handle_prebroken_dependencies ();
378 fixup_refpoints (get_grob_property ("all-elements"));
380 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
382 Grob* sc = unsmob_grob (ly_car (s));
383 sc->calculate_dependencies (PRECALCED, PRECALCING, ly_symbol2scm ("before-line-breaking-callback"));
386 progress_indication ("\n" + _ ("Calculating line breaks...") + " ");
387 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
389 Grob * e = unsmob_grob (ly_car (s));
390 SCM proc = e->get_grob_property ("spacing-procedure");
391 if (gh_procedure_p (proc))
392 gh_call1 (proc, e->self_scm ());
397 System::post_processing (bool last_line)
399 for (SCM s = get_grob_property ("all-elements");
400 gh_pair_p (s); s = ly_cdr (s))
402 Grob* sc = unsmob_grob (ly_car (s));
403 sc->calculate_dependencies (POSTCALCED, POSTCALCING,
404 ly_symbol2scm ("after-line-breaking-callback"));
407 Interval i (extent (this, Y_AXIS));
409 programming_error ("Huh? Empty System?");
411 translate_axis (- i[MAX], Y_AXIS);
413 Real height = i.length ();
416 programming_error ("Improbable system height");
421 generate all molecules to trigger all font loads.
423 (ugh. This is not very memory efficient.) */
424 this->get_molecule();
425 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s); s = ly_cdr (s))
427 unsmob_grob (ly_car (s))->get_molecule ();
432 SCM font_names = ly_quote_scm (get_paper ()->font_descriptions ());
433 output_scheme (scm_list_n (ly_symbol2scm ("define-fonts"),
440 Interval j (extent (this, X_AXIS));
441 Real length = j[RIGHT];
443 output_scheme (scm_list_n (ly_symbol2scm ("start-system"),
444 gh_double2scm (length),
445 gh_double2scm (height),
448 /* Output elements in three layers, 0, 1, 2.
449 The default layer is 1. */
452 Molecule *m = this->get_molecule();
454 output_molecule (m->get_expr (), Offset(0,0));
457 for (int i = 0; i < 3; i++)
458 for (SCM s = get_grob_property ("all-elements"); gh_pair_p (s);
461 Grob *sc = unsmob_grob (ly_car (s));
462 Molecule *m = sc->get_molecule ();
466 SCM s = sc->get_grob_property ("layer");
467 int layer = gh_number_p (s) ? gh_scm2int (s) : 1;
471 Offset o (sc->relative_coordinate (this, X_AXIS),
472 sc->relative_coordinate (this, Y_AXIS));
474 SCM e = sc->get_grob_property ("extra-offset");
477 o[X_AXIS] += gh_scm2double (ly_car (e));
478 o[Y_AXIS] += gh_scm2double (ly_cdr (e));
481 output_molecule (m->get_expr (), o);
488 output_scheme (scm_list_n (ly_symbol2scm ("stop-last-system"), SCM_UNDEFINED));
492 output_scheme (scm_list_n (ly_symbol2scm ("stop-system"), SCM_UNDEFINED));
498 System::broken_col_range (Item const*l, Item const*r) const
500 Link_array<Item> ret;
502 l = l->get_column ();
503 r = r->get_column ();
504 SCM s = get_grob_property ("columns");
506 while (gh_pair_p (s) && ly_car (s) != r->self_scm ())
512 while (gh_pair_p (s) && ly_car (s) != l->self_scm ())
514 Paper_column*c = dynamic_cast<Paper_column*> (unsmob_grob (ly_car (s)));
515 if (Item::breakable_b (c) && !c->system_)
526 Return all columns, but filter out any unused columns , since they might
527 disrupt the spacing problem.
530 System::columns ()const
533 = Pointer_group_interface__extract_grobs (this, (Grob*) 0, "columns");
535 for (int i= acs.size (); i -- ;)
537 bool brb = Item::breakable_b (acs[i]);
538 bfound = bfound || brb;
541 the last column should be breakable. Weed out any columns that
542 seem empty. We need to retain breakable columns, in case
543 someone forced a breakpoint.
545 if (!bfound || !Paper_column::used_b (acs[i]))
554 ADD_INTERFACE (System,"system-interface",
555 "Super grob, parent of all: "
557 "The columns of a score that form one line. The toplevel grob. Any "
558 "grob has a Line_of_score as both X and Y reference point. The "
559 "Paper_score contains one grob of this type. Control enters the "
560 "Grob dependency calculation from this single Line_of_score "
562 "between-system-string all-elements columns");