2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1999--2012 Glen Prideaux <glenprideaux@iname.com>,
5 Han-Wen Nienhuys <hanwen@xs4all.nl>,
6 Jan Nieuwenhuizen <janneke@gnu.org>
8 LilyPond is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 LilyPond is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
22 #include "engraver.hh"
23 #include "international.hh"
25 #include "pointer-group-interface.hh"
27 #include "stream-event.hh"
30 #include "translator.icc"
32 class Hyphen_engraver : public Engraver
35 Stream_event *finished_ev_;
38 Spanner *finished_hyphen_;
41 TRANSLATOR_DECLARATIONS (Hyphen_engraver);
45 DECLARE_ACKNOWLEDGER (lyric_syllable);
46 DECLARE_TRANSLATOR_LISTENER (hyphen);
48 virtual void finalize ();
50 void stop_translation_timestep ();
51 void process_music ();
54 Hyphen_engraver::Hyphen_engraver ()
63 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
65 Item *item = i.item ();
68 hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
71 hyphen_->set_bound (LEFT, item);
74 finished_hyphen_->set_bound (RIGHT, item);
77 IMPLEMENT_TRANSLATOR_LISTENER (Hyphen_engraver, hyphen);
79 Hyphen_engraver::listen_hyphen (Stream_event *ev)
81 ASSIGN_EVENT_ONCE (ev_, ev);
85 completize_hyphen (Spanner *sp)
87 if (!sp->get_bound (RIGHT))
89 extract_item_set (sp, "heads", heads);
91 sp->set_bound (RIGHT, heads.back ());
96 Hyphen_engraver::finalize ()
100 completize_hyphen (hyphen_);
102 if (!hyphen_->get_bound (RIGHT))
104 hyphen_->warning (_ ("removing unterminated hyphen"));
111 if (finished_hyphen_)
113 completize_hyphen (finished_hyphen_);
115 if (!finished_hyphen_->get_bound (RIGHT))
118 finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
119 finished_hyphen_->suicide ();
121 finished_hyphen_ = 0;
126 Hyphen_engraver::process_music ()
129 hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
133 Hyphen_engraver::stop_translation_timestep ()
135 if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
137 finished_hyphen_ = 0;
141 if (finished_hyphen_ && hyphen_)
143 programming_error ("hyphen not finished yet");
144 finished_hyphen_ = 0;
150 finished_hyphen_ = hyphen_;
158 ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
160 ADD_TRANSLATOR (Hyphen_engraver,
162 "Create lyric hyphens and distance constraints between words.",