/*
- 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--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2009 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 "musical-request.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"
/**
- 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 create_grobs ();
- virtual void start_translation_timestep ();
-
+ void stop_translation_timestep ();
+ void process_music ();
+ DECLARE_TRANSLATOR_LISTENER (lyric);
+
public:
- Lyric_engraver ();
- VIRTUAL_COPY_CONS (Translator);
+ TRANSLATOR_DECLARATIONS (Lyric_engraver);
private:
- Lyric_req * req_l_;
- Item* text_p_;
-};
-
-ADD_THIS_TRANSLATOR (Lyric_engraver);
+ Stream_event *event_;
+ Item *text_;
+ Item *last_text_;
+ Context *get_voice_context ();
+};
Lyric_engraver::Lyric_engraver ()
{
- text_p_ =0;
- req_l_ =0;
+ text_ = 0;
+ last_text_ = 0;
+ event_ = 0;
}
-bool
-Lyric_engraver::try_music (Music*r)
+IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
+void
+Lyric_engraver::listen_lyric (Stream_event *ev)
{
- if (Lyric_req* l = dynamic_cast <Lyric_req *> (r))
- {
- if (req_l_)
- return false;
- req_l_ =l;
- return true;
- }
- return false;
+ ASSIGN_EVENT_ONCE (event_, ev);
}
void
-Lyric_engraver::create_grobs ()
+Lyric_engraver::process_music ()
{
- if (req_l_)
+ if (event_)
{
- text_p_= new Item (get_property ("LyricText"));
-
- text_p_->set_grob_property ("text", req_l_->get_mus_property ("text"));
+ SCM text = event_->get_property ("text");
+ if (ly_is_equal (text, scm_from_locale_string (" ")))
+ {
+ if (last_text_)
+ last_text_->set_property ("self-alignment-X", scm_from_int (LEFT));
+ }
/*
- 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)
+ "Empty" LyricText objects are needed to allow the Extender_engraver to
+ distinguish between the end of a lyrics block and manual melismata.
*/
-
- text_p_->translate_axis (0.66, X_AXIS);
-
- announce_grob (text_p_, req_l_);
- req_l_ = 0;
+ text_ = make_item ("LyricText", event_->self_scm ());
}
}
-void
-Lyric_engraver::stop_translation_timestep ()
+Context *
+get_voice_to_lyrics (Context *lyrics)
{
- if (text_p_)
+ SCM avc = lyrics->get_property ("associatedVoiceContext");
+ if (Context *c = unsmob_context (avc))
+ 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 == "")
+ return 0;
+ else
{
- typeset_grob (text_p_);
- text_p_ =0;
+ ssize idx = nm.rfind ('-');
+ if (idx != NPOS)
+ nm = nm.substr (0, idx);
}
+
+ Context *parent = lyrics;
+ Context *voice = 0;
+ while (parent && !voice)
+ {
+ voice = find_context_below (parent, ly_symbol2scm ("Voice"), nm);
+ parent = parent->get_parent_context ();
+ }
+
+ if (voice)
+ return voice;
+
+ parent = lyrics;
+ voice = 0;
+ while (parent && !voice)
+ {
+ voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
+ parent = parent->get_parent_context ();
+ }
+
+ return voice;
+}
+
+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;
+ }
+
+ if (end_mom->main_part_ > now.main_part_
+ && dynamic_cast<Item *> (g)
+ && Note_head::has_interface (g))
+ return g;
+ }
+
+ return 0;
}
void
-Lyric_engraver::start_translation_timestep ()
+Lyric_engraver::stop_translation_timestep ()
{
- req_l_ =0;
+ if (text_)
+ {
+ 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)
+ && !to_boolean (get_property ("ignoreMelismata")))
+ text_->set_property ("self-alignment-X",
+ get_property("lyricMelismaAlignment"));
+ }
+ else
+ {
+ text_->warning (_ ("Lyric syllable does not have note. Use \\lyricsto or associatedVoice."));
+ text_->set_property ("X-offset", scm_from_int (0));
+ }
+ }
+
+ last_text_ = text_;
+ text_ = 0;
+ }
+ event_ = 0;
}
+ADD_TRANSLATOR (Lyric_engraver,
+ /* doc */
+ "Engrave text for lyrics.",
+
+ /* create */
+ "LyricText ",
+
+ /* read */
+ "ignoreMelismata "
+ "lyricMelismaAlignment ",
+ /* write */
+ ""
+ );