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 ();
69 virtual void create_grobs ();
70 virtual void start_translation_timestep ();
73 ADD_THIS_TRANSLATOR (Dynamic_engraver);
76 Dynamic_engraver::Dynamic_engraver ()
79 finished_cresc_p_ = 0;
81 finished_line_spanner_ = 0;
82 current_cresc_req_ = 0;
86 accepted_spanreqs_drul_[START] = 0;
87 accepted_spanreqs_drul_[STOP] = 0;
91 Dynamic_engraver::start_translation_timestep ()
94 accepted_spanreqs_drul_[START] = 0;
95 accepted_spanreqs_drul_[STOP] = 0;
99 Dynamic_engraver::try_music (Music * m)
101 if (dynamic_cast <Text_script_req*> (m)
102 && m->get_mus_property ("text-type") == ly_symbol2scm ("dynamic"))
104 script_req_l_ = dynamic_cast<Text_script_req*> (m);
107 else if (Span_req* s = dynamic_cast <Span_req*> (m))
109 String t = ly_scm2string (s->get_mus_property ("span-type"));
112 accepted_spanreqs_drul_[LEFT] = 0;
113 accepted_spanreqs_drul_[RIGHT] = 0;
115 line_spanner_->suicide ();
118 cresc_p_->suicide ();
121 else if (t == "crescendo"
122 || t == "decrescendo")
124 accepted_spanreqs_drul_[s->get_span_dir()] = s;
132 Dynamic_engraver::create_grobs ()
134 if (accepted_spanreqs_drul_[START] || accepted_spanreqs_drul_[STOP] || script_req_l_)
138 line_spanner_ = new Spanner (get_property ("DynamicLineSpanner"));
140 Side_position::set_axis (line_spanner_, Y_AXIS);
141 Axis_group_interface::set_interface (line_spanner_);
142 Axis_group_interface::set_axes (line_spanner_, Y_AXIS, Y_AXIS);
144 Music * rq = accepted_spanreqs_drul_[START];
147 announce_grob (line_spanner_, rq);
154 During a (de)crescendo, pending request will not be cleared,
155 and a line-spanner will always be created, as \< \! are already
158 Note: line-spanner must always have at least same duration
159 as (de)crecsendo, b.o. line-breaking.
165 maybe we should leave dynamic texts to the text-engraver and
166 simply acknowledge them?
170 script_p_ = new Item (get_property ("DynamicText"));
171 script_p_->set_grob_property ("text",
172 script_req_l_->get_mus_property ("text"));
174 Side_position::set_direction (script_p_, LEFT);
175 Side_position::set_axis (script_p_, X_AXIS);
177 if (Direction d = script_req_l_->get_direction ())
178 Directional_element_interface::set (line_spanner_, d);
180 Axis_group_interface::add_element (line_spanner_, script_p_);
182 announce_grob (script_p_, script_req_l_);
185 if (accepted_spanreqs_drul_[STOP])
188 finish side position alignment if the (de)cresc ends here, and
189 there are no new dynamics.
195 accepted_spanreqs_drul_[STOP]->origin ()->warning
196 (_ ("can't find start of (de)crescendo"));
197 accepted_spanreqs_drul_[STOP] = 0;
201 assert (!finished_cresc_p_ && cresc_p_);
203 cresc_p_->set_bound (RIGHT, script_p_
205 : unsmob_grob (get_property ("currentMusicalColumn")));
207 finished_cresc_p_ = cresc_p_;
209 current_cresc_req_ = 0;
212 if (accepted_spanreqs_drul_[START])
214 if (current_cresc_req_)
216 accepted_spanreqs_drul_[START]->origin ()->warning
217 (current_cresc_req_->get_span_dir() == 1
218 ? _ ("already have a crescendo")
219 : _ ("already have a decrescendo"));
223 current_cresc_req_ = accepted_spanreqs_drul_[START];
229 String start_type = ly_scm2string (accepted_spanreqs_drul_[START]->get_mus_property ("span-type"));
234 SCM s = get_property ((start_type + "Spanner").ch_C());
235 if (!gh_symbol_p (s) || s == ly_symbol2scm ("hairpin"))
237 cresc_p_ = new Spanner (get_property ("Hairpin"));
238 cresc_p_->set_grob_property ("grow-direction",
239 gh_int2scm ((start_type == "crescendo")
240 ? BIGGER : SMALLER));
244 This is a convenient (and legacy) interface to TextSpanners
245 for use in (de)crescendi.
250 cresc_p_ = new Spanner (get_property ("TextSpanner"));
251 cresc_p_->set_grob_property ("type", s);
253 daddy_trans_l_->set_property (start_type
254 + "Spanner", SCM_UNDEFINED);
255 s = get_property ((start_type + "Text").ch_C());
258 cresc_p_->set_grob_property ("edge-text",
259 gh_cons (s, ly_str02scm ("")));
260 daddy_trans_l_->set_property (start_type + "Text",
265 cresc_p_->set_bound (LEFT, script_p_
267 : unsmob_grob (get_property ("currentMusicalColumn")));
269 Axis_group_interface::add_element (line_spanner_, cresc_p_);
270 announce_grob (cresc_p_, accepted_spanreqs_drul_[START]);
274 accepted_spanreqs_drul_[START] = 0;
275 accepted_spanreqs_drul_[STOP] = 0;
279 Dynamic_engraver::stop_translation_timestep ()
285 Dynamic_engraver::finalize ()
290 finished_line_spanner_ = line_spanner_;
296 current_cresc_req_->origin ()->warning (_ ("unterminated (de)crescendo"));
297 cresc_p_->suicide ();
303 Dynamic_engraver::typeset_all ()
305 if (finished_cresc_p_)
308 finished_cresc_p_->set_bound (RIGHT, script_p_
310 : unsmob_grob (get_property ("currentMusicalColumn")));
312 typeset_grob (finished_cresc_p_);
313 finished_cresc_p_ =0;
318 typeset_grob (script_p_);
321 if (finished_line_spanner_)
323 Side_position::add_staff_support (finished_line_spanner_);
324 extend_spanner_over_elements (finished_line_spanner_);
325 typeset_grob (finished_line_spanner_);
326 finished_line_spanner_ = 0;
331 Dynamic_engraver::acknowledge_grob (Grob_info i)
333 if (Note_column::has_interface (i.elem_l_))
337 Side_position::add_support (line_spanner_,i.elem_l_);
338 add_bound_item (line_spanner_,dynamic_cast<Item*>(i.elem_l_));