2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
5 Han-Wen Nienhuys <hanwen@xs4all.nl>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "multi-measure-rest.hh"
22 #include "paper-column.hh"
23 #include "engraver-group.hh"
24 #include "side-position-interface.hh"
25 #include "staff-symbol-referencer.hh"
26 #include "stream-event.hh"
30 #include "translator.icc"
33 The name says it all: make multi measure rests
35 class Multi_measure_rest_engraver : public Engraver
38 TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
41 void process_music ();
42 void start_translation_timestep ();
43 DECLARE_TRANSLATOR_LISTENER (multi_measure_rest);
44 DECLARE_TRANSLATOR_LISTENER (multi_measure_text);
47 void add_bound_item_to_grobs (Item *);
48 void clear_lapsed_events (const Moment &now);
51 Stream_event *rest_ev_;
52 vector<Stream_event *> text_events_;
57 // Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
58 Item *last_command_item_;
61 // text_[0] is a MultiMeasureRestNumber grob
62 // the rest are optional MultiMeasureRestText grobs
63 vector<Spanner *> text_;
66 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
68 last_command_item_ = 0;
71 For the start of a score.
79 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
81 Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
83 /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
84 the kill-mm-rests hack in part-combine-iterator. */
86 const Moment now (now_mom ());
87 stop_moment_ = now + get_event_length (rest_ev_, now);
89 if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
90 stop_moment_ = now_mom () + get_event_length (rest_ev_);
93 clear_lapsed_events (now);
96 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
98 Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
100 text_events_.push_back (ev);
104 Multi_measure_rest_engraver::add_bound_item_to_grobs (Item *item)
106 add_bound_item (mmrest_, item);
107 for (vsize i = 0; i < text_.size (); ++i)
108 add_bound_item (text_[i], item);
112 Multi_measure_rest_engraver::clear_lapsed_events (const Moment &now)
114 if (now.main_part_ >= stop_moment_.main_part_)
117 text_events_.clear ();
122 Multi_measure_rest_engraver::process_music ()
124 const bool measure_end
125 = scm_is_string (get_property ("whichBar"))
126 && (robust_scm2moment (get_property ("measurePosition"),
127 Moment (0)).main_part_ == Rational (0));
129 if (measure_end || first_time_)
131 last_command_item_ = unsmob<Item> (get_property ("currentCommandColumn"));
134 // Finalize the current grobs.
135 if (measure_end && mmrest_)
137 // Set the measure count now that it is known.
138 int cur = scm_to_int (get_property ("internalBarNumber"));
139 int num = cur - start_measure_;
140 SCM num_scm (scm_from_int (num));
142 mmrest_->set_property ("measure-count", num_scm);
144 assert (!text_.empty ());
147 if (scm_is_null (g->get_property ("text")))
149 SCM thres = get_property ("restNumberThreshold");
151 if (scm_is_number (thres))
152 t = scm_to_int (thres);
159 = scm_number_to_string (num_scm, scm_from_int (10));
160 g->set_property ("text", text);
164 if (last_command_item_)
165 add_bound_item_to_grobs (last_command_item_);
171 // Create new grobs if a rest event is (still) active.
172 if (rest_ev_ && !mmrest_)
174 mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
177 = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
178 text_.push_back (sp);
180 if (text_events_.size ())
182 for (vsize i = 0; i < text_events_.size (); i++)
184 Stream_event *e = text_events_[i];
186 = make_spanner ("MultiMeasureRestText", e->self_scm ());
187 SCM t = e->get_property ("text");
188 SCM dir = e->get_property ("direction");
189 sp->set_property ("text", t);
190 if (is_direction (dir))
191 sp->set_property ("direction", dir);
193 text_.push_back (sp);
197 Stack different scripts.
199 for (DOWN_and_UP (d))
202 for (vsize i = 0; i < text_.size (); i++)
204 if (scm_is_eq (scm_from_int (d),
205 text_[i]->get_property ("direction")))
208 Side_position_interface::add_support (text_[i], last);
215 for (vsize i = 0; i < text_.size (); i++)
217 Side_position_interface::add_support (text_[i], mmrest_);
218 text_[i]->set_parent (mmrest_, Y_AXIS);
219 text_[i]->set_parent (mmrest_, X_AXIS);
222 text_events_.clear ();
225 = scm_to_int (get_property ("internalBarNumber"));
227 if (last_command_item_)
229 add_bound_item_to_grobs (last_command_item_);
230 last_command_item_ = 0;
238 Multi_measure_rest_engraver::start_translation_timestep ()
240 clear_lapsed_events (now_mom ());
243 ADD_TRANSLATOR (Multi_measure_rest_engraver,
245 "Engrave multi-measure rests that are produced with"
246 " @samp{R}. It reads @code{measurePosition} and"
247 " @code{internalBarNumber} to determine what number to print"
248 " over the @ref{MultiMeasureRest}.",
252 "MultiMeasureRestNumber "
253 "MultiMeasureRestText ",
257 "restNumberThreshold "
258 "currentCommandColumn "