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 */
  22 class Multi_measure_rest_engraver : public Engraver
  23 {
  24 public:
  25   TRANSLATOR_DECLARATIONS(Multi_measure_rest_engraver);
  26
  27 protected:
  28   virtual bool try_music (Music*);
  29   virtual void process_music ();
  30   virtual void stop_translation_timestep ();
  31   virtual void start_translation_timestep ();
  32   virtual void finalize ();
  33
  34 private:
  35   Music * rest_ev_;
  36   Link_array<Music> text_events_;
  37   int start_measure_;
  38   Rational last_main_moment_;
  39   Moment stop_moment_;
  40
  41   bool bar_seen_;
  42
  43   Spanner *last_rest_;
  44   Spanner *mmrest_;
  45
  46   Link_array<Spanner> numbers_;
  47   Link_array<Spanner> last_numbers_;
  48 };
  49
  50 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  51 {
  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");
  84
  85       if (text_events_.size())
  86         {
  87           for (int i = 0; i < text_events_.size(); i++)
  88             {
  89               Spanner *sp
  90                 = make_spanner ("MultiMeasureRestText");
  91
  92               Music* e = text_events_[i];
  93               SCM t = e->get_mus_property ("text");
  94               SCM dir = e->get_mus_property ("direction");
  95               sp->set_grob_property ("text",t);
  96               if (is_direction (dir))
  97                 sp->set_grob_property ("direction",dir);
  98
  99               numbers_.push (sp);
 100               announce_grob (sp, e->self_scm());
 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 (gh_int2scm (d) == numbers_[i]->get_grob_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       else
 121         {
 122           Spanner *sp
 123             = make_spanner ("MultiMeasureRestNumber");
 124           numbers_.push (sp);
 125           announce_grob (sp, rest_ev_->self_scm());
 126         }
 127
 128       for (int i =0 ; i < numbers_.size(); i++)
 129         {
 130           Side_position_interface::add_support (numbers_[i], mmrest_);
 131           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 132         }
 133
 134       announce_grob (mmrest_, rest_ev_->self_scm());
 135       start_measure_
 136         = gh_scm2int (get_property ("currentBarNumber"));
 137     }
 138
 139   bar_seen_ = gh_string_p (get_property ("whichBar"));
 140 }
 141
 142 void
 143 Multi_measure_rest_engraver::stop_translation_timestep ()
 144 {
 145   /*
 146     We can not do this earlier, as breakableSeparationItem is not yet there.
 147   */
 148
 149   if (bar_seen_)
 150     {
 151       Grob *cmc = unsmob_grob (get_property("breakableSeparationItem"));
 152       if (!cmc)
 153         cmc = unsmob_grob (get_property ("currentCommandColumn"));
 154
 155       Item *it = dynamic_cast<Item*> (cmc);
 156
 157       if (mmrest_)
 158         {
 159           add_bound_item (mmrest_, it);
 160           for (int i = 0; i < numbers_.size(); i++)
 161             add_bound_item (numbers_[i], it);
 162         }
 163
 164       if (last_rest_)
 165         {
 166           add_bound_item (last_rest_,it);
 167           for (int i = 0; i < last_numbers_.size(); i++)
 168             add_bound_item (last_numbers_[i], it);
 169         }
 170     }
 171
 172   SCM smp = get_property ("measurePosition");
 173   Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 174
 175   if (mmrest_
 176       && !mp.to_bool ()
 177       && mmrest_->get_bound (LEFT) && mmrest_->get_bound (RIGHT))
 178     {
 179       typeset_grob (mmrest_);
 180       for (int i = 0 ; i < numbers_.size(); i++)
 181         {
 182           typeset_grob (numbers_[i]);
 183         }
 184
 185       /*
 186         we must keep mmrest_ around to set measure-count, so
 187         no mmrest_ = 0 here.
 188        */
 189     }
 190
 191   if (last_rest_)
 192     {
 193       /* sanity check */
 194       if (last_rest_->get_bound (LEFT) && last_rest_->get_bound (RIGHT)
 195           && last_rest_->get_bound (LEFT) != last_rest_->get_bound (RIGHT))
 196         {
 197           typeset_grob (last_rest_);
 198
 199           for (int i = 0; i < last_numbers_.size ();i++)
 200             {
 201               typeset_grob (last_numbers_[i]);
 202             }
 203         }
 204       last_rest_ = 0;
 205       last_numbers_.clear();
 206     }
 207
 208   text_events_.clear ();
 209 }
 210
 211 void
 212 Multi_measure_rest_engraver::start_translation_timestep ()
 213 {
 214   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 215     {
 216       rest_ev_ = 0;
 217     }
 218
 219   bar_seen_ = false;
 220
 221   SCM smp = get_property ("measurePosition");
 222   Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 223
 224   Moment now =now_mom ();
 225   if (mmrest_
 226       && now.main_part_ != last_main_moment_
 227       && mp.main_part_ == Rational (0))
 228     {
 229       last_rest_ = mmrest_;
 230       last_numbers_ = numbers_;
 231
 232       int cur = gh_scm2int (get_property ("currentBarNumber"));
 233       int num = cur - start_measure_;
 234
 235       /*
 236         We can't plug a markup directly into the grob, since the
 237         measure-count determines the formatting of the mmrest.
 238       */
 239       last_rest_->set_grob_property ("measure-count", gh_int2scm (num));
 240
 241       SCM sml = get_property ("measureLength");
 242       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 243       if (ml >= Rational (2))
 244         {
 245           last_rest_->set_grob_property ("use-breve-rest", SCM_BOOL_T);
 246         }
 247
 248       mmrest_ = 0;
 249       numbers_.clear ();
 250
 251       Grob * last = last_numbers_.size() ? last_numbers_[0] : 0;
 252       if (last && last->get_grob_property ("text") == SCM_EOL)
 253         {
 254           SCM thres = get_property ("restNumberThreshold");
 255           int t = 1;
 256           if (gh_number_p (thres))
 257             t = gh_scm2int (thres);
 258
 259           if (num <= t)
 260             last->suicide();
 261           else
 262             {
 263               SCM text
 264                 = scm_number_to_string (gh_int2scm (num), SCM_MAKINUM (10));
 265               last->set_grob_property ("text", text);
 266             }
 267         }
 268     }
 269
 270   last_main_moment_ = now.main_part_;
 271 }
 272
 273 void
 274 Multi_measure_rest_engraver::finalize ()
 275 {
 276   if (mmrest_)
 277     {
 278       typeset_grob (mmrest_);
 279     }
 280   if (last_rest_)
 281     {
 282       typeset_grob (last_rest_);
 283     }
 284
 285   for (int i = 0; i < last_numbers_.size ();i++)
 286     typeset_grob (last_numbers_[i]);
 287
 288   for (int i = 0; i < numbers_.size ();i++)
 289     typeset_grob (numbers_[i]);
 290
 291 }
 292
 293 ENTER_DESCRIPTION(Multi_measure_rest_engraver,
 294 /* descr */
 295                   "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 296 "measurePosition and currentBarNumber to determine what number to print "
 297 "over the MultiMeasureRest.  Reads measureLength to determine if it "
 298 "should use a whole rest or a breve rest to represent 1 measure "
 299                   ,
 300 /* creats*/       "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
 301 /* accepts */     "multi-measure-rest-event multi-measure-text-event",
 302 /* acks  */      "",
 303 /* reads */       "currentBarNumber restNumberThreshold breakableSeparationItem currentCommandColumn measurePosition measureLength",
 304 /* write */       "");