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