]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.icc
Run grand replace for 2015.
[lilypond.git] / lily / include / translator.icc
index 5bffbf8d2ad30c683c1bff63fda9081ac91637be..0362b5b6c5971e5a04458464507a70ec9168821f 100644 (file)
 /*
-  translator.icc -- declare Translator glue wiring.
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
 
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #ifndef TRANSLATOR_ICC
 #define TRANSLATOR_ICC
 
+#include "listener.hh"
+#include "std-vector.hh"
+#include "translator.hh"
+
+/*
+  TODO: derive "foo-bar-interface" from Foo_bar classname.
+ */
+
 /**
    A macro to automate administration of translators.
 */
-#define ADD_THIS_TRANSLATOR(T)                                         \
-  SCM T::static_description_ = SCM_EOL;                                        \
-  static void _ ## T ## _adder ()                                      \
-  {                                                                    \
-    T *t = new T;                                                      \
-    T::static_description_ = t->static_translator_description ();      \
-    scm_permanent_object (T::static_description_);                     \
-    add_translator (t);                                                        \
-  }                                                                    \
-  SCM T::translator_description () const                               \
-  {                                                                    \
-    return static_description_;                                                \
-  }                                                                    \
-  ADD_GLOBAL_CTOR (_ ## T ## _adder);
-
-#define ADD_TRANSLATOR(classname, desc, grobs, accepted, acked, read, write) \
-  DEFINE_STATIC_METHODS(classname);\
-  IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(classname); \
-  ADD_THIS_TRANSLATOR (classname);                                     \
-  SCM                                                                  \
-  classname::static_translator_description () const                    \
-  {                                                                    \
-    SCM static_properties = SCM_EOL;                                   \
-    /*  static_properties = acons (name , gh_str02scm (Translator::name (self_scm ())),        \
-       static_properties_);                                            \
-    */                                                                 \
-    static_properties = scm_acons (ly_symbol2scm ("grobs-created"),    \
-                                  parse_symbol_list (grobs), static_properties); \
-                                                                       \
-    static_properties = scm_acons (ly_symbol2scm ("description"),      \
-                                  scm_makfrom0str (desc), static_properties); \
-                                                                       \
-    static_properties = scm_acons (ly_symbol2scm ("interfaces-acked"), \
-                                  parse_symbol_list (acked), static_properties); \
-    static_properties = scm_acons (ly_symbol2scm ("events-accepted"),  \
-                                  parse_symbol_list (accepted), static_properties); \
-                                                                       \
-    static_properties = scm_acons (ly_symbol2scm ("properties-read"),  \
-                                  parse_symbol_list (read), static_properties); \
-                                                                       \
-    static_properties = scm_acons (ly_symbol2scm ("properties-written"), \
-                                  parse_symbol_list (write), static_properties); \
-                                                                       \
-    return static_properties;                                          \
+#define ADD_THIS_TRANSLATOR(T)                                          \
+  SCM T::static_description_ = SCM_EOL;                                 \
+  static void _ ## T ## _adder ()                                       \
+  {                                                                     \
+    T *t = new T;                                                       \
+    T::static_description_ =                                            \
+      scm_permanent_object (t->static_translator_description ());       \
+    add_translator (t);                                                 \
+  }                                                                     \
+  SCM T::translator_description () const                                \
+  {                                                                     \
+    return static_description_;                                         \
+  }                                                                     \
+  ADD_GLOBAL_CTOR (_ ## T ## _adder); \
+  /* end define */
+
+#define DEFINE_TRANSLATOR_LISTENER_LIST(T) \
+  translator_listener_record *T::listener_list_;        \
+  /* end define */
+
+#define DEFINE_ACKNOWLEDGERS(classname) \
+  Drul_array< vector<Acknowledge_information> > classname::acknowledge_static_array_drul_;      \
+  Engraver_void_function_engraver_grob_info                             \
+  classname::static_get_acknowledger (SCM sym)                          \
+  {                                                                     \
+    return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[START]);      \
+  }                                                                     \
+  Engraver_void_function_engraver_grob_info                             \
+  classname::static_get_end_acknowledger (SCM sym)                              \
+  {                                                                     \
+    return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[STOP]);       \
+  }                                                                     \
+  /* end define */
+
+#define DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write)              \
+  SCM                                                                   \
+  classname::static_translator_description () const                     \
+  {                                                                     \
+    return Translator::static_translator_description (grobs, desc, listener_list_, read, write); \
   }
 
+#define ADD_TRANSLATOR(classname, desc, grobs, read, write)             \
+  IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname);                    \
+  ADD_THIS_TRANSLATOR (classname);                                      \
+  DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write)            \
+  DEFINE_ACKNOWLEDGERS(classname) \
+  DEFINE_TRANSLATOR_LISTENER_LIST(classname) \
+#define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T)                        \
+  void                                                                  \
+  T::fetch_precomputable_methods (Translator_void_method_ptr ptrs[])    \
+  {                                                                     \
+    ptrs[START_TRANSLATION_TIMESTEP] =                                  \
+      ((Translator_void_method_ptr) & T::start_translation_timestep ==  \
+       (Translator_void_method_ptr) & Translator::start_translation_timestep) \
+      ? 0                                                               \
+      : (Translator_void_method_ptr) & T::start_translation_timestep;   \
+                                                                        \
+    ptrs[STOP_TRANSLATION_TIMESTEP] =                                   \
+      ((Translator_void_method_ptr) & T::stop_translation_timestep == (Translator_void_method_ptr) & Translator::stop_translation_timestep) \
+      ? 0                                                               \
+      : (Translator_void_method_ptr) & T::stop_translation_timestep;    \
+                                                                        \
+    ptrs[PROCESS_MUSIC] =                                               \
+      ((Translator_void_method_ptr) & T::process_music == (Translator_void_method_ptr) & Translator::process_music) \
+      ? 0                                                               \
+      : (Translator_void_method_ptr) & T::process_music;                \
+                                                                        \
+    ptrs[PROCESS_ACKNOWLEDGED] =                                        \
+      ((Translator_void_method_ptr) & T::process_acknowledged == (Translator_void_method_ptr) & Translator::process_acknowledged) \
+      ? 0                                                               \
+      : (Translator_void_method_ptr) & T::process_acknowledged;         \
+  }
+
+void add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
+                       char const *func_name,
+                       vector<Acknowledge_information> *ack_array);
+
+Engraver_void_function_engraver_grob_info
+generic_get_acknowledger (SCM sym,
+                          vector<Acknowledge_information> const *ack_array);
+
+#define ADD_ACKNOWLEDGER(CLASS, NAME)                                   \
+  void CLASS ## NAME ## _ack_adder ()                                   \
+  {                                                                     \
+    add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[START]); \
+  }                                                                     \
+  ADD_SCM_INIT_FUNC (CLASS ## NAME ## _ack_adder_initclass, CLASS ## NAME ## _ack_adder);
+
+#define ADD_END_ACKNOWLEDGER(CLASS, NAME)                                       \
+  void CLASS ## NAME ## _end_ack_adder ()                                       \
+  {                                                                     \
+    add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_end_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[STOP]); \
+  }                                                                     \
+  ADD_SCM_INIT_FUNC (CLASS ## NAME ## _end_ack_adder_initclass, CLASS ## NAME ## _end_ack_adder);
 
 /*
-  FIXME: should be able to cast statically to (T*) -iow.- remove
-  Translator as a virtual base class.
+  Implement the method cl::listen_##m, and make it listen to stream
+  events of class m.
  */
-#define DEFINE_STATIC_METHOD(T, x) \
-void \
-T::x ## _static (Translator* tr) \
-{ \
-  T * t_ptr = (T*) (tr);       \
-  t_ptr->x ();\
+#define IMPLEMENT_TRANSLATOR_LISTENER(cl, m)            \
+void                                                    \
+cl :: _internal_declare_ ## m ()                        \
+{                                                       \
+  static translator_listener_record r;                  \
+  add_translator_listener (&listener_list_, &r, _get_ ## m ## _listener, #m); \
+}                                                       \
+                                                        \
+ADD_SCM_INIT_FUNC (cl ## _declare_event_ ## m, cl::_internal_declare_ ## m);    \
+                                                        \
+Listener                                                \
+ cl :: _get_ ## m ## _listener (void *me, SCM unused)   \
+{                                                       \
+  cl *obj = (cl *) me;                                  \
+  (void) unused; \
+  return obj->GET_LISTENER (_listen_scm_ ## m);         \
+}                                                       \
+                                                        \
+IMPLEMENT_LISTENER (cl, _listen_scm_ ## m)              \
+void                                                    \
+cl::_listen_scm_ ## m (SCM sev)                         \
+{                                                       \
+  Stream_event *ev = Stream_event::unsmob (sev);         \
+  protect_event (sev);                                  \
+  listen_ ## m (ev);                                    \
 }
 
-#define DEFINE_STATIC_METHODS(T) \
-  DEFINE_STATIC_METHOD(T,start_translation_timestep)\
-  DEFINE_STATIC_METHOD(T,stop_translation_timestep)\
-  DEFINE_STATIC_METHOD(T,process_music)\
-  DEFINE_STATIC_METHOD(T,process_acknowledged)
-
-#define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T) \
-void \
-T::fetch_precomputable_methods (Translator_void_method_ptr ptrs[])\
-{                                                                      \
-  ptrs[START_TRANSLATION_TIMESTEP] =                                   \
-    ((Translator_void_method_ptr) &T::start_translation_timestep == \
-     (Translator_void_method_ptr) &Translator::start_translation_timestep)     \
-    ? 0                                                                        \
-    : &T::start_translation_timestep_static;                           \
-                                                                       \
-  ptrs[STOP_TRANSLATION_TIMESTEP] =                                    \
-    ((Translator_void_method_ptr) &T::stop_translation_timestep == (Translator_void_method_ptr) &Translator::stop_translation_timestep) \
-    ? 0                                                                        \
-    : &T::stop_translation_timestep_static;                            \
-                                                                       \
-  ptrs[PROCESS_MUSIC] =                                                        \
-    ((Translator_void_method_ptr) &T::process_music == (Translator_void_method_ptr) &Translator::process_music)                        \
-    ? 0                                                                        \
-    : &T::process_music_static;                                                \
-                                                                       \
-  ptrs[PROCESS_ACKNOWLEDGED] =                                         \
-    ((Translator_void_method_ptr) &T::process_acknowledged == (Translator_void_method_ptr) &Translator::process_acknowledged)  \
-    ? 0                                                                        \
-    : &T::process_acknowledged_static;                                         \
-}
-
-
 #endif /* TRANSLATOR_ICC */
-