lily/include/translator.icc

   1 /* -*- c++ -*-
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2005--2015 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 #ifndef TRANSLATOR_ICC
  21 #define TRANSLATOR_ICC
  22
  23 #include "callback.hh"
  24 #include "std-vector.hh"
  25 #include "engraver.hh"
  26
  27 /*
  28   TODO: derive "foo-bar-interface" from Foo_bar classname.
  29  */
  30
  31 /**
  32    A macro to automate administration of translators.
  33 */
  34 #define ADD_THIS_TRANSLATOR(T)                                          \
  35   SCM T::static_description_ = SCM_EOL;                                 \
  36   static void _ ## T ## _adder ()                                       \
  37   {                                                                     \
  38     T *t = new T;                                                       \
  39     T::static_description_ =                                            \
  40       scm_permanent_object (t->static_translator_description ());       \
  41     add_translator (t);                                                 \
  42   }                                                                     \
  43   SCM T::translator_description () const                                \
  44   {                                                                     \
  45     return static_description_;                                         \
  46   }                                                                     \
  47   ADD_GLOBAL_CTOR (_ ## T ## _adder); \
  48   /* end define */
  49
  50 #define DEFINE_TRANSLATOR_LISTENER_LIST(T) \
  51   Protected_scm T::listener_list_ (SCM_EOL);    \
  52   /* end define */
  53
  54 #define DEFINE_ACKNOWLEDGERS(classname) \
  55   Drul_array<Protected_scm> classname::acknowledge_static_array_drul_;  \
  56   SCM                                                                   \
  57   classname::static_get_acknowledger (SCM sym)                          \
  58   {                                                                     \
  59     return generic_get_acknowledger (sym, acknowledge_static_array_drul_[START]);      \
  60   }                                                                     \
  61   SCM                                                                   \
  62   classname::static_get_end_acknowledger (SCM sym)                      \
  63   {                                                                     \
  64     return generic_get_acknowledger (sym, acknowledge_static_array_drul_[STOP]);       \
  65   }                                                                     \
  66   /* end define */
  67
  68 #define DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write)              \
  69   SCM                                                                   \
  70   classname::static_translator_description () const                     \
  71   {                                                                     \
  72     return Translator::static_translator_description (grobs, desc, listener_list_, read, write); \
  73   }
  74
  75 #define ADD_TRANSLATOR(classname, desc, grobs, read, write)             \
  76   IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname);                    \
  77   DEFINE_ACKNOWLEDGERS(classname);                                      \
  78   ADD_THIS_TRANSLATOR (classname);                                      \
  79   DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write)            \
  80   DEFINE_TRANSLATOR_LISTENER_LIST(classname)                            \
  81
  82 #define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T)                        \
  83   void                                                                  \
  84   T::fetch_precomputable_methods (SCM ptrs[])                           \
  85   {                                                                     \
  86     ptrs[START_TRANSLATION_TIMESTEP] =                                  \
  87       method_finder <&T::start_translation_timestep> ();                \
  88                                                                         \
  89     ptrs[STOP_TRANSLATION_TIMESTEP] =                                   \
  90       method_finder <&T::stop_translation_timestep> ();                 \
  91                                                                         \
  92     ptrs[PROCESS_MUSIC] =                                               \
  93       method_finder <&T::process_music> ();                             \
  94                                                                         \
  95     ptrs[PROCESS_ACKNOWLEDGED] =                                        \
  96       method_finder <&T::process_acknowledged> ();                      \
  97   }
  98
  99 void add_acknowledger (SCM ptr,
 100                        char const *func_name,
 101                        Protected_scm &ack_hash);
 102
 103 #define ADD_ACKNOWLEDGER(CLASS, NAME)                                   \
 104   void CLASS ## NAME ## _ack_adder ()                                   \
 105   {                                                                     \
 106     add_acknowledger (CLASS::ack_finder<&CLASS::acknowledge_ ## NAME> (), \
 107                       #NAME, CLASS::acknowledge_static_array_drul_[START]); \
 108   }                                                                     \
 109   ADD_SCM_INIT_FUNC (CLASS ## NAME ## _ack_adder_initclass, CLASS ## NAME ## _ack_adder);
 110
 111 #define ADD_END_ACKNOWLEDGER(CLASS, NAME)                               \
 112   void CLASS ## NAME ## _end_ack_adder ()                               \
 113   {                                                                     \
 114     add_acknowledger (CLASS::ack_finder<&CLASS::acknowledge_end_ ## NAME> (), \
 115                       #NAME, CLASS::acknowledge_static_array_drul_[STOP]); \
 116   }                                                                     \
 117   ADD_SCM_INIT_FUNC (CLASS ## NAME ## _end_ack_adder_initclass, CLASS ## NAME ## _end_ack_adder);
 118
 119 /*
 120   Implement the method cl::listen_##m, and make it listen to stream
 121   events of class m.
 122  */
 123 #define IMPLEMENT_TRANSLATOR_LISTENER(cl, m)            \
 124 void                                                    \
 125 cl :: _internal_declare_ ## m ()                        \
 126 {                                                       \
 127   listener_list_ = scm_acons                                            \
 128     (event_class_symbol (#m),                                           \
 129      Callback_wrapper::make_smob                                        \
 130      <trampoline <cl, &cl::listen_ ## m> > (), listener_list_);         \
 131 }                                                                       \
 132                                                                         \
 133 ADD_SCM_INIT_FUNC (cl ## _declare_event_ ## m, cl::_internal_declare_ ## m);
 134
 135 #endif /* TRANSLATOR_ICC */