Doc-es: various updates.

[lilypond.git] / lily / collision-engraver.cc

diff --git a/lily/collision-engraver.cc b/lily/collision-engraver.cc
index d3eba9978dad3fdb5ac7d671f18428dd351b167e..15ee2d29239711fd3eda3b02413626078e2b52ab 100644 (file)
--- a/lily/collision-engraver.cc
+++ b/lily/collision-engraver.cc
@@ -1,56 +1,68 @@
 /*
-  collision-reg.cc -- implement Collision_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--2005 Han-Wen Nienhuys <hanwen@cs.uu.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"
 #include "note-column.hh"
 #include "note-collision.hh"
-
-#include "engraver.hh"
 #include "axis-group-interface.hh"
+#include "item.hh"
+
+#include "translator.icc"
 
 class Collision_engraver : public Engraver
 {
-  Item * col_;
-  Link_array<Grob> note_columns_;
+  Item *col_;
+  vector<Grob *> note_columns_;
 
 protected:
-  virtual void acknowledge_grob (Grob_info);
-  virtual void process_acknowledged_grobs ();
-  virtual void stop_translation_timestep ();
+  void acknowledge_note_column (Grob_info);
+  void process_acknowledged ();
+  void stop_translation_timestep ();
 public:
   TRANSLATOR_DECLARATIONS (Collision_engraver);
 };
 
-
 void
-Collision_engraver::process_acknowledged_grobs ()
+Collision_engraver::process_acknowledged ()
 {
   if (col_ || note_columns_.size () < 2)
-    return ;
-  if (!col_) 
-    {
-      col_ = make_item ("NoteCollision", SCM_EOL);
-      
-    }
-  
-  for (int i = 0; i< note_columns_.size (); i++)
-    Note_collision_interface::add_column (col_,note_columns_[i]);
+    return;
+  if (!col_)
+    col_ = make_item ("NoteCollision", SCM_EOL);
+
+  for (vsize i = 0; i < note_columns_.size (); i++)
+    Note_collision_interface::add_column (col_, note_columns_[i]);
 }
 
 void
-Collision_engraver::acknowledge_grob (Grob_info i)
+Collision_engraver::acknowledge_note_column (Grob_info i)
 {
-  if (Note_column::has_interface (i.grob_))
+  if (has_interface<Note_column> (i.grob ()))
     {
       /*should check Y axis? */
-      if (Note_column::has_rests (i.grob_) || i.grob_->get_parent (X_AXIS))
-       return ;
+      if (Note_column::has_rests (i.grob ()) || i.grob ()->get_parent (X_AXIS))
+        return;
+
+      if (to_boolean (i.grob ()->get_property ("ignore-collision")))
+        return;
 
-      note_columns_.push (i.grob_);
+      note_columns_.push_back (i.grob ());
     }
 }
 
@@ -61,18 +73,30 @@ Collision_engraver::stop_translation_timestep ()
   note_columns_.clear ();
 }
 
-Collision_engraver::Collision_engraver ()
+Collision_engraver::Collision_engraver (Context *c)
+  : Engraver (c)
 {
   col_ = 0;
 }
 
 
-
+void
+Collision_engraver::boot ()
+{
+  ADD_ACKNOWLEDGER (Collision_engraver, note_column);
+}
 
 ADD_TRANSLATOR (Collision_engraver,
-/* descr */       "Collect NoteColumns, and as soon as there are two or more, put them in a NoteCollision object.",
-/* creats*/       "NoteCollision",
-/* accepts */     "",
-/* acks  */      "note-column-interface",
-/* reads */       "",
-/* write */       "");
+                /* doc */
+                "Collect @code{NoteColumns}, and as soon as there are two or"
+                " more, put them in a @code{NoteCollision} object.",
+
+                /* create */
+                "NoteCollision ",
+
+                /* read */
+                "",
+
+                /* write */
+                ""
+               );