X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fmusic-iterator.hh;h=bb095df71869e84bbd25d84042cd30adab580e79;hb=3cdc909d8cea64c8faef90d3a6a391f32a424ba2;hp=86b3bf379a0127d8dd1b300e9b608f1e2971dc15;hpb=e344ae579fa1d81fc6c6f3049494697872fd39f9;p=lilypond.git

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index 86b3bf379a..bb095df718 100644
--- a/lily/include/music-iterator.hh
+++ b/lily/include/music-iterator.hh
@@ -1,9 +1,20 @@
 /*
-  music-iterator.hh -- declare Music_iterator
+  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--2008 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/>.
 */
 
 #ifndef MUSIC_ITERATOR_HH
@@ -32,10 +43,10 @@
    ok () -- events left ?
 
    pending_mom () -- time tag of the next event to be processed.
-   PRECONDITION: this->ok () holds.
+   PRECONDITION: ok () holds.
 
    process (M) -- process all at M (Precondition: no events exist
-   before M, this->ok () holds).  Side-effects:
+   before M, ok () holds).  Side-effects:
 
    * This removes all events at M from the pending queue.
 
@@ -47,23 +58,31 @@
 
    merge pending_moment and process?
 */
-class Music_iterator
+class Music_iterator : public Smob<Music_iterator>
 {
+public:
+  int print_smob (SCM, scm_print_state *) const;
+  SCM mark_smob () const;
+  static const char * const type_p_name_;
+  virtual ~Music_iterator ();
 protected:
   Moment music_length_;
   Moment start_mom_;
 
-  DECLARE_CLASSNAME(Music_iterator);
-  DECLARE_SMOBS (Music_iterator);
-  Music_iterator (Music_iterator const &);
+  DECLARE_CLASSNAME (Music_iterator);
+private:
+  Music_iterator (Music_iterator const &); // Do not define!  Not copyable!
 
 public:
   Moment music_get_length () const;
+  // music_start_mom () is calculated relative to the time where the
+  // iterator occurs in the music stream, so it will usually be
+  // non-zero only for expressions starting with grace notes.
   Moment music_start_mom () const;
   Music_iterator ();
   void report_event (Music *);
-  Context *get_outlet () const;
-  void set_context (Context *);
+  virtual Context *get_outlet () const;
+  virtual void set_context (Context *);
   static SCM get_static_get_iterator (Music *mus);
   void init_context (Music *, Context *);
   void quit ();
@@ -73,6 +92,8 @@ public:
   virtual Moment pending_moment () const;
   virtual bool ok () const;
   virtual bool run_always () const;
+  // process is called with a time relative to the iterator start, so
+  // usually the last processed moment is the same as music_get_length.
   virtual void process (Moment until);
   virtual void derived_mark () const;
   virtual void construct_children ();
@@ -91,17 +112,16 @@ private:
 
 bool is_child_context (Context *me, Context *child);
 
-#define IMPLEMENT_CTOR_CALLBACK(Class)					\
+#define IMPLEMENT_CTOR_CALLBACK(Class)                                  \
   LY_DEFINE_MEMBER_FUNCTION (Class, constructor, \
-			     mangle_cxx_identifier (string (#Class) + "::constructor").c_str(), \
-			     0, 0, 0,					\
-			     (),					\
-			     "")					\
-  {									\
-    Class *c = (new Class);						\
-    return c->unprotect ();						\
+                             mangle_cxx_identifier (string (#Class) + "::constructor").c_str(), \
+                             0, 0, 0,                                   \
+                             (),                                        \
+                             "")                                        \
+  {                                                                     \
+    Class *c = (new Class);                                             \
+    return c->unprotect ();                                             \
   }
 
-DECLARE_UNSMOB (Music_iterator, iterator);
 
 #endif // MUSIC_ITERATOR_HH