release: 1.1.43

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

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index d2326a6e53639f9e0e05b62a37e462ce93150b82..c6a8e9a7d8fd1e9efbdb8ea38c9e06148179b9c4 100644 (file)
--- a/lily/include/music-iterator.hh
+++ b/lily/include/music-iterator.hh
@@ -1,9 +1,9 @@
 /*
-  music-iterator.hh -- declare {Music,Chord,Voice}_iterator
+  music-iterator.hh -- declare Music_iterator
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -11,96 +11,84 @@
 #define MUSIC_ITERATOR_HH
 
 #include "lily-proto.hh"
-#include "plist.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 class 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 {
-protected:
-    bool first_b_;
-    virtual void do_print()const;
-    
-public:
-    Music_iterator *daddy_iter_l_;
-    NAME_MEMBERS();
-    Acceptor *report_to_l_;
-    
-    static Music_iterator* static_get_iterator_p(Music*,Acceptor*);
-    Music_iterator* get_iterator_p(Music*)const;
-    void set_acceptor(Acceptor*);
-    Music_iterator();
-    virtual void next(Moment until);
-    virtual Moment next_moment()const;
-    virtual bool ok()const;
-    virtual ~Music_iterator();
-    virtual void construct_children();
-    void print()const;
-    virtual Acceptor * get_req_acceptor_l();
-};
+  Interpretation_context_handle handle_;
 
-// duh.
-class Request_iterator : public Music_iterator {
-    Request  *req_l_;
-    bool last_b_;
-public:
-    Request_iterator(Request const *);
-    NAME_MEMBERS();
 protected:
-    virtual bool ok() const;
-    virtual Moment next_moment() const;
+  Music const * music_l_;
+
+  /// ugh. JUNKME
+  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;
     
-    virtual void do_print()const;
-    virtual void next(Moment);
-};
+  /**
+    Find a bottom notation context to deliver requests to.
+   */
+  virtual Translator_group* get_req_translator_l();
 
-class Change_iterator : public Music_iterator {
-    Change_reg * change_l_;
-public:
-     NAME_MEMBERS();
-    virtual void next(Moment);
-    Change_iterator(Change_reg*);
-};
+  /**
+    Get an iterator for MUS, inheriting the translation unit from THIS.
+   */
+  Music_iterator* get_iterator_p (Music const*mus) const;
+
+  /** 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);
 
-class Chord_iterator : public Music_iterator
-{
-    const Chord *chord_C_;
-    Pointer_list<Music_iterator*> children_p_list_;
 public:
-    Chord_iterator(Chord const*);
-    NAME_MEMBERS();
-protected:
-    virtual void do_print()const;
-    virtual void construct_children();
-    virtual void next(Moment);
-    virtual Moment next_moment()const;
-    virtual bool ok()const;
-};
 
-class Voice_element_iterator : public Chord_iterator {
+  /**
+    The translation unit that we this iterator is reporting  to now.
+   */
+  Translator_group*report_to_l() const;
 
-protected:
-    virtual void construct_children();
-public:
-    Voice_element_iterator(Voice_element*);
-    NAME_MEMBERS();
-};
+  void set_translator (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);
+  void init_translator (Music const *, Translator_group *); 
+
+  Music_iterator();
+    
+  ///  Find the next interesting point in time.
+  virtual Moment next_moment() const;
 
+  ///Are we finished with this piece of music?
+  virtual bool ok() const;
 
-class Voice_iterator :  private PCursor<Music*>, public Music_iterator
-{
-    Moment here_mom_;
-    const Voice * voice_C_;
-    Music_iterator * iter_p_;
-    void next_element();
-public:
-    Voice_iterator(Voice const*);
-    NAME_MEMBERS();
-protected:
-    virtual void do_print()const;
-    virtual void construct_children();
-    ~Voice_iterator();    
-    virtual void next(Moment);
-    virtual Moment next_moment()const;
-    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.
+   */
+  virtual void construct_children();
+  void print() const;
 };
 
 #endif // MUSIC_ITERATOR_HH