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"
18 #include "command-request.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 ()
44 if (!command_column_l_)
46 set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
47 new Paper_column (get_property ("PaperColumn")));
49 command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
52 Grob_info i1 (command_column_l_);
53 i1.origin_trans_l_ = this;
55 Grob_info i2 (musical_column_l_);
56 i2.origin_trans_l_ = 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_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
77 musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
80 Translator_group::start_translation_timestep();
84 Score_engraver::finish ()
87 progress_indication ("[" + to_str (breaks_i_) + "]");
90 removal_processing ();
98 Score_engraver::initialize ()
101 all_fonts_global_p->find_afm("feta20");
103 error (_("Could not find feta20.afm. Fonts have not been installed properly; Aborting"));
105 unsmob_translator_def (definition_)->apply_property_operations (this);
107 assert (dynamic_cast<Paper_def *> (output_def_l_));
108 assert (!daddy_trans_l_);
109 pscore_p_ = new Paper_score;
110 pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
112 SCM props = get_property ("System");
114 pscore_p_->typeset_line (new System (props));
117 scoreline_l_ = pscore_p_->line_l_;
118 scoreline_l_->set_bound (LEFT, command_column_l_);
119 command_column_l_->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 scoreline_l_->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 ();
151 for (int i = announce_info_arr_.size(); i--;)
153 Grob *g = announce_info_arr_[i].grob_l_;
154 if (!dynamic_cast<Paper_column*> (g)) // ugh.
159 + " was created too late!";
160 g->programming_error (msg);
163 announce_info_arr_.clear ();
167 Score_engraver::announce_grob (Grob_info info)
169 announce_info_arr_.push (info);
170 pscore_p_->line_l_->typeset_grob (info.grob_l_);
174 Score_engraver::typeset_grob (Grob *elem_p)
177 programming_error ("Score_engraver: empty elt\n");
180 elem_p_arr_.push (elem_p);
184 Score_engraver::typeset_all ()
186 for (int i =0; i < elem_p_arr_.size (); i++)
188 Grob * elem_p = elem_p_arr_[i];
190 if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
193 do something sensible if spanner not
198 if (!s->get_bound (d))
200 s->set_bound (d, command_column_l_);
201 /* don't warn for empty/suicided spanners,
202 it makes real warningsinvisible.
203 maybe should be junked earlier? */
207 elem_p->warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
210 while (flip (&d) != LEFT);
212 if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
213 programming_error ("Spanner Y-parent is an item.");
217 if (!elem_p->get_parent (X_AXIS))
219 bool br = to_boolean (elem_p->get_grob_property ("breakable"));
220 Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
224 if (!elem_p->get_parent (Y_AXIS))
225 Axis_group_interface::add_element (scoreline_l_, elem_p);
227 elem_p_arr_.clear ();
231 Score_engraver::stop_translation_timestep ()
233 // this generates all items.
234 Engraver_group_engraver::stop_translation_timestep ();
237 if (to_boolean (command_column_l_->get_grob_property ("breakable")))
241 progress_indication ("[" + to_str (breaks_i_) + "]");
245 scoreline_l_->add_column (command_column_l_);
246 scoreline_l_->add_column (musical_column_l_);
248 command_column_l_ = 0;
249 musical_column_l_ = 0;
253 Score_engraver::set_columns (Paper_column *new_command_l,
254 Paper_column *new_musical_l)
256 assert (!command_column_l_ && !musical_column_l_);
258 command_column_l_ = new_command_l;
259 musical_column_l_ = new_musical_l;
262 set_property ("currentCommandColumn", new_command_l->self_scm ());
267 set_property ("currentMusicalColumn", new_musical_l->self_scm ());
272 Score_engraver::get_output_p ()
274 Music_output * o = pscore_p_;
280 Score_engraver::try_music (Music*r)
282 bool gotcha = Engraver_group_engraver::try_music (r);
286 if (Break_req* b = dynamic_cast<Break_req *> (r))
291 SCM pen = command_column_l_->get_grob_property ("penalty");
292 Real total_penalty = gh_number_p (pen)
293 ? gh_scm2double (pen)
296 SCM rpen = b->get_mus_property ("penalty");
297 if (gh_number_p (rpen))
298 total_penalty += gh_scm2double (rpen);
300 if (total_penalty > 10000.0) // ugh. arbitrary.
303 command_column_l_->set_grob_property ("penalty",
304 gh_double2scm (total_penalty));
311 TODO: use property Score.breakForbidden = #t
314 Score_engraver::forbid_breaks ()
319 if (command_column_l_)
320 command_column_l_->remove_grob_property ("breakable");
324 Score_engraver::acknowledge_grob (Grob_info gi)
326 if (Staff_spacing::has_interface (gi.grob_l_))
328 Pointer_group_interface::add_grob (command_column_l_,
329 ly_symbol2scm ("spacing-wishes"),
332 if (Note_spacing::has_interface (gi.grob_l_))
334 Pointer_group_interface::add_grob (musical_column_l_,
335 ly_symbol2scm ("spacing-wishes"),
342 ENTER_DESCRIPTION(Score_engraver,
343 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System)
346 This engraver decides whether a column is breakable. The default is
347 that a column is always breakable. However, when every Bar_engraver
348 that does not have a barline at a certain point will call
349 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
350 means that you can make a breakpoint by creating a barline (assuming
351 that there are no beams or notes that prevent a breakpoint.)
355 /* creats*/ "System PaperColumn NonMusicalPaperColumn",
356 /* acks */ "note-spacing-interface staff-spacing-interface",
357 /* reads */ "currentMusicalColumn currentCommandColumn",