]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lyric-engraver.cc
Run grand replace for 2015.
[lilypond.git] / lily / lyric-engraver.cc
index 4048ed2f26dac76a30e1bd243344317ec15a9a04..56ce20dadac66a7ef4b223dd7b6b066e7475bbe6 100644 (file)
@@ -1,19 +1,31 @@
 /*
-  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--2006 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"
 #include "engraver.hh"
-#include "font-metric.hh"
 #include "item.hh"
-#include "multi-measure-rest.hh"
 #include "note-head.hh"
-#include "rest.hh"
+#include "stream-event.hh"
+#include "international.hh"
+
+#include "translator.icc"
 
 /**
    Generate texts for lyric syllables.  We only do one lyric at a time.
@@ -23,14 +35,14 @@ class Lyric_engraver : public Engraver
 {
 protected:
   void stop_translation_timestep ();
-  virtual bool try_music (Music *);
   void process_music ();
+  DECLARE_TRANSLATOR_LISTENER (lyric);
 
 public:
   TRANSLATOR_DECLARATIONS (Lyric_engraver);
 
 private:
-  Music *event_;
+  Stream_event *event_;
   Item *text_;
   Item *last_text_;
 
@@ -44,15 +56,11 @@ Lyric_engraver::Lyric_engraver ()
   event_ = 0;
 }
 
-bool
-Lyric_engraver::try_music (Music *r)
+IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
+void
+Lyric_engraver::listen_lyric (Stream_event *ev)
 {
-  if (!event_)
-    {
-      event_ = r;
-      return true;
-    }
-  return false;
+  ASSIGN_EVENT_ONCE (event_, ev);
 }
 
 void
@@ -62,43 +70,57 @@ Lyric_engraver::process_music ()
     {
       SCM text = event_->get_property ("text");
 
-      if (ly_is_equal (text, scm_makfrom0str (" ")))
-       {
-         if (last_text_)
-           last_text_->set_property ("self-alignment-X", scm_from_int (LEFT));
-       }
+      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 ());
-         text_->set_property ("text", text);
-       }
+        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))
+  if (Context *c = Context::unsmob (avc))
     return c;
 
   SCM voice_name = lyrics->get_property ("associatedVoice");
-  std::string nm = lyrics->id_string ();
+  string nm = lyrics->id_string ();
 
   if (scm_is_string (voice_name))
     nm = ly_scm2string (voice_name);
+  else if (nm == "" || !searchForVoice)
+    return 0;
   else
     {
       ssize idx = nm.rfind ('-');
       if (idx != NPOS)
-       nm = nm.substr (0, idx);
+        nm = nm.substr (0, idx);
     }
 
+  SCM voice_type = lyrics->get_property ("associatedVoiceType");
+  if (!scm_is_symbol (voice_type))
+    return 0;
+
   Context *parent = lyrics;
   Context *voice = 0;
   while (parent && !voice)
     {
-      voice = find_context_below (parent, ly_symbol2scm ("Voice"), nm);
+      voice = find_context_below (parent, voice_type, nm);
       parent = parent->get_parent_context ();
     }
 
@@ -109,7 +131,7 @@ get_voice_to_lyrics (Context *lyrics)
   voice = 0;
   while (parent && !voice)
     {
-      voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
+      voice = find_context_below (parent, voice_type, "");
       parent = parent->get_parent_context ();
     }
 
@@ -119,14 +141,39 @@ get_voice_to_lyrics (Context *lyrics)
 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))
     {
-      Item *g = dynamic_cast<Item *> (unsmob_grob (scm_cdar (s)));
-
-      if (g && !g->get_column ()
-         && Note_head::has_interface (g))
-       return g;
+      Grob *g = Grob::unsmob (scm_cdar (s));;
+      Moment *end_mom = Moment::unsmob (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 (Stream_event::unsmob (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)
+          && Note_head::has_interface (g))
+        {
+          return g;
+        }
     }
 
   return 0;
@@ -140,16 +187,18 @@ Lyric_engraver::stop_translation_timestep ()
       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_from_int (LEFT));
-           }
-       }
+        {
+          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;
@@ -157,11 +206,18 @@ Lyric_engraver::stop_translation_timestep ()
   event_ = 0;
 }
 
-#include "translator.icc"
-
 ADD_TRANSLATOR (Lyric_engraver,
-               /* doc */ "",
-               /* create */ "LyricText",
-               /* accept */ "lyric-event",
-               /* read */ "",
-               /* write */ "");
+                /* doc */
+                "Engrave text for lyrics.",
+
+                /* create */
+                "LyricText ",
+
+                /* read */
+                "ignoreMelismata "
+                "lyricMelismaAlignment "
+                "searchForVoice",
+
+                /* write */
+                ""
+               );