lily/multi-measure-rest-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2011 Jan Nieuwenhuizen <janneke@gnu.org>
   5   Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "multi-measure-rest.hh"
  22 #include "paper-column.hh"
  23 #include "engraver-group.hh"
  24 #include "side-position-interface.hh"
  25 #include "staff-symbol-referencer.hh"
  26 #include "stream-event.hh"
  27 #include "moment.hh"
  28 #include "spanner.hh"
  29
  30 #include "translator.icc"
  31
  32 /**
  33    The name says it all: make multi measure rests
  34 */
  35 class Multi_measure_rest_engraver : public Engraver
  36 {
  37 public:
  38   TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
  39
  40 protected:
  41   void process_music ();
  42   void stop_translation_timestep ();
  43   void start_translation_timestep ();
  44   virtual void finalize ();
  45   DECLARE_TRANSLATOR_LISTENER (multi_measure_rest);
  46   DECLARE_TRANSLATOR_LISTENER (multi_measure_text);
  47
  48 private:
  49   Stream_event *rest_ev_;
  50   vector<Stream_event*> text_events_;
  51   int start_measure_;
  52   Rational last_main_moment_;
  53   Moment stop_moment_;
  54
  55   bool bar_seen_;
  56   Item *last_command_item_;
  57   Spanner *last_rest_;
  58   Spanner *mmrest_;
  59
  60   vector<Spanner*> numbers_;
  61   vector<Spanner*> last_numbers_;
  62 };
  63
  64 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  65 {
  66   last_command_item_ = 0;
  67
  68   /*
  69     For the start of a score.
  70   */
  71   bar_seen_ = true;
  72   start_measure_ = 0;
  73   mmrest_ = 0;
  74   last_rest_ = 0;
  75   rest_ev_ = 0;
  76 }
  77
  78 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
  79 void
  80 Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
  81 {
  82   /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
  83      the kill-mm-rests hack in part-combine-iterator. */
  84   rest_ev_ = ev;
  85   stop_moment_ = now_mom () + get_event_length (rest_ev_, now_mom ());
  86   /*
  87   if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
  88     stop_moment_ = now_mom () + get_event_length (rest_ev_);
  89   */
  90 }
  91
  92 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
  93 void
  94 Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
  95 {
  96   text_events_.push_back (ev);
  97 }
  98
  99 void
 100 Multi_measure_rest_engraver::process_music ()
 101 {
 102   if (rest_ev_ && !mmrest_
 103       && stop_moment_ > now_mom ())
 104     {
 105       mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
 106
 107       Spanner *sp
 108         = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
 109       numbers_.push_back (sp);
 110
 111       if (text_events_.size ())
 112         {
 113           for (vsize i = 0; i < text_events_.size (); i++)
 114             {
 115               Stream_event *e = text_events_[i];
 116               Spanner *sp
 117                 = make_spanner ("MultiMeasureRestText", e->self_scm ());
 118               SCM t = e->get_property ("text");
 119               SCM dir = e->get_property ("direction");
 120               sp->set_property ("text", t);
 121               if (is_direction (dir))
 122                 sp->set_property ("direction", dir);
 123
 124               numbers_.push_back (sp);
 125             }
 126
 127           /*
 128             Stack different scripts.
 129           */
 130           Direction d = DOWN;
 131           do
 132             {
 133               Grob *last = 0;
 134               for (vsize i = 0; i < numbers_.size (); i++)
 135                 {
 136                   if (scm_from_int (d) == numbers_[i]->get_property ("direction"))
 137                     {
 138                       if (last)
 139                         Side_position_interface::add_support (numbers_[i], last);
 140                       last = numbers_[i];
 141                     }
 142                 }
 143             }
 144           while (flip (&d) != DOWN);
 145         }
 146
 147       for (vsize i = 0; i < numbers_.size (); i++)
 148         {
 149           Side_position_interface::add_support (numbers_[i], mmrest_);
 150           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 151         }
 152
 153       start_measure_
 154         = scm_to_int (get_property ("internalBarNumber"));
 155     }
 156
 157   bar_seen_ = bar_seen_ || scm_is_string (get_property ("whichBar"));
 158 }
 159
 160 void
 161 Multi_measure_rest_engraver::stop_translation_timestep ()
 162 {
 163   /* We cannot do this earlier, as breakableSeparationItem is not yet
 164      there.
 165
 166      Actually, we no longer use breakableSeparationItem -- should this be moved?
 167      -- jneem */
 168   if (bar_seen_)
 169     {
 170       Grob *cmc = unsmob_grob (get_property ("currentCommandColumn"));
 171
 172       /* Ugh, this is a kludge - need this for multi-measure-rest-grace.ly  */
 173       last_command_item_ = dynamic_cast<Item *> (cmc);
 174     }
 175
 176   if (last_command_item_ && (mmrest_ || last_rest_))
 177     {
 178       if (last_rest_)
 179         {
 180           add_bound_item (last_rest_, last_command_item_);
 181           for (vsize i = 0; i < last_numbers_.size (); i++)
 182             add_bound_item (last_numbers_[i], last_command_item_);
 183         }
 184
 185       if (mmrest_)
 186         {
 187           add_bound_item (mmrest_, last_command_item_);
 188           for (vsize i = 0; i < numbers_.size (); i++)
 189             add_bound_item (numbers_[i], last_command_item_);
 190
 191           last_command_item_ = 0;
 192         }
 193     }
 194
 195   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 196   if (last_rest_)
 197     {
 198       last_rest_ = 0;
 199       last_numbers_.clear ();
 200     }
 201
 202   text_events_.clear ();
 203   bar_seen_ = false;
 204 }
 205
 206 void
 207 Multi_measure_rest_engraver::start_translation_timestep ()
 208 {
 209   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 210     rest_ev_ = 0;
 211
 212   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 213
 214   Moment now = now_mom ();
 215   if (mmrest_
 216       && now.main_part_ != last_main_moment_
 217       && mp.main_part_ == Rational (0))
 218     {
 219       last_rest_ = mmrest_;
 220       last_numbers_ = numbers_;
 221
 222       int cur = scm_to_int (get_property ("internalBarNumber"));
 223       int num = cur - start_measure_;
 224
 225       /*
 226         We can't plug a markup directly into the grob, since the
 227         measure-count determines the formatting of the mmrest.
 228       */
 229       last_rest_->set_property ("measure-count", scm_from_int (num));
 230
 231       SCM sml = get_property ("measureLength");
 232       Rational ml = (unsmob_moment (sml)) ? unsmob_moment (sml)->main_part_ : Rational (1);
 233       if (ml >= Rational (2))
 234         last_rest_->set_property ("use-breve-rest", SCM_BOOL_T);
 235
 236       mmrest_ = 0;
 237       numbers_.clear ();
 238
 239       Grob *last = last_numbers_.size () ? last_numbers_[0] : 0;
 240       if (last && last->get_property ("text") == SCM_EOL)
 241         {
 242           SCM thres = get_property ("restNumberThreshold");
 243           int t = 1;
 244           if (scm_is_number (thres))
 245             t = scm_to_int (thres);
 246
 247           if (num <= t)
 248             last->suicide ();
 249           else
 250             {
 251               SCM text
 252                 = scm_number_to_string (scm_from_int (num), scm_from_int (10));
 253               last->set_property ("text", text);
 254             }
 255         }
 256     }
 257
 258   last_main_moment_ = now.main_part_;
 259 }
 260
 261 void
 262 Multi_measure_rest_engraver::finalize ()
 263 {
 264 }
 265
 266 ADD_TRANSLATOR (Multi_measure_rest_engraver,
 267                 /* doc */
 268                 "Engrave multi-measure rests that are produced with"
 269                 " @samp{R}.  It reads @code{measurePosition} and"
 270                 " @code{internalBarNumber} to determine what number to print"
 271                 " over the @ref{MultiMeasureRest}.  Reads @code{measureLength}"
 272                 " to determine whether it should use a whole rest or a breve"
 273                 " rest to represent one measure.",
 274
 275                 /* create */
 276                 "MultiMeasureRest "
 277                 "MultiMeasureRestNumber "
 278                 "MultiMeasureRestText ",
 279
 280                 /* read */
 281                 "internalBarNumber "
 282                 "restNumberThreshold "
 283                 "currentCommandColumn "
 284                 "measurePosition "
 285                 "measureLength ",
 286
 287                 /* write */
 288                 ""
 289                 );