2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2015 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/>.
21 #include "engraver.hh"
22 #include "international.hh"
23 #include "note-column.hh"
25 #include "stream-event.hh"
26 #include "tuplet-bracket.hh"
31 #include "translator.icc"
33 struct Tuplet_description
40 bool full_length_note_;
48 full_length_note_ = false;
55 class Tuplet_engraver : public Engraver
58 TRANSLATOR_DECLARATIONS (Tuplet_engraver);
61 vector<Tuplet_description> tuplets_;
62 vector<Tuplet_description> new_tuplets_;
63 vector<Tuplet_description> stopped_tuplets_;
64 vector<Spanner *> last_tuplets_;
66 DECLARE_ACKNOWLEDGER (note_column);
67 DECLARE_ACKNOWLEDGER (script);
68 DECLARE_ACKNOWLEDGER (finger);
69 DECLARE_ACKNOWLEDGER (string_number);
70 DECLARE_TRANSLATOR_LISTENER (tuplet_span);
71 virtual void finalize ();
72 void start_translation_timestep ();
73 void process_music ();
76 IMPLEMENT_TRANSLATOR_LISTENER (Tuplet_engraver, tuplet_span);
78 Tuplet_engraver::listen_tuplet_span (Stream_event *ev)
80 Direction dir = to_dir (ev->get_property ("span-direction"));
86 d.length_ = robust_scm2moment (d.event_->get_property ("length"),
88 d.start_moment_ = now_mom ();
89 d.stop_moment_ = now_mom () + d.length_;
91 for (vsize i = 0; i < new_tuplets_.size (); i++)
96 if (new_tuplets_[i].stop_moment_ == d.stop_moment_)
100 new_tuplets_.push_back (d);
102 else if (dir == STOP)
104 if (tuplets_.size ())
106 stopped_tuplets_.push_back (tuplets_.back ());
107 tuplets_.pop_back ();
109 else if (!to_boolean (get_property ("skipTypesetting")))
110 ev->origin ()->debug_output (_ ("No tuplet to end"));
113 ev->origin ()->programming_error ("direction tuplet-span-event_ invalid.");
117 Tuplet_engraver::process_music ()
120 This may happen if the end of a tuplet is part of a quoted voice.
122 Moment now = now_mom ();
123 for (vsize i = tuplets_.size (); i--;)
125 if (tuplets_[i].stop_moment_ == now)
127 stopped_tuplets_.push_back (tuplets_[i]);
128 tuplets_.erase (tuplets_.begin () + i);
132 for (vsize i = 0; i < stopped_tuplets_.size (); i++)
134 Spanner *bracket = stopped_tuplets_[i].bracket_;
135 Spanner *number = stopped_tuplets_[i].number_;
138 if (stopped_tuplets_[i].full_length_)
141 = Item::unsmob (stopped_tuplets_[i].full_length_note_
142 ? get_property ("currentMusicalColumn")
143 : get_property ("currentCommandColumn"));
145 bracket->set_bound (RIGHT, col);
146 number->set_bound (RIGHT, col);
148 else if (!bracket->get_bound (RIGHT))
150 if (bracket->get_bound (LEFT))
152 bracket->set_bound (RIGHT,
153 bracket->get_bound (LEFT));
154 number->set_bound (RIGHT,
155 stopped_tuplets_[i].bracket_->get_bound (LEFT));
159 warning ("omitting tuplet bracket with neither left nor right bound");
163 // todo: scrap last_tuplets_, use stopped_tuplets_ only.
164 // clear stopped_tuplets_ at start_translation_timestep
165 last_tuplets_.push_back (bracket);
166 last_tuplets_.push_back (number);
169 stopped_tuplets_.clear ();
171 concat (tuplets_, new_tuplets_);
172 new_tuplets_.clear ();
173 for (vsize j = tuplets_.size (); j > 0; j--)
175 /* i goes from size-1 downto 0, inclusively */
178 if (tuplets_[i].bracket_)
181 tuplets_[i].full_length_ = to_boolean (get_property ("tupletFullLength"));
182 tuplets_[i].full_length_note_
183 = to_boolean (get_property ("tupletFullLengthNote"));
185 tuplets_[i].bracket_ = make_spanner ("TupletBracket",
186 tuplets_[i].event_->self_scm ());
187 tuplets_[i].number_ = make_spanner ("TupletNumber",
188 tuplets_[i].event_->self_scm ());
189 tuplets_[i].number_->set_object ("bracket", tuplets_[i].bracket_->self_scm ());
190 tuplets_[i].number_->set_parent (tuplets_[i].bracket_, X_AXIS);
191 tuplets_[i].number_->set_parent (tuplets_[i].bracket_, Y_AXIS);
192 tuplets_[i].bracket_->set_object ("tuplet-number", tuplets_[i].number_->self_scm ());
193 tuplets_[i].stop_moment_.grace_part_ = 0;
195 if (i + 1 < tuplets_.size () && tuplets_[i + 1].bracket_)
196 Tuplet_bracket::add_tuplet_bracket (tuplets_[i].bracket_, tuplets_[i + 1].bracket_);
198 if (i > 0 && tuplets_[i - 1].bracket_)
199 Tuplet_bracket::add_tuplet_bracket (tuplets_[i - 1].bracket_, tuplets_[i].bracket_);
205 Tuplet_engraver::acknowledge_note_column (Grob_info inf)
207 for (vsize j = 0; j < tuplets_.size (); j++)
208 if (tuplets_[j].bracket_)
210 Item *i = dynamic_cast<Item *> (inf.grob ());
211 Tuplet_bracket::add_column (tuplets_[j].bracket_, i);
212 add_bound_item (tuplets_[j].number_, i);
217 Tuplet_engraver::acknowledge_script (Grob_info inf)
219 for (vsize j = 0; j < tuplets_.size (); j++)
220 if (tuplets_[j].bracket_)
222 Item *i = dynamic_cast<Item *> (inf.grob ());
223 if (!i->internal_has_interface (ly_symbol2scm ("dynamic-interface")))
224 Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
229 Tuplet_engraver::acknowledge_finger (Grob_info inf)
231 for (vsize j = 0; j < tuplets_.size (); j++)
232 if (tuplets_[j].bracket_)
234 Item *i = dynamic_cast<Item *> (inf.grob ());
235 Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
240 Tuplet_engraver::acknowledge_string_number (Grob_info inf)
242 for (vsize j = 0; j < tuplets_.size (); j++)
243 if (tuplets_[j].bracket_)
245 Item *i = dynamic_cast<Item *> (inf.grob ());
246 Tuplet_bracket::add_script (tuplets_[j].bracket_, i);
251 Tuplet_engraver::start_translation_timestep ()
253 last_tuplets_.clear ();
255 May seem superfluous, but necessary for skipTypesetting.
257 new_tuplets_.clear ();
261 Tuplet_engraver::finalize ()
263 if (to_boolean (get_property ("tupletFullLength")))
264 for (vsize i = 0; i < last_tuplets_.size (); i++)
266 Item *col = Item::unsmob (get_property ("currentCommandColumn"));
267 last_tuplets_[i]->set_bound (RIGHT, col);
271 Tuplet_engraver::Tuplet_engraver ()
275 ADD_ACKNOWLEDGER (Tuplet_engraver, note_column);
276 ADD_ACKNOWLEDGER (Tuplet_engraver, script);
277 ADD_ACKNOWLEDGER (Tuplet_engraver, finger);
278 ADD_ACKNOWLEDGER (Tuplet_engraver, string_number);
279 ADD_TRANSLATOR (Tuplet_engraver,
281 "Catch tuplet events and generate appropriate bracket.",
289 "tupletFullLengthNote ",