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 "score-context.hh"
  20 #include "side-position-interface.hh"
  21 #include "spanner.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   Music *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   virtual bool try_music (Music *);
  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 bool
  73 Percent_repeat_engraver::try_music (Music *m)
  74 {
  75   if (m->is_mus_type ("percent-event")
  76       && !percent_event_)
  77     {
  78       Moment body_length = m->get_length ();
  79       Moment meas_len (robust_scm2moment (get_property ("measureLength"),
  80                                           Moment (1)));
  81
  82       if (meas_len == body_length)
  83       {
  84         repeat_sign_type_ = MEASURE;
  85         start_mom_ = now_mom ();
  86         stop_mom_ = now_mom () + body_length;
  87         get_global_context ()->add_moment_to_process (stop_mom_);
  88       }
  89       else if (Moment (2) * meas_len == body_length)
  90       {
  91         repeat_sign_type_ = DOUBLE_MEASURE;
  92         start_mom_ = now_mom () + meas_len;
  93         stop_mom_ = now_mom () + body_length; /* never used */
  94         get_global_context ()->add_moment_to_process (start_mom_);
  95       }
  96       else
  97         return false;
  98
  99       percent_event_ = m;
 100
 101       return true;
 102     }
 103
 104   return false;
 105 }
 106
 107 void
 108 Percent_repeat_engraver::process_music ()
 109 {
 110   if (percent_event_ && now_mom ().main_part_ == start_mom_.main_part_)
 111     {
 112       if (repeat_sign_type_ == MEASURE)
 113         {
 114           if (percent_)
 115             typeset_perc ();
 116           percent_ = make_spanner ("PercentRepeat", percent_event_->self_scm ());
 117
 118           Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 119           percent_->set_bound (LEFT, col);
 120
 121           SCM count = percent_event_->get_property ("repeat-count");
 122           if (count != SCM_EOL && to_boolean (get_property ("countPercentRepeats")))
 123             {
 124               percent_counter_
 125                 = make_spanner ("PercentRepeatCounter", percent_event_->self_scm ());
 126
 127               SCM text = scm_number_to_string (count, scm_from_int (10));
 128               percent_counter_->set_property ("text", text);
 129               percent_counter_->set_bound (LEFT, col);
 130               Side_position_interface::add_support (percent_counter_,
 131                                                     percent_);
 132               percent_counter_->set_parent (percent_, Y_AXIS);
 133             }
 134           else
 135             percent_counter_ = 0;
 136         }
 137       else if (repeat_sign_type_ == DOUBLE_MEASURE)
 138         {
 139           Item *double_percent = make_item ("DoublePercentRepeat", percent_event_->self_scm ());
 140
 141           SCM count = percent_event_->get_property ("repeat-count");
 142           if (count != SCM_EOL
 143               && to_boolean (get_property ("countPercentRepeats")))
 144             {
 145               Item *double_percent_counter = make_item ("DoublePercentRepeatCounter",
 146                                                         percent_event_->self_scm());
 147
 148               SCM text = scm_number_to_string (count,
 149                                                scm_from_int (10));
 150               double_percent_counter->set_property ("text", text);
 151
 152               Side_position_interface::add_support (double_percent_counter,
 153                                                     double_percent);
 154               double_percent_counter->set_parent (double_percent, Y_AXIS);
 155               double_percent_counter->set_parent (double_percent, X_AXIS);
 156             }
 157
 158           /* forbid breaks on a % line. Should forbid all breaks, really. */
 159           context ()->get_score_context ()->set_property ("forbidBreak", SCM_BOOL_T);
 160
 161           /* No more processing needed. */
 162           repeat_sign_type_ = UNKNOWN;
 163         }
 164     }
 165 }
 166
 167 void
 168 Percent_repeat_engraver::finalize ()
 169 {
 170   if (percent_)
 171     {
 172       percent_event_->origin ()->warning (_ ("unterminated percent repeat"));
 173       percent_->suicide ();
 174       percent_counter_->suicide();
 175     }
 176 }
 177
 178 void
 179 Percent_repeat_engraver::typeset_perc ()
 180 {
 181   if (percent_)
 182     {
 183       Grob *col = unsmob_grob (get_property ("currentCommandColumn"));
 184
 185       percent_->set_bound (RIGHT, col);
 186       percent_ = 0;
 187
 188       if (percent_counter_)
 189         percent_counter_->set_bound (RIGHT, col);
 190       percent_counter_ = 0;
 191     }
 192 }
 193
 194 void
 195 Percent_repeat_engraver::start_translation_timestep ()
 196 {
 197   if (stop_mom_.main_part_ == now_mom ().main_part_)
 198     {
 199       if (percent_)
 200         typeset_perc ();
 201       percent_event_ = 0;
 202       repeat_sign_type_ = UNKNOWN;
 203     }
 204 }
 205
 206 void
 207 Percent_repeat_engraver::stop_translation_timestep ()
 208 {
 209 }
 210
 211 ADD_TRANSLATOR (Percent_repeat_engraver,
 212                 /* doc */
 213                 "Make whole bar and double bar repeats.",
 214
 215                 /* create */
 216                 "DoublePercentRepeat "
 217                 "DoublePercentRepeatCounter "
 218                 "PercentRepeat "
 219                 "PercentRepeatCounter ",
 220
 221                 /* accept */
 222                 "percent-event ",
 223
 224                 /* read */
 225                 "countPercentRepeats "
 226                 "currentCommandColumn "
 227                 "measureLength ",
 228
 229                 /* write */
 230                 "forbidBreak "
 231                 );