lily/include/music-iterator.hh

   1 /*
   2   music-iterator.hh -- declare Music_iterator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #ifndef MUSIC_ITERATOR_HH
  11 #define MUSIC_ITERATOR_HH
  12
  13 #include "lily-proto.hh"
  14 #include "array.hh"
  15 #include "moment.hh"
  16 #include "virtual-methods.hh"
  17 #include "interpretation-context-handle.hh"
  18
  19 /** Walk through music and deliver music to translation units, synced
  20   in time.  This class provides both the implementation of the shared
  21   code, and the public interface.
  22
  23   Derived classes should only have a public constructor.
  24   The state of an iterator would be the intersection of the particular music
  25   construct with one point in musical time.
  26  */
  27 class Music_iterator
  28 {
  29 public:
  30   VIRTUAL_COPY_CONS (Music_iterator);
  31
  32   Music_iterator ();
  33   Music_iterator (Music_iterator const&);
  34   virtual ~Music_iterator ();
  35
  36   /**
  37      Do the reporting.  Will try MUSIC_L_ in its own translator first,
  38      then its children. Returns the iterator that succeeded
  39   */
  40   Music_iterator *  try_music (Music  *) const;
  41
  42   /**
  43     The translation unit that we this iterator is reporting  to now.
  44    */
  45   Translator_group*report_to_l () const;
  46
  47   void set_translator (Translator_group*);
  48
  49   /** Get an iterator matching the type of MUS, and use TRANS to find
  50     an accompanying translation unit
  51    */
  52   static Music_iterator* static_get_iterator_p (Music * mus);
  53   void init_translator (Music  *, Translator_group *);
  54
  55   ///  Find the next interesting point in time.
  56   virtual Moment next_moment () const;
  57
  58
  59   ///Are we finished with this piece of music?
  60   virtual bool ok () const;
  61
  62   virtual Music* get_music ();
  63   virtual bool next ();
  64
  65   ///Report all musical information that occurs between now and UNTIL
  66   void process_and_next (Moment until);
  67
  68   /**
  69     Construct sub-iterators, and set the translator to
  70     report to.
  71    */
  72   virtual void construct_children ();
  73   void print () const;
  74
  75 protected:
  76   Music  * music_l_;
  77
  78   /// ugh. JUNKME
  79   bool first_b_;
  80
  81   /**
  82     Do the actual printing.  This should be overriden in derived classes.  It
  83     is called by #print#, in the public interface
  84    */
  85   virtual void do_print () const;
  86
  87   /**
  88     Find a bottom notation context to deliver requests to.
  89    */
  90   virtual Translator_group* get_req_translator_l ();
  91
  92   /**
  93     Get an iterator for MUS, inheriting the translation unit from THIS.
  94    */
  95   Music_iterator* get_iterator_p (Music *) const;
  96
  97   /** Do the actual move.  This should be overriden in derived
  98     classes.  It is called by #process_and_next#, the public interface
  99     */
 100   virtual void do_process_and_next (Moment until);
 101
 102   virtual Music_iterator* try_music_in_children (Music *) const;
 103
 104 private:
 105   Interpretation_context_handle handle_;
 106 };
 107
 108 #endif // MUSIC_ITERATOR_HH