]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/lyric-engraver.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / lyric-engraver.cc
index d9e68dbf6a2c6a036a58ccf69868f3c18b028698..6dce40a464ba7b385f0149dd254debd7de9b6ecd 100644 (file)
@@ -1,56 +1,66 @@
 /*
-  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--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  Copyright (C) 1997--2014 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 "event.hh"
 #include "item.hh"
-#include "context.hh"
-#include "font-metric.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 process_music ();
-  
+  void stop_translation_timestep ();
+  void process_music ();
+  DECLARE_TRANSLATOR_LISTENER (lyric);
+
 public:
   TRANSLATOR_DECLARATIONS (Lyric_engraver);
+
 private:
-  Music * event_;
-  Item* text_;
+  Stream_event *event_;
+  Item *text_;
+  Item *last_text_;
 
-  Contextget_voice_context ();
+  Context *get_voice_context ();
 };
 
 Lyric_engraver::Lyric_engraver ()
 {
-  text_ =0;
-  event_ =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 (r->is_mus_type ("lyric-event"))
-    {
-      if (event_)
-       return false;
-      event_ =r;
-      return true;
-    }
-  return false;
+  ASSIGN_EVENT_ONCE (event_, ev);
 }
 
 void
@@ -58,34 +68,52 @@ Lyric_engraver::process_music ()
 {
   if (event_)
     {
-      text_=  make_item ("LyricText",event_->self_scm ());
-      
-      text_->set_property ("text", event_->get_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",
+                                      get_property ("lyricMelismaAlignment"));
+        }
+      else
+        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*
+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 = unsmob_context (avc))
     return c;
 
   SCM voice_name = lyrics->get_property ("associatedVoice");
-  String nm = lyrics->id_string ();
+  string nm = lyrics->id_string ();
 
-  if (ly_c_string_p (voice_name))
+  if (scm_is_string (voice_name))
     nm = ly_scm2string (voice_name);
+  else if (nm == "" || !searchForVoice)
+    return 0;
   else
     {
-      int idx = nm.index_last ('-');
-      if (idx >= 0)
-       nm = nm.left_string (idx);
+      ssize idx = nm.rfind ('-');
+      if (idx != NPOS)
+        nm = nm.substr (0, idx);
     }
 
   Context *parent = lyrics;
-  Context *voice = 0; 
+  Context *voice = 0;
   while (parent && !voice)
     {
       voice = find_context_below (parent, ly_symbol2scm ("Voice"), nm);
@@ -96,7 +124,7 @@ get_voice_to_lyrics (Context *lyrics)
     return voice;
 
   parent = lyrics;
-  voice = 0; 
+  voice = 0;
   while (parent && !voice)
     {
       voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
@@ -107,19 +135,30 @@ get_voice_to_lyrics (Context *lyrics)
 }
 
 Grob *
-get_current_note_head (Context * voice)
+get_current_note_head (Context *voice, bool include_grace_notes)
 {
+  Moment now = voice->now_mom ();
   for (SCM s = voice->get_property ("busyGrobs");
-       ly_c_pair_p (s); s = ly_cdr (s))
+       scm_is_pair (s); s = scm_cdr (s))
     {
-      Item*g = dynamic_cast<Item*> (unsmob_grob (ly_cdar (s)));
-         
-      if (g && !g->get_column ()
-         && Note_head::has_interface (g))
-       return g;
+      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;  
+
+  return 0;
 }
 
 void
@@ -127,30 +166,48 @@ Lyric_engraver::stop_translation_timestep ()
 {
   if (text_)
     {
-      Context * voice = get_voice_to_lyrics (context ());
+      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_int2num (LEFT)); 
-           }
-       }
-      
-      text_ =0;
+        {
+          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;
     }
-  event_ =0;
+  event_ = 0;
 }
 
+ADD_TRANSLATOR (Lyric_engraver,
+                /* doc */
+                "Engrave text for lyrics.",
+
+                /* create */
+                "LyricText ",
+
+                /* read */
+                "ignoreMelismata "
+                "includeGraceNotes "
+                "lyricMelismaAlignment "
+                "searchForVoice",
 
-ENTER_DESCRIPTION (Lyric_engraver,
-/* descr */       "",
-/* creats*/       "",
-/* accepts */     "lyric-event",
-/* acks  */      "",
-/* reads */       "",
-/* write */       "");
+                /* write */
+                ""
+               );