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
 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       if (last_rest_)
 159         {
 160           add_bound_item (last_rest_, last_command_item_);
 161           for (int i = 0; i < last_numbers_.size (); i++)
 162             add_bound_item (last_numbers_[i], last_command_item_);
 163         }
 164
 165       if (mmrest_)
 166         {
 167           add_bound_item (mmrest_, last_command_item_);
 168           for (int i = 0; i < numbers_.size (); i++)
 169             add_bound_item (numbers_[i], last_command_item_);
 170
 171           last_command_item_ = 0;
 172         }
 173     }
 174
 175   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 176   if (last_rest_)
 177     {
 178       last_rest_ = 0;
 179       last_numbers_.clear ();
 180     }
 181
 182   text_events_.clear ();
 183 }
 184
 185 void
 186 Multi_measure_rest_engraver::start_translation_timestep ()
 187 {
 188   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 189     {
 190       rest_ev_ = 0;
 191     }
 192
 193   bar_seen_ = false;
 194
 195   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 196
 197   Moment now = now_mom ();
 198   if (mmrest_
 199       && now.main_part_ != last_main_moment_
 200       && mp.main_part_ == Rational (0))
 201     {
 202       last_rest_ = mmrest_;
 203       last_numbers_ = numbers_;
 204
 205       int cur = scm_to_int (get_property ("currentBarNumber"));
 206       int num = cur - start_measure_;
 207
 208       /*
 209         We can't plug a markup directly into the grob, since the
 210         measure-count determines the formatting of the mmrest.
 211       */
 212       last_rest_->set_property ("measure-count", scm_int2num (num));
 213
 214       SCM sml = get_property ("measureLength");
 215       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 216       if (ml >= Rational (2))
 217         {
 218           last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 219         }
 220
 221       mmrest_ = 0;
 222       numbers_.clear ();
 223
 224       Grob *last = last_numbers_.size () ? last_numbers_[0] : 0;
 225       if (last && last->get_property ("text") == SCM_EOL)
 226         {
 227           SCM thres = get_property ("restNumberThreshold");
 228           int t = 1;
 229           if (scm_is_number (thres))
 230             t = scm_to_int (thres);
 231
 232           if (num <= t)
 233             last->suicide ();
 234           else
 235             {
 236               SCM text
 237                 = scm_number_to_string (scm_int2num (num), scm_from_int (10));
 238               last->set_property ("text", text);
 239             }
 240         }
 241     }
 242
 243   last_main_moment_ = now.main_part_;
 244 }
 245
 246 void
 247 Multi_measure_rest_engraver::finalize ()
 248 {
 249 }
 250
 251 ADD_TRANSLATOR (Multi_measure_rest_engraver,
 252                 /* descr */
 253                 "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 254                 "measurePosition and currentBarNumber to determine what number to print "
 255                 "over the MultiMeasureRest.  Reads measureLength to determine if it "
 256                 "should use a whole rest or a breve rest to represent 1 measure ",
 257                 /* creats*/ "MultiMeasureRest MultiMeasureRestNumber MultiMeasureRestText",
 258                 /* accepts */ "multi-measure-rest-event multi-measure-text-event",
 259                 /* acks  */ "",
 260                 /* reads */ "currentBarNumber restNumberThreshold breakableSeparationItem currentCommandColumn measurePosition measureLength",
 261                 /* write */ "");