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         TODO: make this configurable. RehearsalMark cannot be
  58         break-aligned, since the width of the object should not be taken
  59         into alignment considerations.
  60       */
  61       text_->set_parent (s, X_AXIS);
  62     }
  63 }
  64
  65 void
  66 Mark_engraver::stop_translation_timestep ()
  67 {
  68   if (text_)
  69     {
  70       text_->set_object ("side-support-elements",
  71                          grob_list_to_grob_array (get_property ("stavesFound")));
  72       text_ = 0;
  73     }
  74   mark_ev_ = 0;
  75 }
  76
  77 void
  78 Mark_engraver::create_items (Music *ev)
  79 {
  80   if (text_)
  81     return;
  82
  83   text_ = make_item ("RehearsalMark", ev->self_scm ());
  84 }
  85
  86 bool
  87 Mark_engraver::try_music (Music *r)
  88 {
  89   mark_ev_ = r;
  90   return true;
  91 }
  92
  93 /*
  94   TODO: make the increment function in Scheme.
  95 */
  96 void
  97 Mark_engraver::process_music ()
  98 {
  99   if (mark_ev_)
 100     {
 101       create_items (mark_ev_);
 102
 103       /*
 104         automatic marks.
 105       */
 106
 107       SCM m = mark_ev_->get_property ("label");
 108       SCM proc = get_property ("markFormatter");
 109       if (!Text_interface::is_markup (m)
 110           && ly_is_procedure (proc))
 111         {
 112           if (!scm_is_number (m))
 113             m = get_property ("rehearsalMark");
 114
 115           if (scm_integer_p (m) == SCM_BOOL_T
 116               && scm_exact_p (m) == SCM_BOOL_T)
 117             {
 118               int mark_count = scm_to_int (m);
 119               mark_count++;
 120               context ()->set_property ("rehearsalMark",
 121                                         scm_from_int (mark_count));
 122             }
 123
 124           if (scm_is_number (m))
 125             m = scm_call_2 (proc, m, context ()->self_scm ());
 126           else
 127             /* FIXME: constant error message.  */
 128             warning (_ ("rehearsalMark must have integer value"));
 129         }
 130
 131       if (Text_interface::is_markup (m))
 132         text_->set_property ("text", m);
 133       else
 134         warning (_ ("mark label must be a markup object"));
 135     }
 136 }
 137
 138 #include "translator.icc"
 139
 140 ADD_ACKNOWLEDGER (Mark_engraver, break_aligned);
 141
 142 ADD_TRANSLATOR (Mark_engraver,
 143                 /* doc */ "This engraver will create RehearsalMark objects. "
 144                 "It puts them on top of all staves (which is taken from "
 145                 "the property @code{stavesFound}). If moving this engraver "
 146                 "to a different context, "
 147                 "@ref{Staff_collecting_engraver} must move along, otherwise all marks"
 148                 "end up on the same Y-location",
 149                 /* create */ "RehearsalMark",
 150                 /* accept */ "mark-event",
 151                 /* read */ "rehearsalMark rehearsalMarkAlignSymbol markFormatter stavesFound",
 152                 /* write */ "");