lily/include/music-wrapper-iterator.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef MUSIC_WRAPPER_ITERATOR_HH
  21 #define MUSIC_WRAPPER_ITERATOR_HH
  22
  23 #include "music-iterator.hh"
  24
  25 /**
  26    The iterator for a #Music_wrapper#.  Since #Music_wrapper# essentially
  27    does nothing, this iterator creates a child iterator and delegates
  28    all work to that child.
  29 */
  30 class Music_wrapper_iterator : public Music_iterator
  31 {
  32 public:
  33   DECLARE_SCHEME_CALLBACK (constructor, ());
  34   Music_wrapper_iterator ();
  35   DECLARE_CLASSNAME(Music_wrapper_iterator);
  36
  37   virtual void derived_substitute (Context *f, Context *t);
  38   virtual void derived_mark () const;
  39   virtual void construct_children ();
  40   virtual Moment pending_moment () const;
  41   virtual void do_quit ();
  42   virtual bool ok () const;
  43   virtual bool run_always () const;
  44 protected:
  45   virtual void process (Moment);
  46
  47   Music_iterator *child_iter_;
  48 };
  49
  50 #endif /* MUSIC_WRAPPER_ITERATOR_HH */
  51