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