/*
- stem-grav.cc -- implement Stem_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
+ Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 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 "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"
+
+#include "translator.icc"
-Stem_engraver::Stem_engraver()
+class Stem_engraver : public Engraver
+{
+ Grob *stem_;
+ Grob *tremolo_;
+ vector <Grob *> maybe_flags_;
+ Stream_event *rhythmic_ev_;
+ Stream_event *tremolo_ev_;
+ bool tuplet_start_;
+
+ TRANSLATOR_DECLARATIONS (Stem_engraver);
+
+protected:
+ void make_stem (Grob_info, bool);
+
+ DECLARE_TRANSLATOR_LISTENER (tremolo);
+ DECLARE_TRANSLATOR_LISTENER (tuplet_span);
+ DECLARE_ACKNOWLEDGER (rhythmic_head);
+ void stop_translation_timestep ();
+ void finalize ();
+ void kill_unused_flags ();
+};
+
+Stem_engraver::Stem_engraver ()
{
- abbrev_req_l_ = 0;
- stem_p_ = 0;
- abbrev_p_ = 0;
- default_abbrev_i_ = 16;
- rhythmic_req_l_ =0;
+ tremolo_ev_ = 0;
+ stem_ = 0;
+ tremolo_ = 0;
+ rhythmic_ev_ = 0;
+ tuplet_start_ = false;
}
void
-Stem_engraver::do_creation_processing ()
+Stem_engraver::make_stem (Grob_info gi, bool tuplet_start)
{
- SCM prop = get_property ("abbrev", 0);
- if (gh_number_p(prop))
+ /* 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 (tuplet_start)
+ stem_->set_property ("tuplet-start", SCM_BOOL_T);
+ (void) make_item ("StemStub", gi.grob ()->self_scm ());
+ if (tremolo_ev_)
{
- default_abbrev_i_ = gh_scm2int (prop);
+ /* Stem tremolo is never applied to a note by default,
+ it must be requested. But there is a default for the
+ tremolo value:
+
+ c4:8 c c:
+
+ the first and last (quarter) note both get one tremolo flag. */
+ int requested_type
+ = robust_scm2int (tremolo_ev_->get_property ("tremolo-type"), 8);
+
+ /*
+ 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 = Duration::unsmob (ev->get_property ("duration"));
+
+ int tremolo_flags = intlog2 (requested_type) - 2
+ - (dur->duration_log () > 2 ? dur->duration_log () - 2 : 0);
+ if (tremolo_flags <= 0)
+ {
+ tremolo_ev_->origin ()->warning (_ ("tremolo duration is too long"));
+ tremolo_flags = 0;
+ }
+
+ 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::acknowledge_element(Score_element_info i)
+Stem_engraver::acknowledge_rhythmic_head (Grob_info gi)
{
- if (Rhythmic_head * h = dynamic_cast<Rhythmic_head *> (i.elem_l_))
+ if (Rhythmic_head::get_stem (gi.grob ()))
+ return;
+
+ Stream_event *cause = gi.event_cause ();
+ if (!cause)
+ return;
+ Duration *d = Duration::unsmob (cause->get_property ("duration"));
+ if (!d)
+ return;
+
+ if (!stem_)
+ make_stem (gi, tuplet_start_);
+
+ int ds = Stem::duration_log (stem_);
+ int dc = d->duration_log ();
+
+ // half notes and quarter notes all have compatible stems.
+ // Longas are done differently (oops?), so we can't unify
+ // them with the other stemmed notes.
+ if (ds == 1)
+ ds = 2;
+ if (dc == 1)
+ dc = 2;
+ // whole notes and brevis both have no stems
+ if (ds == -1)
+ ds = 0;
+ if (dc == -1)
+ dc = 0;
+
+ if (ds != dc)
{
- 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_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 (stem_p_->flag_i_ != duration_log)
- {
- r->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 << stem_p_->flag_i_));
- }
-
- stem_p_->add_head (h);
+ gi.event_cause ()->origin ()->warning (_f ("adding note head to incompatible stem (type = %d/%d)",
+ ds < 0 ? 1 << -ds : 1,
+ ds > 0 ? 1 << ds : 1));
+ gi.event_cause ()->origin ()->warning (_ ("maybe input should specify polyphonic voices"));
}
+
+ Stem::add_head (stem_, gi.grob ());
+
+ if (Stem::is_normal_stem (stem_)
+ && Stem::duration_log (stem_) > 2)
+ {
+ Item *flag = make_item ("Flag", stem_->self_scm ());
+ flag->set_parent (stem_, X_AXIS);
+ stem_->set_object ("flag", flag->self_scm ());
+ maybe_flags_.push_back (flag);
+ }
+ if (tuplet_start_)
+ stem_->set_property ("tuplet-start", SCM_BOOL_T);
}
void
-Stem_engraver::do_pre_move_processing()
+Stem_engraver::kill_unused_flags ()
{
- if (abbrev_p_)
- {
- abbrev_p_->set_stem (stem_p_);
- typeset_element (abbrev_p_);
- abbrev_p_ = 0;
- }
+ for (vsize i = 0; i < maybe_flags_.size (); i++)
+ if (Grob::is_smob (maybe_flags_[i]->get_parent (X_AXIS)->get_object ("beam")))
+ maybe_flags_[i]->suicide ();
+}
- if (stem_p_)
+void
+Stem_engraver::finalize ()
+{
+ kill_unused_flags ();
+}
+
+void
+Stem_engraver::stop_translation_timestep ()
+{
+ if (scm_is_string (get_property ("whichBar")))
+ kill_unused_flags ();
+
+ tremolo_ = 0;
+ if (stem_)
{
- Translator_group* which;
- SCM prop = get_property ("stemLeftBeamCount", &which);
- if (gh_number_p(prop))
- {
- stem_p_->beams_i_drul_[LEFT] = gh_scm2int (prop);
- ((Translator_group*)which)->set_property ("stemLeftBeamCount", SCM_UNDEFINED);
- }
- prop = get_property ("stemRightBeamCount", &which);
- if (gh_number_p(prop))
- {
- stem_p_->beams_i_drul_[RIGHT] = gh_scm2int (prop);
- ((Translator_group*)which)->set_property ("stemRightBeamCount", SCM_UNDEFINED);
- }
-
- // UGH. Should mark non-forced instead.
- SCM dir = stem_p_->get_elt_property ("direction");
- if (gh_number_p (dir) && gh_int2scm (dir))
- {
- stem_p_->set_elt_property ("dir-forced", SCM_BOOL_T);
- }
-
-
- typeset_element(stem_p_);
- stem_p_ = 0;
+ /* FIXME: junk these properties. */
+ SCM prop = get_property ("stemLeftBeamCount");
+ if (scm_is_number (prop))
+ {
+ Stem::set_beaming (stem_, scm_to_int (prop), LEFT);
+ context ()->unset_property (ly_symbol2scm ("stemLeftBeamCount"));
+ }
+ prop = get_property ("stemRightBeamCount");
+ if (scm_is_number (prop))
+ {
+ Stem::set_beaming (stem_, scm_to_int (prop), RIGHT);
+ context ()->unset_property (ly_symbol2scm ("stemRightBeamCount"));
+ }
+ stem_ = 0;
}
- abbrev_req_l_ = 0;
+ tuplet_start_ = false;
+ tremolo_ev_ = 0;
}
-bool
-Stem_engraver::do_try_music (Music* r)
+IMPLEMENT_TRANSLATOR_LISTENER (Stem_engraver, tuplet_span);
+void
+Stem_engraver::listen_tuplet_span (Stream_event *ev)
{
- if (Tremolo_req* a = dynamic_cast <Tremolo_req *> (r))
+ Direction dir = to_dir (ev->get_property ("span-direction"));
+ if (dir == START)
{
- abbrev_req_l_ = a;
- return true;
+ // set stem property if stem already exists
+ if (stem_)
+ stem_->set_property ("tuplet-start", SCM_BOOL_T);
+ tuplet_start_ = true; // stash the value for use in later creation
}
- return false;
}
+IMPLEMENT_TRANSLATOR_LISTENER (Stem_engraver, tremolo);
+void
+Stem_engraver::listen_tremolo (Stream_event *ev)
+{
+ 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 ",
-ADD_THIS_TRANSLATOR(Stem_engraver);
+ /* read */
+ "stemLeftBeamCount "
+ "stemRightBeamCount "
+ "whichBar ",
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff