lily/global-context.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2014 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
  55   default_child_ = ly_symbol2scm ("Score");
  56   accepts_list_ = scm_list_1 (default_child_);
  57 }
  58
  59 Output_def *
  60 Global_context::get_output_def () const
  61 {
  62   return output_def_;
  63 }
  64
  65 void
  66 Global_context::add_moment_to_process (Moment m)
  67 {
  68   if (m < now_mom_)
  69     programming_error ("trying to freeze in time");
  70
  71   for (vsize i = 0; i < extra_mom_pq_.size (); i++)
  72     if (extra_mom_pq_[i] == m)
  73       return;
  74   extra_mom_pq_.insert (m);
  75 }
  76
  77 Moment
  78 Global_context::sneaky_insert_extra_moment (Moment w)
  79 {
  80   while (extra_mom_pq_.size () && extra_mom_pq_.front () <= w)
  81     w = extra_mom_pq_.get ();
  82   return w;
  83 }
  84
  85 int
  86 Global_context::get_moments_left () const
  87 {
  88   return extra_mom_pq_.size ();
  89 }
  90
  91 IMPLEMENT_LISTENER (Global_context, prepare);
  92 void
  93 Global_context::prepare (SCM sev)
  94 {
  95   Stream_event *ev = unsmob_stream_event (sev);
  96   Moment *mom = unsmob_moment (ev->get_property ("moment"));
  97
  98   assert (mom);
  99
 100   if (prev_mom_.main_part_.is_infinity () && prev_mom_ < 0)
 101     prev_mom_ = *mom;
 102   else
 103     prev_mom_ = now_mom_;
 104   now_mom_ = *mom;
 105 }
 106
 107 Moment
 108 Global_context::now_mom () const
 109 {
 110   return now_mom_;
 111 }
 112
 113 Context *
 114 Global_context::get_score_context () const
 115 {
 116   return (scm_is_pair (context_list_))
 117          ? unsmob_context (scm_car (context_list_))
 118          : 0;
 119 }
 120
 121 SCM
 122 Global_context::get_output ()
 123 {
 124   Context *c = get_score_context ();
 125   if (c)
 126     return c->get_property ("output");
 127   else
 128     return SCM_EOL;
 129 }
 130
 131 void
 132 Global_context::run_iterator_on_me (Music_iterator *iter)
 133 {
 134   prev_mom_.set_infinite (-1);
 135   now_mom_.set_infinite (-1);
 136   Moment final_mom = iter->get_music ()->get_length ();
 137
 138   bool first = true;
 139   while (iter->ok () || get_moments_left ())
 140     {
 141       Moment w;
 142       w.set_infinite (1);
 143       if (iter->ok ())
 144         w = iter->pending_moment ();
 145
 146       w = sneaky_insert_extra_moment (w);
 147       if (w.main_part_.is_infinity () || w > final_mom)
 148         break;
 149
 150       if (w == prev_mom_)
 151         {
 152           programming_error ("Moment is not increasing."
 153                              "  Aborting interpretation.");
 154           break;
 155         }
 156
 157       if (first)
 158         {
 159           /*
 160             Need this to get grace notes at start of a piece correct.
 161           */
 162           first = false;
 163           set_property ("measurePosition", w.smobbed_copy ());
 164         }
 165
 166       send_stream_event (this, "Prepare", 0,
 167                          ly_symbol2scm ("moment"), w.smobbed_copy ());
 168
 169       if (iter->ok ())
 170         iter->process (w);
 171
 172       send_stream_event (this, "OneTimeStep", 0, 0);
 173       apply_finalizations ();
 174       check_removal ();
 175     }
 176 }
 177
 178 void
 179 Global_context::apply_finalizations ()
 180 {
 181   SCM lst = get_property ("finalizations");
 182   set_property ("finalizations", SCM_EOL);
 183   for (SCM s = lst; scm_is_pair (s); s = scm_cdr (s))
 184     scm_apply_0 (scm_caar (s), scm_cdar (s));
 185 }
 186
 187 /* Add a function to execute before stepping to the next time step.  */
 188 void
 189 Global_context::add_finalization (SCM x)
 190 {
 191   SCM lst = get_property ("finalizations");
 192   lst = scm_cons (x, lst);
 193   set_property ("finalizations", lst);
 194 }
 195
 196 Moment
 197 Global_context::previous_moment () const
 198 {
 199   return prev_mom_;
 200 }
 201
 202 Context *
 203 Global_context::get_default_interpreter (const string &/* context_id */)
 204 {
 205   if (get_score_context ())
 206     return get_score_context ()->get_default_interpreter ();
 207   else
 208     return Context::get_default_interpreter ();
 209 }
 210
 211 Global_context *
 212 unsmob_global_context (SCM x)
 213 {
 214   return dynamic_cast<Global_context *> (unsmob_context (x));
 215 }