2 beam-engraver.cc -- implement Beam_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "beaming-pattern.hh"
12 #include "drul-array.hh"
13 #include "duration.hh"
14 #include "engraver.hh"
15 #include "international.hh"
19 #include "stream-event.hh"
23 #include "translator.icc"
25 class Beam_engraver : public Engraver
28 DECLARE_ACKNOWLEDGER (stem);
29 DECLARE_ACKNOWLEDGER (rest);
31 Stream_event *start_ev_;
33 Spanner *finished_beam_;
35 Stream_event *prev_start_ev_;
37 Stream_event *now_stop_ev_;
39 Beaming_pattern *beam_info_;
40 Beaming_pattern *finished_beam_info_;
42 /// location within measure where beam started.
43 Moment beam_start_location_;
45 /// moment (global time) where beam started.
46 Moment beam_start_mom_;
48 bool subdivide_beams_;
52 void set_melisma (bool);
54 Moment last_stem_added_at_;
55 void stop_translation_timestep ();
56 void start_translation_timestep ();
57 virtual void finalize ();
59 void process_music ();
61 virtual bool valid_start_point ();
62 virtual bool valid_end_point ();
64 DECLARE_TRANSLATOR_LISTENER (beam);
66 TRANSLATOR_DECLARATIONS (Beam_engraver);
70 Hmm. this isn't necessary, since grace beams and normal beams are
74 Beam_engraver::valid_start_point ()
76 Moment n = now_mom ();
78 return n.grace_part_ == Rational (0);
82 Beam_engraver::valid_end_point ()
84 return valid_start_point ();
87 Beam_engraver::Beam_engraver ()
91 finished_beam_info_ = 0;
98 IMPLEMENT_TRANSLATOR_LISTENER (Beam_engraver, beam);
100 Beam_engraver::listen_beam (Stream_event *ev)
102 Direction d = to_dir (ev->get_property ("span-direction"));
104 if (d == START && valid_start_point ())
105 ASSIGN_EVENT_ONCE (start_ev_, ev);
106 else if (d == STOP && valid_end_point ())
107 ASSIGN_EVENT_ONCE (now_stop_ev_, ev);
111 Beam_engraver::set_melisma (bool ml)
113 SCM b = get_property ("autoBeaming");
115 context ()->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T : SCM_BOOL_F);
119 Beam_engraver::process_music ()
121 if (beam_ && !to_boolean (get_property ("allowBeamBreak")))
122 context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
128 start_ev_->origin ()->warning (_ ("already have a beam"));
133 prev_start_ev_ = start_ev_;
134 beam_ = make_spanner ("Beam", start_ev_->self_scm ());
135 Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
137 beam_start_location_ = mp;
138 beam_start_mom_ = now_mom ();
140 beam_info_ = new Beaming_pattern;
141 /* urg, must copy to Auto_beam_engraver too */
146 Beam_engraver::typeset_beam ()
150 if (!finished_beam_->get_bound (RIGHT))
151 finished_beam_->set_bound (RIGHT, finished_beam_->get_bound (LEFT));
153 finished_beam_info_->beamify (context ());
154 Beam::set_beaming (finished_beam_, finished_beam_info_);
156 delete finished_beam_info_;
157 finished_beam_info_ = 0;
163 Beam_engraver::start_translation_timestep ()
174 Beam_engraver::stop_translation_timestep ()
179 finished_beam_ = beam_;
180 finished_beam_info_ = beam_info_;
191 Beam_engraver::finalize ()
196 prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
199 we don't typeset it, (we used to, but it was commented
200 out. Reason unknown) */
207 Beam_engraver::acknowledge_rest (Grob_info info)
210 && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
212 chain_offset_callback (info.grob(),
213 Beam::rest_collision_callback_proc, Y_AXIS);
220 Beam_engraver::acknowledge_stem (Grob_info info)
225 Moment now = now_mom ();
226 if (!valid_start_point ())
229 Item *stem = dynamic_cast<Item *> (info.grob ());
230 if (Stem::get_beam (stem))
235 Stream_event *ev = info.ultimate_event_cause ();
236 if (!ev->in_event_class ("rhythmic-event"))
238 info.grob ()->warning (_ ("stem must have Rhythmic structure"));
242 last_stem_added_at_ = now;
243 int durlog = unsmob_duration (ev->get_property ("duration"))->duration_log ();
246 ev->origin ()->warning (_ ("stem doesn't fit in beam"));
247 prev_start_ev_->origin ()->warning (_ ("beam was started here"));
251 [r4 c8] can just as well be modern notation.
255 stem->set_property ("duration-log",
256 scm_from_int (durlog));
257 Moment stem_location = now - beam_start_mom_ + beam_start_location_;
258 beam_info_->add_stem (stem_location,
260 Beam::add_stem (beam_, stem);
263 ADD_ACKNOWLEDGER (Beam_engraver, stem);
264 ADD_ACKNOWLEDGER (Beam_engraver, rest);
266 ADD_TRANSLATOR (Beam_engraver,
269 "Handles Beam events by engraving Beams. If omitted, then notes will be "
270 "printed with flags instead of beams.",
282 class Grace_beam_engraver : public Beam_engraver
285 TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
287 DECLARE_TRANSLATOR_LISTENER (beam);
290 virtual bool valid_start_point ();
291 virtual bool valid_end_point ();
294 Grace_beam_engraver::Grace_beam_engraver ()
299 Grace_beam_engraver::valid_start_point ()
301 Moment n = now_mom ();
303 return n.grace_part_ != Rational (0);
307 Grace_beam_engraver::valid_end_point ()
309 return beam_ && valid_start_point ();
315 IMPLEMENT_TRANSLATOR_LISTENER (Grace_beam_engraver, beam);
317 Grace_beam_engraver::listen_beam (Stream_event *ev)
319 Direction d = to_dir (ev->get_property ("span-direction"));
321 if (d == START && valid_start_point ())
323 else if (d == STOP && valid_end_point ())
328 ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
329 ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
331 ADD_TRANSLATOR (Grace_beam_engraver,
335 "Handles Beam events by engraving Beams. If omitted, then notes will "
336 "be printed with flags instead of beams. Only engraves beams when we "
337 " are at grace points in time. ",