2 dynamic-engraver.cc -- implement Dynamic_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
9 #include "axis-group-interface.hh"
11 #include "dimensions.hh"
12 #include "directional-element-interface.hh"
13 #include "engraver.hh"
15 #include "interval.hh"
16 #include "note-column.hh"
17 #include "paper-column.hh"
18 #include "script-interface.hh"
19 #include "side-position-interface.hh"
20 #include "staff-symbol-referencer.hh"
22 #include "self-alignment-interface.hh"
23 #include "pointer-group-interface.hh"
25 #include "translator.icc"
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
41 print text & hairpin dynamics.
43 class Dynamic_engraver : public Engraver
46 Spanner *line_spanner_;
49 Spanner *finished_line_spanner_;
50 Spanner *finished_cresc_;
53 Music *current_cresc_ev_;
55 Drul_array<Music *> accepted_spanevents_drul_;
57 Link_array<Note_column> pending_columns_;
58 Link_array<Grob> pending_elements_;
62 TRANSLATOR_DECLARATIONS (Dynamic_engraver);
63 DECLARE_ACKNOWLEDGER (script);
64 DECLARE_ACKNOWLEDGER (stem_tremolo);
65 DECLARE_ACKNOWLEDGER (note_column);
66 DECLARE_ACKNOWLEDGER (slur);
69 virtual void finalize ();
70 virtual bool try_music (Music *event);
71 void stop_translation_timestep ();
72 void process_music ();
75 Dynamic_engraver::Dynamic_engraver ()
80 finished_line_spanner_ = 0;
81 current_cresc_ev_ = 0;
85 accepted_spanevents_drul_[START] = 0;
86 accepted_spanevents_drul_[STOP] = 0;
90 Dynamic_engraver::try_music (Music *m)
92 if (m->is_mus_type ("absolute-dynamic-event"))
95 TODO: probably broken.
100 else if (m->is_mus_type ("decrescendo-event")
101 || m->is_mus_type ("crescendo-event"))
103 Direction d = to_dir (m->get_property ("span-direction"));
105 accepted_spanevents_drul_[d] = m;
106 if (current_cresc_ev_ && d == START)
107 accepted_spanevents_drul_[STOP] = m;
114 Dynamic_engraver::process_music ()
116 if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
120 Music *rq = accepted_spanevents_drul_[START];
121 line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
128 During a (de)crescendo, pending event will not be cleared,
129 and a line-spanner will always be created, as \< \! are already
132 Note: line-spanner must always have at least same duration
133 as (de)crecsendo, b.o. line-breaking.
137 maybe we should leave dynamic texts to the text-engraver and
138 simply acknowledge them?
142 script_ = make_item ("DynamicText", script_ev_->self_scm ());
143 script_->set_property ("text",
144 script_ev_->get_property ("text"));
146 if (Direction d = to_dir (script_ev_->get_property ("direction")))
147 set_grob_direction (line_spanner_, d);
148 else if (Direction d = to_dir (line_spanner_->get_property ("direction")))
149 set_grob_direction (script_, d);
151 Axis_group_interface::add_element (line_spanner_, script_);
154 Music *stop_ev = accepted_spanevents_drul_ [STOP]
155 ? accepted_spanevents_drul_[STOP] : script_ev_;
157 if (accepted_spanevents_drul_[STOP] || script_ev_)
160 finish side position alignment if the (de)cresc ends here, and
161 there are no new dynamics.
166 assert (!finished_cresc_ && cresc_);
170 cresc_->set_bound (RIGHT, script_);
171 add_bound_item (line_spanner_, script_);
174 finished_cresc_ = cresc_;
176 current_cresc_ev_ = 0;
178 else if (accepted_spanevents_drul_[STOP])
180 accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
185 if (accepted_spanevents_drul_[START])
187 if (current_cresc_ev_)
189 String msg = _ ("already have a decrescendo");
190 if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
191 msg = _ ("already have a crescendo");
193 accepted_spanevents_drul_[START]->origin ()->warning (msg);
194 current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
198 current_cresc_ev_ = accepted_spanevents_drul_[START];
200 if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
201 set_grob_direction (line_spanner_, d);
208 = ly_symbol2string (current_cresc_ev_->get_property ("name"));
213 if (start_type == "DecrescendoEvent")
214 start_type = "decrescendo";
215 else if (start_type == "CrescendoEvent")
216 start_type = "crescendo";
218 SCM s = get_property ((start_type + "Spanner").to_str0 ());
219 if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
221 cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
224 Pointer_group_interface::add_grob (finished_cresc_,
225 ly_symbol2scm ("adjacent-hairpins"),
228 Pointer_group_interface::add_grob (cresc_,
229 ly_symbol2scm ("adjacent-hairpins"),
232 cresc_->set_property ("grow-direction",
233 scm_from_int ((start_type == "crescendo")
234 ? BIGGER : SMALLER));
238 This is a convenient (and legacy) interface to TextSpanners
239 for use in (de)crescendi.
244 cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
245 cresc_->set_property ("style", s);
246 context ()->set_property ((start_type
247 + "Spanner").to_str0 (), SCM_EOL);
248 s = get_property ((start_type + "Text").to_str0 ());
250 FIXME: use get_markup () to check type.
252 if (scm_is_string (s) || scm_is_pair (s))
254 cresc_->set_property ("edge-text",
255 scm_cons (s, scm_makfrom0str ("")));
256 context ()->set_property ((start_type + "Text").to_str0 (),
263 cresc_->set_bound (LEFT, script_);
264 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
267 Axis_group_interface::add_element (line_spanner_, cresc_);
273 Dynamic_engraver::stop_translation_timestep ()
275 if (!current_cresc_ev_ && line_spanner_)
277 assert (!finished_line_spanner_);
278 finished_line_spanner_ = line_spanner_;
284 if (cresc_ && !cresc_->get_bound (LEFT))
286 cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
287 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
291 accepted_spanevents_drul_[START] = 0;
292 accepted_spanevents_drul_[STOP] = 0;
296 Dynamic_engraver::finalize ()
301 && !line_spanner_->is_live ())
305 finished_line_spanner_ = line_spanner_;
310 && !cresc_->is_live ())
314 current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
321 Dynamic_engraver::typeset_all ()
325 if (!finished_cresc_->get_bound (RIGHT))
327 finished_cresc_->set_bound (RIGHT, script_
329 : unsmob_grob (get_property ("currentMusicalColumn")));
331 if (finished_line_spanner_)
332 add_bound_item (finished_line_spanner_,
333 finished_cresc_->get_bound (RIGHT));
339 if (finished_line_spanner_)
344 extend-spanner-over-elements (finished_line_spanner_);
346 but this is rather kludgy, since finished_line_spanner_
347 typically has a staff-symbol field set , extending it over the
352 Grob *l = finished_line_spanner_->get_bound (LEFT);
353 Grob *r = finished_line_spanner_->get_bound (RIGHT);
355 finished_line_spanner_->set_bound (RIGHT, l);
357 finished_line_spanner_->set_bound (LEFT, r);
361 This is a isolated dynamic apparently, and does not even have
362 any interesting support item.
364 Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
365 Item *ci = dynamic_cast<Item *> (cc);
366 finished_line_spanner_->set_bound (RIGHT, ci);
367 finished_line_spanner_->set_bound (LEFT, ci);
370 finished_line_spanner_ = 0;
376 Dynamic_engraver::acknowledge_stem_tremolo (Grob_info info)
379 Side_position_interface::add_support (line_spanner_, info.grob ());
384 Dynamic_engraver::acknowledge_slur (Grob_info info)
387 Side_position_interface::add_support (line_spanner_, info.grob ());
392 Dynamic_engraver::acknowledge_note_column (Grob_info info)
398 /* Don't refill killed spanner */
399 && line_spanner_->is_live ())
401 Side_position_interface::add_support (line_spanner_, info.grob ());
402 add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
405 if (script_ && !script_->get_parent (X_AXIS))
407 extract_grob_set (info.grob (), "note-heads", heads);
410 Grob *head = heads[0];
411 script_->set_parent (head, X_AXIS);
412 Self_alignment_interface::set_center_parent (script_, X_AXIS);
418 if (!cresc_->get_bound (LEFT))
420 cresc_->set_bound (LEFT, info.grob ());
421 add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
425 if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
426 finished_cresc_->set_bound (RIGHT, info.grob ());
430 Dynamic_engraver::acknowledge_script (Grob_info info)
432 if (!line_spanner_ || !script_)
435 SCM p = info.grob ()->get_property ("script-priority");
440 DynamicText doesn't really have a script-priority field.
442 if (scm_is_number (p)
444 < scm_to_int (script_->get_property ("script-priority")))
445 Side_position_interface::add_support (line_spanner_, info.grob ());
448 ADD_ACKNOWLEDGER (Dynamic_engraver, script);
449 ADD_ACKNOWLEDGER (Dynamic_engraver, note_column);
450 ADD_ACKNOWLEDGER (Dynamic_engraver, slur);
451 ADD_ACKNOWLEDGER (Dynamic_engraver, stem_tremolo);
453 ADD_TRANSLATOR (Dynamic_engraver,
455 "This engraver creates hairpins, dynamic texts, and their vertical\n"
456 "alignments. The symbols are collected onto a DynamicLineSpanner grob\n"
457 "which takes care of vertical positioning. ",
459 /* create */ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
460 /* accept */ "absolute-dynamic-event crescendo-event decrescendo-event",