2 score-engraver.cc -- implement Score_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
11 #include "line-of-score.hh"
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_, SCM_EOL);
50 i1.origin_trans_l_ = this;
52 Grob_info i2 (musical_column_l_, SCM_EOL);
53 i2.origin_trans_l_ = this;
61 Score_engraver::prepare (Moment w)
63 Global_translator::prepare (w);
66 start_translation_timestep ();
70 Score_engraver::finish ()
73 progress_indication ("[" + to_str (breaks_i_) + "]");
76 removal_processing ();
84 Score_engraver::initialize ()
86 unsmob_translator_def (definition_)->apply_property_operations (this);
88 assert (dynamic_cast<Paper_def *> (output_def_l_));
89 assert (!daddy_trans_l_);
90 pscore_p_ = new Paper_score;
91 pscore_p_->paper_l_ = dynamic_cast<Paper_def*> (output_def_l_);
93 SCM props = get_property ("LineOfScore");
95 pscore_p_->typeset_line (new Line_of_score (props));
98 scoreline_l_ = pscore_p_->line_l_;
99 scoreline_l_->set_bound (LEFT, command_column_l_);
100 command_column_l_->set_grob_property ("breakable", SCM_BOOL_T);
102 Engraver_group_engraver::initialize ();
107 Score_engraver::finalize ()
109 Engraver_group_engraver::finalize ();
112 = unsmob_grob (get_property ("currentCommandColumn"));
113 scoreline_l_->set_bound (RIGHT, cc);
114 cc->set_grob_property ("breakable", SCM_BOOL_T);
120 Score_engraver::one_time_step ()
122 if (!to_boolean (get_property ("skipTypesetting")))
129 stop_translation_timestep ();
134 Score_engraver::announce_grob (Grob_info info)
136 announce_info_arr_.push (info);
137 pscore_p_->line_l_->typeset_grob (info.grob_l_);
144 Score_engraver::typeset_grob (Grob *elem_p)
147 programming_error ("Score_engraver: empty elt\n");
150 elem_p_arr_.push (elem_p);
155 Score_engraver::typeset_all ()
157 for (int i =0; i < elem_p_arr_.size (); i++)
159 Grob * elem_p = elem_p_arr_[i];
161 if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
164 do something sensible if spanner not
169 if (!s->get_bound (d))
171 s->set_bound (d, command_column_l_);
172 /* don't warn for empty/suicided spanners,
173 it makes real warningsinvisible.
174 maybe should be junked earlier? */
175 if (elem_p->immutable_property_alist_ == SCM_EOL)
178 ::warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
180 } while (flip (&d) != LEFT);
184 if (!elem_p->get_parent (X_AXIS))
186 bool br = to_boolean (elem_p->get_grob_property ("breakable"));
187 Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
191 if (!elem_p->get_parent (Y_AXIS))
192 Axis_group_interface::add_element (scoreline_l_, elem_p);
194 elem_p_arr_.clear ();
198 Score_engraver::stop_translation_timestep ()
200 // this generates all items.
201 Engraver_group_engraver::stop_translation_timestep ();
204 if (to_boolean (command_column_l_->get_grob_property ("breakable")))
208 progress_indication ("[" + to_str (breaks_i_) + "]");
211 command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
212 musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
214 scoreline_l_->add_column (command_column_l_);
215 scoreline_l_->add_column (musical_column_l_);
217 command_column_l_ = 0;
218 musical_column_l_ = 0;
222 Score_engraver::set_columns (Paper_column *new_command_l,
223 Paper_column *new_musical_l)
225 assert (!command_column_l_ && !musical_column_l_);
226 command_column_l_ = new_command_l;
227 musical_column_l_ = new_musical_l;
230 set_property ("currentMusicalColumn", new_musical_l->self_scm ());
232 set_property ("currentCommandColumn", new_command_l->self_scm ());
236 Score_engraver::get_output_p ()
238 Music_output * o = pscore_p_;
244 Score_engraver::try_music (Music*r)
246 bool gotcha = Engraver_group_engraver::try_music (r);
250 if (Break_req* b = dynamic_cast<Break_req *> (r))
255 SCM pen = command_column_l_->get_grob_property ("penalty");
256 Real total_penalty = gh_number_p (pen)
257 ? gh_scm2double (pen)
260 SCM rpen = b->get_mus_property ("penalty");
261 if (gh_number_p (rpen))
262 total_penalty += gh_scm2double (rpen);
264 if (total_penalty > 10000.0) // ugh. arbitrary.
267 command_column_l_->set_grob_property ("penalty",
268 gh_double2scm (total_penalty));
275 TODO: use property Score.breakForbidden = #t
279 Score_engraver::forbid_breaks ()
284 command_column_l_->remove_grob_property ("breakable");
288 Score_engraver::acknowledge_grob (Grob_info gi)
290 if (Staff_spacing::has_interface (gi.grob_l_))
292 Pointer_group_interface::add_grob (command_column_l_,
293 ly_symbol2scm ("spacing-wishes"),
296 if (Note_spacing::has_interface (gi.grob_l_))
298 Pointer_group_interface::add_grob (musical_column_l_,
299 ly_symbol2scm ("spacing-wishes"),
306 ENTER_DESCRIPTION(Score_engraver,
307 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. LineOfScore)
310 This engraver decides whether a column is breakable. The default is
311 that a column is always breakable. However, when every Bar_engraver
312 that does not have a barline at a certain point will call
313 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
314 means that you can make a breakpoint by creating a barline (assuming
315 that there are no beams or notes that prevent a breakpoint.)
319 /* creats*/ "LineOfScore PaperColumn NonMusicalPaperColumn",
320 /* acks */ "note-spacing-interface staff-spacing-interface",
321 /* reads */ "currentMusicalColumn currentCommandColumn",