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--2006 Han-Wen Nienhuys <hanwen@xs4all.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 *bracket_;
  24   Spanner *number_;
  25   Tuplet_description ()
  26   {
  27     music_ = 0;
  28     bracket_ = 0;
  29     number_ = 0;
  30   }
  31   static int compare (Tuplet_description const &a, Tuplet_description const &b)
  32   {
  33     return ::compare (a.length_, b.length_);
  34   }
  35 };
  36
  37 class Tuplet_engraver : public Engraver
  38 {
  39 public:
  40   TRANSLATOR_DECLARATIONS (Tuplet_engraver);
  41
  42 protected:
  43   vector<Tuplet_description> tuplets_;
  44   vector<Spanner*> last_tuplets_;
  45   DECLARE_ACKNOWLEDGER (note_column);
  46   virtual bool try_music (Music *r);
  47   virtual void finalize ();
  48   void start_translation_timestep ();
  49   void process_music ();
  50 };
  51
  52 bool
  53 Tuplet_engraver::try_music (Music *music)
  54 {
  55   if (music->is_mus_type ("time-scaled-music"))
  56     {
  57       Music *el = unsmob_music (music->get_property ("element"));
  58       if (el && !el->is_mus_type ("event-chord"))
  59         {
  60           Tuplet_description d;
  61           d.music_ = music;
  62           d.length_ = music->get_length ().main_part_;
  63           d.stop_ = now_mom ().main_part_ + d.length_;
  64           d.span_stop_ = d.stop_;
  65
  66           SCM s = get_property ("tupletSpannerDuration");
  67           if (unsmob_moment (s))
  68             d.span_stop_ = min (d.span_stop_, (now_mom () + *unsmob_moment (s)).main_part_);
  69
  70           tuplets_.push_back (d);
  71         }
  72       return true;
  73     }
  74   return false;
  75 }
  76
  77 void
  78 Tuplet_engraver::process_music ()
  79 {
  80   if (!tuplets_.size ())
  81     return;
  82
  83   vector_sort (tuplets_, Tuplet_description::compare);
  84   for (vsize i = 0; i < tuplets_.size (); i++)
  85     {
  86       if (tuplets_[i].bracket_)
  87         continue;
  88
  89       tuplets_[i].bracket_ = make_spanner ("TupletBracket",
  90                                            tuplets_[i].music_->self_scm ());
  91       tuplets_[i].number_ = make_spanner ("TupletNumber",
  92                                           tuplets_[i].music_->self_scm ());
  93       tuplets_[i].number_->set_object ("bracket", tuplets_[i].bracket_->self_scm ());
  94       tuplets_[i].bracket_->set_object ("tuplet-number", tuplets_[i].number_->self_scm ());
  95
  96       if (i > 0 && tuplets_[i - 1].bracket_)
  97         Tuplet_bracket::add_tuplet_bracket (tuplets_[i].bracket_, tuplets_[i - 1].bracket_);
  98
  99       if (i < tuplets_.size () - 1 && tuplets_[i + 1].bracket_)
 100         Tuplet_bracket::add_tuplet_bracket (tuplets_[i + 1].bracket_, tuplets_[i].bracket_);
 101
 102       SCM proc = get_property ("tupletNumberFormatFunction");
 103       if (ly_is_procedure (proc))
 104         {
 105           SCM t = scm_apply_0 (proc, scm_list_1 (tuplets_[i].music_->self_scm ()));
 106           tuplets_[i].number_->set_property ("text", t);
 107         }
 108     }
 109 }
 110
 111 void
 112 Tuplet_engraver::acknowledge_note_column (Grob_info inf)
 113 {
 114   for (vsize j = 0; j < tuplets_.size (); j++)
 115     if (tuplets_[j].bracket_)
 116       {
 117         Item *i = dynamic_cast<Item *> (inf.grob ());
 118         Tuplet_bracket::add_column (tuplets_[j].bracket_, i);
 119         add_bound_item (tuplets_[j].number_, i);
 120       }
 121 }
 122
 123 void
 124 Tuplet_engraver::start_translation_timestep ()
 125 {
 126   Moment now = now_mom ();
 127
 128   last_tuplets_.clear ();
 129   if (tuplets_.empty ())
 130     return;
 131
 132   Moment tsdmom = robust_scm2moment (get_property ("tupletSpannerDuration"), Moment (0));
 133   bool full_length = to_boolean (get_property ("tupletFullLength"));
 134
 135   for (vsize i = tuplets_.size (); i--;)
 136     {
 137       Rational tsd = tsdmom.main_part_;
 138
 139       if (now.main_part_ >= tuplets_[i].span_stop_)
 140         {
 141           if (tuplets_[i].bracket_)
 142             {
 143               if (full_length)
 144                 {
 145                   Item *col = unsmob_item (get_property ("currentMusicalColumn"));
 146
 147                   tuplets_[i].bracket_->set_bound (RIGHT, col);
 148                   tuplets_[i].number_->set_bound (RIGHT, col);
 149                 }
 150               else if (!tuplets_[i].bracket_->get_bound (RIGHT))
 151                 {
 152                   tuplets_[i].bracket_->set_bound (RIGHT,
 153                                                    tuplets_[i].bracket_->get_bound (LEFT));
 154                   tuplets_[i].number_->set_bound (RIGHT,
 155                                                   tuplets_[i].bracket_->get_bound (LEFT));
 156                 }
 157               last_tuplets_.push_back (tuplets_[i].bracket_);
 158               last_tuplets_.push_back (tuplets_[i].number_);
 159
 160               tuplets_[i].bracket_ = 0;
 161               tuplets_[i].number_ = 0;
 162             }
 163
 164           if (tsd)
 165             tuplets_[i].span_stop_ += tsd;
 166         }
 167
 168       if (now.main_part_ >= tuplets_[i].stop_)
 169         tuplets_.erase (tuplets_.begin () + i);
 170     }
 171 }
 172
 173 void
 174 Tuplet_engraver::finalize ()
 175 {
 176   if (to_boolean (get_property ("tupletFullLength")))
 177     {
 178       for (vsize i = 0; i < last_tuplets_.size (); i++)
 179         {
 180           Item *col = unsmob_item (get_property ("currentCommandColumn"));
 181           last_tuplets_[i]->set_bound (RIGHT, col);
 182         }
 183     }
 184 }
 185
 186 Tuplet_engraver::Tuplet_engraver ()
 187 {
 188 }
 189
 190 ADD_ACKNOWLEDGER (Tuplet_engraver, note_column);
 191 ADD_TRANSLATOR (Tuplet_engraver,
 192                 /* doc */ "Catch Time_scaled_music and generate appropriate bracket  ",
 193                 /* create */ "TupletBracket TupletNumber",
 194                 /* accept */ "time-scaled-music",
 195                 /* read */ "tupletNumberFormatFunction tupletSpannerDuration tupletFullLength",
 196                 /* write */ "");