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 Phrasing_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 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_;
56 void set_melisma (bool);
59 DECLARE_TRANSLATOR_LISTENER (slur);
60 DECLARE_ACKNOWLEDGER (inline_accidental);
61 DECLARE_ACKNOWLEDGER (fingering);
62 DECLARE_ACKNOWLEDGER (note_column);
63 DECLARE_ACKNOWLEDGER (script);
64 DECLARE_ACKNOWLEDGER (dots);
65 DECLARE_ACKNOWLEDGER (text_script);
66 DECLARE_ACKNOWLEDGER (tie);
67 DECLARE_ACKNOWLEDGER (tuplet_number);
69 void acknowledge_extra_object (Grob_info);
70 void stop_translation_timestep ();
71 void process_music ();
73 virtual void finalize ();
74 virtual void derived_mark () const;
77 TRANSLATOR_DECLARATIONS (Slur_engraver);
80 Slur_engraver::Slur_engraver ()
85 Slur_engraver::derived_mark () const
87 for (vsize i = start_events_.size (); i--;)
88 scm_gc_mark (start_events_[i]->self_scm ());
89 for (vsize i = stop_events_.size (); i--;)
90 scm_gc_mark (stop_events_[i]->self_scm ());
93 IMPLEMENT_TRANSLATOR_LISTENER (Slur_engraver, slur);
95 Slur_engraver::listen_slur (Stream_event *ev)
97 Direction d = to_dir (ev->get_property ("span-direction"));
99 start_events_.push_back (ev);
101 stop_events_.push_back (ev);
102 else ev->origin ()->warning (_f ("direction of %s invalid: %d",
103 "slur-event", int (d)));
107 Slur_engraver::set_melisma (bool m)
109 context ()->set_property ("slurMelismaBusy", m ? SCM_BOOL_T : SCM_BOOL_F);
113 Slur_engraver::acknowledge_note_column (Grob_info info)
115 Grob *e = info.grob ();
116 for (vsize i = slurs_.size (); i--;)
117 Slur::add_column (slurs_[i], e);
118 for (vsize i = end_slurs_.size (); i--;)
119 Slur::add_column (end_slurs_[i], e);
123 Slur_engraver::acknowledge_extra_object (Grob_info info)
125 objects_to_acknowledge_.push_back (info);
129 Slur_engraver::acknowledge_inline_accidental (Grob_info info)
131 acknowledge_extra_object (info);
135 Slur_engraver::acknowledge_dots (Grob_info info)
137 acknowledge_extra_object (info);
141 Slur_engraver::acknowledge_fingering (Grob_info info)
143 acknowledge_extra_object (info);
147 Slur_engraver::acknowledge_tuplet_number (Grob_info info)
149 acknowledge_extra_object (info);
153 Slur_engraver::acknowledge_script (Grob_info info)
155 if (!info.grob ()->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
156 acknowledge_extra_object (info);
160 Slur_engraver::acknowledge_text_script (Grob_info info)
162 acknowledge_extra_object (info);
166 Slur_engraver::acknowledge_tie (Grob_info info)
168 acknowledge_extra_object (info);
172 Slur_engraver::finalize ()
174 for (vsize i = 0; i < slurs_.size (); i++)
176 slurs_[i]->warning (_ ("unterminated slur"));
177 slurs_[i]->suicide ();
183 Slur_engraver::process_music ()
185 for (vsize i = 0; i < stop_events_.size (); i++)
187 Stream_event *ev = stop_events_[i];
188 string id = robust_scm2string (ev->get_property ("spanner-id"), "");
190 // Find the slurs that are ended with this event (by checking the spanner-id)
192 for (vsize j = slurs_.size (); j--;)
194 if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
197 end_slurs_.push_back (slurs_[j]);
198 slurs_.erase (slurs_.begin () + j);
203 // Ignore redundant stop events for this id
204 for (vsize j = stop_events_.size (); --j > i;)
206 if (id == robust_scm2string (stop_events_[j]->get_property ("spanner-id"), ""))
207 stop_events_.erase (stop_events_.begin () + j);
211 ev->origin ()->warning (_ ("cannot end slur"));
214 vsize old_slurs = slurs_.size ();
215 for (vsize i = start_events_.size (); i--;)
217 Stream_event *ev = start_events_[i];
218 string id = robust_scm2string (ev->get_property ("spanner-id"), "");
219 Direction updown = to_dir (ev->get_property ("direction"));
222 for (vsize j = slurs_.size (); !(completed = (j-- == 0));)
224 // Check if we already have a slur with the same spanner-id.
225 if (id == robust_scm2string (slurs_[j]->get_property ("spanner-id"), ""))
229 // We already have an old slur, so give a warning
230 // and completely ignore the new slur.
231 ev->origin ()->warning (_ ("already have slur"));
232 start_events_.erase (start_events_.begin () + i);
236 // If this slur event has no direction, it will not
237 // contribute anything new to the existing slur(s), so
243 Stream_event *c = unsmob_stream_event (slurs_[j]->get_property ("cause"));
247 slurs_[j]->programming_error ("slur without a cause");
251 Direction slur_dir = to_dir (c->get_property ("direction"));
253 // If the existing slur does not have a direction yet,
254 // we'd rather take the new one.
258 slurs_[j]->suicide ();
259 slurs_.erase (slurs_.begin () + j);
263 // If the existing slur has the same direction as ours, drop ours
265 if (slur_dir == updown)
269 // If the loop completed, our slur is new
272 Grob *slur = make_spanner ("Slur", ev->self_scm ());
273 slur->set_property ("spanner-id", ly_string2scm (id));
275 set_grob_direction (slur, updown);
276 slurs_.push_back (slur);
278 if (to_boolean (get_property ("doubleSlurs")))
280 set_grob_direction (slur, DOWN);
281 slur = make_spanner ("Slur", ev->self_scm ());
282 slur->set_property ("spanner-id", ly_string2scm (id));
283 set_grob_direction (slur, UP);
284 slurs_.push_back (slur);
288 set_melisma (slurs_.size ());
292 Slur_engraver::stop_translation_timestep ()
294 if (Grob *g = unsmob_grob (get_property ("currentCommandColumn")))
296 for (vsize i = 0; i < end_slurs_.size (); i++)
297 Slur::add_extra_encompass (end_slurs_[i], g);
299 if (!start_events_.size ())
300 for (vsize i = 0; i < slurs_.size (); i++)
301 Slur::add_extra_encompass (slurs_[i], g);
304 for (vsize i = 0; i < end_slurs_.size (); i++)
306 Spanner *s = dynamic_cast<Spanner *> (end_slurs_[i]);
307 if (!s->get_bound (RIGHT))
308 s->set_bound (RIGHT, unsmob_grob (get_property ("currentMusicalColumn")));
309 announce_end_grob (s, SCM_EOL);
312 for (vsize i = 0; i < objects_to_acknowledge_.size (); i++)
313 Slur::auxiliary_acknowledge_extra_object (objects_to_acknowledge_[i], slurs_, end_slurs_);
315 objects_to_acknowledge_.clear ();
317 start_events_.clear ();
318 stop_events_.clear ();
321 ADD_ACKNOWLEDGER (Slur_engraver, inline_accidental);
322 ADD_ACKNOWLEDGER (Slur_engraver, fingering);
323 ADD_ACKNOWLEDGER (Slur_engraver, note_column);
324 ADD_ACKNOWLEDGER (Slur_engraver, script);
325 ADD_ACKNOWLEDGER (Slur_engraver, text_script);
326 ADD_ACKNOWLEDGER (Slur_engraver, dots);
327 ADD_ACKNOWLEDGER (Slur_engraver, tie);
328 ADD_ACKNOWLEDGER (Slur_engraver, tuplet_number);
329 ADD_TRANSLATOR (Slur_engraver,
331 "Build slur grobs from slur events.",