X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Fmusic-iterator.hh;h=a34e3009037120f66baeeda9104d27a753ffe43a;hb=09ae845ea458bc35ffa486b4bcac25c88e2fb856;hp=019976f8484f70e1c73444f4f701babfaaa02d0a;hpb=94189ec2b8da6d7e89dc619c646a927adead9b19;p=lilypond.git diff --git a/lily/include/music-iterator.hh b/lily/include/music-iterator.hh index 019976f848..a34e300903 100644 --- a/lily/include/music-iterator.hh +++ b/lily/include/music-iterator.hh @@ -1,138 +1,118 @@ /* - music-iterator.hh -- declare Music_iterator + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2012 Han-Wen Nienhuys - (c) 1997--2001 Han-Wen Nienhuys -*/ + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #ifndef MUSIC_ITERATOR_HH #define MUSIC_ITERATOR_HH -#include "lily-proto.hh" -#include "array.hh" +#include "std-vector.hh" #include "moment.hh" #include "virtual-methods.hh" -#include "interpretation-context-handle.hh" -#include "cxx-function-smob.hh" +#include "context-handle.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. - - 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. + 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. - * 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 - before M). No side-effects + ok () -- events left ? - skip (M) -- remove all events starting before M (leave the ones that - start M). no side-effects on interpretation context + 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: - TODO: + * This removes all events at M from the pending queue. - merge pending_moment and process? - + * Typically this reports the music to an interpretation context, + thus changing the state of the interpretation context. + + + TODO: + + merge pending_moment and process? */ class Music_iterator { protected: Moment music_length_; + Moment start_mom_; -public: - VIRTUAL_COPY_CONS (Music_iterator); + DECLARE_CLASSNAME (Music_iterator); + DECLARE_SMOBS (Music_iterator); + Music_iterator (Music_iterator const &); - Moment music_length_mom () const; +public: + Moment music_get_length () 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 *); - + void report_event (Music *); + Context *get_outlet () const; + void set_context (Context *); + static SCM get_static_get_iterator (Music *mus); + void init_context (Music *, Context *); + void quit (); + void substitute_outlet (Context *from, Context *to); + void descend_to_bottom_context (); + virtual void derived_substitute (Context *, Context *); virtual Moment pending_moment () const; virtual bool ok () const; - virtual SCM get_music (Moment until)const; + virtual bool run_always () const; virtual void process (Moment until); - virtual void skip (Moment until); - - /** - Construct sub-iterators, and set the translator to - report to. - */ + virtual void derived_mark () const; virtual void construct_children (); - static SCM constructor_cxx_function; - -protected: - Music * music_l_; + DECLARE_SCHEME_CALLBACK (constructor, ()); + SCM get_iterator (Music *) const; - /** - 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 *get_music () const; +protected: + virtual void do_quit (); + void descend_to_child (Context *); private: - Interpretation_context_handle handle_; + Context_handle handle_; + Music *music_; }; +bool is_child_context (Context *me, Context *child); -/* - 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); - - - - - +#define IMPLEMENT_CTOR_CALLBACK(Class) \ + LY_DEFINE_MEMBER_FUNCTION (Class, constructor, \ + mangle_cxx_identifier (string (#Class) + "::constructor").c_str(), \ + 0, 0, 0, \ + (), \ + "") \ + { \ + Class *c = (new Class); \ + return c->unprotect (); \ + } +DECLARE_UNSMOB (Music_iterator, iterator); #endif // MUSIC_ITERATOR_HH