lily/metronome-engraver.cc

   1 /*
   2   mark-engraver.cc -- implement Metronome_mark_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include <cctype>
  10 using namespace std;
  11
  12 #include "engraver.hh"
  13
  14 #include "note-column.hh"
  15 #include "context.hh"
  16 #include "grob-array.hh"
  17
  18 /**
  19    put stuff over or next to  bars.  Examples: bar numbers, marginal notes,
  20    rehearsal marks.
  21 */
  22 class Metronome_mark_engraver : public Engraver
  23 {
  24 public:
  25   TRANSLATOR_DECLARATIONS (Metronome_mark_engraver);
  26 protected:
  27   Item *text_;
  28   Grob *bar_line_;
  29   Music *mark_ev_;
  30
  31   void create_items (Music *);
  32 protected:
  33   void stop_translation_timestep ();
  34   virtual bool try_music (Music *ev);
  35   void process_music ();
  36 };
  37
  38 Metronome_mark_engraver::Metronome_mark_engraver ()
  39 {
  40   text_ = 0;
  41   mark_ev_ = 0;
  42 }
  43
  44 void
  45 Metronome_mark_engraver::stop_translation_timestep ()
  46 {
  47   if (text_)
  48     {
  49       Grob *mc = unsmob_grob (get_property ("currentMusicalColumn"));
  50       text_->set_parent (mc, X_AXIS);
  51       text_->set_object ("side-support-elements",
  52                          grob_list_to_grob_array (get_property ("stavesFound")));
  53
  54       text_ = 0;
  55     }
  56   mark_ev_ = 0;
  57 }
  58
  59 void
  60 Metronome_mark_engraver::create_items (Music *rq)
  61 {
  62   if (text_)
  63     return;
  64
  65   text_ = make_item ("MetronomeMark", rq->self_scm ());
  66 }
  67
  68 bool
  69 Metronome_mark_engraver::try_music (Music *r)
  70 {
  71   mark_ev_ = r;
  72   return true;
  73 }
  74
  75 void
  76 Metronome_mark_engraver::process_music ()
  77 {
  78   if (mark_ev_)
  79     {
  80       create_items (mark_ev_);
  81
  82       SCM proc = get_property ("metronomeMarkFormatter");
  83       SCM result = scm_call_2 (proc, mark_ev_->self_scm (),
  84                                context ()->self_scm ());
  85
  86       text_->set_property ("text", result);
  87     }
  88 }
  89
  90 #include "translator.icc"
  91
  92 ADD_TRANSLATOR (Metronome_mark_engraver,
  93                 /* doc */ "Engrave metro nome marking. This delegates the formatting work "
  94                 "to the function in the metronomeMarkFormatter property. "
  95                 "The mark is put over all staves. "
  96                 "The staves are taken from the @code{stavesFound} property, "
  97                 "which is maintained by @code{@ref{Staff_collecting_engraver}}. ",
  98                 /* create */ "MetronomeMark",
  99                 /* accept */ "metronome-change-event",
 100                 /* read */ "stavesFound metronomeMarkFormatter",
 101                 /* write */ "");