2 score-engraver.cc -- implement Score_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "all-font-metrics.hh"
14 #include "score-engraver.hh"
15 #include "paper-score.hh"
16 #include "paper-column.hh"
17 #include "output-def.hh"
18 #include "axis-group-interface.hh"
19 #include "context-def.hh"
20 #include "staff-spacing.hh"
21 #include "note-spacing.hh"
22 #include "global-context.hh"
25 TODO: the column creation logic is rather hairy. Revise it.
27 Score_engraver::Score_engraver ()
37 Score_engraver::make_columns ()
45 = updated_grob_properties (context (),
46 ly_symbol2scm ("NonMusicalPaperColumn"));
48 Object_key const *key1 = context()->get_grob_key ("NonMusicalPaperColumn");
50 SCM pc = updated_grob_properties (context (),
51 ly_symbol2scm ("PaperColumn"));
52 Object_key const *key2 = context()->get_grob_key ("PaperColumn");
53 set_columns (new Paper_column (nmp, key1), new Paper_column (pc, key2));
56 scm_gc_unprotect_object (key1->self_scm());
57 scm_gc_unprotect_object (key2->self_scm());
60 i1.grob_ = command_column_;
61 i1.origin_trans_ = this;
66 i2.grob_ = musical_column_;
67 i2.origin_trans_ = this;
74 Score_engraver::prepare (Moment m)
77 TODO: don't make columns when skipTypesetting is true.
81 SCM w = m.smobbed_copy ();
82 command_column_->set_property ("when", w);
83 musical_column_->set_property ("when", w);
85 recurse_over_translators (context (), &Translator::start_translation_timestep, DOWN);
89 Score_engraver::finish ()
92 progress_indication ("[" + to_string (breaks_) + "]");
94 recurse_over_translators (context (), &Translator::finalize, UP);
101 Score_engraver::initialize ()
103 Font_metric *fm = all_fonts_global->find_afm ("feta20");
105 error (_f ("cannot find `%s'", "feta20.afm")
107 + _ ("Music font has not been installed properly.")
110 if (!scm_is_string (ly_kpathsea_find_file (scm_makfrom0str ("ecrm10.pfa")))
111 && (!scm_is_string (ly_kpathsea_find_file (scm_makfrom0str ("lmr10.pfb")))))
112 error (_f ("cannot find `%s'", "ecrm10.pfa")
114 + _f ("cannot find `%s'", "lmr10.pfb")
116 + _f ("Install the ec-fonts-mftraced package from: %s.",
117 "http://lilypond.org/download/fonts/")
121 pscore_ = new Paper_score;
122 pscore_->layout_ = dynamic_cast<Output_def*> (get_output_def ());
124 SCM props = updated_grob_properties (context (), ly_symbol2scm ("System"));
126 Object_key const *sys_key = context()->get_grob_key ("System");
127 pscore_->typeset_line (new System (props, sys_key));
128 scm_gc_unprotect_object (sys_key->self_scm ());
131 system_ = pscore_->system_;
132 system_->set_bound (LEFT, command_column_);
133 command_column_->set_property ("breakable", SCM_BOOL_T);
135 Engraver_group_engraver::initialize ();
140 Score_engraver::finalize ()
142 Score_translator::finalize ();
145 = unsmob_grob (get_property ("currentCommandColumn"));
146 system_->set_bound (RIGHT, cc);
147 cc->set_property ("breakable", SCM_BOOL_T);
154 Score_engraver::one_time_step ()
156 if (!to_boolean (get_property ("skipTypesetting")))
158 recurse_over_translators (context (), &Engraver::process_music, UP);
159 Engraver_group_engraver::do_announces();
162 recurse_over_translators (context (), &Translator::stop_translation_timestep, UP);
166 Score_engraver::announce_grob (Grob_info info)
168 announce_infos_.push (info);
169 pscore_->system_->typeset_grob (info.grob_);
170 elems_.push (info.grob_);
175 Score_engraver::typeset_all ()
177 for (int i =0; i < elems_.size (); i++)
179 Grob * elem = elems_[i];
182 if (dynamic_cast<Item*> (elem))
184 if (!elem->get_parent (X_AXIS)
185 && elem != command_column_
186 && elem != musical_column_
189 bool br = to_boolean (elem->get_property ("breakable"));
190 Axis_group_interface::add_element (br ? command_column_ : musical_column_, elem);
194 if (!elem->get_parent (Y_AXIS))
195 Axis_group_interface::add_element (system_, elem);
201 Score_engraver::stop_translation_timestep ()
203 // this generates all items.
204 Engraver_group_engraver::stop_translation_timestep ();
207 if (to_boolean (command_column_->get_property ("breakable")))
211 progress_indication ("[" + to_string (breaks_) + "]");
215 system_->add_column (command_column_);
216 system_->add_column (musical_column_);
223 Score_engraver::set_columns (Paper_column *new_command,
224 Paper_column *new_musical)
226 assert (!command_column_ && !musical_column_);
228 command_column_ = new_command;
229 musical_column_ = new_musical;
232 context ()->set_property ("currentCommandColumn", new_command->self_scm ());
237 context ()->set_property ("currentMusicalColumn", new_musical->self_scm ());
242 Score_engraver::get_output ()
244 Music_output *o = pscore_;
245 ///FIXME WTF? pscore_ = 0;
250 Score_engraver::try_music (Music *m)
252 if (Engraver_group_engraver::try_music (m))
255 if (m->is_mus_type ("break-event"))
257 SCM pen = command_column_->get_property ("penalty");
258 Real total_penalty = scm_is_number (pen) ? scm_to_double (pen) : 0.0;
260 SCM mpen = m->get_property ("penalty");
261 if (scm_is_number (mpen))
262 total_penalty += scm_to_double (mpen);
264 command_column_->set_property ("penalty", scm_make_real (total_penalty));
266 /* ugh. arbitrary, hardcoded */
267 if (total_penalty > 10000.0)
270 SCM page_pen = command_column_->get_property ("page-penalty");
271 Real total_pp = scm_is_number (page_pen) ? scm_to_double (page_pen) : 0.0;
272 SCM mpage_pen = m->get_property ("page-penalty");
273 if (scm_is_number (mpage_pen))
274 total_pp += scm_to_double (mpage_pen);
276 command_column_->set_property ("page-penalty", scm_make_real (total_pp));
283 Score_engraver::forbid_breaks ()
286 command_column_->set_property ("breakable", SCM_EOL);
290 Score_engraver::acknowledge_grob (Grob_info gi)
292 if (Staff_spacing::has_interface (gi.grob_))
294 Pointer_group_interface::add_grob (command_column_,
295 ly_symbol2scm ("spacing-wishes"),
298 if (Note_spacing::has_interface (gi.grob_))
300 Pointer_group_interface::add_grob (musical_column_,
301 ly_symbol2scm ("spacing-wishes"),
305 if (Axis_group_interface::has_interface (gi.grob_)
306 && gi.grob_->internal_has_interface (ly_symbol2scm ("vertically-spaceable-interface")))
308 SCM spaceable = get_property ("verticallySpacedContexts");
309 Context *orig = gi.origin_contexts (this)[0];
311 if (scm_memq (ly_symbol2scm (orig->context_name ().to_str0()),
312 spaceable) != SCM_BOOL_F)
314 Pointer_group_interface::add_grob (system_,
315 ly_symbol2scm ("spaceable-staves"),
324 ENTER_DESCRIPTION (Score_engraver,
325 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System) "
327 "This engraver decides whether a column is breakable. The default is "
328 "that a column is always breakable. However, when every Bar_engraver "
329 "that does not have a barline at a certain point will call "
330 "Score_engraver::forbid_breaks to stop linebreaks. In practice, this "
331 "means that you can make a breakpoint by creating a barline (assuming "
332 "that there are no beams or notes that prevent a breakpoint.) "
334 /* creats*/ "System PaperColumn NonMusicalPaperColumn",
335 /* accepts */ "break-event",
336 /* acks */ "note-spacing-interface staff-spacing-interface axis-group-interface",
337 /* reads */ "currentMusicalColumn currentCommandColumn verticallySpacedContexts",