release: 1.1.26

[lilypond.git] / lily / include / music-iterator.hh

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index d543a858c99248ebccf7af0df66d835ba9029462..f9d6953f9b07da1a1c56b10cce24cca879692bbb 100644 (file)
--- a/lily/include/music-iterator.hh
+++ b/lily/include/music-iterator.hh
@@ -3,7 +3,7 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -12,38 +12,78 @@
 
 #include "lily-proto.hh"
 #include "plist.hh"
-#include "varray.hh"
+#include "array.hh"
 #include "moment.hh"
 #include "virtual-methods.hh"
+#include "interpretation-context-handle.hh"
 
+/** Walk through music and deliver music to translation units, synced
+  in time.  This classa provides both the implementation of the shared
+  code, and the public interface.
+
+  Derived classes should only have a public constructor.
+  The state of an iterator would be the intersection of the particular music 
+  construct with one point in musical time.
+ */
 class Music_iterator {
-  Array<Translator_group*>report_to_l_arr_;
-  void push_translator (Translator_group*);
-  void pop_translator();
+  Interpretation_context_handle handle_;
+
 protected:
+  Music const * music_l_;
   bool first_b_;
+
+  /**
+    Do the actual printing.  This should be overriden in derived classes.  It 
+    is called by #print#, in the public interface
+   */
   virtual void do_print() const;
     
+  /**
+    Find a bottom notation context to deliver requests to.
+   */
   virtual Translator_group* get_req_translator_l();
-  Music_iterator* get_iterator_p (Music*) const;
+
+  /**
+    Get an iterator for MUS, inheriting the translation unit from THIS.
+   */
+  Music_iterator* get_iterator_p (Music const*mus) const;
   void set_translator (Translator_group*);
-  Music_iterator *daddy_iter_l_;
-    
+
+  /** Do the actual reporting.  This should be overriden in derived
+    classes.  It is called by #process_and_next#, the public interface 
+    */
+  virtual void do_process_and_next (Moment until);
+
 public:
+
+  /**
+    The translation unit that we this iterator is reporting  to now.
+   */
   Translator_group*report_to_l() const;
-  DECLARE_MY_RUNTIME_TYPEINFO;
- 
-  static Music_iterator* static_get_iterator_p (Music*,Translator_group*);
+
+  
+  /** Get an iterator matching the type of MUS, and use TRANS to find
+    an accompanying translation unit
+   */
+  static Music_iterator* static_get_iterator_p (Music const* mus,Translator_group* trans);
+
   Music_iterator();
     
-  virtual void process_and_next (Moment until);
+  ///  Find the next interesting point in time.
   virtual Moment next_moment() const;
+
+  ///Are we finished with this piece of music?
   virtual bool ok() const;
+
   virtual ~Music_iterator();
 
+
+  ///Report all musical information that occurs between now and UNTIL
+  void process_and_next (Moment until);
+
   /**
     Construct sub-iterators, and set the translator to 
-    report to
+    report to.
    */
   virtual void construct_children();
   void print() const;