lily/rhythmic-column-engraver.cc

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