lily/include/sequential-iterator.hh

   1 /*
   2   sequential-iterator.hh -- declare Sequential_iterator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2002--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #ifndef SEQUENTIAL_ITERATOR_HH
  10 #define SEQUENTIAL_ITERATOR_HH
  11
  12 #include "music-iterator.hh"
  13 #include "protected-scm.hh"
  14
  15 /*
  16
  17   This is a lookahead list for grace notes.
  18
  19    {  ... X \grace Y  Z ... }
  20
  21    normally, the ending of X is the start of Z. In case of a grace
  22    note, we take off a little at the end of X. What is stored: START
  23    (start point of X), LENGTH (length of X), GRACE_START (start_music
  24    of Y), and the next fixup element.
  25
  26   This is also done for nested musics, i.e.
  27
  28   voiceA = \notes { \grace b16 c'2 }
  29   voiceB = \notes { c'2 \voiceA }
  30
  31   the iterator for voiceB will contain a fixup entry with (START=0/1,
  32   LENGTH=2/1, GRACE_START=(0G-1/16) )
  33
  34   Graces at the start of a sequential music iterator are handled
  35   by initting here_mom_ with Music::start_music (); no fixups are needed.
  36
  37 */
  38 struct Grace_fixup
  39 {
  40   Moment start_;
  41   Moment length_;
  42
  43   Rational grace_start_;
  44   Grace_fixup *next_;
  45 };
  46
  47 /** Sequential_music iteration: walk each element in turn, and
  48   construct an iterator for every element.
  49
  50  */
  51 class Sequential_iterator :  public Music_iterator
  52 {
  53 public:
  54   Grace_fixup * grace_fixups_;
  55
  56   DECLARE_SCHEME_CALLBACK(constructor, ());
  57   Sequential_iterator ();
  58   Sequential_iterator (Sequential_iterator const&);
  59   virtual void derived_substitute (Translator_group*f, Translator_group*t) ;
  60
  61   virtual void derived_mark () const;
  62
  63   virtual void construct_children ();
  64   virtual Moment pending_moment () const;
  65   virtual void do_quit();
  66   virtual bool ok () const;
  67
  68 protected:
  69   virtual void process (Moment);
  70   virtual Music_iterator *try_music_in_children (Music *) const;
  71   virtual bool run_always () const;
  72 protected:
  73   Moment here_mom_;
  74   Music_iterator * iter_;
  75   SCM  list_;
  76   SCM cursor_;
  77
  78   virtual void next_element (bool side_effect);
  79   virtual void descend_to_child ();
  80   virtual SCM get_music_list ()const;
  81 };
  82
  83 #endif /* SEQUENTIAL_ITERATOR_HH */