/*
- stem-grav.cc -- implement Stem_engraver
+ stem-engraver.cc -- implement Stem_engraver
source file of the GNU LilyPond music typesetter
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-#include "stem-engraver.hh"
-#include "note-head.hh"
-#include "stem.hh"
-#include "musical-request.hh"
-#include "duration-convert.hh"
+#include "engraver.hh"
+
+#include "context.hh"
+#include "directional-element-interface.hh"
+#include "duration.hh"
+#include "international.hh"
+#include "item.hh"
#include "misc.hh"
+#include "rhythmic-head.hh"
+#include "script-interface.hh"
+#include "staff-symbol-referencer.hh"
#include "stem-tremolo.hh"
-#include "staff-info.hh"
-#include "translator-group.hh"
+#include "stem.hh"
+#include "stream-event.hh"
-Stem_engraver::Stem_engraver()
+#include "translator.icc"
+
+class Stem_engraver : public Engraver
{
- abbrev_req_l_ = 0;
- stem_p_ = 0;
- abbrev_p_ = 0;
- default_abbrev_i_ = 16;
- rhythmic_req_l_ =0;
-}
+ Grob *stem_;
+ Grob *tremolo_;
+ Stream_event *rhythmic_ev_;
+ Stream_event *tremolo_ev_;
-void
-Stem_engraver::do_creation_processing ()
+ TRANSLATOR_DECLARATIONS (Stem_engraver);
+
+protected:
+ void make_stem (Grob_info);
+
+ DECLARE_TRANSLATOR_LISTENER (tremolo);
+ DECLARE_ACKNOWLEDGER (rhythmic_head);
+ void stop_translation_timestep ();
+};
+
+Stem_engraver::Stem_engraver ()
{
- SCM prop = get_property ("abbrev", 0);
- if (SCM_NUMBERP(prop))
- {
- default_abbrev_i_ = gh_scm2int (prop);
- }
+ tremolo_ev_ = 0;
+ stem_ = 0;
+ tremolo_ = 0;
+ rhythmic_ev_ = 0;
}
void
-Stem_engraver::acknowledge_element(Score_element_info i)
+Stem_engraver::make_stem (Grob_info gi)
{
- if (Rhythmic_head * h = dynamic_cast<Rhythmic_head *> (i.elem_l_))
+ /* Announce the cause of the head as cause of the stem. The
+ stem needs a rhythmic structure to fit it into a beam. */
+ stem_ = make_item ("Stem", gi.grob ()->self_scm ());
+
+ if (tremolo_ev_)
{
- if (h->stem_l_)
- return;
-
- Rhythmic_req * r = dynamic_cast <Rhythmic_req *> (i.req_l_);
- int duration_log = r->duration_.durlog_i_;
- if (!stem_p_)
+ /* Stem tremolo is never applied to a note by default,
+ is must me requested. But there is a default for the
+ tremolo value:
+
+ c4:8 c c:
+
+ the first and last (quarter) note bothe get one tremolo flag. */
+ int requested_type
+ = scm_to_int (tremolo_ev_->get_property ("tremolo-type"));
+ SCM f = get_property ("tremoloFlags");
+ if (!requested_type)
{
- stem_p_ = new Stem;
- stem_p_->flag_i_ = duration_log;
-
- if (abbrev_req_l_)
- {
- /*
- suggests typing of:
- c8:16 c: c: c:
- hmm, which isn't so bad?
- */
- int t = abbrev_req_l_->type_i_;
- if (!t)
- t = default_abbrev_i_;
- else
- default_abbrev_i_ = t;
-
- if (t)
- {
- abbrev_p_ = new Stem_tremolo;
- announce_element (Score_element_info (abbrev_p_, abbrev_req_l_));
- abbrev_p_->abbrev_flags_i_ =intlog2 (t) - (duration_log>? 2);
- }
- }
-
- // must give the request, to preserve the rhythmic info.
- announce_element (Score_element_info (stem_p_, r));
+ if (scm_is_number (f))
+ requested_type = scm_to_int (f);
+ else
+ requested_type = 8;
}
+ else
+ context ()->set_property ("tremoloFlags", scm_from_int (requested_type));
- if (stem_p_->flag_i_ != duration_log)
+
+ /*
+ we take the duration log from the Event, since the duration-log
+ for a note head is always <= 2.
+ */
+ Stream_event *ev = gi.event_cause ();
+ Duration *dur = unsmob_duration (ev->get_property ("duration"));
+
+ int tremolo_flags = intlog2 (requested_type) - 2
+ - (dur->duration_log () > 2 ? dur->duration_log () - 2 : 0);
+ if (tremolo_flags <= 0)
{
- r->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 << stem_p_->flag_i_));
+ tremolo_ev_->origin ()->warning (_ ("tremolo duration is too long"));
+ tremolo_flags = 0;
}
- stem_p_->add_head (h);
+ if (tremolo_flags)
+ {
+ tremolo_ = make_item ("StemTremolo", tremolo_ev_->self_scm ());
+
+ /* The number of tremolo flags is the number of flags of the
+ tremolo-type minus the number of flags of the note itself. */
+ tremolo_->set_property ("flag-count", scm_from_int (tremolo_flags));
+ tremolo_->set_parent (stem_, X_AXIS);
+ stem_->set_object ("tremolo-flag", tremolo_->self_scm ());
+ tremolo_->set_object ("stem", stem_->self_scm ());
+ }
}
}
void
-Stem_engraver::do_pre_move_processing()
+Stem_engraver::acknowledge_rhythmic_head (Grob_info gi)
{
- if (abbrev_p_)
- {
- abbrev_p_->set_stem (stem_p_);
- typeset_element (abbrev_p_);
- abbrev_p_ = 0;
- }
+ if (Rhythmic_head::get_stem (gi.grob ()))
+ return;
- if (stem_p_)
- {
- SCM prop = get_property ("verticalDirection", 0);
- if (SCM_NUMBERP(prop))
- {
- stem_p_->dir_ = to_dir (prop);
- stem_p_->set_elt_property (dir_forced_scm_sym, SCM_BOOL_T);
- }
+ Stream_event *cause = gi.event_cause ();
+ if (!cause)
+ return;
+ Duration *d = unsmob_duration (cause->get_property ("duration"));
+ if (!d)
+ return;
- Translator_group* which;
- prop = get_property ("stemLeftBeamCount", &which);
- if (SCM_NUMBERP(prop))
- {
- stem_p_->beams_i_drul_[LEFT] = gh_scm2int (prop);
- ((Translator_group*)which)->set_property ("stemLeftBeamCount", SCM_UNDEFINED);
- }
- prop = get_property ("stemRightBeamCount", &which);
- if (SCM_NUMBERP(prop))
- {
- stem_p_->beams_i_drul_[RIGHT] = gh_scm2int (prop);
- ((Translator_group*)which)->set_property ("stemRightBeamCount", SCM_UNDEFINED);
- }
+ if (!stem_)
+ make_stem (gi);
- prop = get_property ("stemLength", 0);
- if (SCM_NUMBERP(prop))
- {
- stem_p_->set_elt_property (length_scm_sym, prop);
- }
+ if (Stem::duration_log (stem_) != d->duration_log ())
+ {
+ // FIXME:
+ gi.event_cause ()->origin ()->warning (_f ("adding note head to incompatible stem (type = %d)",
+ 1 << Stem::duration_log (stem_)));
+ gi.event_cause ()->origin ()->warning (_ ("maybe input should specify polyphonic voices"));
+ }
+
+ Stem::add_head (stem_, gi.grob ());
+}
- prop = get_property ("stemStyle", 0);
- if (gh_string_p (prop))
+void
+Stem_engraver::stop_translation_timestep ()
+{
+ tremolo_ = 0;
+ if (stem_)
+ {
+ /* FIXME: junk these properties. */
+ SCM prop = get_property ("stemLeftBeamCount");
+ if (scm_is_number (prop))
{
- stem_p_->set_elt_property (style_scm_sym, prop);
+ Stem::set_beaming (stem_, scm_to_int (prop), LEFT);
+ context ()->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
}
-
- prop = get_property ("noStemExtend", 0);
- if (gh_boolean_p (prop) && gh_scm2bool (prop))
+ prop = get_property ("stemRightBeamCount");
+ if (scm_is_number (prop))
{
- stem_p_->set_elt_property (no_stem_extend_scm_sym, prop);
+ Stem::set_beaming (stem_, scm_to_int (prop), RIGHT);
+ context ()->unset_property (ly_symbol2scm ("stemRightBeamCount"));
}
-
- typeset_element(stem_p_);
- stem_p_ = 0;
+ stem_ = 0;
}
- abbrev_req_l_ = 0;
+ tremolo_ev_ = 0;
}
-bool
-Stem_engraver::do_try_music (Music* r)
+IMPLEMENT_TRANSLATOR_LISTENER (Stem_engraver, tremolo);
+void
+Stem_engraver::listen_tremolo (Stream_event *ev)
{
- if (Tremolo_req* a = dynamic_cast <Tremolo_req *> (r))
- {
- abbrev_req_l_ = a;
- return true;
- }
- return false;
+ ASSIGN_EVENT_ONCE (tremolo_ev_, ev);
}
+ADD_ACKNOWLEDGER (Stem_engraver, rhythmic_head);
+
+ADD_TRANSLATOR (Stem_engraver,
+ /* doc */
+ "Create stems and single-stem tremolos. It also works"
+ " together with the beam engraver for overriding beaming.",
+
+ /* create */
+ "Stem "
+ "StemTremolo ",
+
+ /* read */
+ "tremoloFlags "
+ "stemLeftBeamCount "
+ "stemRightBeamCount ",
-ADD_THIS_TRANSLATOR(Stem_engraver);
+ /* write */
+ ""
+ );