2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2012 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/>.
20 #include "translator.hh"
22 #include "context-def.hh"
23 #include "dispatcher.hh"
24 #include "global-context.hh"
25 #include "international.hh"
26 #include "translator-group.hh"
29 #include "translator.icc"
30 #include "ly-smobs.icc"
32 Translator::~Translator ()
45 Translator::process_music ()
50 Translator::process_acknowledged ()
54 Translator::Translator ()
59 Translator::Translator (Translator const &src)
66 Translator::now_mom () const
68 return daddy_context_->now_mom ();
72 Translator::get_output_def () const
74 return daddy_context_->get_output_def ();
78 Translator::get_daddy_translator () const
80 return daddy_context_->implementation ();
84 Translator::protect_event (SCM ev)
86 get_daddy_translator ()->protect_event (ev);
90 Translator::internal_get_property (SCM sym) const
92 return daddy_context_->internal_get_property (sym);
96 Translator::stop_translation_timestep ()
101 this function is called once each moment, before any user
102 information enters the translators. (i.e. no \property or event has
106 Translator::start_translation_timestep ()
111 Translator::initialize ()
116 Translator::finalize ()
121 Translator::connect_to_context (Context *c)
123 for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
124 c->events_below ()->add_listener (r->get_listener_ (this, r->event_class_),
129 Translator::disconnect_from_context (Context *c)
131 for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
132 c->events_below ()->remove_listener (r->get_listener_ (this, r->event_class_),
137 internally called once, statically, for each translator
138 listener. Connects the name of an event class with a procedure that
139 fetches the corresponding listener.
141 The method should only be called from the macro
142 IMPLEMENT_TRANSLATOR_LISTENER.
145 Translator::add_translator_listener (translator_listener_record **listener_list,
146 translator_listener_record *r,
147 Listener (*get_listener) (void *, SCM),
148 const char *ev_class)
150 /* ev_class is the C++ identifier name. Convert to scm symbol */
151 string name = string (ev_class);
152 name = replace_all (&name, '_', '-');
155 // we make the symbol permanent in order not to have to bother about
156 // the static translator_listener_record chains while garbage
159 SCM class_sym = scm_permanent_object (scm_from_locale_symbol (name.c_str ()));
161 r->event_class_ = class_sym;
162 r->get_listener_ = get_listener;
163 r->next_ = *listener_list;
168 Helps the individual static_translator_description methods of translators.
171 Translator::static_translator_description (const char *grobs,
173 translator_listener_record *listener_list,
175 const char *write) const
177 SCM static_properties = SCM_EOL;
179 static_properties = scm_acons (ly_symbol2scm ("grobs-created"),
180 parse_symbol_list (grobs), static_properties);
182 static_properties = scm_acons (ly_symbol2scm ("description"),
183 scm_from_locale_string (desc), static_properties);
186 for (; listener_list; listener_list = listener_list->next_)
187 list = scm_cons (listener_list->event_class_, list);
188 static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
189 list, static_properties);
191 static_properties = scm_acons (ly_symbol2scm ("properties-read"),
192 parse_symbol_list (read), static_properties);
194 static_properties = scm_acons (ly_symbol2scm ("properties-written"),
195 parse_symbol_list (write), static_properties);
197 return static_properties;
204 Translator::mark_smob (SCM sm)
206 Translator *me = (Translator *) SCM_CELL_WORD_1 (sm);
212 Translator::get_global_context () const
214 return daddy_context_->get_global_context ();
218 Translator::get_score_context () const
220 return daddy_context_->get_score_context ();
223 IMPLEMENT_SMOBS (Translator);
224 IMPLEMENT_DEFAULT_EQUAL_P (Translator);
225 IMPLEMENT_TYPE_P (Translator, "ly:translator?");
228 Translator::must_be_last () const
234 Translator::derived_mark () const
239 Translator::print_smob (SCM s, SCM port, scm_print_state *)
241 Translator *me = (Translator *) SCM_CELL_WORD_1 (s);
242 scm_puts ("#<Translator ", port);
243 scm_puts (me->class_name (), port);
244 scm_puts (" >", port);
249 add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
250 char const *func_name,
251 vector<Acknowledge_information> *ack_array)
253 Acknowledge_information inf;
256 string interface_name (func_name);
258 interface_name = replace_all (&interface_name, '_', '-');
259 interface_name += "-interface";
262 this is only called during program init, so safe to use scm_gc_protect_object ()
264 inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
265 ack_array->push_back (inf);
268 Engraver_void_function_engraver_grob_info
269 generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_array)
271 for (vsize i = 0; i < ack_array->size (); i++)
273 if (ack_array->at (i).symbol_ == sym)
274 return ack_array->at (i).function_;
280 get_event_length (Stream_event *e)
282 Moment *m = unsmob_moment (e->get_property ("length"));
290 get_event_length (Stream_event *e, Moment now)
292 Moment len = get_event_length (e);
296 len.grace_part_ = len.main_part_;
297 len.main_part_ = Rational (0);
303 Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
304 simultaneous events. The helper is only useful in listen_* methods
308 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
311 && !to_boolean (scm_equal_p ((*old_ev)->self_scm (),
312 new_ev->self_scm ())))
314 /* extract event class from function name */
315 string ev_class = function;
317 /* This assertion fails if EVENT_ASSIGNMENT was called outside a
318 translator listener. Don't do that. */
319 const char *prefix = "listen_";
320 assert (0 == ev_class.find (prefix));
322 /* "listen_foo_bar" -> "foo-bar" */
323 ev_class.erase (0, strlen (prefix));
324 replace_all (&ev_class, '_', '-');
326 new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
327 (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
337 ADD_TRANSLATOR (Translator,
339 "Base class. Not instantiated.",