/*
- 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--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
- (c) 1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-*/
+ 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 <http://www.gnu.org/licenses/>.
+*/
#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 "context-handle.hh"
-/** Walk through music and deliver music to translation units, synced
- in time. This class provides both the implementation of the shared
- code, and the public interface.
+/**
+ ---
- Derived classes should only have a public constructor.
- The state of an iterator would be the intersection of the particular music
- construct with one point in musical time.
- */
-class Music_iterator {
- Interpretation_context_handle handle_;
+ 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.
-protected:
- bool playback_b_; // Should use SCMs
-
- Music const * music_l_;
-
- /// ugh. JUNKME
- bool first_b_;
-
- /**
- Do the actual printing. This should be overriden in derived classes. It
- is called by #print#, in the public interface
- */
- virtual void do_print() const;
-
- /**
- Find a bottom notation context to deliver requests to.
- */
- virtual Translator_group* get_req_translator_l();
-
- /**
- Get an iterator for MUS, inheriting the translation unit from THIS.
- */
- Music_iterator* get_iterator_p (Music const*mus) const;
-
- /** Do the actual move. This should be overriden in derived
- classes. It is called by #process_and_next#, the public interface
- */
- virtual void do_process_and_next (Moment until);
-
-
- virtual Music_iterator* try_music_in_children (Music const *) const;
-
-public:
- /**
- 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 *) const;
+ ok () -- events left ?
- /**
- The translation unit that we this iterator is reporting to now.
- */
- Translator_group*report_to_l() const;
+ pending_mom () -- time tag of the next event to be processed.
+ PRECONDITION: this->ok () holds.
- void set_translator (Translator_group*);
-
- /** Get an iterator matching the type of MUS, and use TRANS to find
- an accompanying translation unit. Repeated music can be fully
- unfolded by setting PLAYING */
- static Music_iterator* static_get_iterator_p (Music const* mus, bool playing);
- void init_translator (Music const *, Translator_group *);
+ process (M) -- process all at M (Precondition: no events exist
+ before M, this->ok () holds). Side-effects:
- Music_iterator();
-
- /// Find the next interesting point in time.
- virtual Moment next_moment() const;
+ * This removes all events at M from the pending queue.
+ * Typically this reports the music to an interpretation context,
+ thus changing the state of the interpretation context.
- ///Are we finished with this piece of music?
- virtual bool ok() const;
- virtual ~Music_iterator();
+ TODO:
+ merge pending_moment and process?
+*/
+class Music_iterator
+{
+protected:
+ Moment music_length_;
+ Moment start_mom_;
- ///Report all musical information that occurs between now and UNTIL
- void process_and_next (Moment until);
+ DECLARE_CLASSNAME (Music_iterator);
+ DECLARE_SMOBS (Music_iterator);
+ Music_iterator (Music_iterator const &);
+
+public:
+ Moment music_get_length () const;
+ Moment music_start_mom () const;
+ Music_iterator ();
+ 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 bool run_always () const;
+ virtual void process (Moment until);
+ virtual void derived_mark () const;
+ virtual void construct_children ();
+ DECLARE_SCHEME_CALLBACK (constructor, ());
+ SCM get_iterator (Music *) const;
+
+ Music *get_music () const;
+protected:
+ virtual void do_quit ();
+ void descend_to_child (Context *);
- /**
- Construct sub-iterators, and set the translator to
- report to.
- */
- virtual void construct_children();
- void print() const;
+private:
+ Context_handle handle_;
+ Music *music_;
};
+bool is_child_context (Context *me, Context *child);
+
+#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
projects / lilypond.git / blobdiff