lily/footnote-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2011--2012 Mike Solomon <mike@apollinemike.com>
   5
   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.
  10
  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.
  15
  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/>.
  18 */
  19
  20 #include "engraver.hh"
  21
  22 #include "music.hh"
  23 #include "stream-event.hh"
  24 #include "international.hh"
  25 #include "item.hh"
  26 #include "pointer-group-interface.hh"
  27 #include "spanner.hh"
  28 #include "system.hh"
  29
  30 #include "translator.icc"
  31
  32 class Footnote_engraver : public Engraver
  33 {
  34   TRANSLATOR_DECLARATIONS (Footnote_engraver);
  35
  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_;
  41
  42   void stop_translation_timestep ();
  43   void finalize ();
  44   virtual void derived_mark () const;
  45
  46   void footnotify (Grob *, SCM);
  47 };
  48
  49 IMPLEMENT_TRANSLATOR_LISTENER (Footnote_engraver, footnote);
  50 void
  51 Footnote_engraver::listen_footnote (Stream_event *ev)
  52 {
  53   events_.push_back (ev);
  54 }
  55
  56 void
  57 Footnote_engraver::stop_translation_timestep ()
  58 {
  59   events_.clear ();
  60 }
  61
  62 void
  63 Footnote_engraver::finalize ()
  64 {
  65   annotated_spanners_.clear ();
  66 }
  67
  68 void
  69 Footnote_engraver::derived_mark () const
  70 {
  71   for (vsize i = 0; i < events_.size (); ++i)
  72     scm_gc_mark (events_[i]->self_scm ());
  73 }
  74
  75 Footnote_engraver::Footnote_engraver ()
  76 {
  77 }
  78
  79 void
  80 Footnote_engraver::footnotify (Grob *g, SCM cause)
  81 {
  82   Spanner *s = dynamic_cast<Spanner *>(g);
  83
  84   if (s)
  85     {
  86       Spanner *b = make_spanner ("FootnoteSpanner", cause);
  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));
  92     }
  93   else
  94     {
  95       Grob *b = make_item ("FootnoteItem", cause);
  96       b->set_parent (g, Y_AXIS);
  97       b->set_parent (g, X_AXIS);
  98     }
  99 }
 100
 101 void
 102 Footnote_engraver::acknowledge_grob (Grob_info info)
 103 {
 104   Music *mus = unsmob_music (info.grob ()->get_property ("footnote-music"));
 105
 106   if (mus)
 107     {
 108       if (!mus->is_mus_type ("footnote-event"))
 109         {
 110           mus->origin ()->programming_error (_ ("Must be footnote-event."));
 111           return;
 112         }
 113
 114       footnotify (info.grob (), mus->to_event (context ())->unprotect ());
 115
 116       // This grob has exhausted its footnote
 117       info.grob ()->set_property ("footnote-music", SCM_EOL);
 118       return;
 119     }
 120
 121   if (!events_.empty ())
 122     {
 123       string grobname = info.grob ()->name ();
 124
 125       for (vsize i = 0; i < events_.size (); i++)
 126         {
 127           SCM name = events_[i]->get_property ("symbol");
 128           if (scm_is_symbol (name)
 129               && grobname == ly_symbol2string (name))
 130             {
 131               footnotify (info.grob (), events_[i]->self_scm ());
 132               // Event has exhausted its footnote
 133               events_[i]->set_property ("symbol", SCM_EOL);
 134             }
 135         }
 136     }
 137 }
 138
 139 void
 140 Footnote_engraver::acknowledge_end_grob (Grob_info info)
 141 {
 142   Spanner *s = dynamic_cast<Spanner *>(info.grob ());
 143
 144   if (s)
 145     for (vsize i = 0; i < annotated_spanners_.size (); i++)
 146       {
 147         if (annotated_spanners_[i][LEFT] == s)
 148           {
 149             Grob *bound = unsmob_grob (get_property ("currentMusicalColumn"));
 150             annotated_spanners_[i][RIGHT]->set_bound (RIGHT, bound);
 151             break;
 152           }
 153       }
 154 }
 155
 156 ADD_ACKNOWLEDGER (Footnote_engraver, grob);
 157 ADD_END_ACKNOWLEDGER (Footnote_engraver, grob);
 158
 159 ADD_TRANSLATOR (Footnote_engraver,
 160                 /* doc */
 161                 "Create footnote texts.",
 162
 163                 /* create */
 164                 "FootnoteItem "
 165                 "FootnoteSpanner ",
 166
 167                 /*read*/
 168                 "currentMusicalColumn ",
 169
 170                 /*write*/
 171                 ""
 172                );