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 "beam.hh"
  10 #include "engraver.hh"
  11 #include "international.hh"
  12 #include "note-column.hh"
  13 #include "spanner.hh"
  14 #include "stream-event.hh"
  15 #include "tuplet-bracket.hh"
  16 #include "warn.hh"
  17
  18 #include "translator.icc"
  19
  20 struct Tuplet_description
  21 {
  22   Stream_event *event_;
  23   Spanner *bracket_;
  24   Spanner *number_;
  25
  26   bool full_length_;
  27   bool full_length_note_;
  28
  29   Tuplet_description ()
  30   {
  31     event_ = 0;
  32     full_length_note_ = false;
  33     full_length_ = false;
  34     bracket_ = 0;
  35     number_ = 0;
  36   }
  37 };
  38
  39 class Tuplet_engraver : public Engraver
  40 {
  41 public:
  42   TRANSLATOR_DECLARATIONS (Tuplet_engraver);
  43
  44 protected:
  45   vector<Tuplet_description> tuplets_;
  46   vector<Tuplet_description> stopped_tuplets_;
  47   vector<Spanner*> last_tuplets_;
  48   DECLARE_ACKNOWLEDGER (note_column);
  49   DECLARE_TRANSLATOR_LISTENER (tuplet_span);
  50   virtual void finalize ();
  51   void start_translation_timestep ();
  52   void process_music ();
  53 };
  54
  55 IMPLEMENT_TRANSLATOR_LISTENER (Tuplet_engraver, tuplet_span);
  56 void
  57 Tuplet_engraver::listen_tuplet_span (Stream_event *ev)
  58 {
  59   Direction dir = to_dir (ev->get_property ("span-direction"));
  60   if (dir == START)
  61     {
  62       Tuplet_description d;
  63       d.event_ = ev;
  64       tuplets_.push_back (d);
  65     }
  66   else if (dir == STOP && tuplets_.size ())
  67     {
  68       stopped_tuplets_.push_back (tuplets_.back ());
  69       tuplets_.pop_back ();
  70     }
  71   else
  72     programming_error (_ ("invalid direction of tuplet-span-event"));
  73 }
  74
  75 void
  76 Tuplet_engraver::process_music ()
  77 {
  78   for (vsize i = 0; i < stopped_tuplets_.size (); i++)
  79     {
  80       if (stopped_tuplets_[i].bracket_)
  81         {
  82           if (stopped_tuplets_[i].full_length_)
  83             {
  84               Item *col =
  85                 unsmob_item (stopped_tuplets_[i].full_length_note_
  86                              ? get_property ("currentMusicalColumn")
  87                              : get_property ("currentCommandColumn"));
  88
  89               stopped_tuplets_[i].bracket_->set_bound (RIGHT, col);
  90               stopped_tuplets_[i].number_->set_bound (RIGHT, col);
  91             }
  92           else if (!stopped_tuplets_[i].bracket_->get_bound (RIGHT))
  93             {
  94               stopped_tuplets_[i].bracket_->set_bound (RIGHT,
  95                                                        stopped_tuplets_[i].bracket_->get_bound (LEFT));
  96               stopped_tuplets_[i].number_->set_bound (RIGHT,
  97                                                       stopped_tuplets_[i].bracket_->get_bound (LEFT));
  98             }
  99           // todo: scrap last_tuplets_, use stopped_tuplets_ only.
 100           // clear stopped_tuplets_ at start_translation_timestep
 101           last_tuplets_.push_back (tuplets_[i].bracket_);
 102           last_tuplets_.push_back (tuplets_[i].number_);
 103         }
 104     }
 105   stopped_tuplets_.clear ();
 106
 107   for (vsize j = tuplets_.size (); j > 0; j--)
 108     {
 109       /* i goes from size-1 downto 0, inclusively */
 110       vsize i = j - 1;
 111
 112
 113       if (tuplets_[i].bracket_)
 114         continue;
 115
 116       tuplets_[i].full_length_ = to_boolean (get_property ("tupletFullLength"));
 117       tuplets_[i].full_length_note_
 118         = to_boolean (get_property ("tupletFullLengthNote"));
 119
 120       tuplets_[i].bracket_ = make_spanner ("TupletBracket",
 121                                            tuplets_[i].event_->self_scm ());
 122       tuplets_[i].number_ = make_spanner ("TupletNumber",
 123                                           tuplets_[i].event_->self_scm ());
 124       tuplets_[i].number_->set_object ("bracket", tuplets_[i].bracket_->self_scm ());
 125       tuplets_[i].bracket_->set_object ("tuplet-number", tuplets_[i].number_->self_scm ());
 126
 127       if (i < tuplets_.size () - 1 && tuplets_[i + 1].bracket_)
 128         Tuplet_bracket::add_tuplet_bracket (tuplets_[i].bracket_, tuplets_[i + 1].bracket_);
 129
 130       if (i > 0 && tuplets_[i - 1].bracket_)
 131         Tuplet_bracket::add_tuplet_bracket (tuplets_[i - 1].bracket_, tuplets_[i].bracket_);
 132
 133     }
 134 }
 135
 136 void
 137 Tuplet_engraver::acknowledge_note_column (Grob_info inf)
 138 {
 139   for (vsize j = 0; j < tuplets_.size (); j++)
 140     if (tuplets_[j].bracket_)
 141       {
 142         Item *i = dynamic_cast<Item *> (inf.grob ());
 143         Tuplet_bracket::add_column (tuplets_[j].bracket_, i);
 144         add_bound_item (tuplets_[j].number_, i);
 145       }
 146 }
 147
 148 void
 149 Tuplet_engraver::start_translation_timestep ()
 150 {
 151   last_tuplets_.clear ();
 152 }
 153
 154 void
 155 Tuplet_engraver::finalize ()
 156 {
 157   if (to_boolean (get_property ("tupletFullLength")))
 158     for (vsize i = 0; i < last_tuplets_.size (); i++)
 159       {
 160         Item *col = unsmob_item (get_property ("currentCommandColumn"));
 161         last_tuplets_[i]->set_bound (RIGHT, col);
 162       }
 163 }
 164
 165 Tuplet_engraver::Tuplet_engraver ()
 166 {
 167 }
 168
 169 ADD_ACKNOWLEDGER (Tuplet_engraver, note_column);
 170 ADD_TRANSLATOR (Tuplet_engraver,
 171                 /* doc */ "Catch TupletSpannerEvent and generate appropriate bracket  ",
 172                 /* create */
 173                 "TupletBracket "
 174                 "TupletNumber ",
 175                 /* accept */ "tuplet-span-event",
 176                 /* read */
 177                 "tupletFullLength "
 178                 "tupletFullLengthNote ",
 179                 /* write */ "");