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>
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_);
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);
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")))
128 stop_translation_timestep ();
133 Score_engraver::announce_grob (Grob_info info)
135 announce_info_arr_.push (info);
136 pscore_p_->line_l_->typeset_grob (info.grob_l_);
143 Score_engraver::typeset_grob (Grob *elem_p)
146 programming_error ("Score_engraver: empty elt\n");
149 elem_p_arr_.push (elem_p);
154 Score_engraver::typeset_all ()
156 for (int i =0; i < elem_p_arr_.size (); i++)
158 Grob * elem_p = elem_p_arr_[i];
160 if (Spanner *s = dynamic_cast <Spanner *> (elem_p))
163 do something sensible if spanner not
168 if (!s->get_bound (d))
170 s->set_bound (d, command_column_l_);
171 /* don't warn for empty/suicided spanners,
172 it makes real warningsinvisible.
173 maybe should be junked earlier? */
174 if (elem_p->immutable_property_alist_ == SCM_EOL)
177 ::warning (_f ("unbound spanner `%s'", s->name ().ch_C ()));
179 } while (flip (&d) != LEFT);
183 if (!elem_p->get_parent (X_AXIS))
185 bool br = to_boolean (elem_p->get_grob_property ("breakable"));
186 Axis_group_interface::add_element (br ? command_column_l_ : musical_column_l_, elem_p);
190 if (!elem_p->get_parent (Y_AXIS))
191 Axis_group_interface::add_element (scoreline_l_, elem_p);
193 elem_p_arr_.clear ();
197 Score_engraver::stop_translation_timestep ()
199 // this generates all items.
200 Engraver_group_engraver::stop_translation_timestep ();
203 if (to_boolean (command_column_l_->get_grob_property ("breakable")))
207 progress_indication ("[" + to_str (breaks_i_) + "]");
210 command_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
211 musical_column_l_->set_grob_property ("when", now_mom_.smobbed_copy ());
213 scoreline_l_->add_column (command_column_l_);
214 scoreline_l_->add_column (musical_column_l_);
216 command_column_l_ = 0;
217 musical_column_l_ = 0;
221 Score_engraver::set_columns (Paper_column *new_command_l,
222 Paper_column *new_musical_l)
224 assert (!command_column_l_ && !musical_column_l_);
225 command_column_l_ = new_command_l;
226 musical_column_l_ = new_musical_l;
229 set_property ("currentMusicalColumn", new_musical_l->self_scm ());
231 set_property ("currentCommandColumn", new_command_l->self_scm ());
235 Score_engraver::get_output_p ()
237 Music_output * o = pscore_p_;
243 Score_engraver::try_music (Music*r)
245 bool gotcha = Engraver_group_engraver::try_music (r);
249 if (Break_req* b = dynamic_cast<Break_req *> (r))
254 SCM pen = command_column_l_->get_grob_property ("penalty");
255 Real total_penalty = gh_number_p (pen)
256 ? gh_scm2double (pen)
259 SCM rpen = b->get_mus_property ("penalty");
260 if (gh_number_p (rpen))
261 total_penalty += gh_scm2double (rpen);
263 if (total_penalty > 10000.0) // ugh. arbitrary.
266 command_column_l_->set_grob_property ("penalty",
267 gh_double2scm (total_penalty));
274 TODO: use property Score.breakForbidden = #t
278 Score_engraver::forbid_breaks ()
283 command_column_l_->remove_grob_property ("breakable");
287 Score_engraver::acknowledge_grob (Grob_info gi)
289 if (Staff_spacing::has_interface (gi.grob_l_))
291 Pointer_group_interface::add_grob (command_column_l_,
292 ly_symbol2scm ("spacing-wishes"),
295 if (Note_spacing::has_interface (gi.grob_l_))
297 Pointer_group_interface::add_grob (musical_column_l_,
298 ly_symbol2scm ("spacing-wishes"),
305 ENTER_DESCRIPTION(Score_engraver,
306 /* descr */ "Top level engraver. Takes care of generating columns and the complete system (ie. LineOfScore)
309 This engraver decides whether a column is breakable. The default is
310 that a column is always breakable. However, when every Bar_engraver
311 that does not have a barline at a certain point will call
312 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
313 means that you can make a breakpoint by creating a barline (assuming
314 that there are no beams or notes that prevent a breakpoint.)
318 /* creats*/ "LineOfScore PaperColumn NonMusicalPaperColumn",
319 /* acks */ "note-spacing-interface staff-spacing-interface",
320 /* reads */ "currentMusicalColumn currentCommandColumn",