]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lyric-engraver.cc
Web-ja: update introduction
[lilypond.git] / lily / lyric-engraver.cc
index ce138390890eac3900854c84b0891f4fd98ce0a4..bad1203266f75b43842e6bdea358b6a734dc339f 100644 (file)
@@ -1,10 +1,21 @@
 /*
-  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--2007 Han-Wen Nienhuys <hanwen@xs4all.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"
@@ -25,7 +36,7 @@ class Lyric_engraver : public Engraver
 protected:
   void stop_translation_timestep ();
   void process_music ();
-  DECLARE_TRANSLATOR_LISTENER (lyric);
+  void listen_lyric (Stream_event *);
 
 public:
   TRANSLATOR_DECLARATIONS (Lyric_engraver);
@@ -38,14 +49,14 @@ private:
   Context *get_voice_context ();
 };
 
-Lyric_engraver::Lyric_engraver ()
+Lyric_engraver::Lyric_engraver (Context *c)
+  : Engraver (c)
 {
   text_ = 0;
   last_text_ = 0;
   event_ = 0;
 }
 
-IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
 void
 Lyric_engraver::listen_lyric (Stream_event *ev)
 {
@@ -59,61 +70,60 @@ Lyric_engraver::process_music ()
     {
       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));
-       }
+      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 ());
-       }
+        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 *
 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_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 if (nm == "" || !searchForVoice)
+    return 0;
   else
     {
       ssize idx = nm.rfind ('-');
       if (idx != NPOS)
-       nm = nm.substr (0, idx);
+        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 ();
-    }
+  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;
 
-  parent = lyrics;
-  voice = 0;
-  while (parent && !voice)
-    {
-      voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
-      parent = parent->get_parent_context ();
-    }
-
-  return voice;
+  return find_context_near (lyrics, voice_type, "");
 }
 
 Grob *
@@ -123,18 +133,35 @@ get_current_note_head (Context *voice)
   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));
+      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;
+        {
+          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;
@@ -146,23 +173,20 @@ Lyric_engraver::stop_translation_timestep ()
   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))
-               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));
-           }
-       }
+        {
+          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;
@@ -170,8 +194,24 @@ Lyric_engraver::stop_translation_timestep ()
   event_ = 0;
 }
 
+void
+Lyric_engraver::boot ()
+{
+  ADD_LISTENER (Lyric_engraver, lyric);
+}
+
 ADD_TRANSLATOR (Lyric_engraver,
-               /* doc */ "",
-               /* create */ "LyricText",
-               /* read */ "lyricMelismaAlignment",
-               /* write */ "");
+                /* doc */
+                "Engrave text for lyrics.",
+
+                /* create */
+                "LyricText ",
+
+                /* read */
+                "ignoreMelismata "
+                "lyricMelismaAlignment "
+                "searchForVoice",
+
+                /* write */
+                ""
+               );