2 score-engraver.cc -- implement Score_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 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);
53 i1.grob_ = command_column_;
54 i1.origin_trans_ = this;
59 i2.grob_ = musical_column_;
60 i2.origin_trans_ = this;
67 Score_engraver::prepare (Moment w)
69 Global_translator::prepare (w);
72 TODO: don't make columns when skipTypesetting is true.
76 command_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
77 musical_column_->set_grob_property ("when", now_mom_.smobbed_copy ());
80 Translator_group::start_translation_timestep();
84 Score_engraver::finish ()
87 progress_indication ("[" + to_string (breaks_) + "]");
98 Score_engraver::initialize ()
100 Font_metric *fm = all_fonts_global->find_afm("feta20");
102 error (_f ("can't find `%s'", "feta20.afm")
103 + "\n" +_ ("Fonts have not been installed properly. Aborting"));
105 unsmob_translator_def (definition_)->apply_property_operations (this);
107 assert (dynamic_cast<Paper_def *> (output_def_));
108 assert (!daddy_trans_);
109 pscore_ = new Paper_score;
110 pscore_->paper_ = dynamic_cast<Paper_def*> (output_def_);
112 SCM props = get_property ("System");
114 pscore_->typeset_line (new System (props));
117 system_ = pscore_->system_;
118 system_->set_bound (LEFT, command_column_);
119 command_column_->set_grob_property ("breakable", SCM_BOOL_T);
121 Engraver_group_engraver::initialize ();
126 Score_engraver::finalize ()
128 Engraver_group_engraver::finalize ();
131 = unsmob_grob (get_property ("currentCommandColumn"));
132 system_->set_bound (RIGHT, cc);
133 cc->set_grob_property ("breakable", SCM_BOOL_T);
139 Score_engraver::one_time_step ()
141 if (!to_boolean (get_property ("skipTypesetting")))
147 stop_translation_timestep ();
149 apply_finalizations ();
153 for (int i = announce_infos_.size(); i--;)
155 Grob *g = announce_infos_[i].grob_;
156 if (!dynamic_cast<Paper_column*> (g)) // ugh.
161 + " was created too late!";
162 g->programming_error (msg);
165 announce_infos_.clear ();
169 Score_engraver::announce_grob (Grob_info info)
171 announce_infos_.push (info);
172 pscore_->system_->typeset_grob (info.grob_);
176 Score_engraver::typeset_grob (Grob *elem)
179 programming_error ("Score_engraver: empty elt\n");
185 Score_engraver::typeset_all ()
187 for (int i =0; i < elems_.size (); i++)
189 Grob * elem = elems_[i];
191 if (Spanner *s = dynamic_cast <Spanner *> (elem))
194 do something sensible if spanner not
199 if (!s->get_bound (d))
201 s->set_bound (d, command_column_);
202 /* don't warn for empty/suicided spanners,
203 it makes real warningsinvisible.
204 maybe should be junked earlier? */
208 elem->warning (_f ("unbound spanner `%s'", s->name ().to_str0 ()));
211 while (flip (&d) != LEFT);
213 if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
214 programming_error ("Spanner Y-parent is an item.");
218 if (!elem->get_parent (X_AXIS))
220 bool br = to_boolean (elem->get_grob_property ("breakable"));
221 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
225 if (!elem->get_parent (Y_AXIS))
226 Axis_group_interface::add_element (system_, elem);
232 Score_engraver::stop_translation_timestep ()
234 // this generates all items.
235 Engraver_group_engraver::stop_translation_timestep ();
238 if (to_boolean (command_column_->get_grob_property ("breakable")))
242 progress_indication ("[" + to_string (breaks_) + "]");
246 system_->add_column (command_column_);
247 system_->add_column (musical_column_);
254 Score_engraver::set_columns (Paper_column *new_command,
255 Paper_column *new_musical)
257 assert (!command_column_ && !musical_column_);
259 command_column_ = new_command;
260 musical_column_ = new_musical;
263 set_property ("currentCommandColumn", new_command->self_scm ());
268 set_property ("currentMusicalColumn", new_musical->self_scm ());
273 Score_engraver::get_output ()
275 Music_output * o = pscore_;
281 Score_engraver::try_music (Music*r)
283 bool gotcha = Engraver_group_engraver::try_music (r);
285 if (!gotcha && r->is_mus_type ("break-event"))
289 SCM pen = command_column_->get_grob_property ("penalty");
290 Real total_penalty = gh_number_p (pen)
291 ? gh_scm2double (pen)
294 SCM rpen = r->get_mus_property ("penalty");
295 if (gh_number_p (rpen))
296 total_penalty += gh_scm2double (rpen);
298 if (total_penalty > 10000.0) // ugh. arbitrary.
301 command_column_->set_grob_property ("penalty",
302 gh_double2scm (total_penalty));
308 TODO: use property Score.breakForbidden = #t
311 Score_engraver::forbid_breaks ()
317 command_column_->set_grob_property ("breakable", SCM_EOL);
321 Score_engraver::acknowledge_grob (Grob_info gi)
323 if (Staff_spacing::has_interface (gi.grob_))
325 Pointer_group_interface::add_grob (command_column_,
326 ly_symbol2scm ("spacing-wishes"),
329 if (Note_spacing::has_interface (gi.grob_))
331 Pointer_group_interface::add_grob (musical_column_,
332 ly_symbol2scm ("spacing-wishes"),
339 ENTER_DESCRIPTION(Score_engraver,
340 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System) "
342 "This engraver decides whether a column is breakable. The default is "
343 "that a column is always breakable. However, when every Bar_engraver "
344 "that does not have a barline at a certain point will call "
345 "Score_engraver::forbid_breaks to stop linebreaks. In practice, this "
346 "means that you can make a breakpoint by creating a barline (assuming "
347 "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",