2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "engraver.hh"
23 #include "directional-element-interface.hh"
24 #include "international.hh"
25 #include "note-column.hh"
28 #include "stream-event.hh"
31 #include "translator.icc"
36 This is largely similar to Slur_engraver. Check if fixes
39 (on principle, engravers don't use inheritance for code sharing)
44 It is possible that a slur starts and ends on the same note. At
45 least, it is for phrasing slurs: a note can be both beginning and
48 class Phrasing_slur_engraver : public Engraver
50 vector<Stream_event *> start_events_;
51 vector<Stream_event *> stop_events_;
52 vector<Grob *> slurs_;
53 vector<Grob *> end_slurs_;
54 vector<Grob_info> objects_to_acknowledge_;
57 DECLARE_TRANSLATOR_LISTENER (phrasing_slur);
58 DECLARE_ACKNOWLEDGER (inline_accidental);
59 DECLARE_ACKNOWLEDGER (fingering);
60 DECLARE_ACKNOWLEDGER (note_column);
61 DECLARE_ACKNOWLEDGER (slur);
62 DECLARE_ACKNOWLEDGER (script);
63 DECLARE_ACKNOWLEDGER (dots);
64 DECLARE_ACKNOWLEDGER (text_script);
65 DECLARE_END_ACKNOWLEDGER (tie);
66 DECLARE_ACKNOWLEDGER (tuplet_number);
68 void acknowledge_extra_object (Grob_info);
69 void stop_translation_timestep ();
70 void process_music ();
72 virtual void finalize ();
73 virtual void derived_mark () const;
76 TRANSLATOR_DECLARATIONS (Phrasing_slur_engraver);
79 Phrasing_slur_engraver::Phrasing_slur_engraver ()
84 Phrasing_slur_engraver::derived_mark () const
86 for (vsize i = start_events_.size (); i--;)
87 scm_gc_mark (start_events_[i]->self_scm ());
88 for (vsize i = stop_events_.size (); i--;)
89 scm_gc_mark (stop_events_[i]->self_scm ());
92 IMPLEMENT_TRANSLATOR_LISTENER (Phrasing_slur_engraver, phrasing_slur);
94 Phrasing_slur_engraver::listen_phrasing_slur (Stream_event *ev)
96 Direction d = to_dir (ev->get_property ("span-direction"));
98 start_events_.push_back (ev);
100 stop_events_.push_back (ev);
101 else ev->origin ()->warning (_f ("direction of %s invalid: %d",
102 "phrasing-slur-event", int (d)));
106 Phrasing_slur_engraver::acknowledge_note_column (Grob_info info)
108 Grob *e = info.grob ();
109 for (vsize i = slurs_.size (); i--;)
110 Slur::add_column (slurs_[i], e);
111 for (vsize i = end_slurs_.size (); i--;)
112 Slur::add_column (end_slurs_[i], e);
116 Phrasing_slur_engraver::acknowledge_extra_object (Grob_info info)
118 objects_to_acknowledge_.push_back (info);
122 Phrasing_slur_engraver::acknowledge_inline_accidental (Grob_info info)
124 acknowledge_extra_object (info);
128 Phrasing_slur_engraver::acknowledge_dots (Grob_info info)
130 acknowledge_extra_object (info);
134 Phrasing_slur_engraver::acknowledge_fingering (Grob_info info)
136 acknowledge_extra_object (info);
140 Phrasing_slur_engraver::acknowledge_tuplet_number (Grob_info info)
142 acknowledge_extra_object (info);
146 Phrasing_slur_engraver::acknowledge_script (Grob_info info)
148 if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
149 acknowledge_extra_object (info);
153 Phrasing_slur_engraver::acknowledge_text_script (Grob_info info)
155 acknowledge_extra_object (info);
159 Phrasing_slur_engraver::acknowledge_end_tie (Grob_info info)
161 acknowledge_extra_object (info);
165 Phrasing_slur_engraver::acknowledge_slur (Grob_info info)
167 acknowledge_extra_object (info);
171 Phrasing_slur_engraver::finalize ()
173 for (vsize i = 0; i < slurs_.size (); i++)
175 slurs_[i]->warning (_ ("unterminated phrasing slur"));
176 slurs_[i]->suicide ();
182 Phrasing_slur_engraver::process_music ()
184 for (vsize i = 0; i < stop_events_.size (); i++)
186 Stream_event *ev = stop_events_[i];
187 string id = robust_scm2string (ev->get_property ("spanner-id"), "");
189 // Find the slurs that are ended with this event (by checking the spanner-id)
191 for (vsize j = slurs_.size (); j--;)
193 if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
196 end_slurs_.push_back (slurs_[j]);
197 slurs_.erase (slurs_.begin () + j);
202 // Ignore redundant stop events for this id
203 for (vsize j = stop_events_.size (); --j > i;)
205 if (id == robust_scm2string (stop_events_[j]->get_property ("spanner-id"), ""))
206 stop_events_.erase (stop_events_.begin () + j);
210 ev->origin ()->warning (_ ("cannot end phrasing slur"));
213 vsize old_slurs = slurs_.size ();
214 for (vsize i = start_events_.size (); i--;)
216 Stream_event *ev = start_events_[i];
217 string id = robust_scm2string (ev->get_property ("spanner-id"), "");
218 Direction updown = to_dir (ev->get_property ("direction"));
221 for (vsize j = slurs_.size (); !(completed = (j-- == 0));)
223 // Check if we already have a slur with the same spanner-id.
224 if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
228 // We already have an old slur, so give a warning
229 // and completely ignore the new slur.
230 ev->origin ()->warning (_ ("already have phrasing slur"));
231 start_events_.erase (start_events_.begin () + i);
235 // If this slur event has no direction, it will not
236 // contribute anything new to the existing slur(s), so
242 Stream_event *c = unsmob_stream_event (slurs_[j]->get_property ("cause"));
246 slurs_[j]->programming_error ("phrasing slur without a cause");
250 Direction slur_dir = to_dir (c->get_property ("direction"));
252 // If the existing slur does not have a direction yet,
253 // we'd rather take the new one.
257 slurs_[j]->suicide ();
258 slurs_.erase (slurs_.begin () + j);
262 // If the existing slur has the same direction as ours, drop ours
264 if (slur_dir == updown)
268 // If the loop completed, our slur is new
271 Grob *slur = make_spanner ("PhrasingSlur", ev->self_scm ());
272 slur->set_property ("spanner-id", ly_string2scm (id));
274 set_grob_direction (slur, updown);
275 slurs_.push_back (slur);
281 Phrasing_slur_engraver::stop_translation_timestep ()
283 if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
285 for (vsize i = 0; i < end_slurs_.size (); i++)
286 Slur::add_extra_encompass (end_slurs_[i], g);
288 if (!start_events_.size ())
289 for (vsize i = 0; i < slurs_.size (); i++)
290 Slur::add_extra_encompass (slurs_[i], g);
293 for (vsize i = 0; i < end_slurs_.size (); i++)
295 Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
296 if (!s->get_bound (RIGHT))
297 s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
298 announce_end_grob (s, SCM_EOL);
301 for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
302 Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
304 objects_to_acknowledge_.clear ();
306 start_events_.clear ();
307 stop_events_.clear ();
310 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, inline_accidental);
311 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, fingering)
312 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, note_column);
313 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, slur);
314 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, script);
315 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, dots);
316 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, text_script);
317 ADD_END_ACKNOWLEDGER (Phrasing_slur_engraver, tie);
318 ADD_ACKNOWLEDGER (Phrasing_slur_engraver, tuplet_number);
320 ADD_TRANSLATOR (Phrasing_slur_engraver,
322 "Print phrasing slurs. Similar to @ref{Slur_engraver}.",