lily/include/translator.icc

   1 /*
   2   translator.icc -- declare Translator glue wiring.
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #ifndef TRANSLATOR_ICC
  11 #define TRANSLATOR_ICC
  12
  13 #include "array.hh"
  14
  15 /**
  16    A macro to automate administration of translators.
  17 */
  18 #define ADD_THIS_TRANSLATOR(T)                                          \
  19   SCM T::static_description_ = SCM_EOL;                                 \
  20   static void _ ## T ## _adder ()                                       \
  21   {                                                                     \
  22     T *t = new T;                                                       \
  23     T::static_description_ = t->static_translator_description ();       \
  24     scm_permanent_object (T::static_description_);                      \
  25     add_translator (t);                                                 \
  26   }                                                                     \
  27   SCM T::translator_description () const                                \
  28   {                                                                     \
  29     return static_description_;                                         \
  30   }                                                                     \
  31   ADD_GLOBAL_CTOR (_ ## T ## _adder);
  32
  33 #define ADD_TRANSLATOR(classname, desc, grobs, accepted, acked, read, write) \
  34   Array<Acknowledge_information> classname::acknowledge_static_array_;\
  35   IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(classname); \
  36   ADD_THIS_TRANSLATOR (classname);                                      \
  37   Translator_void_method_ptr\
  38   classname::static_get_acknowledger (SCM sym)                          \
  39   {\
  40     return generic_get_acknowledger (sym, &acknowledge_static_array_);\
  41   }\
  42   SCM                                                                   \
  43   classname::static_translator_description () const                     \
  44   {                                                                     \
  45     SCM static_properties = SCM_EOL;                                    \
  46     /*  static_properties = acons (name , gh_str02scm (Translator::name (self_scm ())), \
  47         static_properties_);                                            \
  48     */                                                                  \
  49     static_properties = scm_acons (ly_symbol2scm ("grobs-created"),     \
  50                                    parse_symbol_list (grobs), static_properties); \
  51                                                                         \
  52     static_properties = scm_acons (ly_symbol2scm ("description"),       \
  53                                    scm_makfrom0str (desc), static_properties); \
  54                                                                         \
  55     static_properties = scm_acons (ly_symbol2scm ("interfaces-acked"),  \
  56                                    parse_symbol_list (acked), static_properties); \
  57     static_properties = scm_acons (ly_symbol2scm ("events-accepted"),   \
  58                                    parse_symbol_list (accepted), static_properties); \
  59                                                                         \
  60     static_properties = scm_acons (ly_symbol2scm ("properties-read"),   \
  61                                    parse_symbol_list (read), static_properties); \
  62                                                                         \
  63     static_properties = scm_acons (ly_symbol2scm ("properties-written"), \
  64                                    parse_symbol_list (write), static_properties); \
  65                                                                         \
  66     return static_properties;                                           \
  67   }
  68
  69 #define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T) \
  70 void \
  71 T::fetch_precomputable_methods (Translator_void_method_ptr ptrs[])\
  72 {                                                                       \
  73   ptrs[START_TRANSLATION_TIMESTEP] =                                    \
  74     ((Translator_void_method_ptr) &T::start_translation_timestep == \
  75      (Translator_void_method_ptr) &Translator::start_translation_timestep)      \
  76     ? 0                                                                 \
  77     : (Translator_void_method_ptr) &T::start_translation_timestep;      \
  78                                                                         \
  79   ptrs[STOP_TRANSLATION_TIMESTEP] =                                     \
  80     ((Translator_void_method_ptr) &T::stop_translation_timestep == (Translator_void_method_ptr) &Translator::stop_translation_timestep) \
  81     ? 0                                                                 \
  82     : (Translator_void_method_ptr) &T::stop_translation_timestep;       \
  83                                                                         \
  84   ptrs[PROCESS_MUSIC] =                                                 \
  85     ((Translator_void_method_ptr) &T::process_music == (Translator_void_method_ptr) &Translator::process_music)                 \
  86     ? 0                                                                 \
  87     : (Translator_void_method_ptr) &T::process_music;           \
  88                                                                         \
  89   ptrs[PROCESS_ACKNOWLEDGED] =                                          \
  90     ((Translator_void_method_ptr) &T::process_acknowledged == (Translator_void_method_ptr) &Translator::process_acknowledged)   \
  91     ? 0                                                                 \
  92     : (Translator_void_method_ptr) &T::process_acknowledged;            \
  93 }
  94
  95 void add_acknowledger (Translator_void_method_ptr ptr, const char *func_name, Array<Acknowledge_information> *ack_array);
  96 Translator_void_method_ptr
  97 generic_get_acknowledger (SCM sym, Array<Acknowledge_information> const *ack_array);
  98
  99 #define ADD_ACKNOWLEDGER(CLASS,NAME)            \
 100 void CLASS ## NAME ## _ack_adder () \
 101 {\
 102   add_acknowledger ((Translator_void_method_ptr) &CLASS::NAME, #NAME, &CLASS::acknowledge_static_array_);\
 103 }\
 104 ADD_SCM_INIT_FUNC(CLASS ## NAME ## _ack_adder);\
 105
 106
 107
 108 #endif /* TRANSLATOR_ICC */
 109