lily/multi-measure-rest-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2015 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 using std::vector;
  33
  34 /**
  35    The name says it all: make multi measure rests
  36 */
  37 class Multi_measure_rest_engraver : public Engraver
  38 {
  39 public:
  40   TRANSLATOR_DECLARATIONS (Multi_measure_rest_engraver);
  41
  42 protected:
  43   void process_music ();
  44   void stop_translation_timestep ();
  45   void start_translation_timestep ();
  46   virtual void finalize ();
  47   DECLARE_TRANSLATOR_LISTENER (multi_measure_rest);
  48   DECLARE_TRANSLATOR_LISTENER (multi_measure_text);
  49
  50 private:
  51   Stream_event *rest_ev_;
  52   vector<Stream_event *> text_events_;
  53   int start_measure_;
  54   Rational last_main_moment_;
  55   Moment stop_moment_;
  56
  57   bool bar_seen_;
  58   Item *last_command_item_;
  59   Spanner *last_rest_;
  60   Spanner *mmrest_;
  61
  62   vector<Spanner *> numbers_;
  63   vector<Spanner *> last_numbers_;
  64 };
  65
  66 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  67 {
  68   last_command_item_ = 0;
  69
  70   /*
  71     For the start of a score.
  72   */
  73   bar_seen_ = true;
  74   start_measure_ = 0;
  75   mmrest_ = 0;
  76   last_rest_ = 0;
  77   rest_ev_ = 0;
  78 }
  79
  80 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
  81 void
  82 Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
  83 {
  84   /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
  85      the kill-mm-rests hack in part-combine-iterator. */
  86   rest_ev_ = ev;
  87   stop_moment_ = now_mom () + get_event_length (rest_ev_, now_mom ());
  88   /*
  89   if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
  90     stop_moment_ = now_mom () + get_event_length (rest_ev_);
  91   */
  92 }
  93
  94 IMPLEMENT_TRANSLATOR_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
  95 void
  96 Multi_measure_rest_engraver::listen_multi_measure_text (Stream_event *ev)
  97 {
  98   text_events_.push_back (ev);
  99 }
 100
 101 void
 102 Multi_measure_rest_engraver::process_music ()
 103 {
 104   if (rest_ev_ && !mmrest_
 105       && stop_moment_ > now_mom ())
 106     {
 107       mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
 108
 109       Spanner *sp
 110         = make_spanner ("MultiMeasureRestNumber", rest_ev_->self_scm ());
 111       numbers_.push_back (sp);
 112
 113       if (text_events_.size ())
 114         {
 115           for (vsize i = 0; i < text_events_.size (); i++)
 116             {
 117               Stream_event *e = text_events_[i];
 118               Spanner *sp
 119                 = make_spanner ("MultiMeasureRestText", e->self_scm ());
 120               SCM t = e->get_property ("text");
 121               SCM dir = e->get_property ("direction");
 122               sp->set_property ("text", t);
 123               if (is_direction (dir))
 124                 sp->set_property ("direction", dir);
 125
 126               numbers_.push_back (sp);
 127             }
 128
 129           /*
 130             Stack different scripts.
 131           */
 132           for (DOWN_and_UP (d))
 133             {
 134               Grob *last = 0;
 135               for (vsize i = 0; i < numbers_.size (); i++)
 136                 {
 137                   if (scm_is_eq (scm_from_int (d),
 138                                  numbers_[i]->get_property ("direction")))
 139                     {
 140                       if (last)
 141                         Side_position_interface::add_support (numbers_[i], last);
 142                       last = numbers_[i];
 143                     }
 144                 }
 145             }
 146         }
 147
 148       for (vsize i = 0; i < numbers_.size (); i++)
 149         {
 150           Side_position_interface::add_support (numbers_[i], mmrest_);
 151           numbers_[i]->set_parent (mmrest_, Y_AXIS);
 152           numbers_[i]->set_parent (mmrest_, X_AXIS);
 153         }
 154
 155       start_measure_
 156         = scm_to_int (get_property ("internalBarNumber"));
 157     }
 158
 159   bar_seen_ = bar_seen_ || scm_is_string (get_property ("whichBar"));
 160 }
 161
 162 void
 163 Multi_measure_rest_engraver::stop_translation_timestep ()
 164 {
 165   /* We cannot do this earlier, as breakableSeparationItem is not yet
 166      there.
 167
 168      Actually, we no longer use breakableSeparationItem -- should this be moved?
 169      -- jneem */
 170   if (bar_seen_)
 171     {
 172       Grob *cmc = unsmob<Grob> (get_property ("currentCommandColumn"));
 173
 174       /* Ugh, this is a kludge - need this for multi-measure-rest-grace.ly  */
 175       last_command_item_ = dynamic_cast<Item *> (cmc);
 176     }
 177
 178   if (last_command_item_ && (mmrest_ || last_rest_))
 179     {
 180       if (last_rest_)
 181         {
 182           add_bound_item (last_rest_, last_command_item_);
 183           for (vsize i = 0; i < last_numbers_.size (); i++)
 184             add_bound_item (last_numbers_[i], last_command_item_);
 185         }
 186
 187       if (mmrest_)
 188         {
 189           add_bound_item (mmrest_, last_command_item_);
 190           for (vsize i = 0; i < numbers_.size (); i++)
 191             add_bound_item (numbers_[i], last_command_item_);
 192
 193           last_command_item_ = 0;
 194         }
 195     }
 196
 197   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 198   if (last_rest_)
 199     {
 200       last_rest_ = 0;
 201       last_numbers_.clear ();
 202     }
 203
 204   text_events_.clear ();
 205   bar_seen_ = false;
 206 }
 207
 208 void
 209 Multi_measure_rest_engraver::start_translation_timestep ()
 210 {
 211   if (now_mom ().main_part_ >= stop_moment_.main_part_)
 212     rest_ev_ = 0;
 213
 214   Moment mp (robust_scm2moment (get_property ("measurePosition"), Moment (0)));
 215
 216   Moment now = now_mom ();
 217   if (mmrest_
 218       && now.main_part_ != last_main_moment_
 219       && mp.main_part_ == Rational (0))
 220     {
 221       last_rest_ = mmrest_;
 222       last_numbers_ = numbers_;
 223
 224       int cur = scm_to_int (get_property ("internalBarNumber"));
 225       int num = cur - start_measure_;
 226
 227       /*
 228         We can't plug a markup directly into the grob, since the
 229         measure-count determines the formatting of the mmrest.
 230       */
 231       last_rest_->set_property ("measure-count", scm_from_int (num));
 232
 233       mmrest_ = 0;
 234       numbers_.clear ();
 235
 236       Grob *last = last_numbers_.size () ? last_numbers_[0] : 0;
 237       if (last && scm_is_null (last->get_property ("text")))
 238         {
 239           SCM thres = get_property ("restNumberThreshold");
 240           int t = 1;
 241           if (scm_is_number (thres))
 242             t = scm_to_int (thres);
 243
 244           if (num <= t)
 245             last->suicide ();
 246           else
 247             {
 248               SCM text
 249                 = scm_number_to_string (scm_from_int (num), scm_from_int (10));
 250               last->set_property ("text", text);
 251             }
 252         }
 253     }
 254
 255   last_main_moment_ = now.main_part_;
 256 }
 257
 258 void
 259 Multi_measure_rest_engraver::finalize ()
 260 {
 261 }
 262
 263 ADD_TRANSLATOR (Multi_measure_rest_engraver,
 264                 /* doc */
 265                 "Engrave multi-measure rests that are produced with"
 266                 " @samp{R}.  It reads @code{measurePosition} and"
 267                 " @code{internalBarNumber} to determine what number to print"
 268                 " over the @ref{MultiMeasureRest}.",
 269
 270                 /* create */
 271                 "MultiMeasureRest "
 272                 "MultiMeasureRestNumber "
 273                 "MultiMeasureRestText ",
 274
 275                 /* read */
 276                 "internalBarNumber "
 277                 "restNumberThreshold "
 278                 "currentCommandColumn "
 279                 "measurePosition ",
 280
 281                 /* write */
 282                 ""
 283                );