/*
- hyphen-engraver.cc -- implement Hyphen_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- (c) 1999 Glen Prideaux <glenprideaux@iname.com>
+ 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 "hyphen-engraver.hh"
-#include "hyphen-spanner.hh"
-#include "paper-column.hh"
-#include "text-item.hh"
-#include "extender-engraver.hh"
+#include "engraver.hh"
+#include "international.hh"
+#include "item.hh"
+#include "pointer-group-interface.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+class Hyphen_engraver : public Engraver
+{
+ Stream_event *ev_;
+ Stream_event *finished_ev_;
+
+ Spanner *hyphen_;
+ Spanner *finished_hyphen_;
+
+public:
+ TRANSLATOR_DECLARATIONS (Hyphen_engraver);
+
+protected:
-ADD_THIS_TRANSLATOR (Hyphen_engraver);
+ void acknowledge_lyric_syllable (Grob_info);
+ void listen_hyphen (Stream_event *);
-Hyphen_engraver::Hyphen_engraver ()
+ virtual void finalize ();
+
+ void stop_translation_timestep ();
+ void process_music ();
+};
+
+Hyphen_engraver::Hyphen_engraver (Context *c)
+ : Engraver (c)
{
- current_lyric_l_ = 0;
- last_lyric_l_ = 0;
- hyphen_spanner_p_ = 0;
- req_l_ = 0;
+ hyphen_ = 0;
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
+ ev_ = 0;
}
void
-Hyphen_engraver::acknowledge_element (Score_element_info i)
+Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- if (Text_item* t = dynamic_cast<Text_item*> (i.elem_l_))
- {
- current_lyric_l_ = t;
- if (hyphen_spanner_p_
- && !hyphen_spanner_p_->spanned_drul_[RIGHT]
- )
- {
- hyphen_spanner_p_->set_textitem (RIGHT, t);
- }
- }
-}
+ Item *item = i.item ();
+ if (!hyphen_)
+ hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
-bool
-Hyphen_engraver::do_try_music (Music* r)
-{
- if (Hyphen_req* p = dynamic_cast <Hyphen_req *> (r))
- {
- if (req_l_)
- return false;
+ if (hyphen_)
+ hyphen_->set_bound (LEFT, item);
- req_l_ = p;
- return true;
- }
- return false;
+ if (finished_hyphen_)
+ finished_hyphen_->set_bound (RIGHT, item);
+}
+
+void
+Hyphen_engraver::listen_hyphen (Stream_event *ev)
+{
+ ASSIGN_EVENT_ONCE (ev_, ev);
}
void
-Hyphen_engraver::do_removal_processing ()
+completize_hyphen (Spanner *sp)
{
- if (hyphen_spanner_p_)
+ if (!sp->get_bound (RIGHT))
{
- req_l_->warning (_ ("unterminated hyphen"));
- hyphen_spanner_p_->set_bounds(RIGHT, get_staff_info ().command_pcol_l ());
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
}
void
-Hyphen_engraver::do_process_requests ()
+Hyphen_engraver::finalize ()
{
- if (req_l_)
+ if (hyphen_)
{
- if (!last_lyric_l_)
- {
- req_l_->warning (_ ("Nothing to connect hyphen to on the left. Ignoring hyphen request."));
- return;
- }
-
- hyphen_spanner_p_ = new Hyphen_spanner;
- hyphen_spanner_p_->set_textitem (LEFT, last_lyric_l_);
- announce_element (Score_element_info (hyphen_spanner_p_, req_l_));
+ completize_hyphen (hyphen_);
+
+ if (!hyphen_->get_bound (RIGHT))
+ {
+ hyphen_->warning (_ ("removing unterminated hyphen"));
+ hyphen_->suicide ();
+ }
+
+ hyphen_ = 0;
+ }
+
+ if (finished_hyphen_)
+ {
+ completize_hyphen (finished_hyphen_);
+
+ if (!finished_hyphen_->get_bound (RIGHT))
+ {
+ if (finished_ev_)
+ finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
+ finished_hyphen_->suicide ();
+ }
+ finished_hyphen_ = 0;
}
}
+void
+Hyphen_engraver::process_music ()
+{
+ if (ev_)
+ hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
+}
void
-Hyphen_engraver::do_pre_move_processing ()
+Hyphen_engraver::stop_translation_timestep ()
{
- if (hyphen_spanner_p_)
+ if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
+ {
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
+ }
+
+ if (finished_hyphen_ && hyphen_)
{
- typeset_element (hyphen_spanner_p_);
- hyphen_spanner_p_ = 0;
+ programming_error ("hyphen not finished yet");
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
}
- if (current_lyric_l_)
+ if (hyphen_)
{
- last_lyric_l_ = current_lyric_l_;
- current_lyric_l_ =0;
+ finished_hyphen_ = hyphen_;
+ finished_ev_ = ev_;
}
+
+ hyphen_ = 0;
+ ev_ = 0;
}
+
void
-Hyphen_engraver::do_post_move_processing ()
+Hyphen_engraver::boot ()
{
- req_l_ = 0;
+ ADD_LISTENER (Hyphen_engraver, hyphen);
+ ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
}
+ADD_TRANSLATOR (Hyphen_engraver,
+ /* doc */
+ "Create lyric hyphens and distance constraints between words.",
+
+ /* create */
+ "LyricHyphen "
+ "LyricSpace ",
+
+ /* read */
+ "",
+ /* write */
+ ""
+ );