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;
43 #define DECLARE_TRANSLATOR_CALLBACKS(NAME) \
44 template <void (NAME::*mf)()> \
45 static SCM method_finder () { return method_find_base<NAME, mf> (); } \
49 Each translator class has a static alist of event class symbols
50 mapping to callbacks that are called with a translator instance and
51 a stream event when an event of the appropriate event class is
52 announced in a context.
55 #define TRANSLATOR_DECLARATIONS(NAME) \
57 TRANSLATOR_FAMILY_DECLARATIONS (NAME); \
58 static Drul_array<Protected_scm> acknowledge_static_array_drul_; \
59 static SCM static_description_; \
60 static Protected_scm listener_list_; \
61 static SCM static_get_acknowledger (SCM sym, Direction start_end); \
62 virtual SCM get_acknowledger (SCM sym, Direction start_end) \
64 return static_get_acknowledger (sym, start_end); \
68 static void boot (); \
69 virtual SCM static_translator_description () const; \
70 virtual SCM translator_description () const; \
71 virtual SCM get_listener_list () const \
73 return listener_list_; \
77 enum Translator_precompute_index
79 START_TRANSLATION_TIMESTEP,
80 STOP_TRANSLATION_TIMESTEP,
83 TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
87 Translate music into grobs.
89 class Translator : public Smob<Translator>
92 int print_smob (SCM, scm_print_state *) const;
93 SCM mark_smob () const;
94 static const char type_p_name_[];
95 virtual ~Translator ();
100 Context *context () const { return daddy_context_; }
103 Translator (Translator const &);
105 SCM internal_get_property (SCM symbol) const;
107 virtual Output_def *get_output_def () const;
108 virtual Translator_group *get_daddy_translator ()const;
109 virtual Moment now_mom () const;
110 virtual bool must_be_last () const;
112 virtual void initialize ();
113 virtual void finalize ();
115 virtual void connect_to_context (Context *c);
116 virtual void disconnect_from_context (Context *c);
118 void stop_translation_timestep ();
119 void start_translation_timestep ();
120 void process_music ();
121 void process_acknowledged ();
123 Context *get_score_context () const;
124 Global_context *get_global_context () const;
126 DECLARE_CLASSNAME (Translator);
127 virtual Translator *clone () const = 0;
128 virtual void fetch_precomputable_methods (SCM methods[]) = 0;
129 virtual SCM get_listener_list () const = 0;
130 virtual SCM translator_description () const = 0;
131 virtual SCM get_acknowledger (SCM sym, Direction start_end) = 0;
133 protected: // should be private.
134 Context *daddy_context_;
135 void protect_event (SCM ev);
137 template <class T, void (T::*callback)(Stream_event *)>
138 static SCM trampoline (SCM target, SCM event)
140 T *t = unsmob<T> (target);
141 LY_ASSERT_SMOB (T, target, 1);
142 LY_ASSERT_SMOB (Stream_event, event, 2);
144 t->protect_event (event);
145 (t->*callback) (unsmob<Stream_event> (event));
146 return SCM_UNSPECIFIED;
149 template <class T, void (T::*mf)()>
151 method_find_base () { return Callback0_wrapper::make_smob<T, mf> (); }
153 // Fallback for non-overriden callbacks for which &T::x degrades to
155 template <void (Translator::*)()>
157 method_finder () { return SCM_UNDEFINED; }
159 virtual void derived_mark () const;
160 static SCM event_class_symbol (const char *ev_class);
161 SCM static_translator_description (const char *grobs,
165 const char *write) const;
167 friend class Translator_group;
170 void add_translator (Translator *trans);
172 Translator *get_translator (SCM s);
175 generic_get_acknowledger (SCM sym, SCM ack_hash);
177 Moment get_event_length (Stream_event *s, Moment now);
178 Moment get_event_length (Stream_event *s);
181 This helper is only meaningful inside listen_* methods.
183 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
184 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
186 #endif // TRANSLATOR_HH