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 "input.hh" // for error reporting
28 #include "std-vector.hh"
29 #include "protected-scm.hh"
31 #define TRANSLATOR_FAMILY_DECLARATIONS(NAME) \
33 VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \
34 static Drul_array<vector<Acknowledge_information> > acknowledge_static_array_drul_; \
35 virtual void fetch_precomputable_methods (Callback methods[]); \
36 static Grob_info_callback static_get_acknowledger (SCM sym); \
37 static Grob_info_callback static_get_end_acknowledger(SCM); \
38 virtual Grob_info_callback get_acknowledger (SCM sym) \
40 return static_get_acknowledger (sym); \
42 virtual Grob_info_callback get_end_acknowledger (SCM sym) \
44 return static_get_end_acknowledger (sym); \
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) \
56 TRANSLATOR_FAMILY_DECLARATIONS(NAME) \
57 static SCM static_description_; \
58 static Protected_scm listener_list_; \
61 virtual SCM static_translator_description () const; \
62 virtual SCM translator_description () const; \
63 virtual SCM get_listener_list () const \
65 return listener_list_; \
69 #define DECLARE_TRANSLATOR_LISTENER(m) \
71 inline void listen_ ## m (Stream_event *); \
72 /* Should be private */ \
73 static void _internal_declare_ ## m ();
75 #define DECLARE_ACKNOWLEDGER(x) public : void acknowledge_ ## x (Grob_info); protected:
76 #define DECLARE_END_ACKNOWLEDGER(x) public : void acknowledge_end_ ## x (Grob_info); protected:
78 enum Translator_precompute_index
80 START_TRANSLATION_TIMESTEP,
81 STOP_TRANSLATION_TIMESTEP,
84 TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
88 Translate music into grobs.
90 class Translator : public Smob<Translator>
93 // We don't make Grob_info_callback specific to Engraver since we
94 // otherwise get into a circular mess with regard to the definitions
95 // as the timing of Engraver is exercised from within Translator
96 typedef void (Translator::*Grob_info_callback) (Grob_info);
97 typedef void (Translator::*Callback) (void);
98 int print_smob (SCM, scm_print_state *) const;
99 SCM mark_smob () const;
100 static const char type_p_name_[];
101 virtual ~Translator ();
106 Context *context () const { return daddy_context_; }
109 Translator (Translator const &);
111 SCM internal_get_property (SCM symbol) const;
113 virtual Output_def *get_output_def () const;
114 virtual Translator_group *get_daddy_translator ()const;
115 virtual Moment now_mom () const;
116 virtual bool must_be_last () const;
118 virtual void initialize ();
119 virtual void finalize ();
121 virtual void connect_to_context (Context *c);
122 virtual void disconnect_from_context (Context *c);
124 void stop_translation_timestep ();
125 void start_translation_timestep ();
126 void process_music ();
127 void process_acknowledged ();
129 Context *get_score_context () const;
130 Global_context *get_global_context () const;
132 DECLARE_CLASSNAME (Translator);
133 virtual Translator *clone () const = 0;
134 virtual void fetch_precomputable_methods (Callback methods[]) = 0;
135 virtual SCM get_listener_list () const = 0;
136 virtual SCM translator_description () const = 0;
137 virtual Grob_info_callback get_acknowledger (SCM sym) = 0;
138 virtual Grob_info_callback get_end_acknowledger (SCM sym) = 0;
140 protected: // should be private.
141 Context *daddy_context_;
142 void protect_event (SCM ev);
144 template <class T, void (T::*callback)(Stream_event *)>
145 static SCM trampoline (SCM target, SCM event)
147 T *t = unsmob<T> (target);
148 LY_ASSERT_SMOB (T, target, 1);
149 LY_ASSERT_SMOB (Stream_event, event, 2);
151 t->protect_event (event);
152 (t->*callback) (unsmob<Stream_event> (event));
153 return SCM_UNSPECIFIED;
156 virtual void derived_mark () const;
157 static SCM event_class_symbol (const char *ev_class);
158 SCM static_translator_description (const char *grobs,
162 const char *write) const;
164 friend class Translator_group;
167 struct Acknowledge_information
170 Translator::Grob_info_callback function_;
172 Acknowledge_information ()
180 void add_translator (Translator *trans);
182 Translator *get_translator (SCM s);
183 Moment get_event_length (Stream_event *s, Moment now);
184 Moment get_event_length (Stream_event *s);
187 This helper is only meaningful inside listen_* methods.
189 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
190 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
192 #endif // TRANSLATOR_HH