/*
- extender-engraver.cc -- implement Extender_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1998--1999 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 "g-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);
-ADD_THIS_TRANSLATOR (Extender_engraver);
+protected:
+ void listen_extender (Stream_event *);
+ void listen_completize_extender (Stream_event *);
+ void acknowledge_lyric_syllable (Grob_info);
-Extender_engraver::Extender_engraver ()
+ virtual void finalize ();
+
+ void stop_translation_timestep ();
+ void process_music ();
+};
+
+Extender_engraver::Extender_engraver (Context *c)
+ : Engraver (c)
{
- extender_spanner_p_ = 0;
- req_l_ = 0;
+ extender_ = 0;
+ pending_extender_ = 0;
+ ev_ = 0;
}
void
-Extender_engraver::acknowledge_element (Score_element_info i)
+Extender_engraver::listen_extender (Stream_event *ev)
{
- if (G_text_item* t = dynamic_cast<G_text_item*> (i.elem_l_))
+ 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::listen_completize_extender (Stream_event * /* ev */)
+{
+ if (pending_extender_)
{
- Rhythmic_req * rh = dynamic_cast<Rhythmic_req*> (i.req_l_);
- if (!rh)
- return;
-
- now_lyrics_.push (Text_lyric_tuple (t, rh, now_mom () + rh->length_mom ()));
- /*
- UGH. What do we do in case of multiple alternatives?
- */
- if (extender_spanner_p_
- && !extender_spanner_p_->spanned_drul_[RIGHT]
- )
- {
- extender_spanner_p_->set_textitem (RIGHT, t);
- }
+ completize_extender (pending_extender_);
+ pending_extender_ = 0;
}
}
+void
+Extender_engraver::process_music ()
+{
+ if (ev_)
+ extender_ = make_spanner ("LyricExtender", ev_->self_scm ());
+}
-bool
-Extender_engraver::do_try_music (Music* req_l)
+void
+Extender_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- if (Extender_req* p = dynamic_cast <Extender_req *> (req_l))
- {
- 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::do_removal_processing ()
+Extender_engraver::stop_translation_timestep ()
{
- if (extender_spanner_p_)
+ if (extender_ || pending_extender_)
{
- req_l_->warning (_ ("unterminated extender"));
- extender_spanner_p_->set_bounds(RIGHT, get_staff_info ().command_pcol_l ());
+ 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::do_process_requests ()
+completize_extender (Spanner *sp)
{
- Array<Text_lyric_tuple> stopped_texts;
- Moment now = now_mom ();
-
- stopped_texts.clear ();
- while (past_lyrics_pq_.size ()
- && past_lyrics_pq_.front ().end_ == now)
- stopped_texts.push (past_lyrics_pq_.get ());
-
- if (req_l_)
+ if (!sp->get_bound (RIGHT))
{
- if (!stopped_texts.size ())
- {
- req_l_->warning ("Nothing to connect extender to on the left. Ignoring extender request");
- return;
- }
-
- extender_spanner_p_ = new Extender_spanner;
- extender_spanner_p_->set_textitem (LEFT, stopped_texts[0].text_l_);
- announce_element (Score_element_info (extender_spanner_p_, req_l_));
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
}
-
void
-Extender_engraver::do_pre_move_processing ()
+Extender_engraver::finalize ()
{
- for (int i=0; i < now_lyrics_.size (); i++)
+ if (extender_)
{
- past_lyrics_pq_.insert (now_lyrics_[i]);
+ completize_extender (extender_);
+
+ if (!extender_->get_bound (RIGHT))
+ extender_->warning (_ ("unterminated extender"));
+ extender_ = 0;
}
- now_lyrics_.clear ();
- if (extender_spanner_p_)
+ if (pending_extender_)
{
- typeset_element (extender_spanner_p_);
- extender_spanner_p_ = 0;
+ completize_extender (pending_extender_);
+
+ if (!pending_extender_->get_bound (RIGHT))
+ pending_extender_->warning (_ ("unterminated extender"));
+ pending_extender_ = 0;
}
}
+
void
-Extender_engraver::do_post_move_processing ()
+Extender_engraver::boot ()
{
- Moment now = now_mom ();
- while (past_lyrics_pq_.size () && past_lyrics_pq_.front ().end_ < now)
- past_lyrics_pq_.delmin ();
-
- req_l_ =0;
+ ADD_LISTENER (Extender_engraver, extender);
+ ADD_LISTENER (Extender_engraver, completize_extender);
+ ADD_ACKNOWLEDGER (Extender_engraver, lyric_syllable);
}
-/**********************************************************************/
-Text_lyric_tuple::Text_lyric_tuple ()
-{
- text_l_ =0;
- req_l_ =0;
- end_ = 0;
-}
+ADD_TRANSLATOR (Extender_engraver,
+ /* doc */
+ "Create lyric extenders.",
-Text_lyric_tuple::Text_lyric_tuple (G_text_item *h, Rhythmic_req*m, Moment mom)
-{
- text_l_ = h;
- req_l_ = m;
- end_ = mom;
-}
+ /* create */
+ "LyricExtender ",
+ /* read */
+ "extendersOverRests ",
-int
-Text_lyric_tuple::time_compare (Text_lyric_tuple const&h1,
- Text_lyric_tuple const &h2)
-{
- return (h1.end_ - h2.end_ ).sign ();
-}
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff