]> git.donarmstrong.com Git - lilypond.git/blob - lily/dynamic-engraver.cc
* lily/spacing-determine-loose-columns.cc: new file.
[lilypond.git] / lily / dynamic-engraver.cc
1 /*
2   dynamic-engraver.cc -- implement Dynamic_engraver
3
4   source file of the GNU LilyPond music typesetter
5
6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 */
8
9 #include "axis-group-interface.hh"
10 #include "context.hh"
11 #include "dimensions.hh"
12 #include "directional-element-interface.hh"
13 #include "engraver.hh"
14 #include "hairpin.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"
21 #include "warn.hh"
22 #include "self-alignment-interface.hh"
23 #include "pointer-group-interface.hh"
24
25 #include "translator.icc"
26
27 /*
28   TODO:
29
30   * direction of text-dynamic-event if not equal to direction of
31   line-spanner
32
33   - TODO: this engraver is too complicated. We should split it into
34   the handling of the basic grobs and the linespanner
35
36   - TODO: the line-spanner is not killed after the (de)crescs are
37   finished.
38 */
39
40 /**
41    print text & hairpin dynamics.
42 */
43 class Dynamic_engraver : public Engraver
44 {
45   Item *script_;
46   Spanner *line_spanner_;
47   Spanner *cresc_;
48
49   Spanner *finished_line_spanner_;
50   Spanner *finished_cresc_;
51
52   Music *script_ev_;
53   Music *current_cresc_ev_;
54
55   Drul_array<Music *> accepted_spanevents_drul_;
56
57   Link_array<Note_column> pending_columns_;
58   Link_array<Grob> pending_elements_;
59
60   void typeset_all ();
61
62   TRANSLATOR_DECLARATIONS (Dynamic_engraver);
63   DECLARE_ACKNOWLEDGER (script);
64   DECLARE_ACKNOWLEDGER (note_column);
65   DECLARE_ACKNOWLEDGER (slur);
66
67
68 protected:
69   virtual void finalize ();
70   virtual bool try_music (Music *event);
71   void stop_translation_timestep ();
72   void process_music ();
73 };
74
75 Dynamic_engraver::Dynamic_engraver ()
76 {
77   script_ = 0;
78   finished_cresc_ = 0;
79   line_spanner_ = 0;
80   finished_line_spanner_ = 0;
81   current_cresc_ev_ = 0;
82   cresc_ = 0;
83
84   script_ev_ = 0;
85   accepted_spanevents_drul_[START] = 0;
86   accepted_spanevents_drul_[STOP] = 0;
87 }
88
89 bool
90 Dynamic_engraver::try_music (Music *m)
91 {
92   if (m->is_mus_type ("absolute-dynamic-event"))
93     {
94       /*
95         TODO: probably broken.
96       */
97       script_ev_ = m;
98       return true;
99     }
100   else if (m->is_mus_type ("decrescendo-event")
101            || m->is_mus_type ("crescendo-event"))
102     {
103       Direction d = to_dir (m->get_property ("span-direction"));
104
105       accepted_spanevents_drul_[d] = m;
106       if (current_cresc_ev_ && d == START)
107         accepted_spanevents_drul_[STOP] = m;
108       return true;
109     }
110   return false;
111 }
112
113 void
114 Dynamic_engraver::process_music ()
115 {
116   if (accepted_spanevents_drul_[START] || accepted_spanevents_drul_[STOP] || script_ev_)
117     {
118       if (!line_spanner_)
119         {
120           Music *rq = accepted_spanevents_drul_[START];
121           line_spanner_ = make_spanner ("DynamicLineSpanner", rq ? rq->self_scm () : SCM_EOL);
122
123           if (script_ev_)
124             rq = script_ev_;
125         }
126     }
127
128   /*
129     During a (de)crescendo, pending event will not be cleared,
130     and a line-spanner will always be created, as \< \! are already
131     two events.
132
133     Note: line-spanner must always have at least same duration
134     as (de)crecsendo, b.o. line-breaking.
135   */
136
137   /*
138     maybe we should leave dynamic texts to the text-engraver and
139     simply acknowledge them?
140   */
141   if (script_ev_)
142     {
143       script_ = make_item ("DynamicText", script_ev_->self_scm ());
144       script_->set_property ("text",
145                              script_ev_->get_property ("text"));
146
147       if (Direction d = to_dir (script_ev_->get_property ("direction")))
148         set_grob_direction (line_spanner_, d);
149
150       Axis_group_interface::add_element (line_spanner_, script_);
151     }
152
153   Music *stop_ev = accepted_spanevents_drul_ [STOP]
154     ? accepted_spanevents_drul_[STOP] : script_ev_;
155
156   if (accepted_spanevents_drul_[STOP] || script_ev_)
157     {
158       /*
159         finish side position alignment if the (de)cresc ends here, and
160         there are no new dynamics.
161       */
162
163       if (cresc_)
164         {
165           assert (!finished_cresc_ && cresc_);
166
167           if (script_)
168             {
169               cresc_->set_bound (RIGHT, script_);
170               add_bound_item (line_spanner_, script_);
171             }
172           
173           finished_cresc_ = cresc_;
174           cresc_ = 0;
175           current_cresc_ev_ = 0;
176         }
177       else if (accepted_spanevents_drul_[STOP])
178         {
179           accepted_spanevents_drul_[STOP]->origin ()->warning (_ ("can't find start of (de)crescendo"));
180           stop_ev = 0;
181         }
182     }
183
184   if (accepted_spanevents_drul_[START])
185     {
186       if (current_cresc_ev_)
187         {
188           String msg = _ ("already have a decrescendo");
189           if (current_cresc_ev_->is_mus_type ("decrescendo-event"))
190             msg = _ ("already have a crescendo");
191
192           accepted_spanevents_drul_[START]->origin ()->warning (msg);
193           current_cresc_ev_->origin ()->warning (_ ("cresc starts here"));
194         }
195       else
196         {
197           current_cresc_ev_ = accepted_spanevents_drul_[START];
198
199           if (Direction d = to_dir (current_cresc_ev_->get_property ("direction")))
200             set_grob_direction (line_spanner_, d);
201
202           /*
203             TODO: Use symbols.
204           */
205
206           String start_type
207             = ly_symbol2string (current_cresc_ev_->get_property ("name"));
208
209           /*
210             ugh. Use push/pop?
211           */
212           if (start_type == "DecrescendoEvent")
213             start_type = "decrescendo";
214           else if (start_type == "CrescendoEvent")
215             start_type = "crescendo";
216
217           SCM s = get_property ((start_type + "Spanner").to_str0 ());
218           if (!scm_is_symbol (s) || s == ly_symbol2scm ("hairpin"))
219             {
220               cresc_ = make_spanner ("Hairpin", accepted_spanevents_drul_[START]->self_scm ());
221               if (finished_cresc_)
222                 {
223                   Pointer_group_interface::add_grob (finished_cresc_,
224                                                      ly_symbol2scm ("adjacent-hairpins"),
225                                                      cresc_);
226
227                   Pointer_group_interface::add_grob (cresc_,
228                                                      ly_symbol2scm ("adjacent-hairpins"),
229                                                      finished_cresc_);
230                 }
231               cresc_->set_property ("grow-direction",
232                                     scm_from_int ((start_type == "crescendo")
233                                                  ? BIGGER : SMALLER));
234             }
235
236           /*
237             This is a convenient (and legacy) interface to TextSpanners
238             for use in (de)crescendi.
239             Hmm.
240           */
241           else
242             {
243               cresc_ = make_spanner ("DynamicTextSpanner", accepted_spanevents_drul_[START]->self_scm ());
244               cresc_->set_property ("style", s);
245               context ()->set_property ((start_type
246                                          + "Spanner").to_str0 (), SCM_EOL);
247               s = get_property ((start_type + "Text").to_str0 ());
248               /*
249                 FIXME: use get_markup () to check type.
250               */
251               if (scm_is_string (s) || scm_is_pair (s))
252                 {
253                   cresc_->set_property ("edge-text",
254                                         scm_cons (s, scm_makfrom0str ("")));
255                   context ()->set_property ((start_type + "Text").to_str0 (),
256                                             SCM_EOL);
257                 }
258             }
259
260           if (script_)
261             {
262               cresc_->set_bound (LEFT, script_);
263               add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
264             }
265
266           Axis_group_interface::add_element (line_spanner_, cresc_);
267         }
268     }
269 }
270
271 void
272 Dynamic_engraver::stop_translation_timestep ()
273 {
274   if (!current_cresc_ev_ && line_spanner_)
275     {
276       assert (!finished_line_spanner_);
277       finished_line_spanner_ = line_spanner_;
278       line_spanner_ = 0;
279     }
280   
281   typeset_all ();
282
283   if (cresc_ && !cresc_->get_bound (LEFT))
284     {
285       cresc_->set_bound (LEFT, unsmob_grob (get_property ("currentMusicalColumn")));
286       add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
287     }
288
289   script_ev_ = 0;
290   accepted_spanevents_drul_[START] = 0;
291   accepted_spanevents_drul_[STOP] = 0;
292 }
293
294 void
295 Dynamic_engraver::finalize ()
296 {
297   typeset_all ();
298
299   if (line_spanner_
300       && !line_spanner_->is_live ())
301     line_spanner_ = 0;
302   if (line_spanner_)
303     {
304       finished_line_spanner_ = line_spanner_;
305       typeset_all ();
306     }
307
308   if (cresc_
309       && !cresc_->is_live ())
310     cresc_ = 0;
311   if (cresc_)
312     {
313       current_cresc_ev_->origin ()->warning (_ ("unterminated (de)crescendo"));
314       cresc_->suicide ();
315       cresc_ = 0;
316     }
317 }
318
319 void
320 Dynamic_engraver::typeset_all ()
321 {
322   if (finished_cresc_)
323     {
324       if (!finished_cresc_->get_bound (RIGHT))
325         {
326           finished_cresc_->set_bound (RIGHT, script_
327                                       ? script_
328                                       : unsmob_grob (get_property ("currentMusicalColumn")));
329
330           if (finished_line_spanner_)
331             add_bound_item (finished_line_spanner_,
332                             finished_cresc_->get_bound (RIGHT));
333         }
334       finished_cresc_ = 0;
335     }
336
337   script_ = 0;
338   if (finished_line_spanner_)
339     {
340       /*
341         We used to have
342
343         extend-spanner-over-elements (finished_line_spanner_);
344
345         but this is rather kludgy, since finished_line_spanner_
346         typically has a staff-symbol field set , extending it over the
347         entire staff.
348
349       */
350
351       Grob *l = finished_line_spanner_->get_bound (LEFT);
352       Grob *r = finished_line_spanner_->get_bound (RIGHT);
353       if (!r && l)
354         finished_line_spanner_->set_bound (RIGHT, l);
355       else if (!l && r)
356         finished_line_spanner_->set_bound (LEFT, r);
357       else if (!r && !l)
358         {
359           /*
360             This is a isolated dynamic apparently, and does not even have
361             any interesting support item.
362           */
363           Grob *cc = unsmob_grob (get_property ("currentMusicalColumn"));
364           Item *ci = dynamic_cast<Item *> (cc);
365           finished_line_spanner_->set_bound (RIGHT, ci);
366           finished_line_spanner_->set_bound (LEFT, ci);
367         }
368
369       finished_line_spanner_ = 0;
370     }
371 }
372
373 void
374 Dynamic_engraver::acknowledge_slur (Grob_info info)
375 {
376   if (line_spanner_)
377     {
378       Side_position_interface::add_support (line_spanner_, info.grob ());
379     }
380 }
381
382 void
383 Dynamic_engraver::acknowledge_note_column (Grob_info info)
384 {
385   if (!line_spanner_)
386     return;
387
388   if (line_spanner_
389       /* Don't refill killed spanner */
390       && line_spanner_->is_live ())
391     {
392       Side_position_interface::add_support (line_spanner_, info.grob ());
393       add_bound_item (line_spanner_, dynamic_cast<Item *> (info.grob ()));
394     }
395
396   if (script_ && !script_->get_parent (X_AXIS))
397     {
398       extract_grob_set (info.grob (), "note-heads", heads);
399       if (heads.size())
400         {
401           Grob *head = heads[0];
402           script_->set_parent (head, X_AXIS);
403           script_->add_offset_callback (Self_alignment_interface::centered_on_parent_proc,
404                                         X_AXIS);
405
406         }
407     }
408
409   if (cresc_)
410     {
411       if (!cresc_->get_bound (LEFT))
412         {
413           cresc_->set_bound (LEFT, info.grob ());
414           add_bound_item (line_spanner_, cresc_->get_bound (LEFT));
415         }
416     }
417
418   if (finished_cresc_ && !finished_cresc_->get_bound (RIGHT))
419     {
420       finished_cresc_->set_bound (RIGHT, info.grob ());
421     }
422 }
423
424 void
425 Dynamic_engraver::acknowledge_script (Grob_info info)
426 {
427   if (!line_spanner_ || !script_)
428     return;
429
430   SCM p = info.grob ()->get_property ("script-priority");
431
432   /*
433     UGH.
434
435     DynamicText doesn't really have a script-priority field.
436   */
437   if (scm_is_number (p)
438       && scm_to_int (p)
439       < scm_to_int (script_->get_property ("script-priority")))
440     Side_position_interface::add_support (line_spanner_, info.grob ());
441 }
442
443
444 ADD_ACKNOWLEDGER (Dynamic_engraver,script);
445 ADD_ACKNOWLEDGER (Dynamic_engraver,note_column);
446 ADD_ACKNOWLEDGER (Dynamic_engraver,slur);
447
448 ADD_TRANSLATOR (Dynamic_engraver,
449                 /* descr */
450                 "This engraver creates hairpins, dynamic texts, and their vertical\n"
451                 "alignments.  The symbols are collected onto a DynamicLineSpanner grob\n"
452                 "which takes care of vertical positioning.  ",
453
454                 /* creats*/ "DynamicLineSpanner DynamicText Hairpin TextSpanner",
455                 /* accepts */ "absolute-dynamic-event crescendo-event decrescendo-event",
456                 /* reads */ "",
457                 /* write */ "");