lily/multi-measure-rest-engraver.cc

   1 /*
   2   multi_measure_rest-engraver.cc -- implement Multi_measure_rest_engraver
   3
   4   (c) 1998--2004 Jan Nieuwenhuizen <janneke@gnu.org>
   5        Han-Wen Nienhuys <hanwen@cs.uu.nl>
   6 */
   7
   8 #include "multi-measure-rest.hh"
   9 #include "paper-column.hh"
  10 #include "engraver-group-engraver.hh"
  11 #include "side-position-interface.hh"
  12 #include "staff-symbol-referencer.hh"
  13 #include "moment.hh"
  14
  15 /**
  16    The name says it all: make multi measure rests
  17 */
  18 class Multi_measure_rest_engraver : public Engraver
  19 {
  20 public:
  21   TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
  22
  23 protected:
  24   virtual bool try_music (Music*);
  25   virtual void process_music ();
  26   virtual void stop_translation_timestep ();
  27   virtual void start_translation_timestep ();
  28   virtual void finalize ();
  29
  30 private:
  31   Music * rest_ev_;
  32   Link_array<Music> text_events_;
  33   int start_measure_;
  34   Rational last_main_moment_;
  35   Moment stop_moment_;
  36
  37   bool bar_seen_;
  38   Item *last_command_item_ ;
  39   Spanner *last_rest_;
  40   Spanner *mmrest_;
  41
  42   Link_array<Spanner> numbers_;
  43   Link_array<Spanner> last_numbers_;
  44 };
  45
  46 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  47 {
  48   last_command_item_ = 0;
  49   bar_seen_ = false;
  50   start_measure_ = 0;
  51   mmrest_ = 0;
  52   last_rest_ = 0;
  53   rest_ev_ = 0;
  54 }
  55
  56 bool
  57 Multi_measure_rest_engraver::try_music (Music* req)
  58 {
  59   if (req->is_mus_type ("multi-measure-rest-event"))
  60     {
  61       rest_ev_ = req;
  62       stop_moment_ = now_mom () + rest_ev_->get_length ();
  63
  64       return true;
  65     }
  66   else if (req->is_mus_type ("multi-measure-text-event"))
  67     {
  68       text_events_.push (req);
  69       return true;
  70     }
  71   return false;
  72 }
  73
  74 void
  75 Multi_measure_rest_engraver::process_music ()
  76 {
  77   if (rest_ev_ && !mmrest_
  78       && stop_moment_ > now_mom ())
  79     {
  80       mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
  81
  82       Spanner *sp
  83         = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm () );
  84       numbers_.push (sp);
  85
  86       if (text_events_.size ())
  87         {
  88           for (int i = 0; i < text_events_.size (); i++)
  89             {
  90
  91               Music* e = text_events_[i];
  92               Spanner *sp
  93                 = make_spanner ("MultiMeasureRestText", e->self_scm () );
  94               SCM t = e->get_property ("text");
  95               SCM dir = e->get_property ("direction");
  96               sp->set_property ("text",t);
  97               if (is_direction (dir))
  98                 sp->set_property ("direction",dir);
  99
 100               numbers_.push (sp);
 101             }
 102
 103           /*
 104             Stack different scripts.
 105            */
 106           Direction d = DOWN;
 107           do {
 108             Grob *last = 0;
 109             for (int i= 0; i <numbers_.size (); i++)
 110               {
 111                 if (scm_int2num (d) == numbers_[i]->get_property ("direction"))
 112                   {
 113                     if (last)
 114                       Side_position_interface::add_support (numbers_[i], last);
 115                     last = numbers_[i];
 116                   }
 117               }
 118           } while (flip (&d) != DOWN);
 119         }
 120
 121       for (int i = 0 ; i < numbers_.size (); i++)
 122         {
 123           Side_position_interface::add_support (numbers_[i], mmrest_);
 124           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 125         }
 126
 127       start_measure_
 128         = scm_to_int (get_property ("currentBarNumber"));
 129     }
 130
 131   bar_seen_ = scm_is_string (get_property ("whichBar"));
 132 }
 133
 134 void
 135 Multi_measure_rest_engraver::stop_translation_timestep ()
 136 {
 137   /*
 138     We can not do this earlier, as breakableSeparationItem is not yet there.
 139   */
 140
 141   if (bar_seen_)
 142     {
 143       Grob *cmc = unsmob_grob (get_property ("breakableSeparationItem"));
 144       if (!cmc)
 145         cmc = unsmob_grob (get_property ("currentCommandColumn"));
 146
 147       /*
 148         Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
 149        */
 150       last_command_item_ = dynamic_cast<Item*> (cmc);
 151     }
 152
 153   if (last_command_item_ &&  (mmrest_ || last_rest_))
 154     {
 155       if (last_rest_)
 156         {
 157           add_bound_item (last_rest_, last_command_item_);
 158           for (int i = 0; i < last_numbers_.size (); i++)
 159             add_bound_item (last_numbers_[i], last_command_item_);
 160         }
 161
 162       if (mmrest_)
 163         {
 164           add_bound_item (mmrest_, last_command_item_);
 165           for (int i = 0; i < numbers_.size (); i++)
 166             add_bound_item (numbers_[i], last_command_item_);
 167
 168           last_command_item_ = 0;
 169         }
 170     }
 171
 172   Moment mp(robust_scm2moment (get_property ("measurePosition"),  Moment (0)));
 173   if (last_rest_)
 174     {
 175       last_rest_ = 0;
 176       last_numbers_.clear ();
 177     }
 178
 179   text_events_.clear ();
 180 }
 181
 182 void
 183 Multi_measure_rest_engraver::start_translation_timestep ()
 184 {
 185   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 186     {
 187       rest_ev_ = 0;
 188     }
 189
 190   bar_seen_ = false;
 191
 192   Moment mp (robust_scm2moment (get_property ("measurePosition"),  Moment (0)));
 193
 194   Moment now = now_mom ();
 195   if (mmrest_
 196       && now.main_part_ != last_main_moment_
 197       && mp.main_part_ == Rational (0))
 198     {
 199       last_rest_ = mmrest_;
 200       last_numbers_ = numbers_;
 201
 202       int cur = scm_to_int (get_property ("currentBarNumber"));
 203       int num = cur - start_measure_;
 204
 205       /*
 206         We can't plug a markup directly into the grob, since the
 207         measure-count determines the formatting of the mmrest.
 208       */
 209       last_rest_->set_property ("measure-count", scm_int2num (num));
 210
 211       SCM sml = get_property ("measureLength");
 212       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 213       if (ml >= Rational (2))
 214         {
 215           last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 216         }
 217
 218       mmrest_ = 0;
 219       numbers_.clear ();
 220
 221       Grob * last = last_numbers_.size () ? last_numbers_[0] : 0;
 222       if (last && last->get_property ("text") == SCM_EOL)
 223         {
 224           SCM thres = get_property ("restNumberThreshold");
 225           int t = 1;
 226           if (scm_is_number (thres))
 227             t = scm_to_int (thres);
 228
 229           if (num <= t)
 230             last->suicide ();
 231           else
 232             {
 233               SCM text
 234                 = scm_number_to_string (scm_int2num (num), scm_from_int (10));
 235               last->set_property ("text", text);
 236             }
 237         }
 238     }
 239
 240   last_main_moment_ = now.main_part_;
 241 }
 242
 243 void
 244 Multi_measure_rest_engraver::finalize ()
 245 {
 246 }
 247
 248 ENTER_DESCRIPTION (Multi_measure_rest_engraver,
 249 /* descr */
 250                   "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 251 "measurePosition and currentBarNumber to determine what number to print "
 252 "over the MultiMeasureRest.  Reads measureLength to determine if it "
 253 "should use a whole rest or a breve rest to represent 1 measure "
 254                   ,
 255 /* creats*/       "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
 256 /* accepts */     "multi-measure-rest-event multi-measure-text-event",
 257 /* acks  */      "",
 258 /* reads */       "currentBarNumber restNumberThreshold breakableSeparationItem currentCommandColumn measurePosition measureLength",
 259 /* write */       "");