Doc-es: various updates.

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

diff --git a/lily/hyphen-engraver.cc b/lily/hyphen-engraver.cc
index 4046ab06d0a822dc2d7175a2e518c0ca7ab95e1e..20d2a7c9380d3d4cd13fbb8cbae1d2a9f98ab916 100644 (file)
--- a/lily/hyphen-engraver.cc
+++ b/lily/hyphen-engraver.cc
@@ -1,41 +1,62 @@
 /*
-  hyphen-engraver.cc -- implement Hyphen_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 "engraver.hh"
-
-#include "warn.hh"
+#include "international.hh"
 #include "item.hh"
-#include "spanner.hh"
 #include "pointer-group-interface.hh"
+#include "spanner.hh"
+#include "stream-event.hh"
+#include "warn.hh"
+
+#include "translator.icc"
 
 class Hyphen_engraver : public Engraver
 {
-  Music *ev_;
+  Stream_event *ev_;
+  Stream_event *finished_ev_;
+
   Spanner *hyphen_;
   Spanner *finished_hyphen_;
+
 public:
   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
 
 protected:
-  DECLARE_ACKNOWLEDGER (lyric_syllable);
+
+  void acknowledge_lyric_syllable (Grob_info);
+  void listen_hyphen (Stream_event *);
+
   virtual void finalize ();
-  virtual bool try_music (Music *);
+
   void stop_translation_timestep ();
   void process_music ();
-private:
 };
 
-Hyphen_engraver::Hyphen_engraver ()
+Hyphen_engraver::Hyphen_engraver (Context *c)
+  : Engraver (c)
 {
   hyphen_ = 0;
   finished_hyphen_ = 0;
+  finished_ev_ = 0;
   ev_ = 0;
 }
 
@@ -43,6 +64,10 @@ void
 Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
 {
   Item *item = i.item ();
+
+  if (!hyphen_)
+    hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
+
   if (hyphen_)
     hyphen_->set_bound (LEFT, item);
 
@@ -50,14 +75,10 @@ Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
     finished_hyphen_->set_bound (RIGHT, item);
 }
 
-bool
-Hyphen_engraver::try_music (Music *r)
+void
+Hyphen_engraver::listen_hyphen (Stream_event *ev)
 {
-  if (ev_)
-    return false;
-
-  ev_ = r;
-  return true;
+  ASSIGN_EVENT_ONCE (ev_, ev);
 }
 
 void
@@ -67,7 +88,7 @@ completize_hyphen (Spanner *sp)
     {
       extract_item_set (sp, "heads", heads);
       if (heads.size ())
-       sp->set_bound (RIGHT, heads.top ());
+        sp->set_bound (RIGHT, heads.back ());
     }
 }
 
@@ -79,10 +100,10 @@ Hyphen_engraver::finalize ()
       completize_hyphen (hyphen_);
 
       if (!hyphen_->get_bound (RIGHT))
-       {
-         hyphen_->warning (_ ("removing unterminated hyphen"));
-         hyphen_->suicide ();
-       }
+        {
+          hyphen_->warning (_ ("removing unterminated hyphen"));
+          hyphen_->suicide ();
+        }
 
       hyphen_ = 0;
     }
@@ -92,10 +113,11 @@ Hyphen_engraver::finalize ()
       completize_hyphen (finished_hyphen_);
 
       if (!finished_hyphen_->get_bound (RIGHT))
-       {
-         finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
-         finished_hyphen_->suicide ();
-       }
+        {
+          if (finished_ev_)
+            finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
+          finished_hyphen_->suicide ();
+        }
       finished_hyphen_ = 0;
     }
 }
@@ -104,9 +126,7 @@ void
 Hyphen_engraver::process_music ()
 {
   if (ev_)
-    {
-      hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
-    }
+    hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 }
 
 void
@@ -115,27 +135,45 @@ Hyphen_engraver::stop_translation_timestep ()
   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
     {
       finished_hyphen_ = 0;
+      finished_ev_ = 0;
     }
 
   if (finished_hyphen_ && hyphen_)
     {
       programming_error ("hyphen not finished yet");
       finished_hyphen_ = 0;
+      finished_ev_ = 0;
     }
 
   if (hyphen_)
-    finished_hyphen_ = hyphen_;
-  hyphen_ = 0;
+    {
+      finished_hyphen_ = hyphen_;
+      finished_ev_ = ev_;
+    }
 
+  hyphen_ = 0;
   ev_ = 0;
 }
 
-#include "translator.icc"
 
-ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
+void
+Hyphen_engraver::boot ()
+{
+  ADD_LISTENER (Hyphen_engraver, hyphen);
+  ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
+}
+
 ADD_TRANSLATOR (Hyphen_engraver,
-               /* doc */ "Create lyric hyphens",
-               /* create */ "LyricHyphen",
-               /* accept */ "hyphen-event",
-               /* read */ "",
-               /* write */ "");
+                /* doc */
+                "Create lyric hyphens and distance constraints between words.",
+
+                /* create */
+                "LyricHyphen "
+                "LyricSpace ",
+
+                /* read */
+                "",
+
+                /* write */
+                ""
+               );