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