lily/mark-engraver.cc

   1 /*
   2   mark-engraver.cc -- implement Mark_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2009 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include <cctype>
  10 using namespace std;
  11
  12 #include "engraver.hh"
  13
  14 #include "axis-group-interface.hh"
  15 #include "bar-line.hh"
  16 #include "context.hh"
  17 #include "grob-array.hh"
  18 #include "international.hh"
  19 #include "item.hh"
  20 #include "stream-event.hh"
  21 #include "text-interface.hh"
  22 #include "warn.hh"
  23
  24 #include "translator.icc"
  25
  26 /**
  27    put stuff over or next to  bars.  Examples: bar numbers, marginal notes,
  28    rehearsal marks.
  29 */
  30 class Mark_engraver : public Engraver
  31 {
  32
  33   void create_items (Stream_event *);
  34   Item *text_;
  35   Stream_event *mark_ev_;
  36
  37 public:
  38   TRANSLATOR_DECLARATIONS (Mark_engraver);
  39
  40 protected:
  41   void process_music ();
  42   void stop_translation_timestep ();
  43
  44   DECLARE_TRANSLATOR_LISTENER (mark);
  45   DECLARE_ACKNOWLEDGER (break_alignment);
  46 };
  47
  48 Mark_engraver::Mark_engraver ()
  49 {
  50   text_ = 0;
  51   mark_ev_ = 0;
  52 }
  53
  54 void
  55 Mark_engraver::acknowledge_break_alignment (Grob_info inf)
  56 {
  57   Grob *s = inf.grob ();
  58   if (text_
  59       && dynamic_cast<Item *> (s))
  60     {
  61       text_->set_parent (s, X_AXIS);
  62     }
  63 }
  64
  65
  66 void
  67 Mark_engraver::stop_translation_timestep ()
  68 {
  69   if (text_)
  70   {
  71     text_->set_object ("side-support-elements",
  72                        grob_list_to_grob_array (get_property ("stavesFound")));
  73     text_ = 0;
  74   }
  75   mark_ev_ = 0;
  76 }
  77
  78 void
  79 Mark_engraver::create_items (Stream_event *ev)
  80 {
  81   if (text_)
  82     return;
  83
  84   text_ = make_item ("RehearsalMark", ev->self_scm ());
  85 }
  86
  87 IMPLEMENT_TRANSLATOR_LISTENER (Mark_engraver, mark);
  88 void
  89 Mark_engraver::listen_mark (Stream_event *ev)
  90 {
  91   ASSIGN_EVENT_ONCE (mark_ev_, ev);
  92 }
  93
  94 /*
  95   TODO: make the increment function in Scheme.
  96 */
  97 void
  98 Mark_engraver::process_music ()
  99 {
 100   if (mark_ev_)
 101     {
 102       create_items (mark_ev_);
 103
 104       /*
 105         automatic marks.
 106       */
 107
 108       SCM m = mark_ev_->get_property ("label");
 109       SCM proc = get_property ("markFormatter");
 110       if (!Text_interface::is_markup (m)
 111           && ly_is_procedure (proc))
 112         {
 113           if (!scm_is_number (m))
 114             m = get_property ("rehearsalMark");
 115
 116           if (scm_integer_p (m) == SCM_BOOL_T
 117               && scm_exact_p (m) == SCM_BOOL_T)
 118             {
 119               int mark_count = scm_to_int (m);
 120               mark_count++;
 121               context ()->set_property ("rehearsalMark",
 122                                         scm_from_int (mark_count));
 123             }
 124
 125           if (scm_is_number (m))
 126             m = scm_call_2 (proc, m, context ()->self_scm ());
 127           else
 128             /* FIXME: constant error message.  */
 129             warning (_ ("rehearsalMark must have integer value"));
 130         }
 131
 132       if (Text_interface::is_markup (m))
 133         text_->set_property ("text", m);
 134       else
 135         warning (_ ("mark label must be a markup object"));
 136     }
 137 }
 138
 139 ADD_ACKNOWLEDGER (Mark_engraver, break_alignment);
 140
 141 ADD_TRANSLATOR (Mark_engraver,
 142                 /* doc */
 143                 "Create @code{RehearsalMark} objects.  It puts them on top of"
 144                 " all staves (which is taken from the property"
 145                 " @code{stavesFound}).  If moving this engraver to a different"
 146                 " context, @ref{Staff_collecting_engraver} must move along,"
 147                 " otherwise all marks end up on the same Y@tie{}location.",
 148
 149                 /* create */
 150                 "RehearsalMark ",
 151
 152                 /* read */
 153                 "markFormatter "
 154                 "rehearsalMark "
 155                 "stavesFound ",
 156
 157                 /* write */
 158                 ""
 159                 );