2 translator.icc -- declare Translator glue wiring.
4 source file of the GNU LilyPond music typesetter
6 (c) 2005--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #define TRANSLATOR_ICC
12 #include "listener.hh"
13 #include "std-vector.hh"
14 #include "translator.hh"
17 A macro to automate administration of translators.
19 #define ADD_THIS_TRANSLATOR(T) \
20 translator_listener_record *T::listener_list_; \
21 SCM T::static_description_ = SCM_EOL; \
22 static void _ ## T ## _adder () \
25 T::static_description_ = t->static_translator_description (); \
26 scm_permanent_object (T::static_description_); \
29 SCM T::translator_description () const \
31 return static_description_; \
33 ADD_GLOBAL_CTOR (_ ## T ## _adder);
35 #define ADD_TRANSLATOR(classname, desc, grobs, accepted, read, write) \
36 Drul_array< vector<Acknowledge_information> > classname::acknowledge_static_array_drul_; \
37 IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname); \
38 ADD_THIS_TRANSLATOR (classname); \
39 Engraver_void_function_engraver_grob_info \
40 classname::static_get_acknowledger (SCM sym) \
42 return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[START]); \
44 Engraver_void_function_engraver_grob_info \
45 classname::static_get_end_acknowledger (SCM sym) \
47 return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[STOP]); \
50 classname::static_translator_description () const \
52 SCM static_properties = SCM_EOL; \
53 /* static_properties = acons (name , gh_str02scm (Translator::name (self_scm ())), \
54 static_properties_); \
56 static_properties = scm_acons (ly_symbol2scm ("grobs-created"), \
57 parse_symbol_list (grobs), static_properties); \
59 static_properties = scm_acons (ly_symbol2scm ("description"), \
60 scm_makfrom0str (desc), static_properties); \
62 static_properties = scm_acons (ly_symbol2scm ("events-accepted"), \
63 parse_symbol_list (accepted), static_properties); \
65 static_properties = scm_acons (ly_symbol2scm ("properties-read"), \
66 parse_symbol_list (read), static_properties); \
68 static_properties = scm_acons (ly_symbol2scm ("properties-written"), \
69 parse_symbol_list (write), static_properties); \
71 return static_properties; \
74 #define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T) \
76 T::fetch_precomputable_methods (Translator_void_method_ptr ptrs[]) \
78 ptrs[START_TRANSLATION_TIMESTEP] = \
79 ((Translator_void_method_ptr) & T::start_translation_timestep == \
80 (Translator_void_method_ptr) & Translator::start_translation_timestep) \
82 : (Translator_void_method_ptr) & T::start_translation_timestep; \
84 ptrs[STOP_TRANSLATION_TIMESTEP] = \
85 ((Translator_void_method_ptr) & T::stop_translation_timestep == (Translator_void_method_ptr) & Translator::stop_translation_timestep) \
87 : (Translator_void_method_ptr) & T::stop_translation_timestep; \
89 ptrs[PROCESS_MUSIC] = \
90 ((Translator_void_method_ptr) & T::process_music == (Translator_void_method_ptr) & Translator::process_music) \
92 : (Translator_void_method_ptr) & T::process_music; \
94 ptrs[PROCESS_ACKNOWLEDGED] = \
95 ((Translator_void_method_ptr) & T::process_acknowledged == (Translator_void_method_ptr) & Translator::process_acknowledged) \
97 : (Translator_void_method_ptr) & T::process_acknowledged; \
100 void add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
101 char const *func_name,
102 vector<Acknowledge_information> *ack_array);
104 Engraver_void_function_engraver_grob_info
105 generic_get_acknowledger (SCM sym,
106 vector<Acknowledge_information> const *ack_array);
108 #define ADD_ACKNOWLEDGER(CLASS, NAME) \
109 void CLASS ## NAME ## _ack_adder () \
111 add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[START]); \
113 ADD_SCM_INIT_FUNC (CLASS ## NAME ## _ack_adder_initclass, CLASS ## NAME ## _ack_adder);
115 #define ADD_END_ACKNOWLEDGER(CLASS, NAME) \
116 void CLASS ## NAME ## _end_ack_adder () \
118 add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_end_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[STOP]); \
120 ADD_SCM_INIT_FUNC (CLASS ## NAME ## _end_ack_adder_initclass, CLASS ## NAME ## _end_ack_adder);
123 Implement the method cl::listen_##m, and make it listen to stream
126 #define IMPLEMENT_TRANSLATOR_LISTENER(cl, m) \
128 cl :: _internal_declare_ ## m () \
130 static translator_listener_record r; \
131 add_translator_listener (&listener_list_, &r, _get_ ## m ## _listener, #m); \
134 ADD_SCM_INIT_FUNC (cl ## _declare_event_ ## m, cl::_internal_declare_ ## m); \
137 cl :: _get_ ## m ## _listener (void *me) \
139 cl *obj = (cl *) me; \
140 return obj->GET_LISTENER (_listen_scm_ ## m); \
143 IMPLEMENT_LISTENER (cl, _listen_scm_ ## m) \
145 cl::_listen_scm_ ## m (SCM sev) \
147 Stream_event *ev = unsmob_stream_event (sev); \
148 protect_event (sev); \
152 #endif /* TRANSLATOR_ICC */