/*
- beam-grav.cc -- implement Beam_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ LilyPond is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ LilyPond is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "duration-convert.hh"
-#include "time-description.hh"
-#include "beam-engraver.hh"
-#include "stem.hh"
+
#include "beam.hh"
-#include "musical-request.hh"
-#include "grouping.hh"
-#include "p-col.hh"
+#include "beaming-pattern.hh"
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "drul-array.hh"
+#include "duration.hh"
+#include "engraver.hh"
+#include "international.hh"
+#include "item.hh"
+#include "rest.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "stem.hh"
+#include "unpure-pure-container.hh"
#include "warn.hh"
-Beam_engraver::Beam_engraver()
+#include "translator.icc"
+
+class Beam_engraver : public Engraver
+{
+public:
+ void acknowledge_stem (Grob_info);
+ void acknowledge_rest (Grob_info);
+ void listen_beam (Stream_event *);
+
+protected:
+ Stream_event *start_ev_;
+
+ Spanner *finished_beam_;
+ Spanner *beam_;
+ Stream_event *prev_start_ev_;
+
+ Stream_event *stop_ev_;
+
+ Direction forced_direction_;
+
+ Beaming_pattern *beam_info_;
+ Beaming_pattern *finished_beam_info_;
+
+ /// location within measure where beam started.
+ Moment beam_start_location_;
+
+ /// moment (global time) where beam started.
+ Moment beam_start_mom_;
+
+ Beaming_options beaming_options_;
+ Beaming_options finished_beaming_options_;
+
+ void typeset_beam ();
+ void set_melisma (bool);
+
+ Moment last_stem_added_at_;
+ void stop_translation_timestep ();
+ void start_translation_timestep ();
+ virtual void finalize ();
+
+ void process_music ();
+
+ virtual bool valid_start_point ();
+ virtual bool valid_end_point ();
+
+public:
+ TRANSLATOR_DECLARATIONS (Beam_engraver);
+};
+
+/*
+ Hmm. this isn't necessary, since grace beams and normal beams are
+ always nested.
+*/
+bool
+Beam_engraver::valid_start_point ()
{
- span_reqs_drul_[LEFT] = span_reqs_drul_[RIGHT] =0;
- beam_p_ =0;
- current_grouping_p_ =0;
+ Moment n = now_mom ();
+
+ return n.grace_part_ == Rational (0);
}
bool
-Beam_engraver::do_try_request(Request*r)
+Beam_engraver::valid_end_point ()
+{
+ return valid_start_point ();
+}
+
+Beam_engraver::Beam_engraver (Context *c)
+ : Engraver (c)
{
- Musical_req* mus_l = r->access_Musical_req ();
- if (!mus_l)
- return false;
+ beam_ = 0;
+ finished_beam_ = 0;
+ finished_beam_info_ = 0;
+ beam_info_ = 0;
+ forced_direction_ = CENTER;
+ stop_ev_ = 0;
+ start_ev_ = 0;
+ prev_start_ev_ = 0;
+}
- Beam_req* b = mus_l->access_Beam_req ();
- if (!b)
- return false;
+void
+Beam_engraver::listen_beam (Stream_event *ev)
+{
+ Direction d = to_dir (ev->get_property ("span-direction"));
- if (bool (beam_p_) == bool (b->spantype == Span_req::START))
- return false;
+ if (d == START && valid_start_point ())
+ {
+ ASSIGN_EVENT_ONCE (start_ev_, ev);
- Direction d = (!beam_p_) ? LEFT : RIGHT;
- if (span_reqs_drul_[d] && !span_reqs_drul_[d]->equal_b (mus_l))
- return false;
+ Direction updown = to_dir (ev->get_property ("direction"));
+ if (updown)
+ forced_direction_ = updown;
+ }
+ else if (d == STOP && valid_end_point ())
+ ASSIGN_EVENT_ONCE (stop_ev_, ev);
+}
- span_reqs_drul_[d] = b;
- return true;
+void
+Beam_engraver::set_melisma (bool ml)
+{
+ SCM b = get_property ("autoBeaming");
+ if (!to_boolean (b))
+ context ()->set_property ("beamMelismaBusy", ml ? SCM_BOOL_T : SCM_BOOL_F);
}
void
-Beam_engraver::do_process_requests()
+Beam_engraver::process_music ()
{
- if (beam_p_ || !span_reqs_drul_[LEFT])
- return;
+ if (start_ev_)
+ {
+ if (beam_)
+ {
+ start_ev_->origin ()->warning (_ ("already have a beam"));
+ return;
+ }
+
+ set_melisma (true);
+ prev_start_ev_ = start_ev_;
+ beam_ = make_spanner ("Beam", start_ev_->self_scm ());
- current_grouping_p_ = new Rhythmic_grouping;
- beam_p_ = new Beam;
+ Moment mp (robust_scm2moment (get_property ("measurePosition"),
+ Moment (0)));
+
+ beam_start_location_ = mp;
+ beam_start_mom_ = now_mom ();
+
+ beaming_options_.from_context (context ());
+ beam_info_ = new Beaming_pattern;
+ /* urg, must copy to Auto_beam_engraver too */
+ }
- Scalar prop = get_property ("beamslopedamping");
- if (prop.isnum_b ())
- beam_p_->damping_i_ = prop;
+ typeset_beam ();
+ if (stop_ev_ && beam_)
+ {
+ announce_end_grob (beam_, stop_ev_->self_scm ());
- prop = get_property ("beamquantisation");
- if (prop.isnum_b ())
- beam_p_->quantisation_ = (Beam::Quantisation)(int)prop;
-
- announce_element (Score_element_info (beam_p_, span_reqs_drul_[LEFT]));
+ }
}
void
-Beam_engraver::do_pre_move_processing()
+Beam_engraver::typeset_beam ()
{
- if (!beam_p_ || !span_reqs_drul_[RIGHT])
- return;
+ if (finished_beam_)
+ {
+ Grob *stem = finished_beam_->get_bound (RIGHT);
+ if (!stem)
+ {
+ stem = finished_beam_->get_bound (LEFT);
+ if (stem)
+ finished_beam_->set_bound (RIGHT, stem);
+ }
+
+ if (stem && forced_direction_)
+ set_grob_direction (stem, forced_direction_);
+
+ forced_direction_ = CENTER;
+ finished_beam_info_->beamify (finished_beaming_options_);
+
+ Beam::set_beaming (finished_beam_, finished_beam_info_);
- Rhythmic_grouping const * rg_C = get_staff_info().rhythmic_C_;
- rg_C->extend (current_grouping_p_->interval());
- beam_p_->set_grouping (*rg_C, *current_grouping_p_);
- typeset_element (beam_p_);
- beam_p_ = 0;
+ delete finished_beam_info_;
+ finished_beam_info_ = 0;
+ finished_beam_ = 0;
- delete current_grouping_p_;
- current_grouping_p_ = 0;
+ }
+}
- span_reqs_drul_[RIGHT] = span_reqs_drul_[LEFT] = 0;
+void
+Beam_engraver::start_translation_timestep ()
+{
+ start_ev_ = 0;
+
+ if (beam_)
+ set_melisma (true);
}
void
-Beam_engraver::do_removal_processing()
+Beam_engraver::stop_translation_timestep ()
{
- if (beam_p_)
+ if (stop_ev_)
{
- span_reqs_drul_[LEFT]->warning (_("unterminated beam"));
- typeset_element (beam_p_);
- beam_p_ =0;
+ finished_beam_ = beam_;
+ finished_beam_info_ = beam_info_;
+ finished_beaming_options_ = beaming_options_;
+
+ stop_ev_ = 0;
+ beam_ = 0;
+ beam_info_ = 0;
+ typeset_beam ();
+ set_melisma (false);
}
}
+void
+Beam_engraver::finalize ()
+{
+ typeset_beam ();
+ if (beam_)
+ {
+ prev_start_ev_->origin ()->warning (_ ("unterminated beam"));
+
+ /*
+ we don't typeset it, (we used to, but it was commented
+ out. Reason unknown) */
+ beam_->suicide ();
+ delete beam_info_;
+ }
+}
+
+void
+Beam_engraver::acknowledge_rest (Grob_info info)
+{
+ if (beam_
+ && !scm_is_number (info.grob ()->get_property_data ("staff-position")))
+ chain_offset_callback (info.grob (),
+ Unpure_pure_container::make_smob
+ (Beam::rest_collision_callback_proc,
+ Beam::pure_rest_collision_callback_proc),
+ Y_AXIS);
+}
void
-Beam_engraver::acknowledge_element (Score_element_info i)
+Beam_engraver::acknowledge_stem (Grob_info info)
{
- if (!beam_p_ || !i.elem_l_->is_type_b (Stem::static_name ()))
+ if (!beam_)
return;
- Stem* s = (Stem*)i.elem_l_->access_Item ();
- if (!i.req_l_ || !i.req_l_->access_Musical_req () || !i.req_l_->access_Musical_req ()->access_Rhythmic_req ())
- {
- ::warning ( _("Stem must have Rhythmic structure."));
- return;
- }
+ Moment now = now_mom ();
+ if (!valid_start_point ())
+ return;
+
+ // It's suboptimal that we don't support callbacks returning ##f,
+ // but this makes beams have no effect on "stems" reliably in
+ // TabStaff when \tabFullNotation is switched off: the real stencil
+ // callback for beams is called quite late in the process, and we
+ // don't want to trigger it early.
+ if (scm_is_false (beam_->get_property_data ("stencil")))
+ return;
+
+ Item *stem = dynamic_cast<Item *> (info.grob ());
+ if (Stem::get_beam (stem))
+ return;
- Rhythmic_req *rhythmic_req = i.req_l_->access_Musical_req ()->access_Rhythmic_req ();
- if (rhythmic_req->duration_.durlog_i_<= 2)
+ Stream_event *ev = info.ultimate_event_cause ();
+ if (!ev->in_event_class ("rhythmic-event"))
{
- rhythmic_req->warning (_ ("stem doesn't fit in beam"));
+ info.grob ()->warning (_ ("stem must have Rhythmic structure"));
return;
}
- /*
- TODO: do something sensible if it doesn't fit in the beam.
- */
- Moment start = get_staff_info().time_C_->whole_in_measure_;
+ last_stem_added_at_ = now;
- if (!current_grouping_p_->child_fit_b (start))
+ Duration *stem_duration = unsmob<Duration> (ev->get_property ("duration"));
+ int durlog = stem_duration->duration_log ();
+ //int durlog = unsmob<Duration> (ev->get_property ("duration"))->duration_log ();
+ if (durlog <= 2)
{
- String s (_("please fix me") + ": "
- + _f ("stem at %s doesn't fit in beam", now_moment ().str ()));
- if (i.req_l_)
- i.req_l_->warning(s);
- else
- warning (s);
- }
- else
- {
- current_grouping_p_->add_child (start, rhythmic_req->duration ());
- s->flag_i_ = rhythmic_req->duration_.durlog_i_;
- beam_p_->add_stem (s);
+ ev->origin ()->warning (_ ("stem does not fit in beam"));
+ prev_start_ev_->origin ()->warning (_ ("beam was started here"));
+ /*
+ don't return, since
+
+ [r4 c8] can just as well be modern notation.
+ */
}
+
+ if (forced_direction_)
+ set_grob_direction (stem, forced_direction_);
+
+ stem->set_property ("duration-log", scm_from_int (durlog));
+ Moment stem_location = now - beam_start_mom_ + beam_start_location_;
+ beam_info_->add_stem (stem_location,
+ max (durlog - 2, 0),
+ Stem::is_invisible (stem),
+ stem_duration->factor (),
+ (to_boolean (stem->get_property ("tuplet-start"))));
+ Beam::add_stem (beam_, stem);
}
-IMPLEMENT_IS_TYPE_B1(Beam_engraver, Engraver);
-ADD_THIS_TRANSLATOR(Beam_engraver);
+
+
+void
+Beam_engraver::boot ()
+{
+ ADD_LISTENER (Beam_engraver, beam);
+ ADD_ACKNOWLEDGER (Beam_engraver, stem);
+ ADD_ACKNOWLEDGER (Beam_engraver, rest);
+}
+
+ADD_TRANSLATOR (Beam_engraver,
+ /* doc */
+ "Handle @code{Beam} events by engraving beams. If omitted,"
+ " then notes are printed with flags instead of beams.",
+
+ /* create */
+ "Beam ",
+
+ /* read */
+ "baseMoment "
+ "beamMelismaBusy "
+ "beatStructure "
+ "subdivideBeams ",
+
+ /* write */
+ "forbidBreak"
+ );
+
+class Grace_beam_engraver : public Beam_engraver
+{
+public:
+ TRANSLATOR_DECLARATIONS (Grace_beam_engraver);
+ TRANSLATOR_INHERIT (Beam_engraver);
+
+protected:
+ virtual bool valid_start_point ();
+ virtual bool valid_end_point ();
+};
+
+Grace_beam_engraver::Grace_beam_engraver (Context *c)
+ : Beam_engraver (c)
+{
+}
+
+bool
+Grace_beam_engraver::valid_start_point ()
+{
+ Moment n = now_mom ();
+
+ return n.grace_part_ != Rational (0);
+}
+
+bool
+Grace_beam_engraver::valid_end_point ()
+{
+ return beam_ && valid_start_point ();
+}
+
+void
+Grace_beam_engraver::boot ()
+{
+ ADD_LISTENER (Grace_beam_engraver, beam);
+ ADD_ACKNOWLEDGER (Grace_beam_engraver, stem);
+ ADD_ACKNOWLEDGER (Grace_beam_engraver, rest);
+}
+
+ADD_TRANSLATOR (Grace_beam_engraver,
+ /* doc */
+ "Handle @code{Beam} events by engraving beams. If omitted,"
+ " then notes are printed with flags instead of beams. Only"
+ " engraves beams when we are at grace points in time.",
+
+ /* create */
+ "Beam ",
+
+ /* read */
+ "baseMoment "
+ "beamMelismaBusy "
+ "beatStructure "
+ "subdivideBeams ",
+
+ /* write */
+ ""
+ );
+