]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.icc
Issue 1375/1: Let Translator constructor take a Context argument
[lilypond.git] / lily / include / translator.icc
index 775f5b9370b899c74e4114de68ada02ee5a7667e..20954ead0b6b1c670783ac07a8697421d55f0c6c 100644 (file)
@@ -1,17 +1,28 @@
-/*
-  translator.icc -- declare Translator glue wiring.
+/* -*- c++ -*-
+  This file is part of LilyPond, the GNU music typesetter.
+
+  Copyright (C) 2005--2015 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.
 
-  source file of the GNU LilyPond music typesetter
+  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.
 
-  (c) 2005--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  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 "callback.hh"
 #include "std-vector.hh"
-#include "translator.hh"
+#include "engraver.hh"
 
 /*
   TODO: derive "foo-bar-interface" from Foo_bar classname.
 /**
    A macro to automate administration of translators.
 */
-#define ADD_THIS_TRANSLATOR(T)                                         \
-  translator_listener_record *T::listener_list_;                       \
-  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, read, write)            \
-  Drul_array< vector<Acknowledge_information> > classname::acknowledge_static_array_drul_;     \
-  IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname);                   \
-  ADD_THIS_TRANSLATOR (classname);                                     \
-  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]);      \
-  }                                                                    \
-  SCM                                                                  \
-  classname::static_translator_description () const                    \
-  {                                                                    \
+#define ADD_THIS_TRANSLATOR(T)                                          \
+  SCM T::static_description_ = SCM_EOL;                                 \
+  static void _ ## T ## _adder ()                                       \
+  {                                                                     \
+    T::boot ();                                                         \
+    T *t = new T(0);                                                    \
+    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) \
+  Protected_scm T::listener_list_ (SCM_EOL)
+
+#define DEFINE_ACKNOWLEDGERS(classname) \
+  Drul_array<Protected_scm> classname::acknowledge_static_array_drul_;  \
+  SCM                                                                   \
+  classname::static_get_acknowledger (SCM sym, Direction start_end)     \
+  {                                                                     \
+    return generic_get_acknowledger                                     \
+      (sym, acknowledge_static_array_drul_[start_end]);                 \
+  }                                                                     \
+  /* 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 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;  \
+#define ADD_TRANSLATOR(classname, desc, grobs, read, write)             \
+  IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname);                    \
+  DEFINE_ACKNOWLEDGERS(classname);                                      \
+  ADD_THIS_TRANSLATOR (classname);                                      \
+  DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write);           \
+  DEFINE_TRANSLATOR_LISTENER_LIST(classname);
+
+#define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T)                        \
+  void                                                                  \
+  T::fetch_precomputable_methods (SCM ptrs[])                           \
+  {                                                                     \
+    ptrs[START_TRANSLATION_TIMESTEP] =                                  \
+      method_finder <&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;   \
-                                                                       \
+      method_finder <&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;               \
+      method_finder <&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;                \
+      method_finder <&T::process_acknowledged> ();                      \
   }
 
-void add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
-                      char const *func_name,
-                      vector<Acknowledge_information> *ack_array);
+void add_acknowledger (SCM ptr,
+                       char const *func_name,
+                       SCM &ack_hash);
 
-Engraver_void_function_engraver_grob_info
-generic_get_acknowledger (SCM sym,
-                         vector<Acknowledge_information> const *ack_array);
+#define ADD_ACKNOWLEDGER_FOR(CLASS, NAME, GROB)                         \
+  add_acknowledger (method_finder<&CLASS::acknowledge_ ## NAME> (),     \
+                    #GROB, acknowledge_static_array_drul_[START])
 
-#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_ACKNOWLEDGER(CLASS, NAME) ADD_ACKNOWLEDGER_FOR (CLASS, NAME, NAME)
 
-#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);
+// ADD_END_ACKNOWLEDGER_FOR requires your NAME to actually be
+// end_whatever if you are utilizing acknowledge_end_whatever as a
+// different end acknowledger.
+#define ADD_END_ACKNOWLEDGER_FOR(CLASS, NAME, GROB)                     \
+  add_acknowledger (method_finder<&CLASS::acknowledge_ ## NAME> (),     \
+                    #GROB, acknowledge_static_array_drul_[STOP])
+
+#define ADD_END_ACKNOWLEDGER(CLASS, NAME)               \
+  ADD_END_ACKNOWLEDGER_FOR (CLASS, end_ ## NAME, NAME)
 
 /*
-  Implement the method cl::listen_##m, and make it listen to stream 
+  Implement the method cl::listen_##m, and make it listen to stream
   events of class m.
  */
-#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)               \
-{                                                      \
-  cl *obj = (cl *) me;                                 \
-  return obj->GET_LISTENER (_listen_scm_ ## m);                \
-}                                                      \
-                                                       \
-IMPLEMENT_LISTENER (cl, _listen_scm_ ## m)             \
-void                                                   \
-cl::_listen_scm_ ## m (SCM sev)                                \
-{                                                      \
-  Stream_event *ev = unsmob_stream_event (sev);                \
-  protect_event (sev);                                 \
-  listen_ ## m (ev);                                   \
-}
+#define ADD_LISTENER_FOR(cl, m, ev)                                     \
+  listener_list_ = scm_acons                                            \
+    (event_class_symbol (#ev),                                          \
+     method_finder<&cl::listen_ ## m> (),                               \
+     listener_list_)
+
+#define ADD_LISTENER(cl, m) ADD_LISTENER_FOR (cl, m, m)
 
 #endif /* TRANSLATOR_ICC */