/*
- 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--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Copyright (C) 1997--2012 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 "item.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.
+ 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 ();
+ DECLARE_TRANSLATOR_LISTENER (lyric);
+
+public:
+ TRANSLATOR_DECLARATIONS (Lyric_engraver);
-#include "lyric-engraver.hh"
-#include "musical-request.hh"
-#include "text-item.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "main.hh"
-#include "dimensions.hh"
+private:
+ Stream_event *event_;
+ Item *text_;
+ Item *last_text_;
-ADD_THIS_TRANSLATOR(Lyric_engraver);
+ Context *get_voice_context ();
+};
-Lyric_engraver::Lyric_engraver()
+Lyric_engraver::Lyric_engraver ()
{
+ text_ = 0;
+ last_text_ = 0;
+ event_ = 0;
}
-bool
-Lyric_engraver::do_try_music (Music*r)
+IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
+void
+Lyric_engraver::listen_lyric (Stream_event *ev)
+{
+ ASSIGN_EVENT_ONCE (event_, ev);
+}
+
+void
+Lyric_engraver::process_music ()
{
- if (Lyric_req* l = dynamic_cast <Lyric_req *> (r))
+ if (event_)
{
- lyric_req_l_arr_.push (l);
- return true;
+ 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",
+ 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_requests()
+Context *
+get_voice_to_lyrics (Context *lyrics)
{
- if (text_p_arr_.size ())
- return;
+ bool searchForVoice = to_boolean (lyrics->get_property ("searchForVoice"));
+
+ 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 ();
- Scalar style = get_property ("textstyle");
- Scalar alignment = get_property ("textalignment");
- for (int i=0; i < lyric_req_l_arr_.size (); i++)
+ if (scm_is_string (voice_name))
+ nm = ly_scm2string (voice_name);
+ else if (nm == "" || !searchForVoice)
+ return 0;
+ else
{
- Lyric_req* request_l = lyric_req_l_arr_[i];
- Text_def* text_p = new Text_def;
- text_p->text_str_ = request_l->text_str_;
- text_p->align_dir_ = LEFT;
- if (style.length_i ())
- text_p->style_str_ = style;
- if (alignment.isnum_b())
- text_p->align_dir_= (Direction)(int)alignment;
-
- Text_item* item_p = new Text_item (text_p);
- item_p->dir_ = DOWN;
- item_p->fat_b_ = true;
- // urg
- // item_p->translate (Offset (0, (i - 1) * item_p->height ().length_i ()));
-// if (i && ((Text_def*)text_p_arr_[i - 1]->tdef_p_)->text_str_.length_i ())
- item_p->translate (Offset (0, - i * 12 PT));
- text_p_arr_.push (item_p);
- announce_element (Score_element_info (item_p, request_l));
+ 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;
}
-void
-Lyric_engraver::do_post_move_processing()
+Grob *
+get_current_note_head (Context *voice, bool include_grace_notes)
{
+ 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_)
+ || (include_grace_notes && end_mom->grace_part_ > now.grace_part_))
+ && dynamic_cast<Item *> (g)
+ && Note_head::has_interface (g))
+ {
+ return g;
+ }
+ }
+
+ return 0;
}
void
-Lyric_engraver::do_pre_move_processing()
+Lyric_engraver::stop_translation_timestep ()
{
- for (int i=0; i < text_p_arr_.size (); i++)
+ if (text_)
{
- typeset_element (text_p_arr_[i]);
+ Context *voice = get_voice_to_lyrics (context ());
+
+ if (voice)
+ {
+ bool include_grace_notes = to_boolean (get_property ("includeGraceNotes"));
+ Grob *head = get_current_note_head (voice, include_grace_notes);
+
+ 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;
}
- text_p_arr_.clear ();
- lyric_req_l_arr_.clear ();
+ event_ = 0;
}
+ADD_TRANSLATOR (Lyric_engraver,
+ /* doc */
+ "Engrave text for lyrics.",
+
+ /* create */
+ "LyricText ",
+
+ /* read */
+ "ignoreMelismata "
+ "includeGraceNotes "
+ "lyricMelismaAlignment "
+ "searchForVoice",
+
+ /* write */
+ ""
+ );
projects / lilypond.git / blobdiff