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       Spanner *sp
  86         = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm () );
  87       numbers_.push (sp);
  88
  89       if (text_events_.size ())
  90         {
  91           for (int i = 0; i < text_events_.size (); i++)
  92             {
  93
  94               Music* e = text_events_[i];
  95               Spanner *sp
  96                 = make_spanner ("MultiMeasureRestText", e->self_scm () );
  97               SCM t = e->get_property ("text");
  98               SCM dir = e->get_property ("direction");
  99               sp->set_property ("text",t);
 100               if (is_direction (dir))
 101                 sp->set_property ("direction",dir);
 102
 103               numbers_.push (sp);
 104             }
 105
 106           /*
 107             Stack different scripts.
 108            */
 109           Direction d = DOWN;
 110           do {
 111             Grob *last =0;
 112             for (int i=0; i <numbers_.size (); i++)
 113               {
 114                 if (scm_int2num (d) == numbers_[i]->get_property ("direction"))
 115                   {
 116                     if (last)
 117                       Side_position_interface::add_support (numbers_[i], last);
 118                     last = numbers_[i];
 119                   }
 120               }
 121           } while (flip (&d) != DOWN);
 122         }
 123
 124       for (int i =0 ; i < numbers_.size (); i++)
 125         {
 126           Side_position_interface::add_support (numbers_[i], mmrest_);
 127           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 128         }
 129
 130       start_measure_
 131         = scm_to_int (get_property ("currentBarNumber"));
 132     }
 133
 134   bar_seen_ = scm_is_string (get_property ("whichBar"));
 135 }
 136
 137 void
 138 Multi_measure_rest_engraver::stop_translation_timestep ()
 139 {
 140   /*
 141     We can not do this earlier, as breakableSeparationItem is not yet there.
 142   */
 143
 144   if (bar_seen_)
 145     {
 146       Grob *cmc = unsmob_grob (get_property ("breakableSeparationItem"));
 147       if (!cmc)
 148         cmc = unsmob_grob (get_property ("currentCommandColumn"));
 149
 150       /*
 151         Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
 152        */
 153       last_command_item_ = dynamic_cast<Item*> (cmc);
 154     }
 155
 156   if (last_command_item_ &&  (mmrest_ || last_rest_))
 157     {
 158
 159       if (last_rest_)
 160         {
 161           add_bound_item (last_rest_, last_command_item_);
 162           for (int i = 0; i < last_numbers_.size (); i++)
 163             add_bound_item (last_numbers_[i], last_command_item_);
 164         }
 165
 166       if (mmrest_)
 167         {
 168           add_bound_item (mmrest_, last_command_item_);
 169           for (int i = 0; i < numbers_.size (); i++)
 170             add_bound_item (numbers_[i], last_command_item_);
 171
 172           last_command_item_ = 0;
 173         }
 174     }
 175
 176
 177
 178   Moment mp(robust_scm2moment (get_property ("measurePosition"),  Moment (0)));
 179
 180   if (last_rest_)
 181     {
 182       last_rest_ = 0;
 183       last_numbers_.clear ();
 184     }
 185
 186   text_events_.clear ();
 187 }
 188
 189 void
 190 Multi_measure_rest_engraver::start_translation_timestep ()
 191 {
 192   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 193     {
 194       rest_ev_ = 0;
 195     }
 196
 197   bar_seen_ = false;
 198
 199   Moment mp (robust_scm2moment (get_property ("measurePosition"),  Moment (0)));
 200
 201   Moment now = now_mom ();
 202   if (mmrest_
 203       && now.main_part_ != last_main_moment_
 204       && mp.main_part_ == Rational (0))
 205     {
 206       last_rest_ = mmrest_;
 207       last_numbers_ = numbers_;
 208
 209       int cur = scm_to_int (get_property ("currentBarNumber"));
 210       int num = cur - start_measure_;
 211
 212       /*
 213         We can't plug a markup directly into the grob, since the
 214         measure-count determines the formatting of the mmrest.
 215       */
 216       last_rest_->set_property ("measure-count", scm_int2num (num));
 217
 218       SCM sml = get_property ("measureLength");
 219       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 220       if (ml >= Rational (2))
 221         {
 222           last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 223         }
 224
 225       mmrest_ = 0;
 226       numbers_.clear ();
 227
 228       Grob * last = last_numbers_.size () ? last_numbers_[0] : 0;
 229       if (last && last->get_property ("text") == SCM_EOL)
 230         {
 231           SCM thres = get_property ("restNumberThreshold");
 232           int t = 1;
 233           if (scm_is_number (thres))
 234             t = scm_to_int (thres);
 235
 236           if (num <= t)
 237             last->suicide ();
 238           else
 239             {
 240               SCM text
 241                 = scm_number_to_string (scm_int2num (num), scm_from_int (10));
 242               last->set_property ("text", text);
 243             }
 244         }
 245     }
 246
 247   last_main_moment_ = now.main_part_;
 248 }
 249
 250 void
 251 Multi_measure_rest_engraver::finalize ()
 252 {
 253 }
 254
 255 ENTER_DESCRIPTION (Multi_measure_rest_engraver,
 256 /* descr */
 257                   "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 258 "measurePosition and currentBarNumber to determine what number to print "
 259 "over the MultiMeasureRest.  Reads measureLength to determine if it "
 260 "should use a whole rest or a breve rest to represent 1 measure "
 261                   ,
 262 /* creats*/       "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
 263 /* accepts */     "multi-measure-rest-event multi-measure-text-event",
 264 /* acks  */      "",
 265 /* reads */       "currentBarNumber restNumberThreshold breakableSeparationItem currentCommandColumn measurePosition measureLength",
 266 /* write */       "");