lily/multi-measure-rest-engraver.cc

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