2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 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/>.
23 #include "global-ctor.hh"
24 #include "lily-proto.hh"
25 #include "virtual-methods.hh"
26 #include "callback.hh"
27 #include "input.hh" // for error reporting
29 #include "std-vector.hh"
30 #include "protected-scm.hh"
32 #define TRANSLATOR_FAMILY_DECLARATIONS(NAME) \
34 VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \
35 virtual void fetch_precomputable_methods (SCM methods[]); \
36 DECLARE_TRANSLATOR_CALLBACKS (NAME); \
37 TRANSLATOR_INHERIT (Translator) \
40 #define TRANSLATOR_INHERIT(BASE) \
41 using BASE::method_finder; \
42 using BASE::ack_finder;
44 #define DECLARE_TRANSLATOR_CALLBACKS(NAME) \
45 template <void (NAME::*mf)()> \
46 static SCM method_finder () { return method_find_base<NAME, mf> (); } \
47 template <void (NAME::*callback)(Grob_info)> \
48 static SCM ack_finder () { return ack_find_base<NAME, callback> (); } \
52 Each translator class has a static alist of event class symbols
53 mapping to callbacks that are called with a translator instance and
54 a stream event when an event of the appropriate event class is
55 announced in a context.
58 #define TRANSLATOR_DECLARATIONS(NAME) \
60 TRANSLATOR_FAMILY_DECLARATIONS (NAME); \
61 static Drul_array<Protected_scm> acknowledge_static_array_drul_; \
62 static SCM static_description_; \
63 static Protected_scm listener_list_; \
64 static SCM static_get_acknowledger (SCM sym, Direction start_end); \
65 virtual SCM get_acknowledger (SCM sym, Direction start_end) \
67 return static_get_acknowledger (sym, start_end); \
71 static void boot (); \
72 virtual SCM static_translator_description () const; \
73 virtual SCM translator_description () const; \
74 virtual SCM get_listener_list () const \
76 return listener_list_; \
80 #define DECLARE_TRANSLATOR_LISTENER(m) \
82 inline void listen_ ## m (Stream_event *); \
83 /* Should be private */ \
84 static void _internal_declare_ ## m ();
86 #define DECLARE_ACKNOWLEDGER(x) public : void acknowledge_ ## x (Grob_info); protected:
87 #define DECLARE_END_ACKNOWLEDGER(x) public : void acknowledge_end_ ## x (Grob_info); protected:
89 enum Translator_precompute_index
91 START_TRANSLATION_TIMESTEP,
92 STOP_TRANSLATION_TIMESTEP,
95 TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
99 Translate music into grobs.
101 class Translator : public Smob<Translator>
104 int print_smob (SCM, scm_print_state *) const;
105 SCM mark_smob () const;
106 static const char type_p_name_[];
107 virtual ~Translator ();
112 Context *context () const { return daddy_context_; }
115 Translator (Translator const &);
117 SCM internal_get_property (SCM symbol) const;
119 virtual Output_def *get_output_def () const;
120 virtual Translator_group *get_daddy_translator ()const;
121 virtual Moment now_mom () const;
122 virtual bool must_be_last () const;
124 virtual void initialize ();
125 virtual void finalize ();
127 virtual void connect_to_context (Context *c);
128 virtual void disconnect_from_context (Context *c);
130 void stop_translation_timestep ();
131 void start_translation_timestep ();
132 void process_music ();
133 void process_acknowledged ();
135 Context *get_score_context () const;
136 Global_context *get_global_context () const;
138 DECLARE_CLASSNAME (Translator);
139 virtual Translator *clone () const = 0;
140 virtual void fetch_precomputable_methods (SCM methods[]) = 0;
141 virtual SCM get_listener_list () const = 0;
142 virtual SCM translator_description () const = 0;
143 virtual SCM get_acknowledger (SCM sym, Direction start_end) = 0;
145 protected: // should be private.
146 Context *daddy_context_;
147 void protect_event (SCM ev);
149 template <class T, void (T::*callback)(Stream_event *)>
150 static SCM trampoline (SCM target, SCM event)
152 T *t = unsmob<T> (target);
153 LY_ASSERT_SMOB (T, target, 1);
154 LY_ASSERT_SMOB (Stream_event, event, 2);
156 t->protect_event (event);
157 (t->*callback) (unsmob<Stream_event> (event));
158 return SCM_UNSPECIFIED;
161 template <class T, void (T::*mf)()>
163 method_find_base () { return Callback0_wrapper::make_smob<T, mf> (); }
165 // Fallback for non-overriden callbacks for which &T::x degrades to
167 template <void (Translator::*)()>
169 method_finder () { return SCM_UNDEFINED; }
171 // Overriden in Engraver.
172 template <class T, void (T::*callback)(Grob_info)>
174 ack_find_base () { return SCM_UNDEFINED; }
176 template <void (Translator::*)(Grob_info)>
178 ack_finder () { return SCM_UNDEFINED; }
180 virtual void derived_mark () const;
181 static SCM event_class_symbol (const char *ev_class);
182 SCM static_translator_description (const char *grobs,
186 const char *write) const;
188 friend class Translator_group;
191 void add_translator (Translator *trans);
193 Translator *get_translator (SCM s);
196 generic_get_acknowledger (SCM sym, SCM ack_hash);
198 Moment get_event_length (Stream_event *s, Moment now);
199 Moment get_event_length (Stream_event *s);
202 This helper is only meaningful inside listen_* methods.
204 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
205 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
207 #endif // TRANSLATOR_HH