X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Fextender-engraver.cc;h=d38adce683034f520361c508eb3df16648608f19;hb=a1c2a3a778efafbb8abbd44eb212a3f52f34c5f9;hp=25ca7a65b9aa5dbcaa1ca92cc29623d6d9c1cfc4;hpb=31cbeab5d7a702ca843694f000af9abefce2b6a8;p=lilypond.git diff --git a/lily/extender-engraver.cc b/lily/extender-engraver.cc index 25ca7a65b9..d38adce683 100644 --- a/lily/extender-engraver.cc +++ b/lily/extender-engraver.cc @@ -1,148 +1,198 @@ /* - 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--2003 Glen Prideaux , - Han-Wen Nienhuys , - Jan Nieuwenhuizen + Copyright (C) 1999--2010 Glen Prideaux , + Han-Wen Nienhuys , + Jan Nieuwenhuizen + + 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 "flower-proto.hh" -#include "event.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" +void completize_extender (Spanner *sp); -/** - Generate an centred extender. Should make a Extender_spanner that - typesets a nice centred extender of varying length depending on the - gap between syllables. - - We remember the last Item that come across. When we get a - event, 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_; - Grob *current_lyric_; - Music* req_; - Spanner* extender_; + Stream_event *ev_; + Spanner *extender_; + Spanner *pending_extender_; + public: - TRANSLATOR_DECLARATIONS(Extender_engraver); + 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 start_translation_timestep (); - virtual void process_music (); -private: + void stop_translation_timestep (); + void process_music (); }; - - - Extender_engraver::Extender_engraver () { - current_lyric_ = 0; - last_lyric_ = 0; extender_ = 0; - req_ = 0; + pending_extender_ = 0; + ev_ = 0; } +IMPLEMENT_TRANSLATOR_LISTENER (Extender_engraver, extender); void -Extender_engraver::acknowledge_grob (Grob_info i) +Extender_engraver::listen_extender (Stream_event *ev) { - // -> text_item - if (i.grob_->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface"))) - { - current_lyric_ = i.grob_; - if (extender_ - && !extender_->get_bound (RIGHT) - ) - { - Lyric_extender::set_textitem (extender_, RIGHT, dynamic_cast (i.grob_)); - } - } + ASSIGN_EVENT_ONCE (ev_, ev); } -bool -Extender_engraver::try_music (Music* r) +/* + 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 (req_) - return false; + if (pending_extender_) + { + completize_extender (pending_extender_); + pending_extender_ = 0; + } +} - req_ = r; - return true; +void +Extender_engraver::process_music () +{ + if (ev_) + extender_ = make_spanner ("LyricExtender", ev_->self_scm ()); } void -Extender_engraver::finalize () +Extender_engraver::acknowledge_lyric_syllable (Grob_info i) { + Item *item = i.item (); if (extender_) + extender_->set_bound (LEFT, item); + + if (pending_extender_) { - req_->origin ()->warning (_ ("unterminated extender")); - extender_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn"))); + pending_extender_->set_object ("next", item->self_scm ()); + completize_extender (pending_extender_); + pending_extender_ = 0; } } void -Extender_engraver::process_music () +Extender_engraver::stop_translation_timestep () { - if (req_ && ! extender_) + if (extender_ || pending_extender_) { - if (!last_lyric_) + Context *voice = get_voice_to_lyrics (context ()); + 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); + } + } + else + { + if (pending_extender_ + && !get_property ("extendersOverRests")) + { + completize_extender (pending_extender_); + pending_extender_ = 0; + } + } + if (extender_) { - req_->origin ()->warning (_ ("Nothing to connect extender to on the left. Ignoring extender event.")); - return; + pending_extender_ = extender_; + extender_ = 0; } - - extender_ = new Spanner (get_property ("LyricExtender")); + } + ev_ = 0; +} - Lyric_extender::set_textitem (extender_, LEFT, last_lyric_); - announce_grob(extender_, req_->self_scm()); +void +completize_extender (Spanner *sp) +{ + if (!sp->get_bound (RIGHT)) + { + 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_) { - typeset_grob (extender_); + completize_extender (extender_); + + if (!extender_->get_bound (RIGHT)) + extender_->warning (_ ("unterminated extender")); extender_ = 0; } - if (current_lyric_) + if (pending_extender_) { - last_lyric_ = current_lyric_; - current_lyric_ =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 () -{ - req_ = 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 */ + "" + );