lily/global-context.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 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 "global-context.hh"
  21
  22 #include <cstdio>
  23 using namespace std;
  24
  25 #include "context-def.hh"
  26 #include "dispatcher.hh"
  27 #include "international.hh"
  28 #include "music-iterator.hh"
  29 #include "music.hh"
  30 #include "output-def.hh"
  31 #include "warn.hh"
  32
  33 Global_context::Global_context (Output_def *o)
  34   : Context ()
  35 {
  36   output_def_ = o;
  37   definition_ = find_context_def (o, ly_symbol2scm ("Global"));
  38
  39   now_mom_.set_infinite (-1);
  40   prev_mom_.set_infinite (-1);
  41
  42   /* We only need the most basic stuff to bootstrap the context tree */
  43   event_source ()->add_listener (GET_LISTENER (create_context_from_event),
  44                                  ly_symbol2scm ("CreateContext"));
  45   event_source ()->add_listener (GET_LISTENER (prepare),
  46                                  ly_symbol2scm ("Prepare"));
  47   events_below ()->register_as_listener (event_source_);
  48
  49   Context_def *globaldef = unsmob_context_def (definition_);
  50   if (!globaldef)
  51     programming_error ("no `Global' context found");
  52   else
  53     globaldef->apply_default_property_operations (this);
  54   accepts_list_ = scm_list_1 (ly_symbol2scm ("Score"));
  55 }
  56
  57 Output_def *
  58 Global_context::get_output_def () const
  59 {
  60   return output_def_;
  61 }
  62
  63 void
  64 Global_context::add_moment_to_process (Moment m)
  65 {
  66   if (m < now_mom_)
  67     programming_error ("trying to freeze in time");
  68
  69   for (vsize i = 0; i < extra_mom_pq_.size (); i++)
  70     if (extra_mom_pq_[i] == m)
  71       return;
  72   extra_mom_pq_.insert (m);
  73 }
  74
  75 Moment
  76 Global_context::sneaky_insert_extra_moment (Moment w)
  77 {
  78   while (extra_mom_pq_.size () && extra_mom_pq_.front () <= w)
  79     w = extra_mom_pq_.get ();
  80   return w;
  81 }
  82
  83 int
  84 Global_context::get_moments_left () const
  85 {
  86   return extra_mom_pq_.size ();
  87 }
  88
  89 IMPLEMENT_LISTENER (Global_context, prepare);
  90 void
  91 Global_context::prepare (SCM sev)
  92 {
  93   Stream_event *ev = unsmob_stream_event (sev);
  94   Moment *mom = unsmob_moment (ev->get_property ("moment"));
  95
  96   assert (mom);
  97
  98   if (prev_mom_.main_part_.is_infinity () && prev_mom_ < 0)
  99     prev_mom_ = *mom;
 100   else
 101     prev_mom_ = now_mom_;
 102   now_mom_ = *mom;
 103 }
 104
 105 Moment
 106 Global_context::now_mom () const
 107 {
 108   return now_mom_;
 109 }
 110
 111 Context *
 112 Global_context::get_score_context () const
 113 {
 114   return (scm_is_pair (context_list_))
 115          ? unsmob_context (scm_car (context_list_))
 116          : 0;
 117 }
 118
 119 SCM
 120 Global_context::get_output ()
 121 {
 122   Context *c = get_score_context ();
 123   if (c)
 124     return c->get_property ("output");
 125   else
 126     return SCM_EOL;
 127 }
 128
 129 void
 130 Global_context::run_iterator_on_me (Music_iterator *iter)
 131 {
 132   prev_mom_.set_infinite (-1);
 133   now_mom_.set_infinite (-1);
 134   Moment final_mom = iter->get_music ()->get_length ();
 135
 136   bool first = true;
 137   while (iter->ok () || get_moments_left ())
 138     {
 139       Moment w;
 140       w.set_infinite (1);
 141       if (iter->ok ())
 142         w = iter->pending_moment ();
 143
 144       w = sneaky_insert_extra_moment (w);
 145       if (w.main_part_.is_infinity () || w > final_mom)
 146         break;
 147
 148       if (w == prev_mom_)
 149         {
 150           programming_error ("Moment is not increasing. Aborting interpretation.");
 151           break;
 152         }
 153
 154       if (first)
 155         {
 156           /*
 157             Need this to get grace notes at start of a piece correct.
 158           */
 159           first = false;
 160           set_property ("measurePosition", w.smobbed_copy ());
 161         }
 162
 163       send_stream_event (this, "Prepare", 0,
 164                          ly_symbol2scm ("moment"), w.smobbed_copy ());
 165
 166       if (iter->ok ())
 167         iter->process (w);
 168
 169       send_stream_event (this, "OneTimeStep", 0, 0);
 170       apply_finalizations ();
 171       check_removal ();
 172     }
 173 }
 174
 175 void
 176 Global_context::apply_finalizations ()
 177 {
 178   SCM lst = get_property ("finalizations");
 179   set_property ("finalizations", SCM_EOL);
 180   for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s))
 181
 182     /* TODO: make safe.  */
 183     scm_primitive_eval (scm_car (s));
 184 }
 185
 186 /* Add a function to execute before stepping to the next time step.  */
 187 void
 188 Global_context::add_finalization (SCM x)
 189 {
 190   SCM lst = get_property ("finalizations");
 191   lst = scm_cons (x, lst);
 192   set_property ("finalizations", lst);
 193 }
 194
 195 Moment
 196 Global_context::previous_moment () const
 197 {
 198   return prev_mom_;
 199 }
 200
 201 Context *
 202 Global_context::get_default_interpreter (string /* context_id */)
 203 {
 204   if (get_score_context ())
 205     return get_score_context ()->get_default_interpreter ();
 206   else
 207     return Context::get_default_interpreter ();
 208 }
 209
 210 Global_context *
 211 unsmob_global_context (SCM x)
 212 {
 213   return dynamic_cast<Global_context *> (unsmob_context (x));
 214 }