X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fstem-engraver.cc;h=199d9fd17ea735d1a1c2308324938d694268e208;hb=b9e47a70690bb6010cb9371d10366c9bd4abc803;hp=374a3b1f1aac3a553898d9514b39a2366f8259e6;hpb=94189ec2b8da6d7e89dc619c646a927adead9b19;p=lilypond.git diff --git a/lily/stem-engraver.cc b/lily/stem-engraver.cc index 374a3b1f1a..199d9fd17e 100644 --- a/lily/stem-engraver.cc +++ b/lily/stem-engraver.cc @@ -1,177 +1,262 @@ /* - 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 - (c) 1997--2001 Han-Wen Nienhuys + 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 . */ -#include "staff-symbol-referencer.hh" -#include "rhythmic-head.hh" -#include "stem.hh" -#include "musical-request.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 "item.hh" -#include "translator-group.hh" -#include "engraver.hh" +#include "stem.hh" +#include "stream-event.hh" + +#include "translator.icc" -/** - Make stems upon receiving noteheads. - */ class Stem_engraver : public Engraver { + Grob *stem_; + Grob *tremolo_; + vector maybe_flags_; + Stream_event *rhythmic_ev_; + Stream_event *tremolo_ev_; + bool tuplet_start_; + + TRANSLATOR_DECLARATIONS (Stem_engraver); -public: - VIRTUAL_COPY_CONS (Translator); - Stem_engraver(); - protected: - virtual void acknowledge_grob (Grob_info); - virtual void stop_translation_timestep (); - virtual bool try_music (Music*); - -private: - Grob *stem_p_; - Grob *tremolo_p_; - Rhythmic_req *rhythmic_req_l_; - Tremolo_req* tremolo_req_l_; -}; + void make_stem (Grob_info, bool); -ADD_THIS_TRANSLATOR (Stem_engraver); + void listen_tremolo (Stream_event *); + void listen_tuplet_span (Stream_event *); + void acknowledge_rhythmic_head (Grob_info); + void stop_translation_timestep (); + void finalize (); + void kill_unused_flags (); +}; -Stem_engraver::Stem_engraver () +Stem_engraver::Stem_engraver (Context *c) + : Engraver (c) { - tremolo_req_l_ = 0; - stem_p_ = 0; - tremolo_p_ = 0; - rhythmic_req_l_ =0; + tremolo_ev_ = 0; + stem_ = 0; + tremolo_ = 0; + rhythmic_ev_ = 0; + tuplet_start_ = false; } - void -Stem_engraver::acknowledge_grob(Grob_info i) +Stem_engraver::make_stem (Grob_info gi, bool tuplet_start) { - Grob* h = i.elem_l_; - if (Rhythmic_head::has_interface (h)) + /* 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_) { - if (Rhythmic_head::stem_l (h)) - return; - - int duration_log = unsmob_duration (i.req_l_->get_mus_property ("duration"))-> duration_log (); - - if (!stem_p_) - { - stem_p_ = new Item (get_property ("Stem")); - Stem::set_interface (stem_p_); - Staff_symbol_referencer::set_interface(stem_p_); - - - stem_p_->set_grob_property ("duration-log", gh_int2scm (duration_log)); - - if (tremolo_req_l_) - { - /* - 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 = gh_scm2int (tremolo_req_l_->get_mus_property ("tremolo-type")); - - SCM f = get_property ("tremoloFlags"); - if (!requested_type && gh_number_p (f)) - requested_type = gh_scm2int (f); - else - daddy_trans_l_->set_property ("tremoloFlags", gh_int2scm (requested_type)); - - if (requested_type) - { - tremolo_p_ = new Item (get_property ("StemTremolo")); - Stem_tremolo::set_interface (tremolo_p_); - - announce_grob (tremolo_p_, tremolo_req_l_); - /* - The number of tremolo flags is the number of flags of - the tremolo-type minus the number of flags of the note - itself. - */ - int tremolo_flags = intlog2 (requested_type) - 2 - - (duration_log > 2 ? duration_log - 2 : 0); - if (tremolo_flags < 0) - tremolo_flags = 0; - tremolo_p_->set_grob_property ("tremolo-flags", - gh_int2scm (tremolo_flags)); - } - } - announce_grob (stem_p_, i.req_l_); - } - - if (Stem::flag_i (stem_p_) != duration_log) - { - i.req_l_->origin ()->warning (_f ("Adding note head to incompatible stem (type = %d)", 1 << Stem::flag_i (stem_p_))); - } - - Stem::add_head (stem_p_,h); + /* 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 = 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::stop_translation_timestep() +Stem_engraver::acknowledge_rhythmic_head (Grob_info gi) { - if (tremolo_p_) + if (Rhythmic_head::get_stem (gi.grob ())) + return; + + Stream_event *cause = gi.event_cause (); + if (!cause) + return; + Duration *d = 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) + { + 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 + && !(unsmob (stem_->get_object ("flag")))) { - Stem_tremolo::set_stem (tremolo_p_, stem_p_); - typeset_grob (tremolo_p_); - tremolo_p_ = 0; + 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::kill_unused_flags () +{ + for (vsize i = 0; i < maybe_flags_.size (); i++) + if (unsmob (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_) { + /* FIXME: junk these properties. */ SCM prop = get_property ("stemLeftBeamCount"); - if (gh_number_p(prop)) - { - Stem::set_beaming (stem_p_,gh_scm2int (prop),LEFT); - daddy_trans_l_->set_property ("stemLeftBeamCount", SCM_UNDEFINED); - } + 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 (gh_number_p(prop)) - { - Stem::set_beaming (stem_p_,gh_scm2int (prop), RIGHT); - daddy_trans_l_->set_property ("stemRightBeamCount", SCM_UNDEFINED); - } - - - // UGH. Should mark non-forced instead. - /* - aargh: I don't get it. direction is being set (and then set - to forced), if we have a Chord_tremolo. - */ - SCM dir = stem_p_->get_grob_property ("direction"); - if (gh_number_p (dir) && to_dir(dir)) - { - stem_p_->set_grob_property ("dir-forced", SCM_BOOL_T); - } - - typeset_grob(stem_p_); - stem_p_ = 0; + if (scm_is_number (prop)) + { + Stem::set_beaming (stem_, scm_to_int (prop), RIGHT); + context ()->unset_property (ly_symbol2scm ("stemRightBeamCount")); + } + stem_ = 0; } - - - tremolo_req_l_ = 0; + tuplet_start_ = false; + tremolo_ev_ = 0; } -bool -Stem_engraver::try_music (Music* r) +void +Stem_engraver::listen_tuplet_span (Stream_event *ev) { - if (Tremolo_req* a = dynamic_cast (r)) + Direction dir = to_dir (ev->get_property ("span-direction")); + if (dir == START) { - tremolo_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; } +void +Stem_engraver::listen_tremolo (Stream_event *ev) +{ + ASSIGN_EVENT_ONCE (tremolo_ev_, ev); +} + + +void +Stem_engraver::boot () +{ + ADD_LISTENER (Stem_engraver, tuplet_span); + ADD_LISTENER (Stem_engraver, tremolo); + ADD_ACKNOWLEDGER (Stem_engraver, rhythmic_head); +} + +ADD_TRANSLATOR (Stem_engraver, + /* doc */ + "Create stems, flags and single-stem tremolos. It also works" + " together with the beam engraver for overriding beaming.", + + /* create */ + "Flag " + "Stem " + "StemStub " + "StemTremolo ", + + /* read */ + "stemLeftBeamCount " + "stemRightBeamCount " + "whichBar ", + + /* write */ + "" + );