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
  36
  37 class Tuplet_engraver : public Engraver
  38 {
  39 public:
  40   TRANSLATOR_DECLARATIONS (Tuplet_engraver);
  41
  42 protected:
  43   Array<Tuplet_description> tuplets_;
  44   Link_array<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 (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
  84   tuplets_.sort (&Tuplet_description::compare);
  85   for (int i = 0; i < tuplets_.size (); i++)
  86     {
  87       if (tuplets_[i].spanner_)
  88         continue;
  89
  90       Spanner *spanner = make_spanner ("TupletBracket",
  91                                        tuplets_[i].music_->self_scm ());
  92       tuplets_[i].spanner_ = spanner;
  93
  94       if (i > 0 && tuplets_[i-1].spanner_)
  95         Tuplet_bracket::add_tuplet_bracket (tuplets_[i].spanner_, tuplets_[i-1].spanner_);
  96       if (i < tuplets_.size()-1 && tuplets_[i+1].spanner_)
  97         Tuplet_bracket::add_tuplet_bracket (tuplets_[i+1].spanner_, tuplets_[i].spanner_);
  98
  99       SCM proc = get_property ("tupletNumberFormatFunction");
 100       if (ly_is_procedure (proc))
 101         {
 102           SCM t = scm_apply_0 (proc, scm_list_1 (tuplets_[i].music_->self_scm ()));
 103           spanner->set_property ("text", t);
 104         }
 105     }
 106 }
 107
 108 void
 109 Tuplet_engraver::acknowledge_note_column (Grob_info i)
 110 {
 111   for (int j = 0; j < tuplets_.size (); j++)
 112     if (tuplets_[j].spanner_)
 113       Tuplet_bracket::add_column (tuplets_[j].spanner_,
 114                                   dynamic_cast<Item *> (i.grob ()));
 115 }
 116
 117 void
 118 Tuplet_engraver::start_translation_timestep ()
 119 {
 120   Moment now = now_mom ();
 121
 122   if (tuplets_.is_empty())
 123     return;
 124
 125   Moment tsdmom = robust_scm2moment (get_property ("tupletSpannerDuration"), Moment (0));
 126   bool full_length = to_boolean (get_property ("tupletFullLength"));
 127
 128   last_tuplets_.clear ();
 129   for (int i = tuplets_.size (); i--;)
 130     {
 131       Rational tsd = tsdmom.main_part_;
 132
 133       if (now.main_part_ >= tuplets_[i].span_stop_)
 134         {
 135           if (tuplets_[i].spanner_)
 136             {
 137               if (full_length )
 138                 {
 139                   Item * col = unsmob_item (get_property ("currentMusicalColumn"));
 140
 141                   tuplets_[i].spanner_->set_bound (RIGHT, col);
 142                 }
 143               else if (!tuplets_[i].spanner_->get_bound (RIGHT))
 144                 tuplets_[i].spanner_->set_bound (RIGHT,
 145                                                  tuplets_[i].spanner_->get_bound (LEFT));
 146
 147               last_tuplets_.push (tuplets_[i].spanner_);
 148               tuplets_[i].spanner_ = 0;
 149             }
 150
 151           if (tsd)
 152             tuplets_[i].span_stop_ += tsd;
 153         }
 154
 155       if (now.main_part_ >= tuplets_[i].stop_)
 156         {
 157           tuplets_.del (i);
 158         }
 159     }
 160 }
 161
 162 void
 163 Tuplet_engraver::finalize ()
 164 {
 165   if (to_boolean (get_property ("tupletFullLength")))
 166     {
 167       for (int i = 0; i < last_tuplets_.size (); i++)
 168         {
 169           Item * col = unsmob_item (get_property ("currentCommandColumn"));
 170           last_tuplets_[i]->set_bound (RIGHT, col);
 171         }
 172     }
 173 }
 174
 175 Tuplet_engraver::Tuplet_engraver ()
 176 {
 177 }
 178
 179 ADD_ACKNOWLEDGER (Tuplet_engraver,note_column);
 180 ADD_TRANSLATOR (Tuplet_engraver,
 181                 /* descr */ "Catch Time_scaled_music and generate appropriate bracket  ",
 182                 /* creats*/ "TupletBracket",
 183                 /* accepts */ "time-scaled-music",
 184                 /* reads */ "tupletNumberFormatFunction tupletSpannerDuration tupletFullLength" ,
 185                 /* write */ "");