/*
- extender-engraver.cc -- implement Extender_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1999 Glen Prideaux <glenprideaux@iname.com>,
- Han-Wen Nienhuys, Jan Nieuwenhuizen.
-
+ Copyright (C) 1999--2015 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 "flower-proto.hh"
-#include "musical-request.hh"
-#include "lyric-extender.hh"
-#include "paper-column.hh"
-#include "item.hh"
+#include "context.hh"
#include "engraver.hh"
-#include "drul-array.hh"
+#include "international.hh"
+#include "item.hh"
#include "lyric-extender.hh"
-#include "pqueue.hh"
-
+#include "note-head.hh"
+#include "pointer-group-interface.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+#include "spanner.hh"
+#include "translator.icc"
-/**
- Generate an centred extender. Should make a Extender_spanner that
- typesets a nice centred extender of varying length depending on the
- gap between syllables.
+void completize_extender (Spanner *sp);
- We remember the last Item that come across. When we get a
- request, we create the spanner, and attach the left point to the
- last lyrics, and the right point to any lyrics we receive by
- then. */
class Extender_engraver : public Engraver
{
- Grob *last_lyric_l_;
- Grob *current_lyric_l_;
- Extender_req* req_l_;
- Spanner* extender_p_;
+ Stream_event *ev_;
+ Spanner *extender_;
+ Spanner *pending_extender_;
+
public:
- TRANSLATOR_DECLARATIONS(Extender_engraver);
+ TRANSLATOR_DECLARATIONS (Extender_engraver);
protected:
- virtual void acknowledge_grob (Grob_info);
+ void listen_extender (Stream_event *);
+ void listen_completize_extender (Stream_event *);
+ void acknowledge_lyric_syllable (Grob_info);
+
virtual void finalize ();
- virtual bool try_music (Music*);
- virtual void stop_translation_timestep ();
- virtual void start_translation_timestep ();
- virtual void process_music ();
-private:
+ void stop_translation_timestep ();
+ void process_music ();
};
+Extender_engraver::Extender_engraver (Context *c)
+ : Engraver (c)
+{
+ extender_ = 0;
+ pending_extender_ = 0;
+ ev_ = 0;
+}
-
-
-Extender_engraver::Extender_engraver ()
+void
+Extender_engraver::listen_extender (Stream_event *ev)
{
- current_lyric_l_ = 0;
- last_lyric_l_ = 0;
- extender_p_ = 0;
- req_l_ = 0;
+ 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)
+*/
void
-Extender_engraver::acknowledge_grob (Grob_info i)
+Extender_engraver::listen_completize_extender (Stream_event * /* ev */)
{
- // -> text_item
- if (i.grob_l_->has_interface (ly_symbol2scm ("lyric-syllable-interface")))
+ if (pending_extender_)
{
- current_lyric_l_ = i.grob_l_;
- if (extender_p_
- && !extender_p_->get_bound (RIGHT)
- )
- {
- Lyric_extender::set_textitem (extender_p_, RIGHT, dynamic_cast<Item*> (i.grob_l_));
- }
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
}
}
+void
+Extender_engraver::process_music ()
+{
+ if (ev_)
+ extender_ = make_spanner ("LyricExtender", ev_->self_scm ());
+}
-bool
-Extender_engraver::try_music (Music* r)
+void
+Extender_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- if (Extender_req* p = dynamic_cast <Extender_req *> (r))
- {
- if (req_l_)
- return false;
+ Item *item = i.item ();
+ if (extender_)
+ extender_->set_bound (LEFT, item);
- req_l_ = p;
- return true;
+ if (pending_extender_)
+ {
+ pending_extender_->set_object ("next", item->self_scm ());
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
}
- return false;
}
void
-Extender_engraver::finalize ()
+Extender_engraver::stop_translation_timestep ()
{
- if (extender_p_)
+ if (extender_ || pending_extender_)
{
- req_l_->origin ()->warning (_ ("unterminated extender"));
- extender_p_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
+ Context *voice = get_voice_to_lyrics (context ());
+ Grob *h = voice ? get_current_note_head (voice) : 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);
+ }
+ }
+ else
+ {
+ if (pending_extender_
+ && !to_boolean (get_property ("extendersOverRests")))
+ {
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
+ }
+ }
+ if (extender_)
+ {
+ pending_extender_ = extender_;
+ extender_ = 0;
+ }
}
+
+ ev_ = 0;
}
void
-Extender_engraver::process_music ()
+completize_extender (Spanner *sp)
{
- if (req_l_ && ! extender_p_)
+ if (!sp->get_bound (RIGHT))
{
- if (!last_lyric_l_)
- {
- req_l_->origin ()->warning (_ ("Nothing to connect extender to on the left. Ignoring extender request."));
- return;
- }
-
- extender_p_ = new Spanner (get_property ("LyricExtender"));
-
-
- Lyric_extender::set_textitem (extender_p_, LEFT, last_lyric_l_);
- announce_grob(extender_p_, req_l_->self_scm());
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
}
-
void
-Extender_engraver::stop_translation_timestep ()
+Extender_engraver::finalize ()
{
- if (extender_p_)
+ if (extender_)
{
- typeset_grob (extender_p_);
- extender_p_ = 0;
+ completize_extender (extender_);
+
+ if (!extender_->get_bound (RIGHT))
+ extender_->warning (_ ("unterminated extender"));
+ extender_ = 0;
}
- if (current_lyric_l_)
+ if (pending_extender_)
{
- last_lyric_l_ = current_lyric_l_;
- current_lyric_l_ =0;
+ completize_extender (pending_extender_);
+
+ if (!pending_extender_->get_bound (RIGHT))
+ pending_extender_->warning (_ ("unterminated extender"));
+ pending_extender_ = 0;
}
}
void
-Extender_engraver::start_translation_timestep ()
+Extender_engraver::boot ()
{
- req_l_ = 0;
+ ADD_LISTENER (Extender_engraver, extender);
+ ADD_LISTENER (Extender_engraver, completize_extender);
+ ADD_ACKNOWLEDGER (Extender_engraver, lyric_syllable);
}
+ADD_TRANSLATOR (Extender_engraver,
+ /* doc */
+ "Create lyric extenders.",
+
+ /* create */
+ "LyricExtender ",
+
+ /* read */
+ "extendersOverRests ",
-ENTER_DESCRIPTION(Extender_engraver,
-/* descr */ "Create lyric extenders",
-/* creats*/ "LyricExtender",
-/* acks */ "lyric-syllable-interface",
-/* reads */ "",
-/* write */ "");
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff