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");
  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_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               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 (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       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         = ly_scm2int (get_property ("currentBarNumber"));
 137     }
 138
 139   bar_seen_ = ly_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       /*
 156         Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
 157        */
 158       last_command_item_ = dynamic_cast<Item*> (cmc);
 159     }
 160
 161   if (last_command_item_ &&  (mmrest_ || last_rest_))
 162     {
 163
 164       if (last_rest_)
 165         {
 166           add_bound_item (last_rest_, last_command_item_);
 167           for (int i = 0; i < last_numbers_.size (); i++)
 168             add_bound_item (last_numbers_[i], last_command_item_);
 169         }
 170
 171       if (mmrest_)
 172         {
 173           add_bound_item (mmrest_, last_command_item_);
 174           for (int i = 0; i < numbers_.size (); i++)
 175             add_bound_item (numbers_[i], last_command_item_);
 176
 177           last_command_item_ = 0;
 178         }
 179     }
 180
 181
 182   SCM smp = get_property ("measurePosition");
 183   Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 184
 185   if (mmrest_
 186       && !mp.to_bool ()
 187       && mmrest_->get_bound (LEFT) && mmrest_->get_bound (RIGHT))
 188     {
 189       typeset_grob (mmrest_);
 190       for (int i = 0 ; i < numbers_.size (); i++)
 191         {
 192           typeset_grob (numbers_[i]);
 193         }
 194
 195       /*
 196         we must keep mmrest_ around to set measure-count, so
 197         no mmrest_ = 0 here.
 198        */
 199     }
 200
 201   if (last_rest_)
 202     {
 203       /* sanity check */
 204       if (last_rest_->get_bound (LEFT) && last_rest_->get_bound (RIGHT)
 205           && last_rest_->get_bound (LEFT) != last_rest_->get_bound (RIGHT))
 206         {
 207           typeset_grob (last_rest_);
 208
 209           for (int i = 0; i < last_numbers_.size ();i++)
 210             {
 211               typeset_grob (last_numbers_[i]);
 212             }
 213         }
 214       last_rest_ = 0;
 215       last_numbers_.clear ();
 216     }
 217
 218   text_events_.clear ();
 219 }
 220
 221 void
 222 Multi_measure_rest_engraver::start_translation_timestep ()
 223 {
 224   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 225     {
 226       rest_ev_ = 0;
 227     }
 228
 229   bar_seen_ = false;
 230
 231   SCM smp = get_property ("measurePosition");
 232   Moment mp = (unsmob_moment (smp)) ? *unsmob_moment (smp) : Moment (0);
 233
 234   Moment now =now_mom ();
 235   if (mmrest_
 236       && now.main_part_ != last_main_moment_
 237       && mp.main_part_ == Rational (0))
 238     {
 239       last_rest_ = mmrest_;
 240       last_numbers_ = numbers_;
 241
 242       int cur = ly_scm2int (get_property ("currentBarNumber"));
 243       int num = cur - start_measure_;
 244
 245       /*
 246         We can't plug a markup directly into the grob, since the
 247         measure-count determines the formatting of the mmrest.
 248       */
 249       last_rest_->set_property ("measure-count", scm_int2num (num));
 250
 251       SCM sml = get_property ("measureLength");
 252       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 253       if (ml >= Rational (2))
 254         {
 255           last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 256         }
 257
 258       mmrest_ = 0;
 259       numbers_.clear ();
 260
 261       Grob * last = last_numbers_.size () ? last_numbers_[0] : 0;
 262       if (last && last->get_property ("text") == SCM_EOL)
 263         {
 264           SCM thres = get_property ("restNumberThreshold");
 265           int t = 1;
 266           if (ly_number_p (thres))
 267             t = ly_scm2int (thres);
 268
 269           if (num <= t)
 270             last->suicide ();
 271           else
 272             {
 273               SCM text
 274                 = scm_number_to_string (scm_int2num (num), SCM_MAKINUM (10));
 275               last->set_property ("text", text);
 276             }
 277         }
 278     }
 279
 280   last_main_moment_ = now.main_part_;
 281 }
 282
 283 void
 284 Multi_measure_rest_engraver::finalize ()
 285 {
 286   if (mmrest_)
 287     {
 288       typeset_grob (mmrest_);
 289     }
 290   if (last_rest_)
 291     {
 292       typeset_grob (last_rest_);
 293     }
 294
 295   for (int i = 0; i < last_numbers_.size ();i++)
 296     typeset_grob (last_numbers_[i]);
 297
 298   for (int i = 0; i < numbers_.size ();i++)
 299     typeset_grob (numbers_[i]);
 300
 301 }
 302
 303 ENTER_DESCRIPTION (Multi_measure_rest_engraver,
 304 /* descr */
 305                   "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 306 "measurePosition and currentBarNumber to determine what number to print "
 307 "over the MultiMeasureRest.  Reads measureLength to determine if it "
 308 "should use a whole rest or a breve rest to represent 1 measure "
 309                   ,
 310 /* creats*/       "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
 311 /* accepts */     "multi-measure-rest-event multi-measure-text-event",
 312 /* acks  */      "",
 313 /* reads */       "currentBarNumber restNumberThreshold breakableSeparationItem currentCommandColumn measurePosition measureLength",
 314 /* write */       "");