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