* VERSION (MY_PATCH_LEVEL): make 1.7.0

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

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index 4041b5d028f46cd442b269108b762f1c7b86afdc..e005bd60d395c5f71bddc6c7a6548721e2f6633f 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--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -15,9 +15,18 @@
 #include "moment.hh"
 #include "virtual-methods.hh"
 #include "interpretation-context-handle.hh"
-#include "cxx-function-smob.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.
@@ -36,7 +45,7 @@
     * 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
+  get_pending_events (M) -- return all events starting at M (pre: no events
     before M). No side-effects
 
   skip (M) -- remove all events starting before M (leave the ones that
@@ -52,14 +61,16 @@ class Music_iterator
 {
 protected:
   Moment music_length_;
+  Moment start_mom_;
 
+  DECLARE_SMOBS (Music_iterator,dummy);
 public:
   VIRTUAL_COPY_CONS (Music_iterator);
-
+  
   Moment music_length_mom () const;
+  Moment music_start_mom () const;
   Music_iterator ();
   Music_iterator (Music_iterator const&);
-  virtual ~Music_iterator ();
 
   /**
      Do the reporting.  Will try MUSIC_L_ in its own translator first,
@@ -70,69 +81,60 @@ public:
   /**
     The translation unit that we this iterator is reporting  to now.
    */
-  Translator_group* report_to_l () const;
+  Translator_group* report_to () 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 ();
 
+  
   virtual Moment pending_moment () const;
   virtual bool ok () const;
-  virtual SCM get_music (Moment until)const;
+  virtual SCM get_pending_events (Moment until)const;
   virtual void process (Moment until);
   virtual void skip (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 ();
-  static SCM constructor_cxx_function;
-  
-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_;
 };
 
 
-/*
-  implement Class::constructor, a SCM function that
-  returns an encapsulated factory function.
- */
 #define IMPLEMENT_CTOR_CALLBACK(Class)         \
-static void *                                          \
-Class ## _ctor (SCM)                           \
+LY_DEFINE_MEMBER_FUNCTION(Class,constructor, #Class "::constructor",\
+         0,0,0,\
+         (),\
+         "Construct a " #Class " music iterator")\
 {                                              \
-  return new Class ;                           \
+  SCM val = (new Class)->self_scm();   \
+  scm_gc_unprotect_object (val);\
+  return val ;                         \
 }                                              \
-SCM Class :: constructor_cxx_function;\
-void                                           \
-Class ## _constructor_init ()                          \
-{                                              \
-  SCM s = smobify_cxx_function (& Class ## _ctor);     \
-  scm_permanent_object (s);\
-  gh_define (#Class "::constructor", s);\
-  Class :: constructor_cxx_function = s;\
-}\
-ADD_SCM_INIT_FUNC (Class ## _ctor_init, Class ## _constructor_init); 
-
- 
-
-
-
 
+DECLARE_UNSMOB(Music_iterator, iterator);
 
 #endif // MUSIC_ITERATOR_HH