release: 1.3.138

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

diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh
index 25d099ecccd105416885da1ceb89a8d829aebad8..4041b5d028f46cd442b269108b762f1c7b86afdc 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--2001 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
@@ -15,6 +15,7 @@
 #include "moment.hh"
 #include "virtual-methods.hh"
 #include "interpretation-context-handle.hh"
+#include "cxx-function-smob.hh"
 
 /** 
   Conceptually a music-iterator operates on a queue of musical events
@@ -25,9 +26,10 @@
   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.
 
@@ -35,16 +37,26 @@
     thus changing the state of the interpretation context.
 
   get_music (M) -- return all events starting at M (pre: no events
-    before M).
+    before M). No side-effects
 
-  skip (M) -- remove all events at M from the pending queue.
+  skip (M) -- remove all events starting before M (leave the ones that
+    start M).  no side-effects on interpretation context
 
+
+  TODO:
+
+  merge pending_moment and process?
+  
 */
 class Music_iterator
 {
+protected:
+  Moment music_length_;
+
 public:
   VIRTUAL_COPY_CONS (Music_iterator);
 
+  Moment music_length_mom () const;
   Music_iterator ();
   Music_iterator (Music_iterator const&);
   virtual ~Music_iterator ();
@@ -54,7 +66,7 @@ public:
      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.
    */
@@ -79,7 +91,8 @@ public:
     report to.
    */
   virtual void construct_children ();
-
+  static SCM constructor_cxx_function;
+  
 protected:
   Music  * music_l_;
 
@@ -94,4 +107,32 @@ private:
   Interpretation_context_handle handle_;
 };
 
+
+/*
+  implement Class::constructor, a SCM function that
+  returns an encapsulated factory function.
+ */
+#define IMPLEMENT_CTOR_CALLBACK(Class)         \
+static void *                                          \
+Class ## _ctor (SCM)                           \
+{                                              \
+  return new Class ;                           \
+}                                              \
+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); 
+
+ 
+
+
+
+
+
 #endif // MUSIC_ITERATOR_HH