lily/global-context.cc

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