/*
- extender-engraver.cc -- implement Extender_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1998 Jan Nieuwenhuizen <janneke@gnu.org>
+ 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 "proto.hh"
-#include "musical-request.hh"
-#include "extender-engraver.hh"
-#include "extender-spanner.hh"
-#include "text-def.hh"
-#include "score-column.hh"
-#include "text-item.hh"
+#include "context.hh"
+#include "engraver.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
+{
+ Stream_event *ev_;
+ Spanner *extender_;
+ Spanner *pending_extender_;
+
+public:
+ TRANSLATOR_DECLARATIONS (Extender_engraver);
+
+protected:
+ void listen_extender (Stream_event *);
+ void listen_completize_extender (Stream_event *);
+ void acknowledge_lyric_syllable (Grob_info);
+
+ virtual void finalize ();
+
+ void stop_translation_timestep ();
+ void process_music ();
+};
+
+Extender_engraver::Extender_engraver (Context *c)
+ : Engraver (c)
+{
+ extender_ = 0;
+ pending_extender_ = 0;
+ ev_ = 0;
+}
-IMPLEMENT_IS_TYPE_B1 (Extender_engraver,Engraver);
-ADD_THIS_TRANSLATOR (Extender_engraver);
+void
+Extender_engraver::listen_extender (Stream_event *ev)
+{
+ ASSIGN_EVENT_ONCE (ev_, ev);
+}
-Extender_engraver::Extender_engraver ()
+/*
+ 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::listen_completize_extender (Stream_event * /* ev */)
{
- extender_spanner_p_ = 0;
- span_reqs_drul_[RIGHT] = span_reqs_drul_[LEFT] = 0;
+ if (pending_extender_)
+ {
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
+ }
}
void
-Extender_engraver::acknowledge_element (Score_element_info i)
+Extender_engraver::process_music ()
{
- Text_item* t = (dynamic_cast<Text_item*> (i.elem_l_));
- if (!t)
- return;
- if (!extender_spanner_p_)
- return;
- if (!span_reqs_drul_[LEFT])
- return;
-
- if (!extender_spanner_p_->textitem_l_drul_[LEFT])
- extender_spanner_p_->set_textitem (LEFT, t);
- else
- if (span_reqs_drul_[RIGHT] && !extender_spanner_p_->textitem_l_drul_[RIGHT])
- extender_spanner_p_->set_textitem (RIGHT, t);
+ if (ev_)
+ extender_ = make_spanner ("LyricExtender", ev_->self_scm ());
}
-bool
-Extender_engraver::do_try_request (Request* req_l)
+void
+Extender_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- Extender_req* p = dynamic_cast <Extender_req *> (req_l);
- if (!p)
- return false;
+ Item *item = i.item ();
+ if (extender_)
+ extender_->set_bound (LEFT, item);
- if (bool (extender_spanner_p_) == bool (p->spantype == Span_req::START))
- return false;
+ if (pending_extender_)
+ {
+ pending_extender_->set_object ("next", item->self_scm ());
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
+ }
+}
- Direction d = (!extender_spanner_p_) ? LEFT : RIGHT;
- if (span_reqs_drul_[d] && !span_reqs_drul_[d]->equal_b (req_l))
- return false;
+void
+Extender_engraver::stop_translation_timestep ()
+{
+ if (extender_ || pending_extender_)
+ {
+ 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;
+ }
+ }
- span_reqs_drul_[d] = p;
- span_mom_drul_[d] = get_staff_info ().musical_l ()->when ();
- return true;
+ ev_ = 0;
}
void
-Extender_engraver::do_removal_processing ()
+completize_extender (Spanner *sp)
{
- if (extender_spanner_p_)
+ if (!sp->get_bound (RIGHT))
{
- span_reqs_drul_[LEFT]->warning (_ ("unterminated extender"));
- extender_spanner_p_->unlink ();
- delete extender_spanner_p_;
- extender_spanner_p_ = 0;
- span_reqs_drul_[RIGHT] = span_reqs_drul_[LEFT] = 0;
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
}
void
-Extender_engraver::do_process_requests ()
+Extender_engraver::finalize ()
{
- if (extender_spanner_p_ || !span_reqs_drul_[LEFT])
- return;
+ if (extender_)
+ {
+ completize_extender (extender_);
- extender_spanner_p_ = new Extender_spanner;
+ if (!extender_->get_bound (RIGHT))
+ extender_->warning (_ ("unterminated extender"));
+ extender_ = 0;
+ }
- announce_element (Score_element_info (extender_spanner_p_, span_reqs_drul_[LEFT]));
+ if (pending_extender_)
+ {
+ completize_extender (pending_extender_);
+
+ if (!pending_extender_->get_bound (RIGHT))
+ pending_extender_->warning (_ ("unterminated extender"));
+ pending_extender_ = 0;
+ }
}
void
-Extender_engraver::do_pre_move_processing ()
+Extender_engraver::boot ()
{
- if (!extender_spanner_p_ || !span_reqs_drul_[RIGHT])
- return;
-
- typeset_element (extender_spanner_p_);
-
- extender_spanner_p_ = 0;
- span_reqs_drul_[RIGHT] = span_reqs_drul_[LEFT] = 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 ",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff