2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>,
5 Erik Sandberg <mandolaerik@gmail.com>
7 LilyPond is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 LilyPond is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
21 #include "translator-group.hh"
23 #include "context-def.hh"
25 #include "dispatcher.hh"
26 #include "engraver.hh"
27 #include "engraver-group.hh"
28 #include "international.hh"
31 #include "output-def.hh"
32 #include "performer.hh"
33 #include "performer-group.hh"
34 #include "scheme-engraver.hh"
35 #include "scm-hash.hh"
39 translator_each (SCM list, Translator_method method)
41 for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
42 (unsmob<Translator> (scm_car (p))->*method) ();
46 Translator_group::initialize ()
48 precompute_method_bindings ();
52 Translator_group::connect_to_context (Context *c)
56 programming_error ("translator group is already connected to context "
57 + context_->context_name ());
61 c->event_source ()->add_listener (GET_LISTENER (Translator_group, create_child_translator),
62 ly_symbol2scm ("AnnounceNewContext"));
63 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
65 Translator *tr = unsmob<Translator> (scm_car (tr_list));
66 tr->connect_to_context (c);
71 Translator_group::disconnect_from_context ()
73 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
75 Translator *tr = unsmob<Translator> (scm_car (tr_list));
76 tr->disconnect_from_context (context_);
78 context_->event_source ()->remove_listener (GET_LISTENER (Translator_group, create_child_translator),
79 ly_symbol2scm ("AnnounceNewContext"));
81 protected_events_ = SCM_EOL;
85 Translator_group::finalize ()
90 Both filter_performers and filter_engravers used to use a direct dynamic_cast
91 on the unsmobbed translator to be filtered, i.e.,
93 if (unsmob<Performer> (scm_car (*tail)))
95 but this caused mysterious optimisation issues in several GUB builds. See
96 issue #818 for the background to this change.
99 filter_performers (SCM ell)
102 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
104 if (unsmob<Performer> (scm_car (*tail)))
105 *tail = scm_cdr (*tail);
107 tail = SCM_CDRLOC (*tail);
113 filter_engravers (SCM ell)
116 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
118 if (unsmob<Engraver> (scm_car (*tail)))
119 *tail = scm_cdr (*tail);
121 tail = SCM_CDRLOC (*tail);
127 Protects the parameter from being garbage collected. The object is
128 protected until the next disconnect_from_context call.
130 Whenever a child translator hears an event, the event is added to
131 this list. This eliminates the need for derived_mark methods in most
132 translators; all incoming events are instead protected by the
135 TODO: Should the list also be flushed at the beginning of each new
139 Translator_group::protect_event (SCM ev)
141 protected_events_ = scm_cons (ev, protected_events_);
145 Create a new translator for a newly created child context. Triggered
146 by AnnounceNewContext events.
149 Translator_group::create_child_translator (SCM sev)
151 Stream_event *ev = unsmob<Stream_event> (sev);
152 // get from AnnounceNewContext
153 SCM cs = ev->get_property ("context");
154 Context *new_context = unsmob<Context> (cs);
155 Context_def *def = unsmob<Context_def> (new_context->get_definition ());
156 SCM ops = new_context->get_definition_mods ();
158 SCM trans_names = def->get_translator_names (ops);
160 Translator_group *g = get_translator_group (def->get_translator_group_type ());
161 SCM trans_list = SCM_EOL;
163 for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
165 SCM definition = scm_car (s);
166 bool is_scheme = false;
168 Translator *type = 0;
169 if (ly_is_symbol (definition))
170 type = get_translator (definition);
171 else if (ly_is_pair (definition))
173 type = get_translator (ly_symbol2scm ("Scheme_engraver"));
176 else if (ly_is_procedure (definition))
178 // `definition' is a procedure, which takes the context as
179 // an argument and evaluates to an a-list scheme engraver
181 definition = scm_call_1 (definition, cs);
182 type = get_translator (ly_symbol2scm ("Scheme_engraver"));
187 warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
190 Translator *instance = type->clone ();
192 dynamic_cast<Scheme_engraver *> (instance)->init_from_scheme (definition);
194 SCM str = instance->self_scm ();
196 if (instance->must_be_last ())
198 SCM cons = scm_cons (str, SCM_EOL);
199 if (scm_is_pair (trans_list))
200 scm_set_cdr_x (scm_last_pair (trans_list), cons);
205 trans_list = scm_cons (str, trans_list);
207 instance->daddy_context_ = new_context;
208 instance->unprotect ();
212 /* Filter unwanted translator types. Required to make
213 \with { \consists "..." } work. */
214 if (dynamic_cast<Engraver_group *> (g))
215 g->simple_trans_list_ = filter_performers (trans_list);
216 else if (dynamic_cast<Performer_group *> (g))
217 g->simple_trans_list_ = filter_engravers (trans_list);
219 // TODO: scrap Context::implementation
220 new_context->implementation_ = g;
222 g->connect_to_context (new_context);
225 recurse_over_translators (new_context,
226 &Translator::initialize,
227 &Translator_group::initialize,
232 Translator_group::get_simple_trans_list ()
234 return simple_trans_list_;
238 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
241 = dynamic_cast<Translator_group *> (c->implementation ());
243 if (tg && dir == DOWN)
245 tg->precomputed_translator_foreach (idx);
246 tg->call_precomputed_self_method (idx);
249 for (SCM s = c->children_contexts (); scm_is_pair (s);
251 precomputed_recurse_over_translators (unsmob<Context> (scm_car (s)), idx, dir);
255 tg->precomputed_translator_foreach (idx);
256 tg->call_precomputed_self_method (idx);
261 recurse_over_translators (Context *c, Translator_method ptr,
262 Translator_group_method tg_ptr, Direction dir)
265 = dynamic_cast<Translator_group *> (c->implementation ());
267 if (tg && dir == DOWN)
270 translator_each (tg->get_simple_trans_list (), ptr);
273 for (SCM s = c->children_contexts (); scm_is_pair (s);
275 recurse_over_translators (unsmob<Context> (scm_car (s)), ptr, tg_ptr, dir);
279 translator_each (tg->get_simple_trans_list (),
286 Translator_group::Translator_group ()
288 simple_trans_list_ = SCM_EOL;
289 protected_events_ = SCM_EOL;
295 Translator_group::derived_mark () const
300 Translator_group::precompute_method_bindings ()
302 for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
304 Translator *tr = unsmob<Translator> (scm_car (s));
305 Translator::Callback ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
306 tr->fetch_precomputable_methods (ptrs);
309 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
312 precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
316 fetch_precomputable_methods (precomputed_self_method_bindings_);
320 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
322 vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
323 for (vsize i = 0; i < bindings.size (); i++)
324 bindings[i].invoke ();
328 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
330 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
335 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
337 if (precomputed_self_method_bindings_[idx])
338 (*precomputed_self_method_bindings_[idx]) (this);
341 Translator_group::~Translator_group ()
346 const char Translator_group::type_p_name_[] = "ly:translator-group?";
349 Translator_group::print_smob (SCM port, scm_print_state *)
351 scm_puts ("#<Translator_group ", port);
352 scm_puts (class_name (), port);
353 scm_display (simple_trans_list_, port);
354 scm_puts (" >", port);
359 Translator_group::mark_smob ()
362 scm_gc_mark (protected_events_);
363 return simple_trans_list_;