X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fmusic-iterator.hh;h=5622e1660184976d52cc2255b2ce937bcba699c0;hb=94b46751bb219ecfe55543c4030c4dd2d9c2ca74;hp=143587be88af2f4efad572c6352ce04e3cd151d1;hpb=6ce61146edb1c36647b514778c29cdc9beedab6a;p=lilypond.git diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh index 143587be88..5622e16601 100644 --- 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 + (c) 1997--2004 Han-Wen Nienhuys */ @@ -11,97 +11,123 @@ #define MUSIC_ITERATOR_HH #include "lily-proto.hh" -#include "plist.hh" -#include "varray.hh" +#include "array.hh" #include "moment.hh" +#include "virtual-methods.hh" +#include "interpretation-context-handle.hh" +#include "smobs.hh" -class Music_iterator { -protected: - bool first_b_; - virtual void do_print()const; - -public: - Music_iterator *daddy_iter_l_; - NAME_MEMBERS(); - Arrayreport_to_l_arr_; +/** + --- - Translator *report_to_l()const; - - static Music_iterator* static_get_iterator_p(Music*,Translator*); - Music_iterator* get_iterator_p(Music*)const; - void set_translator(Translator*); - void push_translator(Translator*); - void pop_translator(); + 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. + + + 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: - Music_iterator(); - - virtual void process_and_next(Moment until); - virtual Moment next_moment()const; - virtual bool ok()const; - virtual ~Music_iterator(); - virtual void construct_children(); - void print()const; - virtual Translator * get_req_translator_l(); -}; + * 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 process_and_next(Moment); - Change_iterator(Change_reg*); -}; + * Typically this reports the music to an interpretation context, + thus changing the state of the interpretation context. + + + TODO: -class Chord_iterator : public Music_iterator + merge pending_moment and process? + +*/ +class Music_iterator { - const Chord *chord_C_; - Pointer_list children_p_list_; -public: - ~Chord_iterator(); - Chord_iterator(Chord const*); - NAME_MEMBERS(); protected: - virtual void do_print()const; - virtual void construct_children(); - virtual void process_and_next(Moment); - virtual Moment next_moment()const; - virtual bool ok()const; -}; + Moment music_length_; + Moment start_mom_; -class Voice_element_iterator : public Music_iterator { - const Voice_element * elt_l_; - Moment elt_duration_; - bool last_b_; + DECLARE_SMOBS (Music_iterator,dummy); + Music_iterator (Music_iterator const&); public: - Voice_element_iterator(Voice_element*); - NAME_MEMBERS(); + + Moment music_get_length () const; + virtual Moment music_start_mom () const; + Music_iterator (); -protected: - virtual void process_and_next(Moment); - virtual Moment next_moment()const; - virtual void construct_children(); - virtual bool ok()const; - virtual void do_print()const; -}; + /** + 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. + */ + Context * get_outlet () const; + void set_translator (Context *); + + /** Get an iterator matching the type of MUS, and use TRANS to find + an accompanying translation unit + */ + static SCM get_static_get_iterator (Music * mus); + void init_translator (Music *, Context *); + void quit (); + void substitute_outlet (Context * from, Context *to); + virtual void derived_substitute (Context *, Context *); + virtual Moment pending_moment () const; + virtual bool ok () const; -class Voice_iterator : private PCursor, public Music_iterator -{ - Moment here_mom_; - const Voice * voice_C_; - Music_iterator * iter_p_; - void next_element(); -public: - Voice_iterator(Voice const*); - NAME_MEMBERS(); + 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. + */ + + DECLARE_SCHEME_CALLBACK(constructor, ()); + + /** + Get an iterator for MUS, inheriting the translation unit from THIS. + */ + SCM get_iterator (Music *) const; + + virtual Music_iterator* try_music_in_children (Music *) const; + + Music * get_music () const; protected: - virtual void do_print()const; - virtual void construct_children(); - ~Voice_iterator(); - virtual void process_and_next(Moment); - virtual Moment next_moment()const; - virtual bool ok()const; + 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