lily/music-iterator.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include <cstdio>
  21 using namespace std;
  22
  23 #include "warn.hh"
  24 #include "music.hh"
  25 #include "context.hh"
  26 #include "event-iterator.hh"
  27 #include "input.hh"
  28 #include "international.hh"
  29 #include "music-wrapper.hh"
  30 #include "music-wrapper-iterator.hh"
  31 #include "simple-music-iterator.hh"
  32
  33
  34 Music_iterator::Music_iterator ()
  35 {
  36   music_ = 0;
  37   smobify_self ();
  38 }
  39
  40 Music_iterator::~Music_iterator ()
  41 {
  42 }
  43
  44 Context *
  45 Music_iterator::get_outlet () const
  46 {
  47   return handle_.get_context ();
  48 }
  49
  50 void
  51 Music_iterator::set_context (Context *trans)
  52 {
  53   handle_.set_context (trans);
  54 }
  55
  56 void
  57 Music_iterator::construct_children ()
  58 {
  59 }
  60
  61 Moment
  62 Music_iterator::pending_moment () const
  63 {
  64   return 0;
  65 }
  66
  67 void
  68 Music_iterator::process (Moment)
  69 {
  70 }
  71
  72 bool
  73 Music_iterator::ok () const
  74 {
  75   return false;
  76 }
  77
  78 SCM
  79 Music_iterator::get_static_get_iterator (Music *m)
  80 {
  81   Music_iterator *p = 0;
  82
  83   SCM ctor = m->get_property ("iterator-ctor");
  84   SCM iter = SCM_EOL;
  85   if (ly_is_procedure (ctor))
  86     {
  87       iter = scm_call_0 (ctor);
  88       p = Music_iterator::unsmob (iter);
  89     }
  90   else
  91     {
  92       if (dynamic_cast<Music_wrapper *> (m))
  93         p = new Music_wrapper_iterator;
  94       else if (m->is_mus_type ("event"))
  95         p = new Event_iterator;
  96       else
  97         p = new Simple_music_iterator;
  98
  99       iter = p->self_scm ();
 100       p->unprotect ();
 101     }
 102
 103   p->music_ = m;
 104   assert (m);
 105   p->music_length_ = m->get_length ();
 106   p->start_mom_ = m->start_mom ();
 107
 108   return iter;
 109 }
 110
 111 Moment
 112 Music_iterator::music_get_length () const
 113 {
 114   return music_length_;
 115 }
 116
 117 Moment
 118 Music_iterator::music_start_mom ()const
 119 {
 120   return start_mom_;
 121 }
 122
 123 void
 124 Music_iterator::init_context (Music *m, Context *report)
 125 {
 126   music_ = m;
 127   assert (m);
 128   if (! get_outlet ())
 129     set_context (report);
 130 }
 131
 132 void
 133 Music_iterator::substitute_outlet (Context *f, Context *t)
 134 {
 135   if (get_outlet () == f)
 136     set_context (t);
 137   derived_substitute (f, t);
 138 }
 139
 140 void
 141 Music_iterator::derived_substitute (Context *, Context *)
 142 {
 143 }
 144
 145 SCM
 146 Music_iterator::get_iterator (Music *m) const
 147 {
 148   SCM ip = get_static_get_iterator (m);
 149   Music_iterator *p = Music_iterator::unsmob (ip);
 150
 151   p->init_context (m, get_outlet ());
 152
 153   p->construct_children ();
 154   return ip;
 155 }
 156
 157 /* Descend to a bottom context; implicitly create a new one if necessary */
 158 void
 159 Music_iterator::descend_to_bottom_context ()
 160 {
 161   assert (get_outlet ());
 162   if (!get_outlet ()->is_bottom_context ())
 163     set_context (get_outlet ()->get_default_interpreter ());
 164 }
 165
 166 void
 167 Music_iterator::report_event (Music *m)
 168 {
 169   descend_to_bottom_context ();
 170
 171   /*
 172     FIXME: then don't do it.
 173   */
 174   if (!m->is_mus_type ("event"))
 175     m->origin ()->programming_error ("Sending non-event to context");
 176
 177   m->send_to_context (get_outlet ());
 178 }
 179
 180 IMPLEMENT_CTOR_CALLBACK (Music_iterator);
 181
 182 Music *
 183 Music_iterator::get_music () const
 184 {
 185   return music_;
 186 }
 187
 188 /****************************************************************/
 189
 190 const char Music_iterator::type_p_name_[] = "ly:iterator?";
 191
 192 SCM
 193 Music_iterator::mark_smob ()
 194 {
 195   derived_mark ();
 196   /*
 197     Careful with GC, although we intend the following as pointers
 198     only, we _must_ mark them.
 199   */
 200   /* Use handle_ directly as get_outlet is a virtual function and we
 201      need to protect the context until Music_iterator::quit is being
 202      run. */
 203   if (handle_.get_context ())
 204     scm_gc_mark (handle_.get_context ()->self_scm ());
 205   if (music_)
 206     scm_gc_mark (music_->self_scm ());
 207
 208   return SCM_EOL;
 209 }
 210
 211 int
 212 Music_iterator::print_smob (SCM port, scm_print_state *)
 213 {
 214   char s[1000];
 215
 216   sprintf (s, "#<%s>", class_name ());
 217   scm_puts (s, port);
 218   return 1;
 219 }
 220
 221 void
 222 Music_iterator::derived_mark ()const
 223 {
 224 }
 225
 226 void
 227 Music_iterator::quit ()
 228 {
 229   do_quit ();
 230   handle_.set_context (0);
 231 }
 232
 233 void
 234 Music_iterator::do_quit ()
 235 {
 236 }
 237
 238 bool
 239 Music_iterator::run_always ()const
 240 {
 241   return false;
 242 }
 243
 244 bool
 245 is_child_context (Context *me, Context *child)
 246 {
 247   while (child && child != me)
 248     child = child->get_parent_context ();
 249
 250   return child == me;
 251 }
 252
 253 /*
 254   move to context of child iterator if it is deeper down in the
 255   hierarchy.
 256 */
 257 void
 258 Music_iterator::descend_to_child (Context *child_report)
 259 {
 260   Context *me_report = get_outlet ();
 261   if (is_child_context (me_report, child_report))
 262     set_context (child_report);
 263 }