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 ()
43 Translator::process_music ()
48 Translator::process_acknowledged ()
52 Translator::Translator ()
57 Translator::Translator (Translator const &)
64 Translator::now_mom () const
66 return daddy_context_->now_mom ();
70 Translator::get_output_def () const
72 return daddy_context_->get_output_def ();
76 Translator::get_daddy_translator () const
78 return daddy_context_->implementation ();
82 Translator::protect_event (SCM ev)
84 get_daddy_translator ()->protect_event (ev);
88 Translator::internal_get_property (SCM sym) const
90 return daddy_context_->internal_get_property (sym);
94 Translator::stop_translation_timestep ()
99 this function is called once each moment, before any user
100 information enters the translators. (i.e. no \property or event has
104 Translator::start_translation_timestep ()
109 Translator::initialize ()
114 Translator::finalize ()
119 Translator::connect_to_context (Context *c)
121 for (SCM r = get_listener_list (); scm_is_pair (r); r = scm_cdr (r))
123 SCM event_class = scm_caar (r);
124 SCM callback = scm_cdar (r);
126 c->events_below ()->add_listener (get_listener (callback),
132 Translator::disconnect_from_context (Context *c)
134 for (SCM r = get_listener_list (); scm_is_pair (r); r = scm_cdr (r))
136 SCM event_class = scm_caar (r);
137 SCM callback = scm_cdar (r);
139 c->events_below ()->remove_listener (get_listener (callback),
145 Translator::event_class_symbol (const char *ev_class)
147 /* ev_class is the C++ identifier name. Convert to scm symbol */
148 string name = string (ev_class);
149 name = replace_all (&name, '_', '-');
152 return scm_from_ascii_symbol (name.c_str ());
156 Helps the individual static_translator_description methods of translators.
159 Translator::static_translator_description (const char *grobs,
163 const char *write) const
165 SCM static_properties = SCM_EOL;
167 static_properties = scm_acons (ly_symbol2scm ("grobs-created"),
168 parse_symbol_list (grobs), static_properties);
170 static_properties = scm_acons (ly_symbol2scm ("description"),
171 scm_from_utf8_string (desc), static_properties);
174 for (; scm_is_pair (listener_list); listener_list = scm_cdr (listener_list))
175 list = scm_cons (scm_caar (listener_list), list);
176 static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
177 list, static_properties);
179 static_properties = scm_acons (ly_symbol2scm ("properties-read"),
180 parse_symbol_list (read), static_properties);
182 static_properties = scm_acons (ly_symbol2scm ("properties-written"),
183 parse_symbol_list (write), static_properties);
185 return static_properties;
192 Translator::mark_smob ()
199 Translator::get_global_context () const
201 return daddy_context_->get_global_context ();
205 Translator::get_score_context () const
207 return daddy_context_->get_score_context ();
210 const char Translator::type_p_name_[] = "ly:translator?";
213 Translator::must_be_last () const
219 Translator::derived_mark () const
224 Translator::print_smob (SCM port, scm_print_state *)
226 scm_puts ("#<Translator ", port);
227 scm_puts (class_name (), port);
228 scm_puts (" >", port);
233 add_acknowledger (Translator::Grob_info_callback ptr,
234 char const *func_name,
235 vector<Acknowledge_information> *ack_array)
237 Acknowledge_information inf;
240 string interface_name (func_name);
242 interface_name = replace_all (&interface_name, '_', '-');
243 interface_name += "-interface";
246 this is only called during program init, so safe to use scm_gc_protect_object ()
248 inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
249 ack_array->push_back (inf);
252 Translator::Grob_info_callback
253 generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_array)
255 for (vsize i = 0; i < ack_array->size (); i++)
257 if (ack_array->at (i).symbol_ == sym)
258 return ack_array->at (i).function_;
264 get_event_length (Stream_event *e)
266 Moment *m = unsmob<Moment> (e->get_property ("length"));
274 get_event_length (Stream_event *e, Moment now)
276 Moment len = get_event_length (e);
280 len.grace_part_ = len.main_part_;
281 len.main_part_ = Rational (0);
287 Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
288 simultaneous events. The helper is only useful in listen_* methods
292 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
295 && !to_boolean (scm_equal_p ((*old_ev)->self_scm (),
296 new_ev->self_scm ())))
298 /* extract event class from function name */
299 string ev_class = function;
301 /* This assertion fails if EVENT_ASSIGNMENT was called outside a
302 translator listener. Don't do that. */
303 const char *prefix = "listen_";
304 assert (0 == ev_class.find (prefix));
306 /* "listen_foo_bar" -> "foo-bar" */
307 ev_class.erase (0, strlen (prefix));
308 replace_all (&ev_class, '_', '-');
310 new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
311 (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
321 ADD_TRANSLATOR (Translator,
323 "Base class. Not instantiated.",