2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--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/>.
20 #include "engraver.hh"
22 #include "note-spacing.hh"
23 #include "paper-column.hh"
24 #include "pointer-group-interface.hh"
27 #include "staff-spacing.hh"
28 #include "stream-event.hh"
30 #include "translator.icc"
42 Rhythmic_tuple (Grob_info i, Moment m)
47 static int time_compare (Rhythmic_tuple const &, Rhythmic_tuple const &);
51 compare (Rhythmic_tuple const &a, Rhythmic_tuple const &b)
53 return Rhythmic_tuple::time_compare (a, b);
57 Rhythmic_tuple::time_compare (Rhythmic_tuple const &h1,
58 Rhythmic_tuple const &h2)
60 return (h1.end_ - h2.end_).main_part_.sign ();
63 /****************************************************************/
66 Acknowledge rhythmic elements, for initializing spacing fields in
69 class Spacing_engraver : public Engraver
71 PQueue<Rhythmic_tuple> playing_durations_;
72 vector<Rhythmic_tuple> now_durations_;
73 vector<Rhythmic_tuple> stopped_durations_;
76 Stream_event *start_section_;
78 TRANSLATOR_DECLARATIONS (Spacing_engraver);
81 DECLARE_ACKNOWLEDGER (staff_spacing);
82 DECLARE_ACKNOWLEDGER (note_spacing);
83 DECLARE_ACKNOWLEDGER (rhythmic_head);
84 DECLARE_ACKNOWLEDGER (rhythmic_grob);
85 DECLARE_TRANSLATOR_LISTENER (spacing_section);
87 void start_translation_timestep ();
88 void stop_translation_timestep ();
89 void process_music ();
90 void add_starter_duration (Grob_info i);
92 virtual void finalize ();
94 void start_spanner ();
98 Spacing_engraver::Spacing_engraver ()
104 IMPLEMENT_TRANSLATOR_LISTENER (Spacing_engraver, spacing_section);
106 Spacing_engraver::listen_spacing_section (Stream_event *ev)
108 ASSIGN_EVENT_ONCE (start_section_, ev);
112 Spacing_engraver::process_music ()
114 if (start_section_ && spacing_)
122 Spacing_engraver::start_spanner ()
126 spacing_ = make_spanner ("SpacingSpanner", SCM_EOL);
127 spacing_->set_bound (LEFT,
128 unsmob<Grob> (get_property ("currentCommandColumn")));
132 Spacing_engraver::finalize ()
138 Spacing_engraver::stop_spanner ()
142 Grob *p = unsmob<Grob> (get_property ("currentCommandColumn"));
144 spacing_->set_bound (RIGHT, p);
150 Spacing_engraver::acknowledge_note_spacing (Grob_info i)
152 Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
156 Spacing_engraver::acknowledge_staff_spacing (Grob_info i)
158 Pointer_group_interface::add_grob (spacing_, ly_symbol2scm ("wishes"), i.grob ());
162 Spacing_engraver::acknowledge_rhythmic_grob (Grob_info i)
164 add_starter_duration (i);
168 Spacing_engraver::acknowledge_rhythmic_head (Grob_info i)
170 add_starter_duration (i);
174 Spacing_engraver::add_starter_duration (Grob_info i)
176 if (i.grob ()->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface"))
177 || i.grob ()->internal_has_interface (ly_symbol2scm ("multi-measure-interface")))
181 only pay attention to durations that are not grace notes.
183 if (!now_.grace_part_)
185 Stream_event *r = i.event_cause ();
186 if (r && r->in_event_class ("rhythmic-event"))
188 Moment len = get_event_length (r, now_);
189 Rhythmic_tuple t (i, now_mom () + len);
190 now_durations_.push_back (t);
196 Spacing_engraver::stop_translation_timestep ()
198 Paper_column *musical_column
199 = unsmob<Paper_column> (get_property ("currentMusicalColumn"));
204 musical_column->set_object ("spacing", spacing_->self_scm ());
205 unsmob<Grob> (get_property ("currentCommandColumn"))
206 ->set_object ("spacing", spacing_->self_scm ());
208 SCM proportional = get_property ("proportionalNotationDuration");
209 if (unsmob<Moment> (proportional))
211 musical_column->set_property ("shortest-playing-duration", proportional);
212 musical_column->set_property ("shortest-starter-duration", proportional);
213 musical_column->set_property ("used", SCM_BOOL_T);
217 Moment shortest_playing;
218 shortest_playing.set_infinite (1);
219 for (vsize i = 0; i < playing_durations_.size (); i++)
221 Stream_event *ev = playing_durations_[i].info_.event_cause ();
224 Moment m = get_event_length (ev);
225 shortest_playing = std::min (shortest_playing, m);
229 starter.set_infinite (1);
231 for (vsize i = 0; i < now_durations_.size (); i++)
233 Moment m = get_event_length (now_durations_[i].info_.event_cause ());
236 starter = std::min (starter, m);
237 playing_durations_.insert (now_durations_[i]);
240 now_durations_.clear ();
242 shortest_playing = std::min (shortest_playing, starter);
244 assert (starter.to_bool ());
245 SCM sh = shortest_playing.smobbed_copy ();
246 SCM st = starter.smobbed_copy ();
248 musical_column->set_property ("shortest-playing-duration", sh);
249 musical_column->set_property ("shortest-starter-duration", st);
253 Spacing_engraver::start_translation_timestep ()
258 stopped_durations_.clear ();
260 while (playing_durations_.size () && playing_durations_.front ().end_ < now_)
261 playing_durations_.delmin ();
262 while (playing_durations_.size () && playing_durations_.front ().end_ == now_)
263 stopped_durations_.push_back (playing_durations_.get ());
266 ADD_ACKNOWLEDGER (Spacing_engraver, staff_spacing);
267 ADD_ACKNOWLEDGER (Spacing_engraver, note_spacing);
268 ADD_ACKNOWLEDGER (Spacing_engraver, rhythmic_head);
269 ADD_ACKNOWLEDGER (Spacing_engraver, rhythmic_grob);
271 ADD_TRANSLATOR (Spacing_engraver,
273 "Make a @code{SpacingSpanner} and do bookkeeping of shortest"
274 " starting and playing notes.",
280 "currentMusicalColumn "
281 "currentCommandColumn "
282 "proportionalNotationDuration ",