lily/translator.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 "translator.hh"
  21
  22 #include "context-def.hh"
  23 #include "dispatcher.hh"
  24 #include "global-context.hh"
  25 #include "international.hh"
  26 #include "translator-group.hh"
  27 #include "warn.hh"
  28
  29 #include "translator.icc"
  30
  31 Translator::~Translator ()
  32 {
  33 }
  34
  35 void
  36 Translator::init ()
  37 {
  38   daddy_context_ = 0;
  39   smobify_self ();
  40 }
  41
  42 void
  43 Translator::process_music ()
  44 {
  45 }
  46
  47 void
  48 Translator::process_acknowledged ()
  49 {
  50 }
  51
  52 Translator::Translator ()
  53 {
  54   init ();
  55 }
  56
  57 Translator::Translator (Translator const &)
  58   : Smob<Translator> ()
  59 {
  60   init ();
  61 }
  62
  63 Moment
  64 Translator::now_mom () const
  65 {
  66   return daddy_context_->now_mom ();
  67 }
  68
  69 Output_def *
  70 Translator::get_output_def () const
  71 {
  72   return daddy_context_->get_output_def ();
  73 }
  74
  75 Translator_group *
  76 Translator::get_daddy_translator () const
  77 {
  78   return daddy_context_->implementation ();
  79 }
  80
  81 void
  82 Translator::protect_event (SCM ev)
  83 {
  84   get_daddy_translator ()->protect_event (ev);
  85 }
  86
  87 SCM
  88 Translator::internal_get_property (SCM sym) const
  89 {
  90   return daddy_context_->internal_get_property (sym);
  91 }
  92
  93 void
  94 Translator::stop_translation_timestep ()
  95 {
  96 }
  97
  98 /*
  99   this function is called once each moment, before any user
 100   information enters the translators.  (i.e. no \property or event has
 101   been processed yet.)
 102 */
 103 void
 104 Translator::start_translation_timestep ()
 105 {
 106 }
 107
 108 void
 109 Translator::initialize ()
 110 {
 111 }
 112
 113 void
 114 Translator::finalize ()
 115 {
 116 }
 117
 118 void
 119 Translator::connect_to_context (Context *c)
 120 {
 121   for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
 122     c->events_below ()->add_listener (r->get_listener_ (this, r->event_class_),
 123                                       r->event_class_);
 124 }
 125
 126 void
 127 Translator::disconnect_from_context (Context *c)
 128 {
 129   for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
 130     c->events_below ()->remove_listener (r->get_listener_ (this, r->event_class_),
 131                                          r->event_class_);
 132 }
 133
 134 /*
 135   internally called once, statically, for each translator
 136   listener. Connects the name of an event class with a procedure that
 137   fetches the corresponding listener.
 138
 139   The method should only be called from the macro
 140   IMPLEMENT_TRANSLATOR_LISTENER.
 141  */
 142 void
 143 Translator::add_translator_listener (translator_listener_record **listener_list,
 144                                      translator_listener_record *r,
 145                                      Listener (*get_listener) (void *, SCM),
 146                                      const char *ev_class)
 147 {
 148   /* ev_class is the C++ identifier name. Convert to scm symbol */
 149   string name = string (ev_class);
 150   name = replace_all (&name, '_', '-');
 151   name += "-event";
 152
 153   // we make the symbol permanent in order not to have to bother about
 154   // the static translator_listener_record chains while garbage
 155   // collecting.
 156
 157   SCM class_sym = scm_permanent_object (scm_from_locale_symbol (name.c_str ()));
 158
 159   r->event_class_ = class_sym;
 160   r->get_listener_ = get_listener;
 161   r->next_ = *listener_list;
 162   *listener_list = r;
 163 }
 164
 165 /*
 166  Helps the individual static_translator_description methods of translators.
 167 */
 168 SCM
 169 Translator::static_translator_description (const char *grobs,
 170                                            const char *desc,
 171                                            translator_listener_record *listener_list,
 172                                            const char *read,
 173                                            const char *write) const
 174 {
 175   SCM static_properties = SCM_EOL;
 176
 177   static_properties = scm_acons (ly_symbol2scm ("grobs-created"),
 178                                  parse_symbol_list (grobs), static_properties);
 179
 180   static_properties = scm_acons (ly_symbol2scm ("description"),
 181                                  scm_from_locale_string (desc), static_properties);
 182
 183   SCM list = SCM_EOL;
 184   for (; listener_list; listener_list = listener_list->next_)
 185     list = scm_cons (listener_list->event_class_, list);
 186   static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
 187                                  list, static_properties);
 188
 189   static_properties = scm_acons (ly_symbol2scm ("properties-read"),
 190                                  parse_symbol_list (read), static_properties);
 191
 192   static_properties = scm_acons (ly_symbol2scm ("properties-written"),
 193                                  parse_symbol_list (write), static_properties);
 194
 195   return static_properties;
 196 }
 197
 198 /*
 199   SMOBS
 200 */
 201 SCM
 202 Translator::mark_smob ()
 203 {
 204   derived_mark ();
 205   return SCM_EOL;
 206 }
 207
 208 Global_context *
 209 Translator::get_global_context () const
 210 {
 211   return daddy_context_->get_global_context ();
 212 }
 213
 214 Context *
 215 Translator::get_score_context () const
 216 {
 217   return daddy_context_->get_score_context ();
 218 }
 219
 220 const char Translator::type_p_name_[] = "ly:translator?";
 221
 222 bool
 223 Translator::must_be_last () const
 224 {
 225   return false;
 226 }
 227
 228 void
 229 Translator::derived_mark () const
 230 {
 231 }
 232
 233 int
 234 Translator::print_smob (SCM port, scm_print_state *)
 235 {
 236   scm_puts ("#<Translator ", port);
 237   scm_puts (class_name (), port);
 238   scm_puts (" >", port);
 239   return 1;
 240 }
 241
 242 void
 243 add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
 244                   char const *func_name,
 245                   vector<Acknowledge_information> *ack_array)
 246 {
 247   Acknowledge_information inf;
 248   inf.function_ = ptr;
 249
 250   string interface_name (func_name);
 251
 252   interface_name = replace_all (&interface_name, '_', '-');
 253   interface_name += "-interface";
 254
 255   /*
 256     this is only called during program init, so safe to use scm_gc_protect_object ()
 257   */
 258   inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
 259   ack_array->push_back (inf);
 260 }
 261
 262 Engraver_void_function_engraver_grob_info
 263 generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_array)
 264 {
 265   for (vsize i = 0; i < ack_array->size (); i++)
 266     {
 267       if (ack_array->at (i).symbol_ == sym)
 268         return ack_array->at (i).function_;
 269     }
 270   return 0;
 271 }
 272
 273 Moment
 274 get_event_length (Stream_event *e)
 275 {
 276   Moment *m = Moment::unsmob (e->get_property ("length"));
 277   if (m)
 278     return *m;
 279   else
 280     return Moment (0);
 281 }
 282
 283 Moment
 284 get_event_length (Stream_event *e, Moment now)
 285 {
 286   Moment len = get_event_length (e);
 287
 288   if (now.grace_part_)
 289     {
 290       len.grace_part_ = len.main_part_;
 291       len.main_part_ = Rational (0);
 292     }
 293   return len;
 294 }
 295
 296 /*
 297   Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
 298   simultaneous events. The helper is only useful in listen_* methods
 299   of translators.
 300 */
 301 bool
 302 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
 303 {
 304   if (*old_ev
 305       && !to_boolean (scm_equal_p ((*old_ev)->self_scm (),
 306                                    new_ev->self_scm ())))
 307     {
 308       /* extract event class from function name */
 309       string ev_class = function;
 310
 311       /* This assertion fails if EVENT_ASSIGNMENT was called outside a
 312          translator listener. Don't do that. */
 313       const char *prefix = "listen_";
 314       assert (0 == ev_class.find (prefix));
 315
 316       /* "listen_foo_bar" -> "foo-bar" */
 317       ev_class.erase (0, strlen (prefix));
 318       replace_all (&ev_class, '_', '-');
 319
 320       new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
 321       (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
 322       return false;
 323     }
 324   else
 325     {
 326       *old_ev = new_ev;
 327       return true;
 328     }
 329 }
 330
 331 ADD_TRANSLATOR (Translator,
 332                 /* doc */
 333                 "Base class.  Not instantiated.",
 334
 335                 /* create */
 336                 "",
 337
 338                 /* read */
 339                 "",
 340
 341                 /* write */
 342                 ""
 343                );