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
  14 Grace_fixup *get_grace_fixups (SCM cursor);
  15
  16 /*
  17
  18   TODO: handling of grace notes is exquisite pain.  This handling
  19   should be formally specified and then the implementation verified.
  20
  21 */
  22
  23 /*
  24   Invariant for the data structure.
  25
  26
  27   if (gh_pair_p (cursor_))
  28     iter_->music_ == unsmob_music (ly_car (cursor_))
  29   else
  30     iter_ == 0;
  31
  32   The length of musiclist from start to up to cursor_ (cursor_ not
  33   including), is summed
  34
  35   here_mom_  = sum (length (musiclist [start ... cursor>))  %)
  36
  37  */
  38 Sequential_iterator::Sequential_iterator ()
  39 {
  40   here_mom_ = Moment (0);
  41   list_ = SCM_EOL;
  42   cursor_ = SCM_EOL;
  43   grace_fixups_ = 0;
  44   iter_ = 0;
  45 }
  46
  47 SCM
  48 Sequential_iterator::get_music_list () const
  49 {
  50   return SCM_EOL;
  51 }
  52
  53 void
  54 Sequential_iterator::do_quit ()
  55 {
  56   if (iter_)
  57     iter_->quit ();
  58 }
  59
  60
  61
  62
  63 void
  64 Sequential_iterator::derived_mark ()const
  65 {
  66   if (iter_)
  67     scm_gc_mark (iter_->self_scm ());
  68   scm_gc_mark (list_);
  69   scm_gc_mark (cursor_);
  70 }
  71
  72
  73 void
  74 Sequential_iterator::derived_substitute (Context *f,Context *t)
  75 {
  76   if (iter_)
  77     iter_->substitute_outlet (f,t);
  78
  79 }
  80
  81 Grace_fixup *
  82 create_grace_fixup_list (SCM cursor)
  83 {
  84   Moment here;
  85   Moment last (-1);
  86   Grace_fixup *head = 0;
  87   Grace_fixup **tail = &head;
  88
  89   for (; gh_pair_p (cursor); cursor = ly_cdr (cursor))
  90     {
  91       Music *mus = unsmob_music (ly_car (cursor));
  92       Moment s = mus->start_mom ();
  93       Moment l = mus->get_length () - s;
  94
  95       if (s.grace_part_)
  96         {
  97           if (last != Moment (-1))
  98             {
  99               Grace_fixup *p = new Grace_fixup;
 100               p->start_ = last;
 101               p->length_ = here - last;
 102               p->grace_start_ = s.grace_part_;
 103               p->next_ = 0;
 104               *tail = p;
 105               tail = &(*tail)->next_;
 106             }
 107
 108           here.grace_part_ = s.grace_part_;
 109         }
 110
 111       if (l.to_bool ())
 112         {
 113           last = here;
 114           here += l;
 115         }
 116     }
 117
 118   return head;
 119 }
 120
 121 void
 122 Sequential_iterator::construct_children ()
 123 {
 124   list_ = get_music_list ();
 125   cursor_ = list_;
 126
 127   iter_ = 0;
 128   if (gh_pair_p (cursor_))
 129     {
 130       Music *m  =unsmob_music (ly_car (cursor_));
 131       iter_ = unsmob_iterator (get_iterator (m));
 132     }
 133
 134   while (iter_ && !iter_->ok ())
 135     {
 136       next_element (true);
 137     }
 138
 139   here_mom_ = get_music ()->start_mom ();
 140   grace_fixups_ = create_grace_fixup_list (cursor_);
 141
 142   /*
 143     iter_->ok () is tautology, but what the heck.
 144    */
 145   if (iter_ && iter_->ok ())
 146     descend_to_child ();
 147 }
 148
 149
 150 /*
 151   maintain invariants: change cursor, iter and here_mom_ in one fell
 152   swoop.
 153 */
 154 void
 155 Sequential_iterator::next_element (bool)
 156 {
 157   Moment len =iter_->music_get_length () - iter_->music_start_mom ();
 158   assert (!grace_fixups_  || grace_fixups_->start_ >= here_mom_);
 159
 160   if (len.main_part_
 161       && get_grace_fixup ())
 162     {
 163       Grace_fixup *gf = get_grace_fixup ();
 164
 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       here_mom_.grace_part_ =0;
 173     }
 174   else
 175     {
 176       /*
 177         !len.grace_part_ || len.main_part_
 178
 179         We skip over a big chunk (mainpart != 0). Any starting graces
 180         in that chunk should be in len.grace_part_
 181
 182       */
 183       here_mom_ += len;
 184     }
 185
 186   cursor_ = ly_cdr (cursor_);
 187
 188   iter_->quit ();
 189   if (gh_pair_p (cursor_))
 190     iter_ = unsmob_iterator (get_iterator (unsmob_music (ly_car (cursor_))));
 191   else
 192     iter_ = 0;
 193 }
 194
 195 /*
 196   move to context of child iterator if it is deeper down in the
 197   hierarchy.
 198   */
 199 void
 200 Sequential_iterator::descend_to_child ()
 201 {
 202   Context * child_report = child_report = iter_->get_outlet ();
 203   Context * me_report = get_outlet ();
 204
 205   Context * c = child_report;
 206   while (c && c != me_report)
 207     {
 208       c = c->daddy_context_;
 209     }
 210
 211   if (c == me_report)
 212     set_translator (child_report);
 213 }
 214
 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
 303 Grace_fixup*
 304 Sequential_iterator::get_grace_fixup () const
 305 {
 306   if (grace_fixups_ && grace_fixups_->start_ == here_mom_)
 307     return grace_fixups_;
 308   else
 309     return 0;
 310 }