lily/rhythmic-column-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 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 *flag_;
  59   Grob *note_column_;
  60
  61   TRANSLATOR_DECLARATIONS (Rhythmic_column_engraver);
  62 protected:
  63
  64   void acknowledge_stem (Grob_info);
  65   void acknowledge_flag (Grob_info);
  66   void acknowledge_rhythmic_head (Grob_info);
  67   void process_acknowledged ();
  68   void stop_translation_timestep ();
  69 };
  70
  71 Rhythmic_column_engraver::Rhythmic_column_engraver (Context *c)
  72   : Engraver (c)
  73 {
  74
  75   stem_ = 0;
  76   flag_ = 0;
  77   note_column_ = 0;
  78 }
  79
  80 void
  81 Rhythmic_column_engraver::process_acknowledged ()
  82 {
  83   if (rheads_.size ())
  84     {
  85       if (!note_column_)
  86         note_column_ = make_item ("NoteColumn", rheads_[0]->self_scm ());
  87
  88       for (vsize i = 0; i < rheads_.size (); i++)
  89         if (!rheads_[i]->get_parent (X_AXIS))
  90           Note_column::add_head (note_column_, rheads_[i]);
  91
  92       rheads_.resize (0);
  93     }
  94
  95   if (note_column_)
  96     {
  97       if (stem_
  98           && !stem_->get_parent (X_AXIS))
  99         {
 100           Note_column::set_stem (note_column_, stem_);
 101           stem_ = 0;
 102         }
 103
 104       if (flag_)
 105         {
 106           Pointer_group_interface::add_grob (note_column_, ly_symbol2scm ("elements"), flag_);
 107           flag_ = 0;
 108         }
 109     }
 110 }
 111
 112 void
 113 Rhythmic_column_engraver::acknowledge_stem (Grob_info i)
 114 {
 115   stem_ = i.grob ();
 116 }
 117
 118 void
 119 Rhythmic_column_engraver::acknowledge_flag (Grob_info i)
 120 {
 121   flag_ = i.grob ();
 122 }
 123
 124 void
 125 Rhythmic_column_engraver::acknowledge_rhythmic_head (Grob_info i)
 126 {
 127   rheads_.push_back (i.grob ());
 128 }
 129
 130 void
 131 Rhythmic_column_engraver::stop_translation_timestep ()
 132 {
 133   note_column_ = 0;
 134   stem_ = 0;
 135   flag_ = 0;
 136 }
 137
 138
 139 void
 140 Rhythmic_column_engraver::boot ()
 141 {
 142   ADD_ACKNOWLEDGER (Rhythmic_column_engraver, stem);
 143   ADD_ACKNOWLEDGER (Rhythmic_column_engraver, flag);
 144   ADD_ACKNOWLEDGER (Rhythmic_column_engraver, rhythmic_head);
 145 }
 146
 147 ADD_TRANSLATOR (Rhythmic_column_engraver,
 148                 /* doc */
 149                 "Generate @code{NoteColumn}, an object that groups stems,"
 150                 " note heads, and rests.",
 151
 152                 /* create */
 153                 "NoteColumn ",
 154
 155                 /* read */
 156                 "",
 157
 158                 /* write */
 159                 ""
 160                );