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