/*
- extender-engraver.cc -- implement Extender_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1999--2004 Glen Prideaux <glenprideaux@iname.com>,
- Han-Wen Nienhuys <hanwen@cs.uu.nl>,
- Jan Nieuwenhuizen <janneke@gnu.org>
+ Copyright (C) 1999--2014 Glen Prideaux <glenprideaux@iname.com>,
+ Han-Wen Nienhuys <hanwen@xs4all.nl>,
+ Jan Nieuwenhuizen <janneke@gnu.org>
+
+ 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 "context.hh"
#include "engraver.hh"
-#include "group-interface.hh"
+#include "international.hh"
#include "item.hh"
#include "lyric-extender.hh"
#include "note-head.hh"
+#include "pointer-group-interface.hh"
+#include "stream-event.hh"
#include "warn.hh"
+#include "spanner.hh"
+#include "translator.icc"
void completize_extender (Spanner *sp);
class Extender_engraver : public Engraver
{
- Music *ev_;
+ Stream_event *ev_;
Spanner *extender_;
Spanner *pending_extender_;
TRANSLATOR_DECLARATIONS (Extender_engraver);
protected:
- virtual void acknowledge_grob (Grob_info);
+ DECLARE_TRANSLATOR_LISTENER (extender);
+ DECLARE_TRANSLATOR_LISTENER (completize_extender);
+ DECLARE_ACKNOWLEDGER (lyric_syllable);
+
virtual void finalize ();
- virtual bool try_music (Music*);
- virtual void stop_translation_timestep ();
- virtual void process_music ();
-};
+ void stop_translation_timestep ();
+ void process_music ();
+};
Extender_engraver::Extender_engraver ()
{
ev_ = 0;
}
-bool
-Extender_engraver::try_music (Music *r)
+IMPLEMENT_TRANSLATOR_LISTENER (Extender_engraver, extender);
+void
+Extender_engraver::listen_extender (Stream_event *ev)
{
- if (!ev_)
+ ASSIGN_EVENT_ONCE (ev_, ev);
+}
+
+/*
+ A CompletizeExtenderEvent is sent at the end of each lyrics block
+ to ensure any pending extender can be correctly terminated if the lyrics
+ end before the associated voice (this prevents the right bound being extended
+ to the next note-column if no lyric follows the extender)
+*/
+IMPLEMENT_TRANSLATOR_LISTENER (Extender_engraver, completize_extender);
+void
+Extender_engraver::listen_completize_extender (Stream_event * /* ev */)
+{
+ if (pending_extender_)
{
- ev_ = r;
- return true;
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
}
- return false;
}
void
}
void
-Extender_engraver::acknowledge_grob (Grob_info i)
+Extender_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- Item *item = dynamic_cast<Item*> (i.grob_);
+ Item *item = i.item ();
+ if (extender_)
+ extender_->set_bound (LEFT, item);
- if (item
- && item->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
+ if (pending_extender_)
{
- if (extender_)
- extender_->set_bound (LEFT, item);
-
- if (pending_extender_)
- {
- pending_extender_->set_property ("next", item->self_scm ());
- completize_extender (pending_extender_);
- pending_extender_ = 0;
- }
+ pending_extender_->set_object ("next", item->self_scm ());
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
}
}
if (extender_ || pending_extender_)
{
Context *voice = get_voice_to_lyrics (context ());
- Grob *h = voice ? get_current_note_head (voice) : 0;
+ Grob *h = voice ? get_current_note_head (voice, to_boolean (get_property ("includeGraceNotes"))) : 0;
if (h)
- {
- if (extender_)
- {
- Pointer_group_interface::add_grob (extender_,
- ly_symbol2scm ("heads"), h);
- }
-
- if (pending_extender_)
- {
- Pointer_group_interface::add_grob (pending_extender_,
- ly_symbol2scm ("heads"), h);
- }
- }
-
+ {
+ if (extender_)
+ {
+ Pointer_group_interface::add_grob (extender_,
+ ly_symbol2scm ("heads"), h);
+ }
+
+ if (pending_extender_)
+ {
+ Pointer_group_interface::add_grob (pending_extender_,
+ ly_symbol2scm ("heads"), h);
+ }
+ }
+ else
+ {
+ if (pending_extender_
+ && !get_property ("extendersOverRests"))
+ {
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
+ }
+ }
if (extender_)
- {
- pending_extender_ = extender_;
- extender_ = 0;
- }
+ {
+ pending_extender_ = extender_;
+ extender_ = 0;
+ }
}
ev_ = 0;
{
if (!sp->get_bound (RIGHT))
{
- SCM heads = sp->get_property ("heads");
- if (scm_is_pair (heads))
- {
- Item *it = dynamic_cast<Item*> (unsmob_grob (scm_car (heads)));
- if (it)
- sp->set_bound (RIGHT, it);
- }
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
}
completize_extender (extender_);
if (!extender_->get_bound (RIGHT))
- extender_->warning (_ ("unterminated extender"));
+ extender_->warning (_ ("unterminated extender"));
extender_ = 0;
}
completize_extender (pending_extender_);
if (!pending_extender_->get_bound (RIGHT))
- pending_extender_->warning (_ ("unterminated extender"));
- pending_extender_ =0;
+ pending_extender_->warning (_ ("unterminated extender"));
+ pending_extender_ = 0;
}
}
+ADD_ACKNOWLEDGER (Extender_engraver, lyric_syllable);
+ADD_TRANSLATOR (Extender_engraver,
+ /* doc */
+ "Create lyric extenders.",
+
+ /* create */
+ "LyricExtender ",
+
+ /* read */
+ "extendersOverRests "
+ "includeGraceNotes ",
-ENTER_DESCRIPTION (Extender_engraver,
-/* descr */ "Create lyric extenders",
-/* creats*/ "LyricExtender",
-/* accepts */ "extender-event",
-/* acks */ "lyric-syllable-interface",
-/* reads */ "",
-/* write */ "");
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff