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