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 /**
  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 start_translation_timestep ();
  43   void listen_multi_measure_rest (Stream_event *);
  44   void listen_multi_measure_text (Stream_event *);
  45
  46 private:
  47   void add_bound_item_to_grobs (Item *);
  48   void clear_lapsed_events (const Moment &now);
  49   bool grobs_initialized () const { return mmrest_; }
  50   void initialize_grobs ();
  51   void reset_grobs ();
  52   void set_measure_count (int n);
  53
  54 private:
  55   vector<Stream_event *> text_events_;
  56   // text_[0] is a MultiMeasureRestNumber grob
  57   // the rest are optional MultiMeasureRestText grobs
  58   vector<Spanner *> text_;
  59   Stream_event *rest_ev_;
  60   Spanner *mmrest_;
  61   Moment stop_moment_;
  62   int start_measure_;
  63   // Ugh, this is a kludge - need this for multi-measure-rest-grace.ly
  64   Item *last_command_item_;
  65   bool first_time_;
  66 };
  67
  68 Multi_measure_rest_engraver::Multi_measure_rest_engraver ()
  69   : rest_ev_ (0),
  70     mmrest_ (0),
  71     start_measure_ (0),
  72     last_command_item_ (0),
  73     first_time_ (true)
  74 {
  75 }
  76
  77 void
  78 Multi_measure_rest_engraver::listen_multi_measure_rest (Stream_event *ev)
  79 {
  80   /* FIXME: Should use ASSIGN_EVENT_ONCE. Can't do that yet because of
  81      the kill-mm-rests hack in part-combine-iterator. */
  82   rest_ev_ = ev;
  83   const Moment now (now_mom ());
  84   stop_moment_ = now + get_event_length (rest_ev_, now);
  85   /*
  86   if (ASSIGN_EVENT_ONCE (rest_ev_, ev))
  87     stop_moment_ = now_mom () + get_event_length (rest_ev_);
  88   */
  89
  90   clear_lapsed_events (now);
  91 }
  92
  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::add_bound_item_to_grobs (Item *item)
 101 {
 102   add_bound_item (mmrest_, item);
 103   for (vsize i = 0; i < text_.size (); ++i)
 104     add_bound_item (text_[i], item);
 105 }
 106
 107 void
 108 Multi_measure_rest_engraver::clear_lapsed_events (const Moment &now)
 109 {
 110   if (now.main_part_ >= stop_moment_.main_part_)
 111     {
 112       rest_ev_ = 0;
 113       text_events_.clear ();
 114     }
 115 }
 116
 117 void
 118 Multi_measure_rest_engraver::initialize_grobs ()
 119 {
 120   mmrest_ = make_spanner ("MultiMeasureRest", rest_ev_->self_scm ());
 121   text_.push_back (make_spanner ("MultiMeasureRestNumber",
 122                                  rest_ev_->self_scm ()));
 123
 124   if (text_events_.size ())
 125     {
 126       for (vsize i = 0; i < text_events_.size (); i++)
 127         {
 128           Stream_event *e = text_events_[i];
 129           Spanner *sp = make_spanner ("MultiMeasureRestText", e->self_scm ());
 130           SCM t = e->get_property ("text");
 131           SCM dir = e->get_property ("direction");
 132           sp->set_property ("text", t);
 133           if (is_direction (dir))
 134             sp->set_property ("direction", dir);
 135
 136           text_.push_back (sp);
 137         }
 138
 139       /*
 140         Stack different scripts.
 141       */
 142       for (DOWN_and_UP (d))
 143         {
 144           SCM dir = scm_from_int (d);
 145           Grob *last = 0;
 146           for (vsize i = 0; i < text_.size (); i++)
 147             {
 148               if (scm_is_eq (dir, text_[i]->get_property ("direction")))
 149                 {
 150                   if (last)
 151                     Side_position_interface::add_support (text_[i], last);
 152                   last = text_[i];
 153                 }
 154             }
 155         }
 156     }
 157
 158   for (vsize i = 0; i < text_.size (); i++)
 159     {
 160       Side_position_interface::add_support (text_[i], mmrest_);
 161       text_[i]->set_parent (mmrest_, Y_AXIS);
 162       text_[i]->set_parent (mmrest_, X_AXIS);
 163     }
 164 }
 165
 166 void
 167 Multi_measure_rest_engraver::reset_grobs ()
 168 {
 169   text_.clear ();
 170   mmrest_ = 0;
 171 }
 172
 173 void
 174 Multi_measure_rest_engraver::set_measure_count (int n)
 175 {
 176   SCM n_scm = scm_from_int (n);
 177   assert (mmrest_);
 178   mmrest_->set_property ("measure-count", n_scm);
 179
 180   Grob *g = text_[0]; // the MultiMeasureRestNumber
 181   assert (g);
 182   if (scm_is_null (g->get_property ("text")))
 183     {
 184       SCM thres = get_property ("restNumberThreshold");
 185       int t = 1;
 186       if (scm_is_number (thres))
 187         t = scm_to_int (thres);
 188
 189       if (n <= t)
 190         g->suicide ();
 191       else
 192         {
 193           SCM text = scm_number_to_string (n_scm, scm_from_int (10));
 194           g->set_property ("text", text);
 195         }
 196     }
 197 }
 198
 199 void
 200 Multi_measure_rest_engraver::process_music ()
 201 {
 202   const bool measure_end
 203   = scm_is_string (get_property ("whichBar"))
 204     && (robust_scm2moment (get_property ("measurePosition"),
 205                            Moment (0)).main_part_ == Rational (0));
 206
 207   if (measure_end || first_time_)
 208     {
 209       last_command_item_ = unsmob<Item> (get_property ("currentCommandColumn"));
 210
 211       // Finalize the current grobs.
 212       if (grobs_initialized ())
 213         {
 214           int curr_measure = scm_to_int (get_property ("internalBarNumber"));
 215           set_measure_count (curr_measure - start_measure_);
 216           if (last_command_item_)
 217             add_bound_item_to_grobs (last_command_item_);
 218           reset_grobs ();
 219         }
 220     }
 221
 222   // Create new grobs if a rest event is (still) active.
 223   if (!grobs_initialized () && rest_ev_)
 224     {
 225       initialize_grobs ();
 226       text_events_.clear ();
 227
 228       if (last_command_item_)
 229         {
 230           add_bound_item_to_grobs (last_command_item_);
 231           last_command_item_ = 0;
 232         }
 233
 234       start_measure_ = scm_to_int (get_property ("internalBarNumber"));
 235     }
 236
 237   first_time_ = false;
 238 }
 239
 240 void
 241 Multi_measure_rest_engraver::start_translation_timestep ()
 242 {
 243   clear_lapsed_events (now_mom ());
 244 }
 245
 246 void
 247 Multi_measure_rest_engraver::boot ()
 248 {
 249   ADD_LISTENER (Multi_measure_rest_engraver, multi_measure_rest);
 250   ADD_LISTENER (Multi_measure_rest_engraver, multi_measure_text);
 251 }
 252
 253 ADD_TRANSLATOR (Multi_measure_rest_engraver,
 254                 /* doc */
 255                 "Engrave multi-measure rests that are produced with"
 256                 " @samp{R}.  It reads @code{measurePosition} and"
 257                 " @code{internalBarNumber} to determine what number to print"
 258                 " over the @ref{MultiMeasureRest}.",
 259
 260                 /* create */
 261                 "MultiMeasureRest "
 262                 "MultiMeasureRestNumber "
 263                 "MultiMeasureRestText ",
 264
 265                 /* read */
 266                 "internalBarNumber "
 267                 "restNumberThreshold "
 268                 "currentCommandColumn "
 269                 "measurePosition "
 270                 "whichBar ",
 271
 272                 /* write */
 273                 ""
 274                );