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