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