X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fmusic-iterator.hh;h=37c2242aa602e22f4b3dfdb5f52904f2f37f7d8a;hb=545092a25d8ca41dc90b87482474b3719f7130a9;hp=e49777a659fad1572a1eb4d24e94aa40e39e1cc5;hpb=b9fc4bb5b3ce7d75e7e5284352eeaa04bbe78e14;p=lilypond.git diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh index e49777a659..37c2242aa6 100644 --- a/lily/include/music-iterator.hh +++ b/lily/include/music-iterator.hh @@ -3,19 +3,16 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2003 Han-Wen Nienhuys + (c) 1997--2005 Han-Wen Nienhuys */ - #ifndef MUSIC_ITERATOR_HH #define MUSIC_ITERATOR_HH -#include "lily-proto.hh" #include "array.hh" #include "moment.hh" #include "virtual-methods.hh" -#include "interpretation-context-handle.hh" -#include "smobs.hh" +#include "context-handle.hh" /** --- @@ -26,36 +23,29 @@ --- - - 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 ? + 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: - - * This removes all events at M from the pending queue. + pending_mom () -- time tag of the next event to be processed. + PRECONDITION: this->ok () holds. - * Typically this reports the music to an interpretation context, - thus changing the state of the interpretation context. + process (M) -- process all at M (Precondition: no events exist + before M, this->ok () holds). Side-effects: - get_pending_events (M) -- return all events starting at M (pre: no events - before M). No side-effects + * This removes 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 + * Typically this reports the music to an interpretation context, + thus changing the state of the interpretation context. - TODO: + TODO: - merge pending_moment and process? - + merge pending_moment and process? */ class Music_iterator { @@ -63,80 +53,55 @@ protected: Moment music_length_; Moment start_mom_; - DECLARE_SMOBS (Music_iterator,dummy); + DECLARE_CLASSNAME(Music_iterator); + DECLARE_SMOBS (Music_iterator, dummy); + Music_iterator (Music_iterator const &); + public: - VIRTUAL_COPY_CONS (Music_iterator); - Moment music_get_length () const; Moment music_start_mom () const; Music_iterator (); - Music_iterator (Music_iterator 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. - */ - 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 SCM get_static_get_iterator (Music * mus); - void init_translator (Music *, Translator_group *); -void quit (); - - + Music_iterator *try_music (Music *) const; + Context *get_outlet () const; + void set_context (Context *); + 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; - - virtual bool run_always () const; - virtual SCM get_pending_events (Moment until)const; + virtual bool run_always () const; virtual void process (Moment until); - virtual void skip (Moment until); - virtual void derived_mark ()const; + 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. - */ + DECLARE_SCHEME_CALLBACK (constructor, ()); SCM get_iterator (Music *) const; - virtual Music_iterator* try_music_in_children (Music *) const; + virtual Music_iterator *try_music_in_children (Music *) const; - Music * get_music () const; + Music *get_music () const; protected: - virtual void do_quit(); + virtual void do_quit (); + void descend_to_child (Context *); + private: - Interpretation_context_handle handle_; - Music * music_; + Context_handle handle_; + Music *music_; }; +bool is_child_context (Context *me, Context *child); -#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 ; \ -} \ +#define IMPLEMENT_CTOR_CALLBACK(Class) \ + LY_DEFINE_MEMBER_FUNCTION (Class, constructor, #Class "::constructor", \ + 0, 0, 0, \ + (), \ + "") \ + { \ + Class *c = (new Class); \ + return c->unprotect (); \ + } -DECLARE_UNSMOB(Music_iterator, iterator); +DECLARE_UNSMOB (Music_iterator, iterator); #endif // MUSIC_ITERATOR_HH