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>
13 #include "score-engraver.hh"
14 #include "paper-score.hh"
15 #include "paper-column.hh"
16 #include "command-request.hh"
17 #include "paper-def.hh"
18 #include "axis-group-interface.hh"
19 #include "translator-def.hh"
21 #include "staff-spacing.hh"
22 #include "note-spacing.hh"
25 TODO: the column creation logic is rather hairy. Revise it.
27 Score_engraver::Score_engraver ()
37 Score_engraver::make_columns ()
42 if (!command_column_l_)
44 set_columns (new Paper_column (get_property ("NonMusicalPaperColumn")),
45 new Paper_column (get_property ("PaperColumn")));
47 command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
49 Grob_info i1 (command_column_l_);
50 i1.origin_trans_l_ = this;
52 Grob_info i2 (musical_column_l_);
53 i2.origin_trans_l_ = this;
61 Score_engraver::prepare (Moment w)
63 Global_translator::prepare (w);
67 command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
68 musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
70 start_translation_timestep ();
74 Score_engraver::finish ()
77 progress_indication ("[" + to_str (breaks_i_) + "]");
80 removal_processing ();
88 Score_engraver::initialize ()
90 unsmob_translator_def (definition_)->apply_property_operations (this);
92 assert (dynamic_cast<Paper_def *> (output_def_l_));
93 assert (!daddy_trans_l_);
94 pscore_p_ = new Paper_score;
95 pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
97 SCM props = get_property ("System");
99 pscore_p_->typeset_line (new System (props));
102 scoreline_l_ = pscore_p_->line_l_;
103 scoreline_l_->set_bound (LEFT, command_column_l_);
104 command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
106 Engraver_group_engraver::initialize ();
111 Score_engraver::finalize ()
113 Engraver_group_engraver::finalize ();
116 = unsmob_grob (get_property ("currentCommandColumn"));
117 scoreline_l_->set_bound (RIGHT, cc);
118 cc->set_grob_property ("breakable", SCM_BOOL_T);
124 Score_engraver::one_time_step ()
126 if (!to_boolean (get_property ("skipTypesetting")))
132 stop_translation_timestep ();
137 Score_engraver::announce_grob (Grob_info info)
139 announce_info_arr_.push (info);
140 pscore_p_->line_l_->typeset_grob (info.grob_l_);
147 Score_engraver::typeset_grob (Grob *elem_p)
150 programming_error ("Score_engraver: empty elt\n");
153 elem_p_arr_.push (elem_p);
158 Score_engraver::typeset_all ()
160 for (int i =0; i < elem_p_arr_.size (); i++)
162 Grob * elem_p = elem_p_arr_[i];
164 if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
167 do something sensible if spanner not
172 if (!s->get_bound (d))
174 s->set_bound (d, command_column_l_);
175 /* don't warn for empty/suicided spanners,
176 it makes real warningsinvisible.
177 maybe should be junked earlier? */
178 if (elem_p->immutable_property_alist_ == SCM_EOL)
181 elem_p->warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
184 while (flip (&d) != LEFT);
186 if (dynamic_cast<Item*> (s->get_parent (Y_AXIS)))
187 programming_error ("Spanner Y-parent is an item.");
191 if (!elem_p->get_parent (X_AXIS))
193 bool br = to_boolean (elem_p->get_grob_property ("breakable"));
194 Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
198 if (!elem_p->get_parent (Y_AXIS))
199 Axis_group_interface::add_element (scoreline_l_, elem_p);
201 elem_p_arr_.clear ();
205 Score_engraver::stop_translation_timestep ()
207 // this generates all items.
208 Engraver_group_engraver::stop_translation_timestep ();
211 if (to_boolean (command_column_l_->get_grob_property ("breakable")))
215 progress_indication ("[" + to_str (breaks_i_) + "]");
219 scoreline_l_->add_column (command_column_l_);
220 scoreline_l_->add_column (musical_column_l_);
222 command_column_l_ = 0;
223 musical_column_l_ = 0;
227 Score_engraver::set_columns (Paper_column *new_command_l,
228 Paper_column *new_musical_l)
230 assert (!command_column_l_ && !musical_column_l_);
232 command_column_l_ = new_command_l;
233 musical_column_l_ = new_musical_l;
236 set_property ("currentCommandColumn", new_command_l->self_scm ());
241 set_property ("currentMusicalColumn", new_musical_l->self_scm ());
246 Score_engraver::get_output_p ()
248 Music_output * o = pscore_p_;
254 Score_engraver::try_music (Music*r)
256 bool gotcha = Engraver_group_engraver::try_music (r);
260 if (Break_req* b = dynamic_cast<Break_req *> (r))
265 SCM pen = command_column_l_->get_grob_property ("penalty");
266 Real total_penalty = gh_number_p (pen)
267 ? gh_scm2double (pen)
270 SCM rpen = b->get_mus_property ("penalty");
271 if (gh_number_p (rpen))
272 total_penalty += gh_scm2double (rpen);
274 if (total_penalty > 10000.0) // ugh. arbitrary.
277 command_column_l_->set_grob_property ("penalty",
278 gh_double2scm (total_penalty));
285 TODO: use property Score.breakForbidden = #t
288 Score_engraver::forbid_breaks ()
293 command_column_l_->remove_grob_property ("breakable");
297 Score_engraver::acknowledge_grob (Grob_info gi)
299 if (Staff_spacing::has_interface (gi.grob_l_))
301 Pointer_group_interface::add_grob (command_column_l_,
302 ly_symbol2scm ("spacing-wishes"),
305 if (Note_spacing::has_interface (gi.grob_l_))
307 Pointer_group_interface::add_grob (musical_column_l_,
308 ly_symbol2scm ("spacing-wishes"),
315 ENTER_DESCRIPTION(Score_engraver,
316 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. System)
319 This engraver decides whether a column is breakable. The default is
320 that a column is always breakable. However, when every Bar_engraver
321 that does not have a barline at a certain point will call
322 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
323 means that you can make a breakpoint by creating a barline (assuming
324 that there are no beams or notes that prevent a breakpoint.)
328 /* creats*/ "System PaperColumn NonMusicalPaperColumn",
329 /* acks */ "note-spacing-interface staff-spacing-interface",
330 /* reads */ "currentMusicalColumn currentCommandColumn",