/*
- 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--2004 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 "context.hh"
#include "engraver.hh"
-#include "event.hh"
#include "item.hh"
-#include "context.hh"
-#include "font-metric.hh"
#include "note-head.hh"
+#include "stream-event.hh"
+#include "international.hh"
+
+#include "translator.icc"
/**
- Generate texts for lyric syllables. We only do one lyric at a time.
+ 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
+*/
+class Lyric_engraver : public Engraver
{
protected:
- virtual void stop_translation_timestep ();
- virtual bool try_music (Music *);
- virtual void process_music ();
-
+ void stop_translation_timestep ();
+ void process_music ();
+ void listen_lyric (Stream_event *);
+
public:
TRANSLATOR_DECLARATIONS (Lyric_engraver);
+
private:
- Music * event_;
- Item* text_;
+ Stream_event *event_;
+ Item *text_;
+ Item *last_text_;
- Context* get_voice_context ();
+ Context *get_voice_context ();
};
Lyric_engraver::Lyric_engraver ()
{
- text_ =0;
- event_ =0;
+ text_ = 0;
+ last_text_ = 0;
+ event_ = 0;
}
-bool
-Lyric_engraver::try_music (Music*r)
+void
+Lyric_engraver::listen_lyric (Stream_event *ev)
{
- if (r->is_mus_type ("lyric-event"))
- {
- if (event_)
- return false;
- event_ =r;
- return true;
- }
- return false;
+ ASSIGN_EVENT_ONCE (event_, ev);
}
void
{
if (event_)
{
- text_= make_item ("LyricText");
-
- text_->set_property ("text", event_->get_property ("text"));
- announce_grob (text_, event_->self_scm ());
+ 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 ());
}
-}
+ 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"));
+}
-Context*
+Context *
get_voice_to_lyrics (Context *lyrics)
{
+ bool searchForVoice = to_boolean (lyrics->get_property ("searchForVoice"));
+
SCM avc = lyrics->get_property ("associatedVoiceContext");
- if (Context *c = unsmob_context (avc))
- return c;
+ if (Context *c = unsmob<Context> (avc))
+ {
+ if (!c->is_removable ())
+ return c;
+ }
- SCM voice = lyrics->get_property ("associatedVoice");
- String nm = lyrics->id_string_;
+ SCM voice_name = lyrics->get_property ("associatedVoice");
+ string nm = lyrics->id_string ();
- if (ly_string_p (voice))
- nm = ly_scm2string (voice);
+ if (scm_is_string (voice_name))
+ nm = ly_scm2string (voice_name);
+ else if (nm == "" || !searchForVoice)
+ return 0;
else
{
- int idx = nm.index_last ('-');
- if (idx >= 0)
- nm = nm.left_string (idx);
+ ssize idx = nm.rfind ('-');
+ if (idx != NPOS)
+ nm = nm.substr (0, idx);
}
- Context *c = lyrics->find_context_below (ly_symbol2scm ("Voice"), nm);
+ SCM voice_type = lyrics->get_property ("associatedVoiceType");
+ if (!scm_is_symbol (voice_type))
+ return 0;
- if (c)
- return c;
+ Context *voice = find_context_near (lyrics, voice_type, nm);
+ if (voice)
+ return voice;
- return lyrics->find_context_below (ly_symbol2scm ("Voice"), "");
+ return find_context_near (lyrics, voice_type, "");
}
Grob *
-get_current_note_head (Context * voice)
+get_current_note_head (Context *voice)
{
+ Moment now = voice->now_mom ();
for (SCM s = voice->get_property ("busyGrobs");
- ly_pair_p (s); s = ly_cdr (s))
+ scm_is_pair (s); s = scm_cdr (s))
{
- Item*g = dynamic_cast<Item*> (unsmob_grob (ly_cdar (s)));
-
- if (g && !g->get_column ()
- && Note_head::has_interface (g))
- return g;
+ 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;
+
+ return 0;
}
void
{
if (text_)
{
- Context * voice = get_voice_to_lyrics (daddy_context_);
+ Context *voice = get_voice_to_lyrics (context ());
if (voice)
- {
- Grob *head = get_current_note_head (voice);
-
- if (head)
- {
- text_->set_parent (head, X_AXIS);
- if (melisma_busy (voice))
- text_->set_property ("self-alignment-X", scm_int2num (LEFT));
- }
- }
-
- typeset_grob (text_);
- text_ =0;
+ {
+ 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;
+ event_ = 0;
}
+void
+Lyric_engraver::boot ()
+{
+ ADD_LISTENER (Lyric_engraver, lyric);
+}
+
+ADD_TRANSLATOR (Lyric_engraver,
+ /* doc */
+ "Engrave text for lyrics.",
+
+ /* create */
+ "LyricText ",
+
+ /* read */
+ "ignoreMelismata "
+ "lyricMelismaAlignment "
+ "searchForVoice",
-ENTER_DESCRIPTION (Lyric_engraver,
-/* descr */ "",
-/* creats*/ "",
-/* accepts */ "lyric-event",
-/* acks */ "",
-/* reads */ "",
-/* write */ "");
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff