2 score-engraver.cc -- implement Score_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "all-font-metrics.hh"
15 #include "score-engraver.hh"
16 #include "paper-score.hh"
17 #include "paper-column.hh"
19 #include "paper-def.hh"
20 #include "axis-group-interface.hh"
21 #include "translator-def.hh"
23 #include "staff-spacing.hh"
24 #include "note-spacing.hh"
27 TODO: the column creation logic is rather hairy. Revise it.
29 Score_engraver::Score_engraver ()
39 Score_engraver::make_columns ()
46 set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
47 new Paper_column (get_property ("PaperColumn")));
49 command_column_->set_grob_property ("breakable", SCM_BOOL_T);
52 Grob_info i1 (command_column_);
53 i1.origin_trans_ = this;
55 Grob_info i2 (musical_column_);
56 i2.origin_trans_ = this;
64 Score_engraver::prepare (Moment w)
66 Global_translator::prepare (w);
69 TODO: don't make columns when skipTypesetting is true.
73 command_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
74 musical_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
77 Translator_group::start_translation_timestep();
81 Score_engraver::finish ()
84 progress_indication ("[" + to_string (breaks_) + "]");
87 removal_processing ();
95 Score_engraver::initialize ()
97 Font_metric *fm = all_fonts_global->find_afm("feta20");
99 error (_f ("can't find `%s'", "feta20.afm")
100 + "\n" +_ ("Fonts have not been installed properly. Aborting"));
102 unsmob_translator_def (definition_)->apply_property_operations (this);
104 assert (dynamic_cast<Paper_def *> (output_def_));
105 assert (!daddy_trans_);
106 pscore_ = new Paper_score;
107 pscore_->paper_ = dynamic_cast<Paper_def*> (output_def_);
109 SCM props = get_property ("System");
111 pscore_->typeset_line (new System (props));
114 system_ = pscore_->system_;
115 system_->set_bound (LEFT, command_column_);
116 command_column_->set_grob_property ("breakable", SCM_BOOL_T);
118 Engraver_group_engraver::initialize ();
123 Score_engraver::finalize ()
125 Engraver_group_engraver::finalize ();
128 = unsmob_grob (get_property ("currentCommandColumn"));
129 system_->set_bound (RIGHT, cc);
130 cc->set_grob_property ("breakable", SCM_BOOL_T);
136 Score_engraver::one_time_step ()
138 if (!to_boolean (get_property ("skipTypesetting")))
144 stop_translation_timestep ();
146 apply_finalizations ();
150 for (int i = announce_infos_.size(); i--;)
152 Grob *g = announce_infos_[i].grob_;
153 if (!dynamic_cast<Paper_column*> (g)) // ugh.
158 + " was created too late!";
159 g->programming_error (msg);
162 announce_infos_.clear ();
166 Score_engraver::announce_grob (Grob_info info)
168 announce_infos_.push (info);
169 pscore_->system_->typeset_grob (info.grob_);
173 Score_engraver::typeset_grob (Grob *elem)
176 programming_error ("Score_engraver: empty elt\n");
182 Score_engraver::typeset_all ()
184 for (int i =0; i < elems_.size (); i++)
186 Grob * elem = elems_[i];
188 if (Spanner *s = dynamic_cast <Spanner *> (elem))
191 do something sensible if spanner not
196 if (!s->get_bound (d))
198 s->set_bound (d, command_column_);
199 /* don't warn for empty/suicided spanners,
200 it makes real warningsinvisible.
201 maybe should be junked earlier? */
205 elem->warning (_f ("unbound spanner `%s'", s->name ().to_str0 ()));
208 while (flip (&d) != LEFT);
210 if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
211 programming_error ("Spanner Y-parent is an item.");
215 if (!elem->get_parent (X_AXIS))
217 bool br = to_boolean (elem->get_grob_property ("breakable"));
218 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
222 if (!elem->get_parent (Y_AXIS))
223 Axis_group_interface::add_element (system_, elem);
229 Score_engraver::stop_translation_timestep ()
231 // this generates all items.
232 Engraver_group_engraver::stop_translation_timestep ();
235 if (to_boolean (command_column_->get_grob_property ("breakable")))
239 progress_indication ("[" + to_string (breaks_) + "]");
243 system_->add_column (command_column_);
244 system_->add_column (musical_column_);
251 Score_engraver::set_columns (Paper_column *new_command,
252 Paper_column *new_musical)
254 assert (!command_column_ && !musical_column_);
256 command_column_ = new_command;
257 musical_column_ = new_musical;
260 set_property ("currentCommandColumn", new_command->self_scm ());
265 set_property ("currentMusicalColumn", new_musical->self_scm ());
270 Score_engraver::get_output ()
272 Music_output * o = pscore_;
278 Score_engraver::try_music (Music*r)
280 bool gotcha = Engraver_group_engraver::try_music (r);
282 if (!gotcha && r->is_mus_type ("break-event"))
286 SCM pen = command_column_->get_grob_property ("penalty");
287 Real total_penalty = gh_number_p (pen)
288 ? gh_scm2double (pen)
291 SCM rpen = r->get_mus_property ("penalty");
292 if (gh_number_p (rpen))
293 total_penalty += gh_scm2double (rpen);
295 if (total_penalty > 10000.0) // ugh. arbitrary.
298 command_column_->set_grob_property ("penalty",
299 gh_double2scm (total_penalty));
305 TODO: use property Score.breakForbidden = #t
308 Score_engraver::forbid_breaks ()
314 command_column_->set_grob_property ("breakable", SCM_EOL);
318 Score_engraver::acknowledge_grob (Grob_info gi)
320 if (Staff_spacing::has_interface (gi.grob_))
322 Pointer_group_interface::add_grob (command_column_,
323 ly_symbol2scm ("spacing-wishes"),
326 if (Note_spacing::has_interface (gi.grob_))
328 Pointer_group_interface::add_grob (musical_column_,
329 ly_symbol2scm ("spacing-wishes"),
336 ENTER_DESCRIPTION(Score_engraver,
337 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System)
340 This engraver decides whether a column is breakable. The default is
341 that a column is always breakable. However, when every Bar_engraver
342 that does not have a barline at a certain point will call
343 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
344 means that you can make a breakpoint by creating a barline (assuming
345 that there are no beams or notes that prevent a breakpoint.)
349 /* creats*/ "System PaperColumn NonMusicalPaperColumn",
350 /* accepts */ "break-event",
351 /* acks */ "note-spacing-interface staff-spacing-interface",
352 /* reads */ "currentMusicalColumn currentCommandColumn",