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