Doc-es: various updates.

[lilypond.git] / lily / rhythmic-column-engraver.cc

diff --git a/lily/rhythmic-column-engraver.cc b/lily/rhythmic-column-engraver.cc
index fc21e618eb202059a234c64e33e29101aed22721..e307b512de092653ce91d6f54000161c175b07f4 100644 (file)
--- a/lily/rhythmic-column-engraver.cc
+++ b/lily/rhythmic-column-engraver.cc
@@ -1,9 +1,20 @@
 /*
-  rhythmic-column-engraver.cc -- implement Rhythmic_column_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "engraver.hh"
@@ -42,60 +53,59 @@
 
 class Rhythmic_column_engraver : public Engraver
 {
-  vector<Grob*> rheads_;
+  vector<Grob *> rheads_;
   Grob *stem_;
+  Grob *flag_;
   Grob *note_column_;
-  Grob *dotcol_;
 
   TRANSLATOR_DECLARATIONS (Rhythmic_column_engraver);
 protected:
 
-  DECLARE_ACKNOWLEDGER (dot_column);
-  DECLARE_ACKNOWLEDGER (stem);
-  DECLARE_ACKNOWLEDGER (rhythmic_head);
+  void acknowledge_stem (Grob_info);
+  void acknowledge_flag (Grob_info);
+  void acknowledge_rhythmic_head (Grob_info);
   void process_acknowledged ();
   void stop_translation_timestep ();
 };
 
-Rhythmic_column_engraver::Rhythmic_column_engraver ()
+Rhythmic_column_engraver::Rhythmic_column_engraver (Context *c)
+  : Engraver (c)
 {
 
   stem_ = 0;
+  flag_ = 0;
   note_column_ = 0;
-  dotcol_ = 0;
 }
 
-
 void
 Rhythmic_column_engraver::process_acknowledged ()
 {
   if (rheads_.size ())
     {
       if (!note_column_)
-       {
-         note_column_ = make_item ("NoteColumn", rheads_[0]->self_scm ());
-       }
+        note_column_ = make_item ("NoteColumn", rheads_[0]->self_scm ());
 
       for (vsize i = 0; i < rheads_.size (); i++)
-       {
-         if (!rheads_[i]->get_parent (X_AXIS))
-           Note_column::add_head (note_column_, rheads_[i]);
-       }
+        if (!rheads_[i]->get_parent (X_AXIS))
+          Note_column::add_head (note_column_, rheads_[i]);
+
       rheads_.resize (0);
     }
 
   if (note_column_)
     {
-      if (dotcol_
-         && !dotcol_->get_parent (X_AXIS))
-       Note_column::set_dotcol (note_column_, dotcol_);
-
       if (stem_
-         && !stem_->get_parent (X_AXIS))
-       {
-         Note_column::set_stem (note_column_, stem_);
-         stem_ = 0;
-       }
+          && !stem_->get_parent (X_AXIS))
+        {
+          Note_column::set_stem (note_column_, stem_);
+          stem_ = 0;
+        }
+
+      if (flag_)
+        {
+          Pointer_group_interface::add_grob (note_column_, ly_symbol2scm ("elements"), flag_);
+          flag_ = 0;
+        }
     }
 }
 
@@ -106,31 +116,45 @@ Rhythmic_column_engraver::acknowledge_stem (Grob_info i)
 }
 
 void
-Rhythmic_column_engraver::acknowledge_rhythmic_head (Grob_info i)
+Rhythmic_column_engraver::acknowledge_flag (Grob_info i)
 {
-  rheads_.push_back (i.grob ());
+  flag_ = i.grob ();
 }
 
 void
-Rhythmic_column_engraver::acknowledge_dot_column (Grob_info i)
+Rhythmic_column_engraver::acknowledge_rhythmic_head (Grob_info i)
 {
-  dotcol_ = i.grob ();
+  rheads_.push_back (i.grob ());
 }
 
 void
 Rhythmic_column_engraver::stop_translation_timestep ()
 {
   note_column_ = 0;
-  dotcol_ = 0;
   stem_ = 0;
+  flag_ = 0;
 }
 
-ADD_ACKNOWLEDGER (Rhythmic_column_engraver, dot_column);
-ADD_ACKNOWLEDGER (Rhythmic_column_engraver, stem);
-ADD_ACKNOWLEDGER (Rhythmic_column_engraver, rhythmic_head);
+
+void
+Rhythmic_column_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Rhythmic_column_engraver, stem);
+  ADD_ACKNOWLEDGER (Rhythmic_column_engraver, flag);
+  ADD_ACKNOWLEDGER (Rhythmic_column_engraver, rhythmic_head);
+}
 
 ADD_TRANSLATOR (Rhythmic_column_engraver,
-               /* doc */ "Generates NoteColumn, an objects that groups stems, noteheads and rests.",
-               /* create */ "NoteColumn",
-               /* read */ "",
-               /* write */ "");
+                /* doc */
+                "Generate @code{NoteColumn}, an object that groups stems,"
+                " note heads, and rests.",
+
+                /* create */
+                "NoteColumn ",
+
+                /* read */
+                "",
+
+                /* write */
+                ""
+               );