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