Imported Upstream version 2.14.2

[lilypond.git] / lily / extender-engraver.cc

diff --git a/lily/extender-engraver.cc b/lily/extender-engraver.cc
index d3b2e90972facbdee6b1579468aedafb9900d345..49fcbcaf3f598d6a55895c1238cb46685dcacd75 100644 (file)
--- a/lily/extender-engraver.cc
+++ b/lily/extender-engraver.cc
@@ -1,11 +1,22 @@
 /*
-  extender-engraver.cc -- implement Extender_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 1999--2006 Glen Prideaux <glenprideaux@iname.com>,
+  Copyright (C) 1999--2011 Glen Prideaux <glenprideaux@iname.com>,
   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"
@@ -15,13 +26,16 @@
 #include "lyric-extender.hh"
 #include "note-head.hh"
 #include "pointer-group-interface.hh"
+#include "stream-event.hh"
 #include "warn.hh"
+#include "spanner.hh"
+#include "translator.icc"
 
 void completize_extender (Spanner *sp);
 
 class Extender_engraver : public Engraver
 {
-  Music *ev_;
+  Stream_event *ev_;
   Spanner *extender_;
   Spanner *pending_extender_;
 
@@ -29,9 +43,12 @@ public:
   TRANSLATOR_DECLARATIONS (Extender_engraver);
 
 protected:
+  DECLARE_TRANSLATOR_LISTENER (extender);
+  DECLARE_TRANSLATOR_LISTENER (completize_extender);
   DECLARE_ACKNOWLEDGER (lyric_syllable);
+
   virtual void finalize ();
-  virtual bool try_music (Music *);
+
   void stop_translation_timestep ();
   void process_music ();
 };
@@ -43,15 +60,29 @@ Extender_engraver::Extender_engraver ()
   ev_ = 0;
 }
 
-bool
-Extender_engraver::try_music (Music *r)
+IMPLEMENT_TRANSLATOR_LISTENER (Extender_engraver, extender);
+void
+Extender_engraver::listen_extender (Stream_event *ev)
+{
+  ASSIGN_EVENT_ONCE (ev_, ev);
+}
+
+
+/*
+  A CompletizeExtenderEvent is sent at the end of each lyrics block
+  to ensure any pending extender can be correctly terminated if the lyrics
+  end before the associated voice (this prevents the right bound being extended
+  to the next note-column if no lyric follows the extender)
+*/
+IMPLEMENT_TRANSLATOR_LISTENER (Extender_engraver, completize_extender);
+void
+Extender_engraver::listen_completize_extender (Stream_event * /* ev */)
 {
-  if (!ev_)
+  if (pending_extender_)
     {
-      ev_ = r;
-      return true;
+      completize_extender (pending_extender_);
+      pending_extender_ = 0;
     }
-  return false;
 }
 
 void
@@ -82,7 +113,7 @@ Extender_engraver::stop_translation_timestep ()
   if (extender_ || pending_extender_)
     {
       Context *voice = get_voice_to_lyrics (context ());
-      Grob *h = voice ? get_current_note_head (voice) : 0;
+      Grob *h = voice ? get_current_note_head (voice, to_boolean (get_property ("includeGraceNotes"))) : 0;
 
       if (h)
        {
@@ -98,7 +129,15 @@ Extender_engraver::stop_translation_timestep ()
                                                 ly_symbol2scm ("heads"), h);
            }
        }
-
+      else
+       {
+         if (pending_extender_
+             && !get_property ("extendersOverRests"))
+           {
+             completize_extender (pending_extender_);
+             pending_extender_ = 0;
+           }
+       }
       if (extender_)
        {
          pending_extender_ = extender_;
@@ -142,12 +181,18 @@ Extender_engraver::finalize ()
     }
 }
 
-#include "translator.icc"
-
 ADD_ACKNOWLEDGER (Extender_engraver, lyric_syllable);
 ADD_TRANSLATOR (Extender_engraver,
-               /* doc */ "Create lyric extenders",
-               /* create */ "LyricExtender",
-               /* accept */ "extender-event",
-               /* read */ "",
-               /* write */ "");
+               /* doc */
+               "Create lyric extenders.",
+
+               /* create */
+               "LyricExtender ",
+
+               /* read */
+               "extendersOverRests "
+               "includeGraceNotes ",
+
+               /* write */
+               ""
+               );