lily/music-iterator.cc

   1 /*
   2   music-iterator.cc -- implement Music_iterator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 /*
  10   UGH. too many includes.
  11  */
  12
  13 #include "music-iterator.hh"
  14
  15 #include <cstdio>
  16
  17 #include "warn.hh"
  18 #include "context.hh"
  19 #include "music-wrapper.hh"
  20 #include "music-wrapper-iterator.hh"
  21 #include "simple-music-iterator.hh"
  22
  23 #include "ly-smobs.icc"
  24
  25 Music_iterator::Music_iterator ()
  26 {
  27   music_ = 0;
  28   smobify_self ();
  29 }
  30
  31 Music_iterator::Music_iterator (Music_iterator const& )
  32 {
  33   assert (false);
  34 }
  35
  36 Music_iterator::~Music_iterator ()
  37 {
  38 }
  39
  40 Context *
  41 Music_iterator::get_outlet () const
  42 {
  43   return handle_.get_outlet ();
  44 }
  45
  46 void
  47 Music_iterator::set_context (Context *trans)
  48 {
  49   handle_.set_context (trans);
  50 }
  51
  52 void
  53 Music_iterator::construct_children ()
  54 {
  55 }
  56
  57 Moment
  58 Music_iterator::pending_moment () const
  59 {
  60   return 0;
  61 }
  62
  63 void
  64 Music_iterator::process (Moment)
  65 {
  66 }
  67
  68 bool
  69 Music_iterator::ok () const
  70 {
  71   return false;
  72 }
  73
  74
  75
  76 SCM
  77 Music_iterator::get_static_get_iterator (Music *m)
  78 {
  79   Music_iterator * p = 0;
  80
  81   SCM ctor = m->get_property ("iterator-ctor") ;
  82   SCM iter = SCM_EOL;
  83   if (ly_c_procedure_p (ctor))
  84     {
  85       iter = scm_call_0 (ctor);
  86       p = unsmob_iterator (iter);
  87     }
  88   else
  89     {
  90       if (dynamic_cast<Music_wrapper *> (m))
  91         p = new Music_wrapper_iterator;
  92       else
  93         p = new Simple_music_iterator;
  94
  95       iter = p->self_scm ();
  96       scm_gc_unprotect_object (iter);
  97     }
  98
  99   p->music_ = m;
 100   assert (m);
 101   p->music_length_ = m->get_length ();
 102   p->start_mom_ = m->start_mom ();
 103
 104   return iter;
 105 }
 106
 107
 108 Moment
 109 Music_iterator::music_get_length () const
 110 {
 111   return music_length_;
 112 }
 113
 114 Moment
 115 Music_iterator::music_start_mom ()const
 116 {
 117   return start_mom_;
 118 }
 119
 120 void
 121 Music_iterator::init_translator (Music *m, Context *report)
 122 {
 123   music_ = m;
 124   assert (m);
 125   if (! get_outlet ())
 126     set_context (report);
 127 }
 128
 129 void
 130 Music_iterator::substitute_outlet (Context *f, Context *t)
 131 {
 132   if (get_outlet () == f)
 133     set_context (t);
 134   derived_substitute (f, t);
 135 }
 136
 137 void
 138 Music_iterator::derived_substitute (Context *, Context *)
 139 {
 140 }
 141
 142 SCM
 143 Music_iterator::get_iterator (Music *m) const
 144 {
 145   SCM ip = get_static_get_iterator (m);
 146   Music_iterator*p = unsmob_iterator (ip);
 147
 148   p->init_translator (m, get_outlet ());
 149
 150   p->construct_children ();
 151   return ip;
 152 }
 153
 154 /*
 155   TODO: rename to prevent confusion between Context::try_music and
 156   Iterator::try_music
 157
 158  */
 159 Music_iterator*
 160 Music_iterator::try_music (Music *m) const
 161 {
 162   bool b = get_outlet ()->try_music ((Music*)m); // ugh
 163   Music_iterator * it = b ? (Music_iterator*) this : 0; // ugh
 164   if (!it)
 165     it = try_music_in_children (m);
 166   return it;
 167 }
 168
 169 Music_iterator*
 170 Music_iterator::try_music_in_children (Music *) const
 171 {
 172   return 0;
 173 }
 174
 175 IMPLEMENT_CTOR_CALLBACK (Music_iterator);
 176
 177 Music *
 178 Music_iterator::get_music () const
 179 {
 180   return music_;
 181 }
 182
 183 /****************************************************************/
 184
 185 IMPLEMENT_TYPE_P (Music_iterator, "ly:iterator?");
 186 IMPLEMENT_SMOBS (Music_iterator);
 187 IMPLEMENT_DEFAULT_EQUAL_P (Music_iterator);
 188
 189 SCM
 190 Music_iterator::mark_smob (SCM smob)
 191 {
 192   Music_iterator * mus = (Music_iterator *)SCM_CELL_WORD_1 (smob);
 193
 194   mus->derived_mark ();
 195   /*
 196     Careful with GC, although we intend the following as pointers
 197     only, we _must_ mark them.
 198    */
 199   if (mus->get_outlet ())
 200     scm_gc_mark (mus->get_outlet ()->self_scm ());
 201   if (mus->music_)
 202     scm_gc_mark (mus->music_->self_scm ());
 203
 204
 205   return SCM_EOL;
 206 }
 207
 208 int
 209 Music_iterator::print_smob (SCM sm , SCM port, scm_print_state*)
 210 {
 211   char s[1000];
 212
 213   Music_iterator *iter = unsmob_iterator (sm);
 214   sprintf (s, "#<%s>", classname (iter));
 215   scm_puts (s, port);
 216   return 1;
 217 }
 218
 219 void
 220 Music_iterator::derived_mark ()const
 221 {
 222 }
 223
 224 void
 225 Music_iterator::quit ()
 226 {
 227   do_quit ();
 228   handle_.quit ();
 229 }
 230
 231 void
 232 Music_iterator::do_quit ()
 233 {
 234 }
 235
 236 bool
 237 Music_iterator::run_always ()const
 238 {
 239   return false;
 240 }
 241
 242
 243 bool
 244 is_child_context (Context *me, Context *child)
 245 {
 246   while (child && child != me)
 247     {
 248       child = child->get_parent_context ();
 249     }
 250
 251   return child == me;
 252 }
 253
 254 /*
 255   move to context of child iterator if it is deeper down in the
 256   hierarchy.
 257   */
 258 void
 259 Music_iterator::descend_to_child (Context * child_report)
 260 {
 261   Context * me_report = get_outlet ();
 262   if (is_child_context (me_report, child_report))
 263     set_context (child_report);
 264 }