lily/sequential-iterator.cc

   1 /*
   2   Sequential_iterator.cc -- implement Sequential_iterator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "translator-group.hh"
  10 #include "context.hh"
  11 #include "sequential-iterator.hh"
  12 #include "music-list.hh"
  13 #include "grace-fixup.hh"
  14
  15 /*
  16
  17   TODO: handling of grace notes is exquisite pain.  This handling
  18   should be formally specified and then the implementation verified.
  19
  20 */
  21
  22 /*
  23   Invariant for the data structure.
  24
  25
  26   if (gh_pair_p (cursor_))
  27     iter_->music_ == unsmob_music (ly_car (cursor_))
  28   else
  29     iter_ == 0;
  30
  31   The length of musiclist from start to up to cursor_ (cursor_ not
  32   including), is summed
  33
  34   here_mom_  = sum (length (musiclist [start ... cursor>))  %)
  35
  36  */
  37 Sequential_iterator::Sequential_iterator ()
  38 {
  39   here_mom_ = Moment (0);
  40   cursor_ = SCM_EOL;
  41   grace_fixups_ = 0;
  42   iter_ = 0;
  43 }
  44
  45 SCM
  46 Sequential_iterator::get_music_list () const
  47 {
  48   return SCM_EOL;
  49 }
  50
  51 void
  52 Sequential_iterator::do_quit ()
  53 {
  54   if (iter_)
  55     iter_->quit ();
  56 }
  57
  58
  59
  60
  61 void
  62 Sequential_iterator::derived_mark () const
  63 {
  64   if (iter_)
  65     scm_gc_mark (iter_->self_scm ());
  66   scm_gc_mark (cursor_);
  67 }
  68
  69
  70 void
  71 Sequential_iterator::derived_substitute (Context *f, Context *t)
  72 {
  73   if (iter_)
  74     iter_->substitute_outlet (f, t);
  75 }
  76
  77 /*
  78   TODO: this should be made lazily.
  79  */
  80 Grace_fixup *
  81 create_grace_fixup_list (SCM cursor)
  82 {
  83   Moment here;
  84   Moment last (-1);
  85   Grace_fixup *head = 0;
  86   Grace_fixup **tail = &head;
  87
  88   for (; gh_pair_p (cursor); cursor = ly_cdr (cursor))
  89     {
  90       Music *mus = unsmob_music (ly_car (cursor));
  91       Moment s = mus->start_mom ();
  92       Moment l = mus->get_length () - s;
  93
  94       if (s.grace_part_)
  95         {
  96           if (last != Moment (-1))
  97             {
  98               Grace_fixup *p = new Grace_fixup;
  99               p->start_ = last;
 100               p->length_ = here - last;
 101               p->grace_start_ = s.grace_part_;
 102               p->next_ = 0;
 103               *tail = p;
 104               tail = &(*tail)->next_;
 105             }
 106
 107           here.grace_part_ = s.grace_part_;
 108         }
 109
 110       if (l.to_bool ())
 111         {
 112           last = here;
 113           here += l;
 114         }
 115     }
 116
 117   return head;
 118 }
 119
 120 void
 121 Sequential_iterator::construct_children ()
 122 {
 123   cursor_ = get_music_list ();
 124
 125   iter_ = 0;
 126   if (gh_pair_p (cursor_))
 127     {
 128       Music *m = unsmob_music (ly_car (cursor_));
 129       iter_ = unsmob_iterator (get_iterator (m));
 130     }
 131
 132   while (iter_ && !iter_->ok ())
 133     {
 134       next_element (true);
 135     }
 136
 137   last_mom_ = Moment (-1);
 138   here_mom_ = get_music ()->start_mom ();
 139   grace_fixups_ = create_grace_fixup_list (cursor_);
 140
 141   /*
 142     iter_->ok () is tautology, but what the heck.
 143    */
 144   if (iter_ && iter_->ok ())
 145     descend_to_child ();
 146 }
 147
 148
 149 /*
 150   maintain invariants: change cursor, iter and here_mom_ in one fell
 151   swoop.
 152 */
 153 void
 154 Sequential_iterator::next_element (bool)
 155 {
 156   Moment len =iter_->music_get_length () - iter_->music_start_mom ();
 157   assert (!grace_fixups_  || grace_fixups_->start_ >= here_mom_);
 158
 159   if (len.main_part_
 160       && get_grace_fixup ())
 161     {
 162       Grace_fixup *gf = get_grace_fixup ();
 163
 164       last_mom_ = here_mom_;
 165       here_mom_ += gf->length_;
 166       here_mom_.grace_part_ += gf->grace_start_;
 167
 168       next_grace_fixup ();
 169     }
 170   else if (len.grace_part_ && !len.main_part_)
 171     {
 172       last_mom_ = here_mom_;
 173       here_mom_.grace_part_ =0;
 174     }
 175   else
 176     {
 177       /*
 178         !len.grace_part_ || len.main_part_
 179
 180         We skip over a big chunk (mainpart != 0). Any starting graces
 181         in that chunk should be in len.grace_part_
 182
 183       */
 184       last_mom_ = here_mom_;;
 185       here_mom_ += len;
 186     }
 187
 188   cursor_ = ly_cdr (cursor_);
 189
 190   iter_->quit ();
 191   if (gh_pair_p (cursor_))
 192     iter_ = unsmob_iterator (get_iterator (unsmob_music (ly_car (cursor_))));
 193   else
 194     iter_ = 0;
 195 }
 196
 197 /*
 198   move to context of child iterator if it is deeper down in the
 199   hierarchy.
 200   */
 201 void
 202 Sequential_iterator::descend_to_child ()
 203 {
 204   Context * child_report = child_report = iter_->get_outlet ();
 205   Context * me_report = get_outlet ();
 206
 207   Context * c = child_report;
 208   while (c && c != me_report)
 209     {
 210       c = c->daddy_context_;
 211     }
 212
 213   if (c == me_report)
 214     set_translator (child_report);
 215 }
 216
 217 void
 218 Sequential_iterator::process (Moment until)
 219 {
 220   while (iter_)
 221     {
 222       Grace_fixup * gf = get_grace_fixup ();
 223       if (gf
 224           && gf->start_ + gf->length_
 225               + Moment (Rational (0), gf->grace_start_) == until)
 226         {
 227           /*
 228             do the stuff/note/rest preceding a grace.
 229            */
 230           iter_->process (iter_->music_get_length ());
 231         }
 232       else
 233         {
 234           Moment w = until - here_mom_ + iter_->music_start_mom ();
 235           iter_->process (w);
 236         }
 237
 238       /*
 239         if the iter is still OK, there must be events left that have
 240
 241           TIME > LEFT
 242
 243       */
 244       if (iter_->ok ())
 245         return ;
 246
 247       descend_to_child ();
 248       next_element (true);
 249     }
 250 }
 251
 252 Moment
 253 Sequential_iterator::pending_moment () const
 254 {
 255   Moment cp = iter_->pending_moment ();
 256
 257   /*
 258     Fix-up a grace note halfway in the music.
 259   */
 260   Grace_fixup * gf = get_grace_fixup ();
 261   if (gf
 262       && gf->length_ + iter_->music_start_mom () == cp)
 263     {
 264       return here_mom_ + gf->length_ + Moment (0, gf->grace_start_);
 265     }
 266
 267   /*
 268     Fix-up a grace note at  the start of the music.
 269   */
 270   return cp + here_mom_ - iter_->music_start_mom ();
 271 }
 272
 273
 274 bool
 275 Sequential_iterator::ok () const
 276 {
 277   return iter_;
 278 }
 279
 280 Music_iterator*
 281 Sequential_iterator::try_music_in_children (Music *m) const
 282 {
 283   return iter_ ? iter_->try_music (m) : 0;
 284 }
 285
 286 IMPLEMENT_CTOR_CALLBACK (Sequential_iterator);
 287
 288 bool
 289 Sequential_iterator::run_always () const
 290 {
 291   return iter_ ? iter_->run_always () : false;
 292 }
 293
 294 void
 295 Sequential_iterator::next_grace_fixup ()
 296 {
 297   Grace_fixup * n = grace_fixups_->next_;
 298   delete grace_fixups_;
 299   grace_fixups_ = n;
 300 }
 301
 302 Grace_fixup*
 303 Sequential_iterator::get_grace_fixup () const
 304 {
 305   if (grace_fixups_ && grace_fixups_->start_ == here_mom_)
 306     return grace_fixups_;
 307   else
 308     return 0;
 309 }