/*
- 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--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
*/
#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"
+#include "cxx-function-smob.hh"
-class Music_iterator {
-protected:
- bool first_b_;
- virtual void do_print()const;
-
-public:
- Music_iterator *daddy_iter_l_;
- NAME_MEMBERS();
- Register_group_register *report_to_reg_l_;
-
- static Music_iterator* static_get_iterator_p(Music*,Register_group_register*);
- Music_iterator* get_iterator_p(Music*)const;
- void set_reg(Register_group_register*);
- 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 Register_group_register * get_req_acceptor_l();
-};
+/**
+ 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.
-// 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;
+
+ 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, this->ok () holds). Side-effects:
- virtual void do_print()const;
- virtual void next(Moment);
-};
+ * This removes all events at M from the pending queue.
-class Change_iterator : public Music_iterator {
- Change_reg * change_l_;
-public:
- NAME_MEMBERS();
- virtual void next(Moment);
- Change_iterator(Change_reg*);
-};
+ * Typically this reports the music to an interpretation context,
+ thus changing the state of the interpretation context.
-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;
-};
+ get_music (M) -- return all events starting at M (pre: no events
+ before M). No side-effects
-class Voice_element_iterator : public Chord_iterator {
+ skip (M) -- remove all events starting before M (leave the ones that
+ start M). no side-effects on interpretation context
-protected:
- virtual void construct_children();
-public:
- Voice_element_iterator(Voice_element*);
- NAME_MEMBERS();
-};
+ TODO:
-class Voice_iterator : private PCursor<Music*>, public Music_iterator
+ merge pending_moment and process?
+
+*/
+class 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;
+ Moment music_length_;
+ Moment start_mom_;
+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,
+ 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;
+
+ 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);
+ void init_translator (Music *, 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);
+
+ /**
+ Construct sub-iterators, and set the translator to
+ report to.
+ */
+ virtual void construct_children ();
+ static SCM constructor_cxx_function;
+
+ /**
+ Get an iterator for MUS, inheriting the translation unit from THIS.
+ */
+ Music_iterator* get_iterator_p (Music *) const;
+
+ virtual Music_iterator* try_music_in_children (Music *) const;
+
+ Music * music_l () const;
+private:
+ Interpretation_context_handle handle_;
+ Music * music_l_;
};
+
+/*
+ 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
projects / lilypond.git / blobdiff