lily/rhythmic-column-engraver.cc

   1 /*
   2   rhythmic-column-engraver.cc -- implement Rhythmic_column_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7 */
   8
   9 #include "engraver.hh"
  10 #include "rhythmic-head.hh"
  11 #include "stem.hh"
  12 #include "note-column.hh"
  13 #include "item.hh"
  14 #include "dot-column.hh"
  15 #include "pointer-group-interface.hh"
  16
  17 #include "translator.icc"
  18
  19 /*
  20   this engraver  glues together stems, rests and note heads into a NoteColumn
  21   grob.
  22
  23   It also generates spacing objects.  Originally, we have tried to
  24   have the spacing functionality at different levels.
  25
  26   - by simply using the sequence of Separation-item as
  27   spacing-sequences (at staff level). Unfortunately, this fucks up if
  28   there are different kinds of tuplets in different voices (8th and
  29   8ths triplets combined made the program believe there were 1/12 th
  30   notes.).
  31
  32   Doing it in a separate engraver using timing info is generally
  33   complicated (start/end time management), and fucks up if a voice
  34   changes staff.
  35
  36   Now we do it from here again. This has the problem that voices can
  37   appear and disappear at will, leaving lots of loose ends (the note
  38   spacing engraver don't know where to connect the last note of the
  39   voice on the right with), but we don't complain about those, and let
  40   the default spacing do its work.
  41 */
  42
  43 class Rhythmic_column_engraver : public Engraver
  44 {
  45   vector<Grob*> rheads_;
  46   Grob *stem_;
  47   Grob *note_column_;
  48   Grob *dotcol_;
  49   Grob *arpeggio_;
  50
  51   TRANSLATOR_DECLARATIONS (Rhythmic_column_engraver);
  52 protected:
  53
  54   DECLARE_ACKNOWLEDGER (stem);
  55   DECLARE_ACKNOWLEDGER (rhythmic_head);
  56   DECLARE_ACKNOWLEDGER (arpeggio);
  57   void process_acknowledged ();
  58   void stop_translation_timestep ();
  59 };
  60
  61 Rhythmic_column_engraver::Rhythmic_column_engraver ()
  62 {
  63
  64   stem_ = 0;
  65   note_column_ = 0;
  66   arpeggio_ = 0;
  67 }
  68
  69
  70 void
  71 Rhythmic_column_engraver::process_acknowledged ()
  72 {
  73   if (rheads_.size ())
  74     {
  75       if (!note_column_)
  76         note_column_ = make_item ("NoteColumn", rheads_[0]->self_scm ());
  77
  78       for (vsize i = 0; i < rheads_.size (); i++)
  79         if (!rheads_[i]->get_parent (X_AXIS))
  80           Note_column::add_head (note_column_, rheads_[i]);
  81
  82       rheads_.resize (0);
  83     }
  84
  85   if (note_column_)
  86     {
  87       if (stem_
  88           && !stem_->get_parent (X_AXIS))
  89         {
  90           Note_column::set_stem (note_column_, stem_);
  91           stem_ = 0;
  92         }
  93
  94       if (arpeggio_)
  95         note_column_->set_object ("arpeggio", arpeggio_->self_scm ());
  96     }
  97 }
  98
  99 void
 100 Rhythmic_column_engraver::acknowledge_stem (Grob_info i)
 101 {
 102   stem_ = i.grob ();
 103 }
 104
 105 void
 106 Rhythmic_column_engraver::acknowledge_rhythmic_head (Grob_info i)
 107 {
 108   rheads_.push_back (i.grob ());
 109 }
 110
 111 void
 112 Rhythmic_column_engraver::acknowledge_arpeggio (Grob_info i)
 113 {
 114   arpeggio_ = i.grob ();
 115 }
 116
 117 void
 118 Rhythmic_column_engraver::stop_translation_timestep ()
 119 {
 120   note_column_ = 0;
 121   stem_ = 0;
 122   arpeggio_ = 0;
 123 }
 124
 125 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, stem);
 126 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, rhythmic_head);
 127 ADD_ACKNOWLEDGER (Rhythmic_column_engraver, arpeggio);
 128
 129 ADD_TRANSLATOR (Rhythmic_column_engraver,
 130                 /* doc */
 131                 "Generate @code{NoteColumn}, an object that groups stems,"
 132                 " note heads, and rests.",
 133
 134                 /* create */
 135                 "NoteColumn ",
 136
 137                 /* read */
 138                 "",
 139
 140                 /* write */
 141                 ""
 142                 );