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/>.
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 (translator_listener_record *r = get_listener_list (); r; r = r->next_)
122 c->events_below ()->add_listener (r->get_listener_ (this, r->event_class_),
127 Translator::disconnect_from_context (Context *c)
129 for (translator_listener_record *r = get_listener_list (); r; r = r->next_)
130 c->events_below ()->remove_listener (r->get_listener_ (this, r->event_class_),
135 internally called once, statically, for each translator
136 listener. Connects the name of an event class with a procedure that
137 fetches the corresponding listener.
139 The method should only be called from the macro
140 IMPLEMENT_TRANSLATOR_LISTENER.
143 Translator::add_translator_listener (translator_listener_record **listener_list,
144 translator_listener_record *r,
145 Listener (*get_listener) (void *, SCM),
146 const char *ev_class)
148 /* ev_class is the C++ identifier name. Convert to scm symbol */
149 string name = string (ev_class);
150 name = replace_all (&name, '_', '-');
153 // we make the symbol permanent in order not to have to bother about
154 // the static translator_listener_record chains while garbage
157 SCM class_sym = scm_permanent_object (scm_from_locale_symbol (name.c_str ()));
159 r->event_class_ = class_sym;
160 r->get_listener_ = get_listener;
161 r->next_ = *listener_list;
166 Helps the individual static_translator_description methods of translators.
169 Translator::static_translator_description (const char *grobs,
171 translator_listener_record *listener_list,
173 const char *write) const
175 SCM static_properties = SCM_EOL;
177 static_properties = scm_acons (ly_symbol2scm ("grobs-created"),
178 parse_symbol_list (grobs), static_properties);
180 static_properties = scm_acons (ly_symbol2scm ("description"),
181 scm_from_locale_string (desc), static_properties);
184 for (; listener_list; listener_list = listener_list->next_)
185 list = scm_cons (listener_list->event_class_, list);
186 static_properties = scm_acons (ly_symbol2scm ("events-accepted"),
187 list, static_properties);
189 static_properties = scm_acons (ly_symbol2scm ("properties-read"),
190 parse_symbol_list (read), static_properties);
192 static_properties = scm_acons (ly_symbol2scm ("properties-written"),
193 parse_symbol_list (write), static_properties);
195 return static_properties;
202 Translator::mark_smob ()
209 Translator::get_global_context () const
211 return daddy_context_->get_global_context ();
215 Translator::get_score_context () const
217 return daddy_context_->get_score_context ();
220 const char Translator::type_p_name_[] = "ly:translator?";
223 Translator::must_be_last () const
229 Translator::derived_mark () const
234 Translator::print_smob (SCM port, scm_print_state *)
236 scm_puts ("#<Translator ", port);
237 scm_puts (class_name (), port);
238 scm_puts (" >", port);
243 add_acknowledger (Engraver_void_function_engraver_grob_info ptr,
244 char const *func_name,
245 vector<Acknowledge_information> *ack_array)
247 Acknowledge_information inf;
250 string interface_name (func_name);
252 interface_name = replace_all (&interface_name, '_', '-');
253 interface_name += "-interface";
256 this is only called during program init, so safe to use scm_gc_protect_object ()
258 inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ()));
259 ack_array->push_back (inf);
262 Engraver_void_function_engraver_grob_info
263 generic_get_acknowledger (SCM sym, vector<Acknowledge_information> const *ack_array)
265 for (vsize i = 0; i < ack_array->size (); i++)
267 if (ack_array->at (i).symbol_ == sym)
268 return ack_array->at (i).function_;
274 get_event_length (Stream_event *e)
276 Moment *m = Moment::unsmob (e->get_property ("length"));
284 get_event_length (Stream_event *e, Moment now)
286 Moment len = get_event_length (e);
290 len.grace_part_ = len.main_part_;
291 len.main_part_ = Rational (0);
297 Helper, used through ASSIGN_EVENT_ONCE to throw warnings for
298 simultaneous events. The helper is only useful in listen_* methods
302 internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function)
305 && !to_boolean (scm_equal_p ((*old_ev)->self_scm (),
306 new_ev->self_scm ())))
308 /* extract event class from function name */
309 string ev_class = function;
311 /* This assertion fails if EVENT_ASSIGNMENT was called outside a
312 translator listener. Don't do that. */
313 const char *prefix = "listen_";
314 assert (0 == ev_class.find (prefix));
316 /* "listen_foo_bar" -> "foo-bar" */
317 ev_class.erase (0, strlen (prefix));
318 replace_all (&ev_class, '_', '-');
320 new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ()));
321 (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ()));
331 ADD_TRANSLATOR (Translator,
333 "Base class. Not instantiated.",