]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/hyphen-engraver.cc
lilypond-manuals.css: edit color scheme and some spacing
[lilypond.git] / lily / hyphen-engraver.cc
index 96839f8f99e2b481979a924a10ff3d5fbbccbd93..20d2a7c9380d3d4cd13fbb8cbae1d2a9f98ab916 100644 (file)
@@ -1,89 +1,97 @@
 /*
-  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--2004 Glen Prideaux <glenprideaux@iname.com>,
-                  Han-Wen Nienhuys <hanwen@cs.uu.nl>,
-                  Jan Nieuwenhuizen <janneke@gnu.org>
+  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 "warn.hh"
-#include "item.hh"
 #include "engraver.hh"
+#include "international.hh"
+#include "item.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_;  
+  Spanner *finished_hyphen_;
+
 public:
   TRANSLATOR_DECLARATIONS (Hyphen_engraver);
 
 protected:
-  virtual void acknowledge_grob (Grob_info);
-  virtual void finalize ();
-  virtual bool try_music (Music*);
-  virtual void stop_translation_timestep ();
-  virtual void process_music ();
-private:
-
-};
 
+  void acknowledge_lyric_syllable (Grob_info);
+  void listen_hyphen (Stream_event *);
 
+  virtual void finalize ();
 
+  void stop_translation_timestep ();
+  void process_music ();
+};
 
-Hyphen_engraver::Hyphen_engraver ()
+Hyphen_engraver::Hyphen_engraver (Context *c)
+  : Engraver (c)
 {
   hyphen_ = 0;
   finished_hyphen_ = 0;
+  finished_ev_ = 0;
   ev_ = 0;
 }
 
 void
-Hyphen_engraver::acknowledge_grob (Grob_info i)
+Hyphen_engraver::acknowledge_lyric_syllable (Grob_info i)
 {
-  Item * item =  dynamic_cast<Item*> (i.grob_);
-  // -> text_item
-  if (item && item->internal_has_interface (ly_symbol2scm ("lyric-syllable-interface")))
-    {
-      if (hyphen_)
-       hyphen_->set_bound (LEFT, item);
+  Item *item = i.item ();
 
-      if (finished_hyphen_)
-       finished_hyphen_->set_bound (RIGHT, item);
-    }
-}
+  if (!hyphen_)
+    hyphen_ = make_spanner ("LyricSpace", item->self_scm ());
 
+  if (hyphen_)
+    hyphen_->set_bound (LEFT, item);
 
-bool
-Hyphen_engraver::try_music (Music* r)
-{
-  if (ev_)
-    return false;
+  if (finished_hyphen_)
+    finished_hyphen_->set_bound (RIGHT, item);
+}
 
-  ev_ = r;
-  return true;
+void
+Hyphen_engraver::listen_hyphen (Stream_event *ev)
+{
+  ASSIGN_EVENT_ONCE (ev_, ev);
 }
 
 void
-completize_hyphen (Spannersp)
+completize_hyphen (Spanner *sp)
 {
   if (!sp->get_bound (RIGHT))
     {
-      SCM heads = sp->get_property ("heads");
-      if (gh_pair_p (heads))
-       {
-         Item* it = dynamic_cast<Item*> (unsmob_grob (gh_car (heads)));
-         if (it)
-           sp->set_bound (RIGHT, it);
-       }
+      extract_item_set (sp, "heads", heads);
+      if (heads.size ())
+        sp->set_bound (RIGHT, heads.back ());
     }
 }
 
-  
-
 void
 Hyphen_engraver::finalize ()
 {
@@ -92,12 +100,11 @@ Hyphen_engraver::finalize ()
       completize_hyphen (hyphen_);
 
       if (!hyphen_->get_bound (RIGHT))
-       {
-         hyphen_->warning (_ ("unterminated hyphen; removing"));
-         hyphen_->suicide ();
-       }
+        {
+          hyphen_->warning (_ ("removing unterminated hyphen"));
+          hyphen_->suicide ();
+        }
 
-      typeset_grob (hyphen_);
       hyphen_ = 0;
     }
 
@@ -106,12 +113,12 @@ Hyphen_engraver::finalize ()
       completize_hyphen (finished_hyphen_);
 
       if (!finished_hyphen_->get_bound (RIGHT))
-       {
-         finished_hyphen_->warning (_("unterminated hyphen; removing"));
-         finished_hyphen_->suicide ();
-       }
-      typeset_grob (finished_hyphen_);
-      finished_hyphen_ =0;
+        {
+          if (finished_ev_)
+            finished_hyphen_->warning (_ ("unterminated hyphen; removing"));
+          finished_hyphen_->suicide ();
+        }
+      finished_hyphen_ = 0;
     }
 }
 
@@ -119,43 +126,54 @@ void
 Hyphen_engraver::process_music ()
 {
   if (ev_)
-    {
-      hyphen_ = make_spanner ("LyricHyphen");
-      announce_grob (hyphen_, ev_->self_scm ());
-    }
+    hyphen_ = make_spanner ("LyricHyphen", ev_->self_scm ());
 }
 
-
 void
 Hyphen_engraver::stop_translation_timestep ()
 {
   if (finished_hyphen_ && finished_hyphen_->get_bound (RIGHT))
     {
-      typeset_grob (finished_hyphen_);
       finished_hyphen_ = 0;
+      finished_ev_ = 0;
     }
 
   if (finished_hyphen_ && hyphen_)
     {
-      programming_error ("Haven't finished hyphen yet.");
-      typeset_grob (finished_hyphen_);
-      finished_hyphen_ =0;
+      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;
 }
 
 
+void
+Hyphen_engraver::boot ()
+{
+  ADD_LISTENER (Hyphen_engraver, hyphen);
+  ADD_ACKNOWLEDGER (Hyphen_engraver, lyric_syllable);
+}
+
+ADD_TRANSLATOR (Hyphen_engraver,
+                /* doc */
+                "Create lyric hyphens and distance constraints between words.",
+
+                /* create */
+                "LyricHyphen "
+                "LyricSpace ",
 
+                /* read */
+                "",
 
-ENTER_DESCRIPTION (Hyphen_engraver,
-/* descr */       "Create lyric hyphens",
-/* creats*/       "LyricHyphen",
-/* accepts */     "hyphen-event",
-/* acks  */      "lyric-syllable-interface",
-/* reads */       "",
-/* write */       "");
+                /* write */
+                ""
+               );