2003 -> 2004

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

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index 25d099ecccd105416885da1ceb89a8d829aebad8..7d7c5eef2a459c1f7679a442fd981ee523d639f2 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--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -15,8 +15,18 @@
 #include "moment.hh"
 #include "virtual-methods.hh"
 #include "interpretation-context-handle.hh"
+#include "smobs.hh"
 
-/** 
+/**
+   ---
+
+   Music_iterator is an object type that traverses the Music structure and
+   reports the events it finds to interpretation contexts. It is not yet
+   user-serviceable.
+
+
+   ---
+       
   Conceptually a music-iterator operates on a queue of musical events
   that are pending. This queue does not actually exist, but it is a
   way of viewing and traversing music-expressions.
@@ -25,73 +35,99 @@
   ok () -- events left ?
 
   pending_mom () -- time tag of the next event to be processed.
+    PRECONDITION: this->ok () holds.
   
-  process (M) -- process all at M (Precondition: no events exist before
-    M).  Side-effects:
+  process (M) -- process all at M (Precondition: no events exist
+    before M, this->ok () holds).  Side-effects:
     
     * This removes all events at M from the pending queue.
 
     * Typically this reports the music to an interpretation context,
     thus changing the state of the interpretation context.
 
-  get_music (M) -- return all events starting at M (pre: no events
-    before M).
 
-  skip (M) -- remove all events at M from the pending queue.
+  TODO:
 
+  merge pending_moment and process?
+  
 */
 class Music_iterator
 {
-public:
-  VIRTUAL_COPY_CONS (Music_iterator);
+protected:
+  Moment music_length_;
+  Moment start_mom_;
 
-  Music_iterator ();
+  DECLARE_SMOBS (Music_iterator,dummy);
   Music_iterator (Music_iterator const&);
-  virtual ~Music_iterator ();
+public:
+  
+  Moment music_get_length () const;
+  Moment music_start_mom () const;
+  Music_iterator ();
 
   /**
      Do the reporting.  Will try MUSIC_L_ in its own translator first,
      then its children. Returns the iterator that succeeded
   */
   Music_iterator *  try_music (Music  *) const;
-
+  
   /**
     The translation unit that we this iterator is reporting  to now.
    */
-  Translator_group* report_to_l () const;
+  Translator_group* get_outlet () const;
 
   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 * mus);
+  static SCM get_static_get_iterator (Music * mus);
   void init_translator (Music  *, Translator_group *); 
-
+  void quit ();
+  void substitute_outlet (Translator_group* from, Translator_group *to);
+  virtual void derived_substitute (Translator_group*, Translator_group*);
   virtual Moment pending_moment () const;
   virtual bool ok () const;
-  virtual SCM get_music (Moment until)const;
-  virtual void process (Moment until);
-  virtual void skip (Moment until);
 
+  virtual bool run_always () const; 
+  virtual void process (Moment until);
+  virtual void derived_mark ()const;
+  virtual void construct_children ();
+  
   /**
     Construct sub-iterators, and set the translator to 
     report to.
    */
-  virtual void construct_children ();
-
-protected:
-  Music  * music_l_;
 
+  DECLARE_SCHEME_CALLBACK(constructor, ());
+  
   /**
     Get an iterator for MUS, inheriting the translation unit from THIS.
    */
-  Music_iterator* get_iterator_p (Music *) const;
+  SCM get_iterator (Music *) const;
 
   virtual Music_iterator* try_music_in_children (Music *) const;
 
+  Music * get_music () const;
+protected:
+  virtual void do_quit();
 private:
   Interpretation_context_handle handle_;
+  Music  * music_;
 };
 
+
+#define IMPLEMENT_CTOR_CALLBACK(Class)         \
+LY_DEFINE_MEMBER_FUNCTION(Class,constructor, #Class "::constructor",\
+         0,0,0,\
+         (),\
+         "Construct a @code{" #Class "} music iterator")\
+{                                              \
+  SCM val = (new Class)->self_scm();   \
+  scm_gc_unprotect_object (val);\
+  return val ;                         \
+}                                              \
+
+DECLARE_UNSMOB(Music_iterator, iterator);
+
 #endif // MUSIC_ITERATOR_HH