2 translator-group.cc -- implement Translator_group
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>,
7 Erik Sandberg <mandolaerik@gmail.com>
10 #include "translator-group.hh"
12 #include "context-def.hh"
14 #include "dispatcher.hh"
15 #include "engraver-group.hh"
16 #include "international.hh"
19 #include "output-def.hh"
20 #include "performer-group.hh"
21 #include "scm-hash.hh"
22 #include "stream-event.hh"
26 Translator_group::get_daddy_translator () const
28 return context ()->get_parent_context ()->implementation ();
32 translator_each (SCM list, Translator_method method)
34 for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
35 (unsmob_translator (scm_car (p))->*method) ();
39 Translator_group::initialize ()
41 precompute_method_bindings ();
45 Translator_group::connect_to_context (Context *c)
48 programming_error ("translator group is already connected to a context");
50 c->event_source ()->add_listener (GET_LISTENER (eat_event),
51 ly_symbol2scm ("OldMusicEvent"));
52 c->event_source ()->add_listener (GET_LISTENER (create_child_translator),
53 ly_symbol2scm ("AnnounceNewContext"));
54 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
56 Translator *tr = unsmob_translator (scm_car (tr_list));
57 tr->connect_to_context (c);
62 Translator_group::disconnect_from_context ()
64 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
66 Translator *tr = unsmob_translator (scm_car (tr_list));
67 tr->disconnect_from_context (context_);
69 context_->event_source ()->remove_listener (GET_LISTENER (eat_event),
70 ly_symbol2scm ("OldMusicEvent"));
71 context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
72 ly_symbol2scm ("AnnounceNewContext"));
74 protected_events_ = SCM_EOL;
78 Translator_group::finalize ()
83 translator_accepts_any_of (Translator *tr, SCM ifaces)
85 SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
86 tr->translator_description ());
87 ack_ifs = scm_cdr (ack_ifs);
88 for (SCM s = ifaces; scm_is_pair (s); s = scm_cdr (s))
89 if (scm_c_memq (scm_car (s), ack_ifs) != SCM_BOOL_F)
95 find_accept_translators (SCM gravlist, SCM ifaces)
98 for (SCM s = gravlist; scm_is_pair (s); s = scm_cdr (s))
100 Translator *tr = unsmob_translator (scm_car (s));
101 if (translator_accepts_any_of (tr, ifaces))
102 l = scm_cons (tr->self_scm (), l);
104 l = scm_reverse_x (l, SCM_EOL);
110 filter_performers (SCM ell)
113 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
115 if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
116 *tail = scm_cdr (*tail);
118 tail = SCM_CDRLOC (*tail);
124 filter_engravers (SCM ell)
127 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
129 if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
130 *tail = scm_cdr (*tail);
132 tail = SCM_CDRLOC (*tail);
138 Protects the parameter from being garbage collected. The object is
139 protected until the next disconnect_from_context call.
141 Whenever a child translator hears an event, the event is added to
142 this list. This eliminates the need for derived_mark methods in most
143 translators; all incoming events are instead protected by the
146 TODO: Should the list also be flushed at the beginning of each new
150 Translator_group::protect_event (SCM ev)
152 protected_events_ = scm_cons (ev, protected_events_);
156 Create a new translator for a newly created child context. Triggered
157 by AnnounceNewContext events.
159 IMPLEMENT_LISTENER (Translator_group, create_child_translator);
161 Translator_group::create_child_translator (SCM sev)
163 Stream_event *ev = unsmob_stream_event (sev);
164 // get from AnnounceNewContext
165 SCM cs = ev->get_property ("context");
166 Context *new_context = unsmob_context (cs);
167 Context_def *def = unsmob_context_def (new_context->get_definition ());
168 SCM ops = new_context->get_definition_mods ();
170 SCM trans_names = def->get_translator_names (ops);
172 Translator_group *g = get_translator_group (def->get_translator_group_type ());
173 SCM trans_list = SCM_EOL;
175 for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
177 Translator *type = get_translator (scm_car (s));
179 warning (_f ("can't find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
182 Translator *tr = type->clone ();
183 SCM str = tr->self_scm ();
185 if (tr->must_be_last ())
187 SCM cons = scm_cons (str, SCM_EOL);
188 if (scm_is_pair (trans_list))
189 scm_set_cdr_x (scm_last_pair (trans_list), cons);
194 trans_list = scm_cons (str, trans_list);
196 tr->daddy_context_ = new_context;
201 /* Filter unwanted translator types. Required to make
202 \with {\consists "..."} work. */
203 if (dynamic_cast<Engraver_group *> (g))
204 g->simple_trans_list_ = filter_performers (trans_list);
205 else if (dynamic_cast<Performer_group *> (g))
206 g->simple_trans_list_ = filter_engravers (trans_list);
208 // TODO: scrap Context::implementation
209 new_context->implementation_ = g;
211 g->connect_to_context (new_context);
214 recurse_over_translators (new_context,
215 &Translator::initialize,
216 &Translator_group::initialize,
220 IMPLEMENT_LISTENER (Translator_group, eat_event);
222 Translator_group::eat_event (SCM sev)
224 Stream_event *ev = unsmob_stream_event (sev);
225 SCM sm = ev->get_property ("music");
226 Music *m = unsmob_music (sm);
231 Translator_group::try_music (Music *m)
233 SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
234 m->get_property_alist (false));
236 if (!scm_is_pair (name))
239 name = scm_cdr (name);
240 SCM accept_list = scm_hashq_ref (accept_hash_table_, name, SCM_UNDEFINED);
241 if (accept_list == SCM_BOOL_F)
243 accept_list = find_accept_translators (get_simple_trans_list (),
244 m->get_property ("types"));
245 scm_hashq_set_x (accept_hash_table_, name, accept_list);
248 for (SCM p = accept_list; scm_is_pair (p); p = scm_cdr (p))
250 Translator *t = unsmob_translator (scm_car (p));
251 if (t && t->try_music (m))
255 // We couldn't swallow the event in this context. Try parent.
256 Context *p = context ()->get_parent_context ();
257 // Global context's translator group is a dummy, so don't try it.
258 if (p->get_parent_context())
259 // ES todo: Make Translators listeners directly instead.
260 return p->implementation ()->try_music (m);
261 // 'junking event' warning is temporarily disabled during translator cleanup
264 // We have tried all possible contexts. Give up.
265 m->origin ()->warning (_f ("junking event: `%s'", m->name ()));
271 Translator_group::get_simple_trans_list ()
273 return simple_trans_list_;
277 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
280 = dynamic_cast<Translator_group *> (c->implementation ());
284 tg->precomputed_translator_foreach (idx);
285 tg->call_precomputed_self_method (idx);
288 for (SCM s = c->children_contexts (); scm_is_pair (s);
290 precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir);
294 tg->precomputed_translator_foreach (idx);
295 tg->call_precomputed_self_method (idx);
300 recurse_over_translators (Context *c, Translator_method ptr, Translator_group_method tg_ptr, Direction dir)
303 = dynamic_cast<Translator_group *> (c->implementation ());
308 translator_each (tg->get_simple_trans_list (), ptr);
311 for (SCM s = c->children_contexts (); scm_is_pair (s);
313 recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir);
317 translator_each (tg->get_simple_trans_list (),
324 Translator_group::Translator_group ()
326 simple_trans_list_ = SCM_EOL;
327 accept_hash_table_ = SCM_EOL;
328 protected_events_ = SCM_EOL;
332 accept_hash_table_ = scm_c_make_hash_table (19);
336 Translator_group::derived_mark () const
341 Translator_group::precompute_method_bindings ()
343 for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
345 Translator *tr = unsmob_translator (scm_car (s));
346 Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
347 tr->fetch_precomputable_methods (ptrs);
350 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
353 precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
357 fetch_precomputable_methods (precomputed_self_method_bindings_);
361 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
363 vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
364 for (vsize i = 0; i < bindings.size (); i++)
365 bindings[i].invoke ();
369 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
371 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
376 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
378 if (precomputed_self_method_bindings_[idx])
379 (*precomputed_self_method_bindings_[idx]) (this);
382 Translator_group::~Translator_group ()
386 #include "ly-smobs.icc"
388 IMPLEMENT_SMOBS (Translator_group);
389 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
390 IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
393 Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
395 Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
396 scm_puts ("#<Translator_group ", port);
397 scm_puts (me->class_name (), port);
398 scm_display (me->simple_trans_list_, port);
399 scm_puts (" >", port);
404 Translator_group::mark_smob (SCM smob)
406 Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
409 scm_gc_mark (me->accept_hash_table_);
410 scm_gc_mark (me->protected_events_);
411 return me->simple_trans_list_;