2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2014 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 struct Acknowledge_information
34 Engraver_void_function_engraver_grob_info function_;
36 Acknowledge_information ()
44 Each translator class has a static list of listener records. Each
45 record makes one explains how to register one of the class's stream event
46 listeners to a context.
48 typedef struct translator_listener_record
50 Listener (*get_listener_) (void *, SCM event_class);
52 struct translator_listener_record *next_;
54 translator_listener_record ()
57 event_class_ = SCM_EOL;
61 } translator_listener_record;
63 #define TRANSLATOR_DECLARATIONS_NO_LISTENER(NAME) \
67 VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \
68 static SCM static_description_; \
69 static Drul_array<vector<Acknowledge_information> > acknowledge_static_array_drul_; \
70 virtual void fetch_precomputable_methods (Translator_void_method_ptr methods[]); \
71 virtual SCM static_translator_description () const; \
72 virtual SCM translator_description () const; \
73 static Engraver_void_function_engraver_grob_info static_get_acknowledger (SCM sym); \
74 static Engraver_void_function_engraver_grob_info static_get_end_acknowledger(SCM); \
75 virtual Engraver_void_function_engraver_grob_info get_acknowledger (SCM sym) \
77 return static_get_acknowledger (sym); \
79 virtual Engraver_void_function_engraver_grob_info get_end_acknowledger (SCM sym) \
81 return static_get_end_acknowledger (sym); \
85 #define TRANSLATOR_DECLARATIONS(NAME) \
86 TRANSLATOR_DECLARATIONS_NO_LISTENER(NAME) \
88 static translator_listener_record *listener_list_; \
90 virtual translator_listener_record *get_listener_list () const \
92 return listener_list_; \
96 #define DECLARE_TRANSLATOR_LISTENER(m) \
98 inline void listen_ ## m (Stream_event *); \
99 /* Should be private */ \
100 static void _internal_declare_ ## m (); \
102 static Listener _get_ ## m ## _listener (void *, SCM); \
103 DECLARE_LISTENER (_listen_scm_ ## m);
105 #define DECLARE_ACKNOWLEDGER(x) public : void acknowledge_ ## x (Grob_info); protected:
106 #define DECLARE_END_ACKNOWLEDGER(x) public : void acknowledge_end_ ## x (Grob_info); protected:
108 enum Translator_precompute_index
110 START_TRANSLATION_TIMESTEP,
111 STOP_TRANSLATION_TIMESTEP,
113 PROCESS_ACKNOWLEDGED,
114 TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
118 Translate music into grobs.
120 class Translator : public Smob<Translator>
123 static int print_smob (SCM, SCM, scm_print_state *);
125 static const char type_p_name_[];
126 virtual ~Translator ();
131 Context *context () const { return daddy_context_; }
133 Translator (Translator const &);
135 SCM internal_get_property (SCM symbol) const;
137 virtual Output_def *get_output_def () const;
138 virtual Translator_group *get_daddy_translator ()const;
139 virtual Moment now_mom () const;
140 virtual bool must_be_last () const;
142 virtual void initialize ();
143 virtual void finalize ();
145 virtual void connect_to_context (Context *c);
146 virtual void disconnect_from_context (Context *c);
148 void stop_translation_timestep ();
149 void start_translation_timestep ();
150 void process_music ();
151 void process_acknowledged ();
153 Context *get_score_context () const;
154 Global_context *get_global_context () const;
156 TRANSLATOR_DECLARATIONS (Translator);
158 protected: // should be private.
159 Context *daddy_context_;
160 void protect_event (SCM ev);
161 virtual void derived_mark () const;
162 static void add_translator_listener (translator_listener_record **listener_list,
163 translator_listener_record *r,
164 Listener (*get_listener) (void *, SCM),
165 const char *ev_class);
166 SCM static_translator_description (const char *grobs,
168 translator_listener_record *listener_list,
170 const char *write) const;
172 friend class Translator_group;
175 void add_translator (Translator *trans);
177 Translator *get_translator (SCM s);
178 Moment get_event_length (Stream_event *s, Moment now);
179 Moment get_event_length (Stream_event *s);
182 This helper is only meaningful inside listen_* methods.
184 extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
185 #define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
187 #endif // TRANSLATOR_HH