lily/tuplet-engraver.cc

   1 /*
   2   tuplet-engraver.cc -- implement Tuplet_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "tuplet-bracket.hh"
  10 #include "note-column.hh"
  11 #include "beam.hh"
  12 #include "engraver.hh"
  13 #include "spanner.hh"
  14
  15 #include "translator.icc"
  16
  17 struct Tuplet_description
  18 {
  19   Music *music_;
  20   Rational stop_;
  21   Rational span_stop_;
  22   Rational length_;
  23   Spanner *spanner_;
  24   Tuplet_description ()
  25   {
  26     music_ = 0;
  27     spanner_ = 0;
  28   }
  29   static int compare (Tuplet_description const &a, Tuplet_description const &b)
  30   {
  31     return ::compare (a.length_, b.length_);
  32   }
  33 };
  34
  35 class Tuplet_engraver : public Engraver
  36 {
  37 public:
  38   TRANSLATOR_DECLARATIONS (Tuplet_engraver);
  39
  40 protected:
  41   Array<Tuplet_description> tuplets_;
  42   Link_array<Spanner> last_tuplets_;
  43   DECLARE_ACKNOWLEDGER (note_column);
  44   virtual bool try_music (Music *r);
  45   virtual void finalize ();
  46   void start_translation_timestep ();
  47   void process_music ();
  48 };
  49
  50 bool
  51 Tuplet_engraver::try_music (Music *music)
  52 {
  53   if (music->is_mus_type ("time-scaled-music"))
  54     {
  55       Music *el = unsmob_music (music->get_property ("element"));
  56       if (el && !el->is_mus_type ("event-chord"))
  57         {
  58           Tuplet_description d;
  59           d.music_ = music;
  60           d.length_ = music->get_length ().main_part_;
  61           d.stop_ = now_mom ().main_part_ + d.length_;
  62           d.span_stop_ = d.stop_;
  63
  64           SCM s = get_property ("tupletSpannerDuration");
  65           if (unsmob_moment (s))
  66             d.span_stop_ = min (d.span_stop_, (now_mom () + *unsmob_moment (s)).main_part_);
  67
  68           tuplets_.push (d);
  69         }
  70       return true;
  71     }
  72   return false;
  73 }
  74
  75 void
  76 Tuplet_engraver::process_music ()
  77 {
  78   if (!tuplets_.size ())
  79     return;
  80
  81   tuplets_.sort (&Tuplet_description::compare);
  82   for (int i = 0; i < tuplets_.size (); i++)
  83     {
  84       if (tuplets_[i].spanner_)
  85         continue;
  86
  87       Spanner *spanner = make_spanner ("TupletBracket",
  88                                        tuplets_[i].music_->self_scm ());
  89       tuplets_[i].spanner_ = spanner;
  90
  91       if (i > 0 && tuplets_[i - 1].spanner_)
  92         Tuplet_bracket::add_tuplet_bracket (tuplets_[i].spanner_, tuplets_[i - 1].spanner_);
  93       if (i < tuplets_.size () - 1 && tuplets_[i + 1].spanner_)
  94         Tuplet_bracket::add_tuplet_bracket (tuplets_[i + 1].spanner_, tuplets_[i].spanner_);
  95
  96       SCM proc = get_property ("tupletNumberFormatFunction");
  97       if (ly_is_procedure (proc))
  98         {
  99           SCM t = scm_apply_0 (proc, scm_list_1 (tuplets_[i].music_->self_scm ()));
 100           spanner->set_property ("text", t);
 101         }
 102     }
 103 }
 104
 105 void
 106 Tuplet_engraver::acknowledge_note_column (Grob_info i)
 107 {
 108   for (int j = 0; j < tuplets_.size (); j++)
 109     if (tuplets_[j].spanner_)
 110       Tuplet_bracket::add_column (tuplets_[j].spanner_,
 111                                   dynamic_cast<Item *> (i.grob ()));
 112 }
 113
 114 void
 115 Tuplet_engraver::start_translation_timestep ()
 116 {
 117   Moment now = now_mom ();
 118
 119   last_tuplets_.clear ();
 120   if (tuplets_.is_empty ())
 121     return;
 122
 123   Moment tsdmom = robust_scm2moment (get_property ("tupletSpannerDuration"), Moment (0));
 124   bool full_length = to_boolean (get_property ("tupletFullLength"));
 125
 126   for (int i = tuplets_.size (); i--;)
 127     {
 128       Rational tsd = tsdmom.main_part_;
 129
 130       if (now.main_part_ >= tuplets_[i].span_stop_)
 131         {
 132           if (tuplets_[i].spanner_)
 133             {
 134               if (full_length)
 135                 {
 136                   Item *col = unsmob_item (get_property ("currentMusicalColumn"));
 137
 138                   tuplets_[i].spanner_->set_bound (RIGHT, col);
 139                 }
 140               else if (!tuplets_[i].spanner_->get_bound (RIGHT))
 141                 tuplets_[i].spanner_->set_bound (RIGHT,
 142                                                  tuplets_[i].spanner_->get_bound (LEFT));
 143
 144               last_tuplets_.push (tuplets_[i].spanner_);
 145               tuplets_[i].spanner_ = 0;
 146             }
 147
 148           if (tsd)
 149             tuplets_[i].span_stop_ += tsd;
 150         }
 151
 152       if (now.main_part_ >= tuplets_[i].stop_)
 153         tuplets_.del (i);
 154     }
 155 }
 156
 157 void
 158 Tuplet_engraver::finalize ()
 159 {
 160   if (to_boolean (get_property ("tupletFullLength")))
 161     {
 162       for (int i = 0; i < last_tuplets_.size (); i++)
 163         {
 164           Item *col = unsmob_item (get_property ("currentCommandColumn"));
 165           last_tuplets_[i]->set_bound (RIGHT, col);
 166         }
 167     }
 168 }
 169
 170 Tuplet_engraver::Tuplet_engraver ()
 171 {
 172 }
 173
 174 ADD_ACKNOWLEDGER (Tuplet_engraver, note_column);
 175 ADD_TRANSLATOR (Tuplet_engraver,
 176                 /* doc */ "Catch Time_scaled_music and generate appropriate bracket  ",
 177                 /* create */ "TupletBracket",
 178                 /* accept */ "time-scaled-music",
 179                 /* read */ "tupletNumberFormatFunction tupletSpannerDuration tupletFullLength",
 180                 /* write */ "");