]> git.donarmstrong.com Git - lilypond.git/blob - lily/lyric-engraver.cc
Merge branch 'master' into lilypond/translation
[lilypond.git] / lily / lyric-engraver.cc
1 /*
2   This file is part of LilyPond, the GNU music typesetter.
3
4   Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
5   Jan Nieuwenhuizen <janneke@gnu.org>
6
7   LilyPond is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   LilyPond is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "context.hh"
22 #include "engraver.hh"
23 #include "item.hh"
24 #include "note-head.hh"
25 #include "stream-event.hh"
26 #include "international.hh"
27
28 #include "translator.icc"
29
30 /**
31    Generate texts for lyric syllables.  We only do one lyric at a time.
32    Multiple copies of this engraver should be used to do multiple voices.
33 */
34 class Lyric_engraver : public Engraver
35 {
36 protected:
37   void stop_translation_timestep ();
38   void process_music ();
39   DECLARE_TRANSLATOR_LISTENER (lyric);
40
41 public:
42   TRANSLATOR_DECLARATIONS (Lyric_engraver);
43
44 private:
45   Stream_event *event_;
46   Item *text_;
47   Item *last_text_;
48
49   Context *get_voice_context ();
50 };
51
52 Lyric_engraver::Lyric_engraver ()
53 {
54   text_ = 0;
55   last_text_ = 0;
56   event_ = 0;
57 }
58
59 IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
60 void
61 Lyric_engraver::listen_lyric (Stream_event *ev)
62 {
63   ASSIGN_EVENT_ONCE (event_, ev);
64 }
65
66 void
67 Lyric_engraver::process_music ()
68 {
69   if (event_)
70     {
71       SCM text = event_->get_property ("text");
72
73       if (ly_is_equal (text, scm_from_locale_string (" ")))
74         {
75           if (last_text_)
76             last_text_->set_property ("self-alignment-X", scm_from_int (LEFT));
77         }
78       else
79         text_ = make_item ("LyricText", event_->self_scm ());
80     }
81 }
82
83 Context *
84 get_voice_to_lyrics (Context *lyrics)
85 {
86   SCM avc = lyrics->get_property ("associatedVoiceContext");
87   if (Context *c = unsmob_context (avc))
88     return c;
89
90   SCM voice_name = lyrics->get_property ("associatedVoice");
91   string nm = lyrics->id_string ();
92
93   if (scm_is_string (voice_name))
94     nm = ly_scm2string (voice_name);
95   else if (nm == "")
96     return 0;
97   else
98     {
99       ssize idx = nm.rfind ('-');
100       if (idx != NPOS)
101         nm = nm.substr (0, idx);
102     }
103
104   Context *parent = lyrics;
105   Context *voice = 0;
106   while (parent && !voice)
107     {
108       voice = find_context_below (parent, ly_symbol2scm ("Voice"), nm);
109       parent = parent->get_parent_context ();
110     }
111
112   if (voice)
113     return voice;
114
115   parent = lyrics;
116   voice = 0;
117   while (parent && !voice)
118     {
119       voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
120       parent = parent->get_parent_context ();
121     }
122
123   return voice;
124 }
125
126 Grob *
127 get_current_note_head (Context *voice, bool include_grace_notes)
128 {
129   Moment now = voice->now_mom ();
130   for (SCM s = voice->get_property ("busyGrobs");
131        scm_is_pair (s); s = scm_cdr (s))
132     {
133       Grob *g = unsmob_grob (scm_cdar (s));;
134       Moment *end_mom = unsmob_moment (scm_caar (s));
135       if (!end_mom || !g)
136         {
137           programming_error ("busyGrobs invalid");
138           continue;
139         }
140
141       if (((end_mom->main_part_ > now.main_part_) ||
142            (include_grace_notes && end_mom->grace_part_ > now.grace_part_))
143           && dynamic_cast<Item *> (g)
144           && Note_head::has_interface (g))
145         {
146           return g;
147         }
148     }
149
150   return 0;
151 }
152
153 void
154 Lyric_engraver::stop_translation_timestep ()
155 {
156   if (text_)
157     {
158       Context *voice = get_voice_to_lyrics (context ());
159
160       if (voice)
161         {
162           bool include_grace_notes = to_boolean (get_property ("includeGraceNotes"));
163           Grob *head = get_current_note_head (voice, include_grace_notes);
164
165           if (head)
166             {
167               text_->set_parent (head, X_AXIS);
168               if (melisma_busy (voice)
169                   && !to_boolean (get_property ("ignoreMelismata")))
170                 text_->set_property ("self-alignment-X",
171                                      get_property ("lyricMelismaAlignment"));
172             }
173           else
174             {
175               text_->warning (_ ("Lyric syllable does not have note. Use \\lyricsto or associatedVoice."));
176               text_->set_property ("X-offset", scm_from_int (0));
177             }
178         }
179
180       last_text_ = text_;
181       text_ = 0;
182     }
183   event_ = 0;
184 }
185
186 ADD_TRANSLATOR (Lyric_engraver,
187                 /* doc */
188                 "Engrave text for lyrics.",
189
190                 /* create */
191                 "LyricText ",
192
193                 /* read */
194                 "ignoreMelismata "
195                 "includeGraceNotes "
196                 "lyricMelismaAlignment ",
197
198                 /* write */
199                 ""
200                 );