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