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