Run grand replace for 2015.

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

diff --git a/lily/extender-engraver.cc b/lily/extender-engraver.cc
index e3fc6914d1951622b291761c8442e9b12e7887f2..3f3ef3b3ff3941527362496a43e9f2a3f964274a 100644 (file)
--- a/lily/extender-engraver.cc
+++ b/lily/extender-engraver.cc
@@ -1,26 +1,41 @@
 /*
-  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--2005 Glen Prideaux <glenprideaux@iname.com>,
-  Han-Wen Nienhuys <hanwen@cs.uu.nl>,
+  Copyright (C) 1999--2015 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"
 #include "engraver.hh"
-#include "pointer-group-interface.hh"
+#include "international.hh"
 #include "item.hh"
 #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_;
 
@@ -28,11 +43,14 @@ public:
   TRANSLATOR_DECLARATIONS (Extender_engraver);
 
 protected:
-  virtual void acknowledge_grob (Grob_info);
+  DECLARE_TRANSLATOR_LISTENER (extender);
+  DECLARE_TRANSLATOR_LISTENER (completize_extender);
+  DECLARE_ACKNOWLEDGER (lyric_syllable);
+
   virtual void finalize ();
-  virtual bool try_music (Music *);
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
+
+  void stop_translation_timestep ();
+  void process_music ();
 };
 
 Extender_engraver::Extender_engraver ()
@@ -42,15 +60,28 @@ 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)
 {
-  if (!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 (pending_extender_)
     {
-      ev_ = r;
-      return true;
+      completize_extender (pending_extender_);
+      pending_extender_ = 0;
     }
-  return false;
 }
 
 void
@@ -61,22 +92,17 @@ Extender_engraver::process_music ()
 }
 
 void
-Extender_engraver::acknowledge_grob (Grob_info i)
+Extender_engraver::acknowledge_lyric_syllable (Grob_info i)
 {
-  Item *item = dynamic_cast<Item *> (i.grob ());
+  Item *item = i.item ();
+  if (extender_)
+    extender_->set_bound (LEFT, item);
 
-  if (item
-      && item->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
+  if (pending_extender_)
     {
-      if (extender_)
-       extender_->set_bound (LEFT, item);
-
-      if (pending_extender_)
-       {
-         pending_extender_->set_object ("next", item->self_scm ());
-         completize_extender (pending_extender_);
-         pending_extender_ = 0;
-       }
+      pending_extender_->set_object ("next", item->self_scm ());
+      completize_extender (pending_extender_);
+      pending_extender_ = 0;
     }
 }
 
@@ -89,25 +115,33 @@ Extender_engraver::stop_translation_timestep ()
       Grob *h = voice ? get_current_note_head (voice) : 0;
 
       if (h)
-       {
-         if (extender_)
-           {
-             Pointer_group_interface::add_grob (extender_,
-                                                ly_symbol2scm ("heads"), h);
-           }
-
-         if (pending_extender_)
-           {
-             Pointer_group_interface::add_grob (pending_extender_,
-                                                ly_symbol2scm ("heads"), h);
-           }
-       }
-
+        {
+          if (extender_)
+            {
+              Pointer_group_interface::add_grob (extender_,
+                                                 ly_symbol2scm ("heads"), h);
+            }
+
+          if (pending_extender_)
+            {
+              Pointer_group_interface::add_grob (pending_extender_,
+                                                 ly_symbol2scm ("heads"), h);
+            }
+        }
+      else
+        {
+          if (pending_extender_
+              && !get_property ("extendersOverRests"))
+            {
+              completize_extender (pending_extender_);
+              pending_extender_ = 0;
+            }
+        }
       if (extender_)
-       {
-         pending_extender_ = extender_;
-         extender_ = 0;
-       }
+        {
+          pending_extender_ = extender_;
+          extender_ = 0;
+        }
     }
 
   ev_ = 0;
@@ -120,9 +154,7 @@ completize_extender (Spanner *sp)
     {
       extract_item_set (sp, "heads", heads);
       if (heads.size ())
-       {
-         sp->set_bound (RIGHT, heads.top());
-       }
+        sp->set_bound (RIGHT, heads.back ());
     }
 }
 
@@ -134,7 +166,7 @@ Extender_engraver::finalize ()
       completize_extender (extender_);
 
       if (!extender_->get_bound (RIGHT))
-       extender_->warning (_ ("unterminated extender"));
+        extender_->warning (_ ("unterminated extender"));
       extender_ = 0;
     }
 
@@ -143,15 +175,22 @@ Extender_engraver::finalize ()
       completize_extender (pending_extender_);
 
       if (!pending_extender_->get_bound (RIGHT))
-       pending_extender_->warning (_ ("unterminated extender"));
+        pending_extender_->warning (_ ("unterminated extender"));
       pending_extender_ = 0;
     }
 }
 
+ADD_ACKNOWLEDGER (Extender_engraver, lyric_syllable);
 ADD_TRANSLATOR (Extender_engraver,
-               /* descr */ "Create lyric extenders",
-               /* creats*/ "LyricExtender",
-               /* accepts */ "extender-event",
-               /* acks  */ "lyric-syllable-interface",
-               /* reads */ "",
-               /* write */ "");
+                /* doc */
+                "Create lyric extenders.",
+
+                /* create */
+                "LyricExtender ",
+
+                /* read */
+                "extendersOverRests ",
+
+                /* write */
+                ""
+               );