Issue 2559: For time-based footnotes without grob spec, attach to all grobs

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

diff --git a/lily/footnote-engraver.cc b/lily/footnote-engraver.cc
index 6b62af0d47f72131fd06878a6004b1f59a8bdb41..830fdfe97227c6b06412bd4ab66d8a73f69891c0 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,6 +40,8 @@ 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 *);
 };
@@ -54,6 +59,19 @@ 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 ()
 {
 }
@@ -83,6 +101,26 @@ Footnote_engraver::footnotify (Grob *g, Stream_event *event)
 void
 Footnote_engraver::acknowledge_grob (Grob_info info)
 {
+  Music *mus = unsmob_music (info.grob ()->get_property ("footnote-music"));
+
+  if (mus)
+    {
+      if (!mus->is_mus_type ("footnote-event")) {
+       mus->origin ()->programming_error (_ ("Must be footnote-event."));
+       return;
+      }
+      Stream_event *ev = mus->to_event (context ());
+      footnotify (info.grob (), ev);
+      ev->unprotect ();
+      return;
+    }
+
+  // The following performance hog should eventually be removed:
+  // instead of adding a -\footnote ... \default articulation at the
+  // end of a note, you can perfectly well use \footnote ... before
+  // the note.  This is just for the sake of automatic convert-ly
+  // rules.
+
   Stream_event *cause = info.event_cause ();
 
   SCM arts = cause ? cause->get_property ("articulations") : SCM_EOL;
@@ -93,9 +131,15 @@ Footnote_engraver::acknowledge_grob (Grob_info info)
         footnotify (info.grob (), e);
     }
 
+  // In contrast, the following code is only called when actual
+  // footnote events have been listened to.  It should not affect
+  // performance.
+
   for (vsize i = 0; i < events_.size (); i++)
     {
-      if (info.grob ()->name () == ly_symbol2string (events_[i]->get_property ("symbol")))
+      SCM name = events_[i]->get_property ("symbol");
+      if (!scm_is_symbol (name)
+         || info.grob ()->name () == ly_symbol2string (name))
         footnotify (info.grob (), events_[i]);
     }
 }