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/>.
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"
31 Translator::~Translator ()
36 Translator::process_music ()
41 Translator::process_acknowledged ()
45 Translator::Translator (Context *c)
52 Translator::now_mom () const
54 return daddy_context_->now_mom ();
58 Translator::get_output_def () const
60 return daddy_context_->get_output_def ();
64 Translator::get_daddy_translator () const
66 return daddy_context_->implementation ();
70 Translator::protect_event (SCM ev)
72 get_daddy_translator ()->protect_event (ev);
76 Translator::internal_get_property (SCM sym) const
78 return daddy_context_->internal_get_property (sym);
82 Translator::stop_translation_timestep ()
87 this function is called once each moment, before any user
88 information enters the translators. (i.e. no \property or event has
92 Translator::start_translation_timestep ()
97 Translator::initialize ()
102 Translator::finalize ()
107 Translator::connect_to_context (Context *c)
109 for (SCM r = get_listener_list (); scm_is_pair (r); r = scm_cdr (r))
111 SCM event_class = scm_caar (r);
112 SCM callback = scm_cdar (r);
114 c->events_below ()->add_listener (get_listener (callback),
120 Translator::disconnect_from_context (Context *c)
122 for (SCM r = get_listener_list (); scm_is_pair (r); r = scm_cdr (r))
124 SCM event_class = scm_caar (r);
125 SCM callback = scm_cdar (r);
127 c->events_below ()->remove_listener (get_listener (callback),
133 Translator::event_class_symbol (const char *ev_class)
135 /* ev_class is the C++ identifier name. Convert to scm symbol */
136 string name = string (ev_class);
137 name = replace_all (&name, '_', '-');
140 return scm_from_ascii_symbol (name.c_str ());
144 Helps the individual static_translator_description methods of translators.
147 Translator::static_translator_description (const char *grobs,
153 SCM static_properties = SCM_EOL;
155 static_properties = scm_acons (ly_symbol2scm ("grobs-created"),
156 parse_symbol_list (grobs), static_properties);
158 static_properties = scm_acons (ly_symbol2scm ("description"),
159 scm_from_utf8_string (desc), static_properties);
162 for (; scm_is_pair (listener_list); listener_list = scm_cdr (listener_list))
163 list = scm_cons (scm_caar (listener_list), list);
164 static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
165 list, static_properties);
167 static_properties = scm_acons (ly_symbol2scm ("properties-read"),
168 parse_symbol_list (read), static_properties);
170 static_properties = scm_acons (ly_symbol2scm ("properties-written"),
171 parse_symbol_list (write), static_properties);
173 return static_properties;
180 Translator::mark_smob () const
187 Translator::get_global_context () const
189 return daddy_context_->get_global_context ();
193 Translator::get_score_context () const
195 return daddy_context_->get_score_context ();
198 const char * const Translator::type_p_name_ = "ly:translator?";
201 Translator::must_be_last () const
207 Translator::derived_mark () const
212 Translator::print_smob (SCM port, scm_print_state *) const
214 scm_puts ("#<Translator ", port);
215 scm_puts (class_name (), port);
216 scm_puts (" >", port);
221 add_acknowledger (SCM ptr,
222 char const *func_name,
225 if (SCM_UNBNDP (ack_hash))
226 ack_hash = Scheme_hash_table::make_smob ();
228 string interface_name (func_name);
230 interface_name = replace_all (&interface_name, '_', '-');
231 interface_name += "-interface";
233 unsmob<Scheme_hash_table> (ack_hash)
234 ->set (ly_symbol2scm (interface_name.c_str ()), ptr);
238 generic_get_acknowledger (SCM sym, SCM ack_hash)
240 if (SCM_UNBNDP (ack_hash))
241 return SCM_UNDEFINED;
243 return unsmob<Scheme_hash_table> (ack_hash)->get (sym);
247 get_event_length (Stream_event *e)
249 Moment *m = unsmob<Moment> (e->get_property ("length"));
257 get_event_length (Stream_event *e, Moment now)
259 Moment len = get_event_length (e);
263 len.grace_part_ = len.main_part_;
264 len.main_part_ = Rational (0);
270 Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
271 simultaneous events. The helper is only useful in listen_* methods
275 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
278 && !to_boolean (scm_equal_p ((*old_ev)->self_scm (),
279 new_ev->self_scm ())))
281 /* extract event class from function name */
282 string ev_class = function;
284 /* This assertion fails if EVENT_ASSIGNMENT was called outside a
285 translator listener. Don't do that. */
286 const char *prefix = "listen_";
287 assert (0 == ev_class.find (prefix));
289 /* "listen_foo_bar" -> "foo-bar" */
290 ev_class.erase (0, strlen (prefix));
291 replace_all (&ev_class, '_', '-');
293 new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
294 (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
304 // Base class. Not instantiated. No ADD_TRANSLATOR call.