/*
- 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--2014 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 "hyphen-spanner.hh"
-#include "paper-column.hh"
-#include "item.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"
-/**
- Generate an centred hyphen. Should make a Hyphen_spanner that
- typesets a nice centred hyphen of varying length depending on the
- gap between syllables.
+#include "translator.icc"
- 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 Hyphen_engraver : public Engraver
{
- Grob *last_lyric_l_;
- Grob *current_lyric_l_;
- Hyphen_req* req_l_;
- Spanner* hyphen_p_;
+ Stream_event *ev_;
+ Stream_event *finished_ev_;
+
+ Spanner *hyphen_;
+ Spanner *finished_hyphen_;
+
public:
- TRANSLATOR_DECLARATIONS(Hyphen_engraver);
+ TRANSLATOR_DECLARATIONS (Hyphen_engraver);
protected:
- virtual void acknowledge_grob (Grob_info);
- virtual void finalize ();
- virtual bool try_music (Music*);
- virtual void stop_translation_timestep ();
- virtual void start_translation_timestep ();
- virtual void create_grobs ();
-private:
-};
+ DECLARE_ACKNOWLEDGER (lyric_syllable);
+ DECLARE_TRANSLATOR_LISTENER (hyphen);
+ virtual void finalize ();
+ void stop_translation_timestep ();
+ void process_music ();
+};
Hyphen_engraver::Hyphen_engraver ()
{
- current_lyric_l_ = 0;
- last_lyric_l_ = 0;
- hyphen_p_ = 0;
- req_l_ = 0;
+ hyphen_ = 0;
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
+ ev_ = 0;
}
void
-Hyphen_engraver::acknowledge_grob (Grob_info i)
+Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
{
- // -> text-item
- if (i.grob_l_->has_interface (ly_symbol2scm ("lyric-syllable-interface")))
- {
- current_lyric_l_ = i.grob_l_;
- if (hyphen_p_
- && !hyphen_p_->get_bound (RIGHT)
- )
- {
- Hyphen_spanner (hyphen_p_).set_textitem (RIGHT, i.grob_l_);
- }
- }
+ Item *item = i.item ();
+
+ if (!hyphen_)
+ hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
+
+ if (hyphen_)
+ hyphen_->set_bound (LEFT, item);
+
+ if (finished_hyphen_)
+ finished_hyphen_->set_bound (RIGHT, item);
}
+IMPLEMENT_TRANSLATOR_LISTENER (Hyphen_engraver, hyphen);
+void
+Hyphen_engraver::listen_hyphen (Stream_event *ev)
+{
+ ASSIGN_EVENT_ONCE (ev_, ev);
+}
-bool
-Hyphen_engraver::try_music (Music* r)
+void
+completize_hyphen (Spanner *sp)
{
- if (Hyphen_req* p = dynamic_cast <Hyphen_req *> (r))
+ if (!sp->get_bound (RIGHT))
{
- if (req_l_)
- return false;
-
- req_l_ = p;
- return true;
+ extract_item_set (sp, "heads", heads);
+ if (heads.size ())
+ sp->set_bound (RIGHT, heads.back ());
}
- return false;
}
void
Hyphen_engraver::finalize ()
{
- if (hyphen_p_)
+ if (hyphen_)
{
- req_l_->origin ()->warning (_ ("unterminated hyphen"));
- hyphen_p_->set_bound (RIGHT, unsmob_grob (get_property ("currentCommandColumn")));
+ completize_hyphen (hyphen_);
+
+ if (!hyphen_->get_bound (RIGHT))
+ {
+ hyphen_->warning (_ ("removing unterminated hyphen"));
+ hyphen_->suicide ();
+ }
+
+ hyphen_ = 0;
}
-}
-void
-Hyphen_engraver::create_grobs ()
-{
- if (req_l_ &&! hyphen_p_)
+ if (finished_hyphen_)
{
- if (!last_lyric_l_)
- {
- req_l_->origin ()->warning (_ ("Nothing to connect hyphen to on the left. Ignoring hyphen request."));
- return;
- }
-
- hyphen_p_ = new Spanner (get_property ("LyricHyphen"));
-
- Hyphen_spanner (hyphen_p_).set_textitem (LEFT, last_lyric_l_);
- announce_grob(hyphen_p_, req_l_->self_scm());
+ 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::stop_translation_timestep ()
{
- if (hyphen_p_)
+ if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
{
- typeset_grob (hyphen_p_);
- hyphen_p_ = 0;
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
}
- if (current_lyric_l_)
+ if (finished_hyphen_ && hyphen_)
{
- last_lyric_l_ = current_lyric_l_;
- current_lyric_l_ =0;
+ programming_error ("hyphen not finished yet");
+ finished_hyphen_ = 0;
+ finished_ev_ = 0;
}
-}
-void
-Hyphen_engraver::start_translation_timestep ()
-{
- req_l_ = 0;
+ if (hyphen_)
+ {
+ finished_hyphen_ = hyphen_;
+ finished_ev_ = ev_;
+ }
+
+ hyphen_ = 0;
+ ev_ = 0;
}
+ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
+
+ADD_TRANSLATOR (Hyphen_engraver,
+ /* doc */
+ "Create lyric hyphens and distance constraints between words.",
+
+ /* create */
+ "LyricHyphen "
+ "LyricSpace ",
+
+ /* read */
+ "",
-ENTER_DESCRIPTION(Hyphen_engraver,
-/* descr */ "Create lyric hyphens",
-/* creats*/ "LyricHyphen",
-/* acks */ "lyric-syllable-interface",
-/* reads */ "",
-/* write */ "");
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff