2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2005--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
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.
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.
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/>.
20 #ifndef TRANSLATOR_ICC
21 #define TRANSLATOR_ICC
23 #include "listener.hh"
24 #include "std-vector.hh"
25 #include "translator.hh"
28 TODO: derive "foo-bar-interface" from Foo_bar classname.
32 A macro to automate administration of translators.
34 #define ADD_THIS_TRANSLATOR(T) \
35 SCM T::static_description_ = SCM_EOL; \
36 static void _ ## T ## _adder () \
39 T::static_description_ = t->static_translator_description (); \
40 scm_permanent_object (T::static_description_); \
43 SCM T::translator_description () const \
45 return static_description_; \
47 ADD_GLOBAL_CTOR (_ ## T ## _adder); \
50 #define DEFINE_TRANSLATOR_LISTENER_LIST(T) \
51 translator_listener_record *T::listener_list_; \
54 #define DEFINE_ACKNOWLEDGERS(classname) \
55 Drul_array< vector<Acknowledge_information> > classname::acknowledge_static_array_drul_; \
56 Engraver_void_function_engraver_grob_info \
57 classname::static_get_acknowledger (SCM sym) \
59 return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[START]); \
61 Engraver_void_function_engraver_grob_info \
62 classname::static_get_end_acknowledger (SCM sym) \
64 return generic_get_acknowledger (sym, &acknowledge_static_array_drul_[STOP]); \
68 #define DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write) \
70 classname::static_translator_description () const \
72 return Translator::static_translator_description (grobs, desc, listener_list_, read, write); \
75 #define ADD_TRANSLATOR(classname, desc, grobs, read, write) \
76 IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS (classname); \
77 ADD_THIS_TRANSLATOR (classname); \
78 DEFINE_TRANSLATOR_DOC(classname, desc, grobs, read, write) \
79 DEFINE_ACKNOWLEDGERS(classname) \
80 DEFINE_TRANSLATOR_LISTENER_LIST(classname) \
82 #define IMPLEMENT_FETCH_PRECOMPUTABLE_METHODS(T) \
84 T::fetch_precomputable_methods (Translator_void_method_ptr ptrs[]) \
86 ptrs[START_TRANSLATION_TIMESTEP] = \
87 ((Translator_void_method_ptr) & T::start_translation_timestep == \
88 (Translator_void_method_ptr) & Translator::start_translation_timestep) \
90 : (Translator_void_method_ptr) & T::start_translation_timestep; \
92 ptrs[STOP_TRANSLATION_TIMESTEP] = \
93 ((Translator_void_method_ptr) & T::stop_translation_timestep == (Translator_void_method_ptr) & Translator::stop_translation_timestep) \
95 : (Translator_void_method_ptr) & T::stop_translation_timestep; \
97 ptrs[PROCESS_MUSIC] = \
98 ((Translator_void_method_ptr) & T::process_music == (Translator_void_method_ptr) & Translator::process_music) \
100 : (Translator_void_method_ptr) & T::process_music; \
102 ptrs[PROCESS_ACKNOWLEDGED] = \
103 ((Translator_void_method_ptr) & T::process_acknowledged == (Translator_void_method_ptr) & Translator::process_acknowledged) \
105 : (Translator_void_method_ptr) & T::process_acknowledged; \
108 void add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
109 char const *func_name,
110 vector<Acknowledge_information> *ack_array);
112 Engraver_void_function_engraver_grob_info
113 generic_get_acknowledger (SCM sym,
114 vector<Acknowledge_information> const *ack_array);
116 #define ADD_ACKNOWLEDGER(CLASS, NAME) \
117 void CLASS ## NAME ## _ack_adder () \
119 add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[START]); \
121 ADD_SCM_INIT_FUNC (CLASS ## NAME ## _ack_adder_initclass, CLASS ## NAME ## _ack_adder);
123 #define ADD_END_ACKNOWLEDGER(CLASS, NAME) \
124 void CLASS ## NAME ## _end_ack_adder () \
126 add_acknowledger ((Engraver_void_function_engraver_grob_info) & CLASS::acknowledge_end_ ## NAME, #NAME, &CLASS::acknowledge_static_array_drul_[STOP]); \
128 ADD_SCM_INIT_FUNC (CLASS ## NAME ## _end_ack_adder_initclass, CLASS ## NAME ## _end_ack_adder);
131 Implement the method cl::listen_##m, and make it listen to stream
134 #define IMPLEMENT_TRANSLATOR_LISTENER(cl, m) \
136 cl :: _internal_declare_ ## m () \
138 static translator_listener_record r; \
139 add_translator_listener (&listener_list_, &r, _get_ ## m ## _listener, #m); \
142 ADD_SCM_INIT_FUNC (cl ## _declare_event_ ## m, cl::_internal_declare_ ## m); \
145 cl :: _get_ ## m ## _listener (void *me, SCM unused) \
147 cl *obj = (cl *) me; \
149 return obj->GET_LISTENER (_listen_scm_ ## m); \
152 IMPLEMENT_LISTENER (cl, _listen_scm_ ## m) \
154 cl::_listen_scm_ ## m (SCM sev) \
156 Stream_event *ev = unsmob_stream_event (sev); \
157 protect_event (sev); \
161 #endif /* TRANSLATOR_ICC */