lily/rhythmic-column-engraver.cc

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