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 "stream-event.hh"
30 #include "std-vector.hh"
31 #include "protected-scm.hh"
33 #define TRANSLATOR_FAMILY_DECLARATIONS(NAME) \
35 VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \
36 virtual void fetch_precomputable_methods (SCM methods[]); \
37 DECLARE_TRANSLATOR_CALLBACKS (NAME); \
38 TRANSLATOR_INHERIT (Translator); \
41 #define TRANSLATOR_INHERIT(BASE) \
42 using BASE::method_finder
44 #define DECLARE_TRANSLATOR_CALLBACKS(NAME) \
45 template <void (NAME::*mf)()> \
46 static SCM method_finder () \
48 return Callback0_wrapper::make_smob<NAME, mf> (); \
50 template <void (NAME::*mf)(Stream_event *)> \
51 static SCM method_finder () \
53 return Callback_wrapper::make_smob<trampoline<NAME, mf> > (); \
55 template <void (NAME::*callback)(Grob_info)> \
56 static SCM method_finder () { \
57 return Callback2_wrapper::make_smob<ack_trampoline <NAME, callback> > (); \
62 Each translator class has a static alist of event class symbols
63 mapping to callbacks that are called with a translator instance and
64 a stream event when an event of the appropriate event class is
65 announced in a context.
68 #define TRANSLATOR_DECLARATIONS(NAME) \
70 TRANSLATOR_FAMILY_DECLARATIONS (NAME); \
71 static Drul_array<Protected_scm> acknowledge_static_array_drul_; \
72 static SCM static_description_; \
73 static Protected_scm listener_list_; \
74 static SCM static_get_acknowledger (SCM sym, Direction start_end); \
75 virtual SCM get_acknowledger (SCM sym, Direction start_end) \
77 return static_get_acknowledger (sym, start_end); \
81 static void boot (); \
82 virtual SCM static_translator_description () const; \
83 virtual SCM translator_description () const; \
84 virtual SCM get_listener_list () const \
86 return listener_list_; \
90 enum Translator_precompute_index
92 START_TRANSLATION_TIMESTEP,
93 STOP_TRANSLATION_TIMESTEP,
96 TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
100 Translate music into grobs.
102 class Translator : public Smob<Translator>
105 int print_smob (SCM, scm_print_state *) const;
106 SCM mark_smob () const;
107 static const char * const type_p_name_;
108 virtual ~Translator ();
113 Context *context () const { return daddy_context_; }
116 Translator (Translator const &);
118 SCM internal_get_property (SCM symbol) const;
120 virtual Output_def *get_output_def () const;
121 virtual Translator_group *get_daddy_translator ()const;
122 virtual Moment now_mom () const;
123 virtual bool must_be_last () const;
125 virtual void initialize ();
126 virtual void finalize ();
128 virtual void connect_to_context (Context *c);
129 virtual void disconnect_from_context (Context *c);
131 void stop_translation_timestep ();
132 void start_translation_timestep ();
133 void process_music ();
134 void process_acknowledged ();
136 Context *get_score_context () const;
137 Global_context *get_global_context () const;
139 DECLARE_CLASSNAME (Translator);
140 virtual Translator *clone () const = 0;
141 virtual void fetch_precomputable_methods (SCM methods[]) = 0;
142 virtual SCM get_listener_list () const = 0;
143 virtual SCM translator_description () const = 0;
144 virtual SCM get_acknowledger (SCM sym, Direction start_end) = 0;
146 protected: // should be private.
147 Context *daddy_context_;
148 void protect_event (SCM ev);
150 template <class T, void (T::*callback)(Stream_event *)>
151 static SCM trampoline (SCM target, SCM event)
153 T *t = unsmob<T> (target);
154 LY_ASSERT_SMOB (T, target, 1);
155 LY_ASSERT_SMOB (Stream_event, event, 2);
157 t->protect_event (event);
158 (t->*callback) (unsmob<Stream_event> (event));
159 return SCM_UNSPECIFIED;
162 // Fallback for non-overriden callbacks for which &T::x degrades to
164 template <void (Translator::*)()>
166 method_finder () { return SCM_UNDEFINED; }
168 // Overriden in Engraver. Don't instantiate.
169 template <class T, void (T::*)(Grob_info)>
170 static SCM ack_trampoline (SCM, SCM, SCM);
172 virtual void derived_mark () const;
173 static SCM event_class_symbol (const char *ev_class);
174 SCM static_translator_description (const char *grobs,
178 const char *write) const;
180 friend class Translator_group;
183 void add_translator (Translator *trans);
185 Translator *get_translator (SCM s);
188 generic_get_acknowledger (SCM sym, SCM ack_hash);
190 Moment get_event_length (Stream_event *s, Moment now);
191 Moment get_event_length (Stream_event *s);
194 This helper is only meaningful inside listen_* methods.
196 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
197 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
199 #endif // TRANSLATOR_HH