lily/percent-repeat-engraver.cc

   1 /*
   2   new-chord-tremolo-engraver.cc -- implement Chord_tremolo_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2000--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>, Erik Sandberg <mandolaerik@gmail.com>
   7 */
   8
   9
  10 #include "score-engraver.hh"
  11
  12 #include "bar-line.hh"
  13 #include "global-context.hh"
  14 #include "international.hh"
  15 #include "item.hh"
  16 #include "misc.hh"
  17 #include "percent-repeat-iterator.hh"
  18 #include "repeated-music.hh"
  19 #include "side-position-interface.hh"
  20 #include "spanner.hh"
  21 #include "stream-event.hh"
  22 #include "warn.hh"
  23
  24 #include "translator.icc"
  25
  26 /*
  27 * TODO: Create separate Double_percent_repeat_engraver?
  28 * Or, at least move double percent handling to Slash_repeat_engraver
  29 */
  30
  31 class Percent_repeat_engraver : public Engraver
  32 {
  33   void typeset_perc ();
  34 public:
  35   TRANSLATOR_DECLARATIONS (Percent_repeat_engraver);
  36
  37 protected:
  38   Stream_event *percent_event_;
  39
  40   /// moment (global time) where percent started.
  41   Moment stop_mom_;
  42   Moment start_mom_;
  43
  44   enum Repeat_sign_type
  45     {
  46       UNKNOWN,
  47       MEASURE,
  48       DOUBLE_MEASURE,
  49     };
  50   Repeat_sign_type repeat_sign_type_;
  51
  52   Spanner *percent_;
  53   Spanner *percent_counter_;
  54
  55 protected:
  56   virtual void finalize ();
  57   DECLARE_TRANSLATOR_LISTENER (percent);
  58
  59   void stop_translation_timestep ();
  60   void start_translation_timestep ();
  61   void process_music ();
  62 };
  63
  64 Percent_repeat_engraver::Percent_repeat_engraver ()
  65 {
  66   percent_ = 0;
  67   percent_counter_ = 0;
  68
  69   percent_event_ = 0;
  70 }
  71
  72 IMPLEMENT_TRANSLATOR_LISTENER (Percent_repeat_engraver, percent);
  73 void
  74 Percent_repeat_engraver::listen_percent (Stream_event *ev)
  75 {
  76   if (!percent_event_)
  77     {
  78       Moment body_length = get_event_length (ev);
  79       Moment meas_len (robust_scm2moment (get_property ("measureLength"),
  80                                           Moment (1)));
  81       if (meas_len == body_length)
  82         {
  83           repeat_sign_type_ = MEASURE;
  84           start_mom_ = now_mom ();
  85           stop_mom_ = now_mom () + body_length;
  86           get_global_context ()->add_moment_to_process (stop_mom_);
  87         }
  88       else if (Moment (2) * meas_len == body_length)
  89         {
  90           repeat_sign_type_ = DOUBLE_MEASURE;
  91           start_mom_ = now_mom () + meas_len;
  92           stop_mom_ = now_mom () + body_length; /* never used */
  93           get_global_context ()->add_moment_to_process (start_mom_);
  94         }
  95       else
  96         {
  97           ev->origin ()->warning (_ ("Junking percent repeat event: Duration must be exactly one or two measures"));
  98           return;
  99         }
 100       percent_event_ = ev;
 101     }
 102   else
 103     /* print a warning: no assignment happens because
 104        percent_event_ != 0 */
 105     ASSIGN_EVENT_ONCE (percent_event_, ev);
 106 }
 107
 108 void
 109 Percent_repeat_engraver::process_music ()
 110 {
 111   if (percent_event_ && now_mom ().main_part_ == start_mom_.main_part_)
 112     {
 113       if (repeat_sign_type_ == MEASURE)
 114         {
 115           if (percent_)
 116             typeset_perc ();
 117           percent_ = make_spanner ("PercentRepeat", percent_event_->self_scm ());
 118
 119           Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 120           percent_->set_bound (LEFT, col);
 121
 122           SCM count = percent_event_->get_property ("repeat-count");
 123           if (count != SCM_EOL && to_boolean (get_property ("countPercentRepeats")))
 124             {
 125               percent_counter_
 126                 = make_spanner ("PercentRepeatCounter", percent_event_->self_scm ());
 127
 128               SCM text = scm_number_to_string (count, scm_from_int (10));
 129               percent_counter_->set_property ("text", text);
 130               percent_counter_->set_bound (LEFT, col);
 131               Side_position_interface::add_support (percent_counter_,
 132                                                     percent_);
 133               percent_counter_->set_parent (percent_, Y_AXIS);
 134             }
 135           else
 136             percent_counter_ = 0;
 137         }
 138       else if (repeat_sign_type_ == DOUBLE_MEASURE)
 139         {
 140           Item *double_percent = make_item ("DoublePercentRepeat", percent_event_->self_scm ());
 141
 142           SCM count = percent_event_->get_property ("repeat-count");
 143           if (count != SCM_EOL
 144               && to_boolean (get_property ("countPercentRepeats")))
 145             {
 146               Item *double_percent_counter = make_item ("DoublePercentRepeatCounter",
 147                                                         percent_event_->self_scm());
 148
 149               SCM text = scm_number_to_string (count,
 150                                                scm_from_int (10));
 151               double_percent_counter->set_property ("text", text);
 152
 153               Side_position_interface::add_support (double_percent_counter,
 154                                                     double_percent);
 155               double_percent_counter->set_parent (double_percent, Y_AXIS);
 156               double_percent_counter->set_parent (double_percent, X_AXIS);
 157             }
 158
 159           /* forbid breaks on a % line. Should forbid all breaks, really. */
 160           context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
 161
 162           /* No more processing needed. */
 163           repeat_sign_type_ = UNKNOWN;
 164         }
 165     }
 166 }
 167
 168 void
 169 Percent_repeat_engraver::finalize ()
 170 {
 171   if (percent_)
 172     {
 173       percent_event_->origin ()->warning (_ ("unterminated percent repeat"));
 174       percent_->suicide ();
 175       percent_counter_->suicide();
 176     }
 177 }
 178
 179 void
 180 Percent_repeat_engraver::typeset_perc ()
 181 {
 182   if (percent_)
 183     {
 184       Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 185
 186       percent_->set_bound (RIGHT, col);
 187       percent_ = 0;
 188
 189       if (percent_counter_)
 190         percent_counter_->set_bound (RIGHT, col);
 191       percent_counter_ = 0;
 192     }
 193 }
 194
 195 void
 196 Percent_repeat_engraver::start_translation_timestep ()
 197 {
 198   if (stop_mom_.main_part_ == now_mom ().main_part_)
 199     {
 200       if (percent_)
 201         typeset_perc ();
 202       percent_event_ = 0;
 203       repeat_sign_type_ = UNKNOWN;
 204     }
 205 }
 206
 207 void
 208 Percent_repeat_engraver::stop_translation_timestep ()
 209 {
 210 }
 211
 212 ADD_TRANSLATOR (Percent_repeat_engraver,
 213                 /* doc */
 214                 "Make whole bar and double bar repeats.",
 215
 216                 /* create */
 217                 "DoublePercentRepeat "
 218                 "DoublePercentRepeatCounter "
 219                 "PercentRepeat "
 220                 "PercentRepeatCounter ",
 221
 222                 /* accept */
 223                 "percent-event ",
 224
 225                 /* read */
 226                 "countPercentRepeats "
 227                 "currentCommandColumn "
 228                 "measureLength ",
 229
 230                 /* write */
 231                 "forbidBreak "
 232                 );