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--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   7 */
   8
   9 #include <ctype.h>
  10
  11 #include "bar-line.hh"
  12 #include "context.hh"
  13 #include "engraver-group-engraver.hh"
  14 #include "engraver.hh"
  15 #include "item.hh"
  16 #include "warn.hh"
  17 #include "text-item.hh"
  18
  19 /**
  20   put stuff over or next to  bars.  Examples: bar numbers, marginal notes,
  21   rehearsal marks.
  22  */
  23 class Mark_engraver : public Engraver
  24 {
  25 public:
  26   TRANSLATOR_DECLARATIONS (Mark_engraver);
  27 protected:
  28   Item *text_;
  29 protected:
  30   virtual void stop_translation_timestep ();
  31   virtual void acknowledge_grob (Grob_info);
  32   void create_items (Music*);
  33   virtual bool try_music (Music *ev);
  34   virtual void process_music ();
  35
  36 private:
  37   Music * mark_ev_;
  38 };
  39
  40
  41
  42
  43
  44 Mark_engraver::Mark_engraver ()
  45 {
  46   text_ =0;
  47   mark_ev_ = 0;
  48 }
  49
  50 void
  51 Mark_engraver::acknowledge_grob (Grob_info inf)
  52 {
  53   Grob * s = inf.grob_;
  54   if (text_ && Bar_line::has_interface (s))
  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       SCM lst = get_property ("stavesFound");
  71       text_->set_property ("side-support-elements" , lst);
  72       text_ =0;
  73     }
  74   mark_ev_ = 0;
  75 }
  76
  77
  78 void
  79 Mark_engraver::create_items (Music *ev)
  80 {
  81   if (text_)
  82     return;
  83
  84   text_ = make_item ("RehearsalMark", ev->self_scm ());
  85 }
  86
  87
  88 bool
  89 Mark_engraver::try_music (Music* r)
  90 {
  91   mark_ev_ = r;
  92   return true;
  93 }
  94
  95
  96 /*
  97   TODO: make the increment function in Scheme.
  98 */
  99 void
 100 Mark_engraver::process_music ()
 101 {
 102   if (mark_ev_)
 103     {
 104       create_items (mark_ev_);
 105
 106       /*
 107         automatic marks.
 108        */
 109
 110
 111       SCM m = mark_ev_->get_property ("label");
 112       SCM proc = get_property ("markFormatter");
 113       if (!Text_item::markup_p (m) &&
 114           ly_c_procedure_p (proc))
 115         {
 116           if (!ly_c_number_p (m))
 117             m =  get_property ("rehearsalMark");
 118
 119           if (scm_integer_p (m) == SCM_BOOL_T
 120               && scm_exact_p (m) == SCM_BOOL_T)
 121             {
 122               int mark_count = scm_to_int (m);
 123               mark_count ++;
 124               context ()->set_property ("rehearsalMark",
 125                                             scm_int2num (mark_count));
 126             }
 127
 128           if (ly_c_number_p (m))
 129             m = scm_call_2 (proc, m, context ()->self_scm ());
 130           else
 131             warning ("rehearsalMark does not have integer value.");
 132         }
 133
 134       if (Text_item::markup_p (m))
 135         text_->set_property ("text", m);
 136       else
 137         warning ("Mark label should be markup object.");
 138     }
 139 }
 140
 141 ENTER_DESCRIPTION (Mark_engraver,
 142 /* descr */       "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                    ,
 149 /* creats*/       "RehearsalMark",
 150 /* accepts */     "mark-event",
 151 /* acks  */       "bar-line-interface",
 152 /* reads */       "rehearsalMark markFormatter stavesFound",
 153 /* write */       "");