Imported Upstream version 2.16.0

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

diff --git a/lily/footnote-engraver.cc b/lily/footnote-engraver.cc
index 7539bf95039e3ff33be4d8cd93086ab2bad28a50..efa7900b00d5f570130f0dd279278c435e0b138a 100644 (file)
--- a/lily/footnote-engraver.cc
+++ b/lily/footnote-engraver.cc
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2011 Mike Solomon <mike@apollinemike.com>
+  Copyright (C) 2011--2012 Mike Solomon <mike@apollinemike.com>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -19,10 +19,13 @@
 
 #include "engraver.hh"
 
+#include "music.hh"
 #include "stream-event.hh"
+#include "international.hh"
 #include "item.hh"
 #include "pointer-group-interface.hh"
 #include "spanner.hh"
+#include "system.hh"
 
 #include "translator.icc"
 
@@ -37,8 +40,10 @@ class Footnote_engraver : public Engraver
   vector<Drul_array<Spanner *> > annotated_spanners_;
 
   void stop_translation_timestep ();
+  void finalize ();
+  virtual void derived_mark () const;
 
-  void footnotify (Grob *, Stream_event *);
+  void footnotify (Grob *, SCM);
 };
 
 IMPLEMENT_TRANSLATOR_LISTENER (Footnote_engraver, footnote);
@@ -54,27 +59,40 @@ Footnote_engraver::stop_translation_timestep ()
   events_.clear ();
 }
 
+void
+Footnote_engraver::finalize ()
+{
+  annotated_spanners_.clear ();
+}
+
+void
+Footnote_engraver::derived_mark () const
+{
+  for (vsize i = 0; i < events_.size (); ++i)
+    scm_gc_mark (events_[i]->self_scm ());
+}
+
 Footnote_engraver::Footnote_engraver ()
 {
 }
 
 void
-Footnote_engraver::footnotify (Grob *g, Stream_event *event)
+Footnote_engraver::footnotify (Grob *g, SCM cause)
 {
   Spanner *s = dynamic_cast<Spanner *>(g);
 
   if (s)
     {
-      Spanner *b = make_spanner ("FootnoteSpanner", event->self_scm ());
+      Spanner *b = make_spanner ("FootnoteSpanner", cause);
       b->set_parent (s, Y_AXIS);
       b->set_parent (s, X_AXIS);
       Grob *bound = unsmob_grob (get_property ("currentMusicalColumn"));
       b->set_bound (LEFT, bound);
-      annotated_spanners_.push_back (Drul_array<Spanner *> (s,b));
+      annotated_spanners_.push_back (Drul_array<Spanner *> (s, b));
     }
   else
     {
-      Grob *b = make_item ("FootnoteItem", event->self_scm ());
+      Grob *b = make_item ("FootnoteItem", cause);
       b->set_parent (g, Y_AXIS);
       b->set_parent (g, X_AXIS);
     }
@@ -83,20 +101,38 @@ Footnote_engraver::footnotify (Grob *g, Stream_event *event)
 void
 Footnote_engraver::acknowledge_grob (Grob_info info)
 {
-  Stream_event *cause = info.event_cause ();
+  Music *mus = unsmob_music (info.grob ()->get_property ("footnote-music"));
 
-  SCM arts = cause ? cause->get_property ("articulations") : SCM_EOL;
-  for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
+  if (mus)
     {
-      Stream_event *e = unsmob_stream_event (scm_car (s));
-      if (e->in_event_class ("footnote-event"))
-         footnotify (info.grob (), e);
+      if (!mus->is_mus_type ("footnote-event"))
+        {
+          mus->origin ()->programming_error (_ ("Must be footnote-event."));
+          return;
+        }
+
+      footnotify (info.grob (), mus->to_event (context ())->unprotect ());
+
+      // This grob has exhausted its footnote
+      info.grob ()->set_property ("footnote-music", SCM_EOL);
+      return;
     }
 
-  for (vsize i = 0; i < events_.size (); i++)
+  if (!events_.empty ())
     {
-      if (info.grob ()->name () == ly_symbol2string (events_[i]->get_property ("symbol")))
-       footnotify (info.grob (), events_[i]);
+      string grobname = info.grob ()->name ();
+
+      for (vsize i = 0; i < events_.size (); i++)
+        {
+          SCM name = events_[i]->get_property ("symbol");
+          if (scm_is_symbol (name)
+              && grobname == ly_symbol2string (name))
+            {
+              footnotify (info.grob (), events_[i]->self_scm ());
+              // Event has exhausted its footnote
+              events_[i]->set_property ("symbol", SCM_EOL);
+            }
+        }
     }
 }
 
@@ -121,16 +157,16 @@ ADD_ACKNOWLEDGER (Footnote_engraver, grob);
 ADD_END_ACKNOWLEDGER (Footnote_engraver, grob);
 
 ADD_TRANSLATOR (Footnote_engraver,
-              /* doc */
-              "Create footnote texts.",
+                /* doc */
+                "Create footnote texts.",
 
-              /* create */
-              "FootnoteItem "
-              "FootnoteSpanner ",
+                /* create */
+                "FootnoteItem "
+                "FootnoteSpanner ",
 
-              /*read*/
-              "currentMusicalColumn ",
+                /*read*/
+                "currentMusicalColumn ",
 
-              /*write*/
-              ""
-              );
+                /*write*/
+                ""
+               );