lily/multi-measure-rest-engraver.cc

   1 /*
   2   multi_measure_rest-engraver.cc -- implement Multi_measure_rest_engraver
   3
   4   (c) 1998--2006 Jan Nieuwenhuizen <janneke@gnu.org>
   5   Han-Wen Nienhuys <hanwen@xs4all.nl>
   6 */
   7
   8 #include "multi-measure-rest.hh"
   9 #include "paper-column.hh"
  10 #include "engraver-group.hh"
  11 #include "side-position-interface.hh"
  12 #include "staff-symbol-referencer.hh"
  13 #include "stream-event.hh"
  14 #include "moment.hh"
  15
  16 #include "translator.icc"
  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   void process_music ();
  28   void stop_translation_timestep ();
  29   void start_translation_timestep ();
  30   virtual void finalize ();
  31   DECLARE_TRANSLATOR_LISTENER (multi_measure_rest);
  32   DECLARE_TRANSLATOR_LISTENER (multi_measure_text);
  33
  34 private:
  35   Stream_event *rest_ev_;
  36   vector<Stream_event*> text_events_;
  37   int start_measure_;
  38   Rational last_main_moment_;
  39   Moment stop_moment_;
  40
  41   bool bar_seen_;
  42   Item *last_command_item_;
  43   Spanner *last_rest_;
  44   Spanner *mmrest_;
  45
  46   vector<Spanner*> numbers_;
  47   vector<Spanner*> last_numbers_;
  48 };
  49
  50 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  51 {
  52   last_command_item_ = 0;
  53
  54   /*
  55     For the start of a score.
  56   */
  57   bar_seen_ = true;
  58   start_measure_ = 0;
  59   mmrest_ = 0;
  60   last_rest_ = 0;
  61   rest_ev_ = 0;
  62 }
  63
  64 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
  65 void
  66 Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
  67 {
  68   /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
  69      the kill-mm-rests hack in part-combine-iterator. */
  70   rest_ev_ = ev;
  71   stop_moment_ = now_mom () + get_event_length (rest_ev_);
  72   /*
  73   if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
  74     stop_moment_ = now_mom () + get_event_length (rest_ev_);
  75   */
  76 }
  77
  78 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
  79 void
  80 Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
  81 {
  82   text_events_.push_back (ev);
  83 }
  84
  85 void
  86 Multi_measure_rest_engraver::process_music ()
  87 {
  88   if (rest_ev_ && !mmrest_
  89       && stop_moment_ > now_mom ())
  90     {
  91       mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
  92
  93       Spanner *sp
  94         = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
  95       numbers_.push_back (sp);
  96
  97       if (text_events_.size ())
  98         {
  99           for (vsize i = 0; i < text_events_.size (); i++)
 100             {
 101               Stream_event *e = text_events_[i];
 102               Spanner *sp
 103                 = make_spanner ("MultiMeasureRestText", e->self_scm ());
 104               SCM t = e->get_property ("text");
 105               SCM dir = e->get_property ("direction");
 106               sp->set_property ("text", t);
 107               if (is_direction (dir))
 108                 sp->set_property ("direction", dir);
 109
 110               numbers_.push_back (sp);
 111             }
 112
 113           /*
 114             Stack different scripts.
 115           */
 116           Direction d = DOWN;
 117           do
 118             {
 119               Grob *last = 0;
 120               for (vsize i = 0; i < numbers_.size (); i++)
 121                 {
 122                   if (scm_from_int (d) == numbers_[i]->get_property ("direction"))
 123                     {
 124                       if (last)
 125                         Side_position_interface::add_support (numbers_[i], last);
 126                       last = numbers_[i];
 127                     }
 128                 }
 129             }
 130           while (flip (&d) != DOWN);
 131         }
 132
 133       for (vsize i = 0; i < numbers_.size (); i++)
 134         {
 135           Side_position_interface::add_support (numbers_[i], mmrest_);
 136           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 137         }
 138
 139       start_measure_
 140         = scm_to_int (get_property ("internalBarNumber"));
 141     }
 142
 143   bar_seen_ = bar_seen_ || scm_is_string (get_property ("whichBar"));
 144 }
 145
 146 void
 147 Multi_measure_rest_engraver::stop_translation_timestep ()
 148 {
 149   /* We cannot do this earlier, as breakableSeparationItem is not yet
 150      there.  */
 151   if (bar_seen_)
 152     {
 153       Grob *cmc = unsmob_grob (get_property ("breakableSeparationItem"));
 154       if (!cmc)
 155         cmc = unsmob_grob (get_property ("currentCommandColumn"));
 156
 157       /* Ugh, this is a kludge - need this for multi-measure-rest-grace.ly  */
 158       last_command_item_ = dynamic_cast<Item *> (cmc);
 159     }
 160
 161   if (last_command_item_ && (mmrest_ || last_rest_))
 162     {
 163       if (last_rest_)
 164         {
 165           add_bound_item (last_rest_, last_command_item_);
 166           for (vsize i = 0; i < last_numbers_.size (); i++)
 167             add_bound_item (last_numbers_[i], last_command_item_);
 168         }
 169
 170       if (mmrest_)
 171         {
 172           add_bound_item (mmrest_, last_command_item_);
 173           for (vsize i = 0; i < numbers_.size (); i++)
 174             add_bound_item (numbers_[i], last_command_item_);
 175
 176           last_command_item_ = 0;
 177         }
 178     }
 179
 180   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 181   if (last_rest_)
 182     {
 183       last_rest_ = 0;
 184       last_numbers_.clear ();
 185     }
 186
 187   text_events_.clear ();
 188   bar_seen_ = false;
 189 }
 190
 191 void
 192 Multi_measure_rest_engraver::start_translation_timestep ()
 193 {
 194   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 195     rest_ev_ = 0;
 196
 197   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 198
 199   Moment now = now_mom ();
 200   if (mmrest_
 201       && now.main_part_ != last_main_moment_
 202       && mp.main_part_ == Rational (0))
 203     {
 204       last_rest_ = mmrest_;
 205       last_numbers_ = numbers_;
 206
 207       int cur = scm_to_int (get_property ("internalBarNumber"));
 208       int num = cur - start_measure_;
 209
 210       /*
 211         We can't plug a markup directly into the grob, since the
 212         measure-count determines the formatting of the mmrest.
 213       */
 214       last_rest_->set_property ("measure-count", scm_from_int (num));
 215
 216       SCM sml = get_property ("measureLength");
 217       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 218       if (ml >= Rational (2))
 219         last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 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_from_int (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                 /* doc */
 253                 "Engraves multi-measure rests that are produced with @code{R}.  Reads "
 254                 "@code{measurePosition} and @code{internalBarNumber} to determine what number to print "
 255                 "over the @ref{MultiMeasureRest}.  Reads @code{measureLength} to determine if it "
 256                 "should use a whole rest or a breve rest to represent 1 measure ",
 257
 258                 /* create */
 259                 "MultiMeasureRest "
 260                 "MultiMeasureRestNumber "
 261                 "MultiMeasureRestText ",
 262
 263                 /* accept */
 264                 "multi-measure-rest-event "
 265                 "multi-measure-text-event ",
 266
 267                 /* read */
 268                 "internalBarNumber "
 269                 "restNumberThreshold "
 270                 "breakableSeparationItem "
 271                 "currentCommandColumn "
 272                 "measurePosition "
 273                 "measureLength ",
 274
 275                 /* write */ "");