2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "dimensions.hh"
11 #include "musical-request.hh"
12 #include "paper-column.hh"
13 #include "note-column.hh"
15 #include "side-position-interface.hh"
16 #include "engraver.hh"
17 #include "group-interface.hh"
18 #include "directional-element-interface.hh"
19 #include "translator-group.hh"
20 #include "axis-group-interface.hh"
26 * direction of text-dynamic-request if not equal to direction of
29 - TODO: this engraver is too complicated. We should split it into
30 the handling of the basic grobs and the linespanner
32 - TODO: the line-spanner is not killed after the (de)crescs are
38 print text & hairpin dynamics.
40 class Dynamic_engraver : public Engraver
43 Spanner * finished_cresc_p_;
46 Text_script_req* script_req_l_;
48 Span_req * current_cresc_req_;
49 Drul_array<Span_req*> accepted_spanreqs_drul_;
51 Spanner* line_spanner_;
52 Spanner* finished_line_spanner_;
54 Link_array<Note_column> pending_column_arr_;
55 Link_array<Grob> pending_element_arr_;
60 VIRTUAL_COPY_CONS(Translator);
64 virtual void finalize ();
65 virtual void acknowledge_grob (Grob_info);
66 virtual bool try_music (Music *req_l);
67 virtual void stop_translation_timestep ();
68 virtual void process_music ();
69 virtual void start_translation_timestep ();
72 ADD_THIS_TRANSLATOR (Dynamic_engraver);
75 Dynamic_engraver::Dynamic_engraver ()
78 finished_cresc_p_ = 0;
80 finished_line_spanner_ = 0;
81 current_cresc_req_ = 0;
85 accepted_spanreqs_drul_[START] = 0;
86 accepted_spanreqs_drul_[STOP] = 0;
90 Dynamic_engraver::start_translation_timestep ()
93 accepted_spanreqs_drul_[START] = 0;
94 accepted_spanreqs_drul_[STOP] = 0;
98 Dynamic_engraver::try_music (Music * m)
100 if (dynamic_cast <Text_script_req*> (m)
101 && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic"))
103 script_req_l_ = dynamic_cast<Text_script_req*> (m);
106 else if (Span_req* s = dynamic_cast <Span_req*> (m))
108 String t = ly_scm2string (s->get_mus_property ("span-type"));
111 accepted_spanreqs_drul_[LEFT] = 0;
112 accepted_spanreqs_drul_[RIGHT] = 0;
114 line_spanner_->suicide ();
117 cresc_p_->suicide ();
120 else if (t == "crescendo"
121 || t == "decrescendo")
123 accepted_spanreqs_drul_[s->get_span_dir()] = s;
131 Dynamic_engraver::process_music ()
133 if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_)
137 line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
139 Side_position::set_axis (line_spanner_, Y_AXIS);
140 Axis_group_interface::set_interface (line_spanner_);
141 Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
143 Music * rq = accepted_spanreqs_drul_[START];
146 announce_grob (line_spanner_, rq);
153 During a (de)crescendo, pending request will not be cleared,
154 and a line-spanner will always be created, as \< \! are already
157 Note: line-spanner must always have at least same duration
158 as (de)crecsendo, b.o. line-breaking.
164 maybe we should leave dynamic texts to the text-engraver and
165 simply acknowledge them?
169 script_p_ = new Item (get_property ("DynamicText"));
170 script_p_->set_grob_property ("text",
171 script_req_l_->get_mus_property ("text"));
173 Side_position::set_direction (script_p_, LEFT);
174 Side_position::set_axis (script_p_, X_AXIS);
176 if (Direction d = script_req_l_->get_direction ())
177 Directional_element_interface::set (line_spanner_, d);
179 Axis_group_interface::add_element (line_spanner_, script_p_);
181 announce_grob (script_p_, script_req_l_);
184 if (accepted_spanreqs_drul_[STOP])
187 finish side position alignment if the (de)cresc ends here, and
188 there are no new dynamics.
193 accepted_spanreqs_drul_[STOP]->origin ()->warning
194 (_ ("can't find start of (de)crescendo"));
195 accepted_spanreqs_drul_[STOP] = 0;
199 assert (!finished_cresc_p_ && cresc_p_);
201 cresc_p_->set_bound (RIGHT, script_p_
203 : unsmob_grob (get_property ("currentMusicalColumn")));
204 add_bound_item (line_spanner_, cresc_p_->get_bound (RIGHT));
207 finished_cresc_p_ = cresc_p_;
209 current_cresc_req_ = 0;
213 if (accepted_spanreqs_drul_[START])
215 if (current_cresc_req_)
217 accepted_spanreqs_drul_[START]->origin ()->warning
218 (current_cresc_req_->get_span_dir() == 1
219 ? _ ("already have a crescendo")
220 : _ ("already have a decrescendo"));
224 current_cresc_req_ = accepted_spanreqs_drul_[START];
230 String start_type = ly_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type"));
235 SCM s = get_property ((start_type + "Spanner").ch_C());
236 if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
238 cresc_p_ = new Spanner (get_property ("Hairpin"));
239 cresc_p_->set_grob_property ("grow-direction",
240 gh_int2scm ((start_type == "crescendo")
241 ? BIGGER : SMALLER));
245 This is a convenient (and legacy) interface to TextSpanners
246 for use in (de)crescendi.
251 cresc_p_ = new Spanner (get_property ("TextSpanner"));
252 cresc_p_->set_grob_property ("type", s);
254 daddy_trans_l_->set_property (start_type
255 + "Spanner", SCM_UNDEFINED);
256 s = get_property ((start_type + "Text").ch_C());
259 cresc_p_->set_grob_property ("edge-text",
260 gh_cons (s, ly_str02scm ("")));
261 daddy_trans_l_->set_property (start_type + "Text",
266 cresc_p_->set_bound (LEFT, script_p_
268 : unsmob_grob (get_property ("currentMusicalColumn")));
270 Axis_group_interface::add_element (line_spanner_, cresc_p_);
272 add_bound_item (line_spanner_, cresc_p_->get_bound (LEFT));
274 announce_grob (cresc_p_, accepted_spanreqs_drul_[START]);
280 Dynamic_engraver::stop_translation_timestep ()
283 if (script_req_l_ && !current_cresc_req_)
285 finished_line_spanner_ = line_spanner_;
292 Dynamic_engraver::finalize ()
297 finished_line_spanner_ = line_spanner_;
303 current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
304 cresc_p_->suicide ();
310 Dynamic_engraver::typeset_all ()
312 if (finished_cresc_p_)
314 if (!finished_cresc_p_->get_bound (RIGHT))
316 finished_cresc_p_->set_bound (RIGHT, script_p_
318 : unsmob_grob (get_property ("currentMusicalColumn")));
320 if (finished_line_spanner_)
321 add_bound_item (finished_line_spanner_,
322 finished_cresc_p_->get_bound (RIGHT));
324 typeset_grob (finished_cresc_p_);
325 finished_cresc_p_ =0;
330 typeset_grob (script_p_);
333 if (finished_line_spanner_)
336 To make sure that this works
338 Side_position::add_staff_support (finished_line_spanner_);
342 extend_spanner_over_elements (finished_line_spanner_);
344 but this is rather kludgy, since finished_line_spanner_
345 typically has a staff-symbol field set , extending it over the
350 if (!finished_line_spanner_->get_bound (RIGHT))
351 finished_line_spanner_->set_bound (RIGHT, finished_line_spanner_->get_bound (LEFT));
353 typeset_grob (finished_line_spanner_);
354 finished_line_spanner_ = 0;
359 Dynamic_engraver::acknowledge_grob (Grob_info i)
361 if (Note_column::has_interface (i.elem_l_))
365 Side_position::add_support (line_spanner_,i.elem_l_);
366 add_bound_item (line_spanner_,dynamic_cast<Item*>(i.elem_l_));