2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "axis-group-interface.hh"
11 #include "dimensions.hh"
12 #include "directional-element-interface.hh"
13 #include "engraver.hh"
15 #include "group-interface.hh"
17 #include "interval.hh"
20 #include "note-column.hh"
21 #include "paper-column.hh"
22 #include "script-interface.hh"
23 #include "side-position-interface.hh"
24 #include "staff-symbol-referencer.hh"
30 * direction of text-dynamic-event if not equal to direction of
33 - TODO: this engraver is too complicated. We should split it into
34 the handling of the basic grobs and the linespanner
36 - TODO: the line-spanner is not killed after the (de)crescs are
42 print text & hairpin dynamics.
44 class Dynamic_engraver : public Engraver
47 Spanner *line_spanner_;
51 Spanner *finished_line_spanner_;
52 Spanner *finished_cresc_;
55 Music *current_cresc_ev_;
57 Drul_array<Music*> accepted_spanreqs_drul_;
59 Link_array<Note_column> pending_columns_;
60 Link_array<Grob> pending_elements_;
64 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
67 virtual void finalize ();
68 virtual void acknowledge_grob (Grob_info);
69 virtual bool try_music (Music *req);
70 virtual void stop_translation_timestep ();
71 virtual void process_music ();
77 Dynamic_engraver::Dynamic_engraver ()
83 finished_line_spanner_ = 0;
84 current_cresc_ev_ = 0;
88 accepted_spanreqs_drul_[START] = 0;
89 accepted_spanreqs_drul_[STOP] = 0;
93 Dynamic_engraver::try_music (Music *m)
95 if (m->is_mus_type ("absolute-dynamic-event"))
98 TODO: probably broken.
103 else if (m->is_mus_type ("decrescendo-event")
104 || m->is_mus_type ("crescendo-event"))
106 Direction d = to_dir (m->get_property ("span-direction"));
108 accepted_spanreqs_drul_[d] = m;
109 if (current_cresc_ev_ && d == START)
110 accepted_spanreqs_drul_[STOP] = m;
117 Dynamic_engraver::process_music ()
119 if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_ev_)
123 Music * rq = accepted_spanreqs_drul_[START];
124 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm (): SCM_EOL );
132 During a (de)crescendo, pending event will not be cleared,
133 and a line-spanner will always be created, as \< \! are already
136 Note: line-spanner must always have at least same duration
137 as (de)crecsendo, b.o. line-breaking.
142 maybe we should leave dynamic texts to the text-engraver and
143 simply acknowledge them?
147 script_ = make_item ("DynamicText", script_ev_->self_scm ());
148 script_->set_property ("text",
149 script_ev_->get_property ("text"));
152 if (Direction d = to_dir (script_ev_->get_property ("direction")))
153 set_grob_direction (line_spanner_, d);
155 Axis_group_interface::add_element (line_spanner_, script_);
158 Music *stop_ev = accepted_spanreqs_drul_ [STOP] ?
159 accepted_spanreqs_drul_[STOP] : script_ev_;
161 if (accepted_spanreqs_drul_[STOP] || script_ev_)
164 finish side position alignment if the (de)cresc ends here, and
165 there are no new dynamics.
171 assert (!finished_cresc_ && cresc_);
173 cresc_->set_bound (RIGHT, script_
175 : unsmob_grob (get_property ("currentMusicalColumn")));
176 add_bound_item (line_spanner_, cresc_->get_bound (RIGHT));
179 finished_cresc_ = cresc_;
181 current_cresc_ev_ = 0;
183 else if (accepted_spanreqs_drul_[STOP])
185 accepted_spanreqs_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
191 if (accepted_spanreqs_drul_[START])
193 if (current_cresc_ev_)
195 String msg = _ ("already have a decrescendo");
196 if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
197 msg = _ ("already have a crescendo");
199 accepted_spanreqs_drul_[START]->origin ()->warning (msg);
200 current_cresc_ev_->origin ()->warning (_("Cresc started here"));
204 current_cresc_ev_ = accepted_spanreqs_drul_[START];
206 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
207 set_grob_direction (line_spanner_, d);
214 ly_symbol2string (current_cresc_ev_->get_property ("name"));
219 if (start_type == "DecrescendoEvent")
220 start_type = "decrescendo";
221 else if (start_type == "CrescendoEvent")
222 start_type = "crescendo";
224 SCM s = get_property ((start_type + "Spanner").to_str0 ());
225 if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
227 cresc_ = make_spanner ("Hairpin", accepted_spanreqs_drul_[START]->self_scm ());
230 Pointer_group_interface::add_grob (finished_cresc_,
231 ly_symbol2scm ("adjacent-hairpins"),
234 Pointer_group_interface::add_grob (cresc_,
235 ly_symbol2scm ("adjacent-hairpins"),
238 cresc_->set_property ("grow-direction",
239 scm_int2num ((start_type == "crescendo")
240 ? BIGGER : SMALLER));
246 This is a convenient (and legacy) interface to TextSpanners
247 for use in (de)crescendi.
252 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanreqs_drul_[START]->self_scm ());
253 cresc_->set_property ("style", s);
254 context ()->set_property ((start_type
255 + "Spanner").to_str0 (), SCM_EOL);
256 s = get_property ((start_type + "Text").to_str0 ());
258 FIXME: use get_markup () to check type.
260 if (scm_is_string (s) || ly_c_pair_p (s))
262 cresc_->set_property ("edge-text",
263 scm_cons (s, scm_makfrom0str ("")));
264 context ()->set_property ((start_type + "Text").to_str0 (),
271 cresc_->set_bound (LEFT, script_);
272 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
275 Axis_group_interface::add_element (line_spanner_, cresc_);
281 Dynamic_engraver::stop_translation_timestep ()
284 if (!current_cresc_ev_)
286 finished_line_spanner_ = line_spanner_;
291 if (cresc_ && !cresc_->get_bound (LEFT))
293 cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
294 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
298 accepted_spanreqs_drul_[START] = 0;
299 accepted_spanreqs_drul_[STOP] = 0;
303 Dynamic_engraver::finalize ()
308 && !line_spanner_->is_live ())
312 finished_line_spanner_ = line_spanner_;
317 && !cresc_->is_live ())
321 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
328 Dynamic_engraver::typeset_all ()
332 if (!finished_cresc_->get_bound (RIGHT))
334 finished_cresc_->set_bound (RIGHT, script_
336 : unsmob_grob (get_property ("currentMusicalColumn")));
338 if (finished_line_spanner_)
339 add_bound_item (finished_line_spanner_,
340 finished_cresc_->get_bound (RIGHT));
346 if (finished_line_spanner_)
351 extend-spanner-over-elements (finished_line_spanner_);
353 but this is rather kludgy, since finished_line_spanner_
354 typically has a staff-symbol field set , extending it over the
359 Grob * l = finished_line_spanner_->get_bound (LEFT);
360 Grob * r = finished_line_spanner_->get_bound (RIGHT);
362 finished_line_spanner_->set_bound (RIGHT, l);
364 finished_line_spanner_->set_bound (LEFT, r);
368 This is a isolated dynamic apparently, and does not even have
369 any interesting support item.
371 Grob * cc = unsmob_grob (get_property ("currentMusicalColumn"));
372 Item * ci = dynamic_cast<Item*>(cc);
373 finished_line_spanner_->set_bound (RIGHT, ci);
374 finished_line_spanner_->set_bound (LEFT, ci);
377 finished_line_spanner_ = 0;
382 Dynamic_engraver::acknowledge_grob (Grob_info info)
387 if (Note_column::has_interface (info.grob_))
390 /* Don't refill killed spanner */
391 && line_spanner_->is_live ())
393 Side_position_interface::add_support (line_spanner_,info.grob_);
394 add_bound_item (line_spanner_,dynamic_cast<Item*> (info.grob_));
397 if (script_ && !script_->get_parent (X_AXIS))
399 SCM head = scm_last_pair (info.grob_->get_property ("note-heads"));
400 if (ly_c_pair_p (head))
401 script_->set_parent (unsmob_grob (ly_car (head)), X_AXIS);
406 if (cresc_ && !cresc_->get_bound (LEFT))
408 cresc_->set_bound (LEFT, info.grob_);
409 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
413 else if (Script_interface::has_interface (info.grob_) && script_)
415 SCM p = info.grob_->get_property ("script-priority");
420 DynamicText doesn't really have a script-priority field.
422 if (scm_is_number (p)
424 < scm_to_int (script_->get_property ("script-priority")))
425 Side_position_interface::add_support (line_spanner_, info.grob_);
427 else if (Slur::has_interface (info.grob_))
428 slur_ = dynamic_cast<Spanner*> (info.grob_);
431 ENTER_DESCRIPTION (Dynamic_engraver,
433 "This engraver creates hairpins, dynamic texts, and their vertical\n"
434 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
435 "which takes care of vertical positioning. "
438 /* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
439 /* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",
440 /* acks */ "note-column-interface script-interface slur-interface",