/*
- lyric-engraver.cc -- implement Lyric_engraver
+ This file is part of LilyPond, the GNU music typesetter.
- source file of the GNU LilyPond music typesetter
-
- (c) 1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2015 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 "lyric-engraver.hh"
-#include "musical-request.hh"
+#include "context.hh"
+#include "engraver.hh"
#include "item.hh"
-#include "paper-def.hh"
-#include "font-metric.hh"
-#include "side-position-interface.hh"
+#include "note-head.hh"
+#include "stream-event.hh"
+#include "international.hh"
+
+#include "translator.icc"
-ADD_THIS_TRANSLATOR (Lyric_engraver);
+/**
+ Generate texts for lyric syllables. We only do one lyric at a time.
+ Multiple copies of this engraver should be used to do multiple voices.
+*/
+class Lyric_engraver : public Engraver
+{
+protected:
+ void stop_translation_timestep ();
+ void process_music ();
+ void listen_lyric (Stream_event *);
+
+public:
+ TRANSLATOR_DECLARATIONS (Lyric_engraver);
+private:
+ Stream_event *event_;
+ Item *text_;
+ Item *last_text_;
-Lyric_engraver::Lyric_engraver()
+ Context *get_voice_context ();
+};
+
+Lyric_engraver::Lyric_engraver (Context *c)
+ : Engraver (c)
{
- text_p_ =0;
- req_l_ =0;
+ text_ = 0;
+ last_text_ = 0;
+ event_ = 0;
}
-bool
-Lyric_engraver::do_try_music (Music*r)
+void
+Lyric_engraver::listen_lyric (Stream_event *ev)
{
- if (Lyric_req* l = dynamic_cast <Lyric_req *> (r))
+ ASSIGN_EVENT_ONCE (event_, ev);
+}
+
+void
+Lyric_engraver::process_music ()
+{
+ if (event_)
{
- if (req_l_)
- return false;
- req_l_ =l;
- return true;
+ SCM text = event_->get_property ("text");
+
+ if (ly_is_equal (text, scm_from_ascii_string (" ")))
+ {
+ if (last_text_)
+ last_text_->set_property ("self-alignment-X",
+ get_property ("lyricMelismaAlignment"));
+ }
+ else
+ text_ = make_item ("LyricText", event_->self_scm ());
}
- return false;
+
+ Context *voice = get_voice_to_lyrics (context ());
+ if (last_text_
+ && voice
+ && to_boolean (voice->get_property ("melismaBusy"))
+ && !to_boolean (context ()->get_property ("ignoreMelismata")))
+ last_text_->set_property ("self-alignment-X",
+ get_property ("lyricMelismaAlignment"));
}
-void
-Lyric_engraver::do_process_music()
+Context *
+get_voice_to_lyrics (Context *lyrics)
{
- if (req_l_)
+ bool searchForVoice = to_boolean (lyrics->get_property ("searchForVoice"));
+
+ SCM avc = lyrics->get_property ("associatedVoiceContext");
+ if (Context *c = unsmob<Context> (avc))
{
- text_p_= new Item (get_property ("LyricText"));
-
- text_p_->set_elt_property ("text", req_l_->get_mus_property ("text"));
-
- /*
- We can't reach the notehead where we're centered from here. So
- we kludge.
-
- (UGH UGH, pulled amount of space out of thin air)
- */
-
- text_p_->translate_axis (0.66, X_AXIS);
-
- announce_element (text_p_, req_l_);
+ if (!c->is_removable ())
+ return c;
}
+
+ SCM voice_name = lyrics->get_property ("associatedVoice");
+ string nm = lyrics->id_string ();
+
+ if (scm_is_string (voice_name))
+ nm = ly_scm2string (voice_name);
+ else if (nm == "" || !searchForVoice)
+ return 0;
+ else
+ {
+ ssize idx = nm.rfind ('-');
+ if (idx != NPOS)
+ nm = nm.substr (0, idx);
+ }
+
+ SCM voice_type = lyrics->get_property ("associatedVoiceType");
+ if (!scm_is_symbol (voice_type))
+ return 0;
+
+ Context *voice = find_context_near (lyrics, voice_type, nm);
+ if (voice)
+ return voice;
+
+ return find_context_near (lyrics, voice_type, "");
+}
+
+Grob *
+get_current_note_head (Context *voice)
+{
+ Moment now = voice->now_mom ();
+ for (SCM s = voice->get_property ("busyGrobs");
+ scm_is_pair (s); s = scm_cdr (s))
+ {
+ Grob *g = unsmob<Grob> (scm_cdar (s));;
+ Moment *end_mom = unsmob<Moment> (scm_caar (s));
+ if (!end_mom || !g)
+ {
+ programming_error ("busyGrobs invalid");
+ continue;
+ }
+
+ // It's a bit irritating that we just have the length and
+ // duration of the Grob.
+ Moment end_from_now =
+ get_event_length (unsmob<Stream_event> (g->get_property ("cause")), now)
+ + now;
+ // We cannot actually include more than a single grace note
+ // using busyGrobs on ungraced lyrics since a grob ending on
+ // grace time will just have disappeared from busyGrobs by the
+ // time our ungraced lyrics appear. At best we may catch a
+ // single grace note.
+ //
+ // However, a single grace note ending on a non-grace time is
+ // indistinguishable from a proper note ending on a non-grace
+ // time. So we really have no way to obey includeGraceNotes
+ // here. Not with this mechanism.
+ if ((*end_mom == end_from_now)
+ && dynamic_cast<Item *> (g)
+ && has_interface<Note_head> (g))
+ {
+ return g;
+ }
+ }
+
+ return 0;
}
void
-Lyric_engraver::do_pre_move_processing()
+Lyric_engraver::stop_translation_timestep ()
{
- if (text_p_)
+ if (text_)
{
- typeset_element (text_p_);
- text_p_ =0;
+ Context *voice = get_voice_to_lyrics (context ());
+
+ if (voice)
+ {
+ Grob *head = get_current_note_head (voice);
+
+ if (head)
+ {
+ text_->set_parent (head->get_parent(X_AXIS), X_AXIS);
+ if (melisma_busy (voice)
+ && !to_boolean (get_property ("ignoreMelismata")))
+ text_->set_property ("self-alignment-X",
+ get_property ("lyricMelismaAlignment"));
+ }
+ }
+
+ last_text_ = text_;
+ text_ = 0;
}
+ event_ = 0;
}
void
-Lyric_engraver::do_post_move_processing ()
+Lyric_engraver::boot ()
{
- req_l_ =0;
+ ADD_LISTENER (Lyric_engraver, lyric);
}
+ADD_TRANSLATOR (Lyric_engraver,
+ /* doc */
+ "Engrave text for lyrics.",
+
+ /* create */
+ "LyricText ",
+
+ /* read */
+ "ignoreMelismata "
+ "lyricMelismaAlignment "
+ "searchForVoice",
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff