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