2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2011--2012 Mike Solomon <mike@apollinemike.com>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
20 #include "engraver.hh"
23 #include "stream-event.hh"
24 #include "international.hh"
26 #include "pointer-group-interface.hh"
30 #include "translator.icc"
32 class Footnote_engraver : public Engraver
34 TRANSLATOR_DECLARATIONS (Footnote_engraver);
36 DECLARE_TRANSLATOR_LISTENER (footnote);
37 DECLARE_ACKNOWLEDGER (grob);
38 DECLARE_END_ACKNOWLEDGER (grob);
39 vector<Stream_event *> events_;
40 vector<Drul_array<Spanner *> > annotated_spanners_;
42 void stop_translation_timestep ();
44 virtual void derived_mark () const;
46 void footnotify (Grob *, Stream_event *);
49 IMPLEMENT_TRANSLATOR_LISTENER (Footnote_engraver, footnote);
51 Footnote_engraver::listen_footnote (Stream_event *ev)
53 events_.push_back (ev);
57 Footnote_engraver::stop_translation_timestep ()
63 Footnote_engraver::finalize ()
65 annotated_spanners_.clear ();
69 Footnote_engraver::derived_mark () const
71 for (vsize i = 0; i < events_.size (); ++i)
72 scm_gc_mark (events_[i]->self_scm ());
75 Footnote_engraver::Footnote_engraver ()
80 Footnote_engraver::footnotify (Grob *g, Stream_event *event)
82 Spanner *s = dynamic_cast<Spanner *>(g);
86 Spanner *b = make_spanner ("FootnoteSpanner", event->self_scm ());
87 b->set_parent (s, Y_AXIS);
88 b->set_parent (s, X_AXIS);
89 Grob *bound = unsmob_grob (get_property ("currentMusicalColumn"));
90 b->set_bound (LEFT, bound);
91 annotated_spanners_.push_back (Drul_array<Spanner *> (s, b));
95 Grob *b = make_item ("FootnoteItem", event->self_scm ());
96 b->set_parent (g, Y_AXIS);
97 b->set_parent (g, X_AXIS);
102 Footnote_engraver::acknowledge_grob (Grob_info info)
104 Music *mus = unsmob_music (info.grob ()->get_property ("footnote-music"));
108 if (!mus->is_mus_type ("footnote-event")) {
109 mus->origin ()->programming_error (_ ("Must be footnote-event."));
112 Stream_event *ev = mus->to_event (context ());
113 footnotify (info.grob (), ev);
118 // The following performance hog should eventually be removed:
119 // instead of adding a -\footnote ... \default articulation at the
120 // end of a note, you can perfectly well use \footnote ... before
121 // the note. This is just for the sake of automatic convert-ly
124 Stream_event *cause = info.event_cause ();
126 SCM arts = cause ? cause->get_property ("articulations") : SCM_EOL;
127 for (SCM s = arts; scm_is_pair (s); s = scm_cdr (s))
129 Stream_event *e = unsmob_stream_event (scm_car (s));
130 if (e->in_event_class ("footnote-event"))
131 footnotify (info.grob (), e);
134 // In contrast, the following code is only called when actual
135 // footnote events have been listened to. It should not affect
138 for (vsize i = 0; i < events_.size (); i++)
140 if (info.grob ()->name () == ly_symbol2string (events_[i]->get_property ("symbol")))
141 footnotify (info.grob (), events_[i]);
146 Footnote_engraver::acknowledge_end_grob (Grob_info info)
148 Spanner *s = dynamic_cast<Spanner *>(info.grob ());
151 for (vsize i = 0; i < annotated_spanners_.size (); i++)
153 if (annotated_spanners_[i][LEFT] == s)
155 Grob *bound = unsmob_grob (get_property ("currentMusicalColumn"));
156 annotated_spanners_[i][RIGHT]->set_bound (RIGHT, bound);
162 ADD_ACKNOWLEDGER (Footnote_engraver, grob);
163 ADD_END_ACKNOWLEDGER (Footnote_engraver, grob);
165 ADD_TRANSLATOR (Footnote_engraver,
167 "Create footnote texts.",
174 "currentMusicalColumn ",