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)
49 programming_error ("translator group is already connected to context "
50 + context_->context_name ());
54 c->event_source ()->add_listener (GET_LISTENER (eat_event),
55 ly_symbol2scm ("OldMusicEvent"));
56 c->event_source ()->add_listener (GET_LISTENER (create_child_translator),
57 ly_symbol2scm ("AnnounceNewContext"));
58 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
60 Translator *tr = unsmob_translator (scm_car (tr_list));
61 tr->connect_to_context (c);
66 Translator_group::disconnect_from_context ()
68 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
70 Translator *tr = unsmob_translator (scm_car (tr_list));
71 tr->disconnect_from_context (context_);
73 context_->event_source ()->remove_listener (GET_LISTENER (eat_event),
74 ly_symbol2scm ("OldMusicEvent"));
75 context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
76 ly_symbol2scm ("AnnounceNewContext"));
78 protected_events_ = SCM_EOL;
82 Translator_group::finalize ()
87 translator_accepts_any_of (Translator *tr, SCM ifaces)
89 SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
90 tr->translator_description ());
91 ack_ifs = scm_cdr (ack_ifs);
92 for (SCM s = ifaces; scm_is_pair (s); s = scm_cdr (s))
93 if (scm_c_memq (scm_car (s), ack_ifs) != SCM_BOOL_F)
99 find_accept_translators (SCM gravlist, SCM ifaces)
102 for (SCM s = gravlist; scm_is_pair (s); s = scm_cdr (s))
104 Translator *tr = unsmob_translator (scm_car (s));
105 if (translator_accepts_any_of (tr, ifaces))
106 l = scm_cons (tr->self_scm (), l);
108 l = scm_reverse_x (l, SCM_EOL);
114 filter_performers (SCM ell)
117 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
119 if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
120 *tail = scm_cdr (*tail);
122 tail = SCM_CDRLOC (*tail);
128 filter_engravers (SCM ell)
131 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
133 if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
134 *tail = scm_cdr (*tail);
136 tail = SCM_CDRLOC (*tail);
142 Protects the parameter from being garbage collected. The object is
143 protected until the next disconnect_from_context call.
145 Whenever a child translator hears an event, the event is added to
146 this list. This eliminates the need for derived_mark methods in most
147 translators; all incoming events are instead protected by the
150 TODO: Should the list also be flushed at the beginning of each new
154 Translator_group::protect_event (SCM ev)
156 protected_events_ = scm_cons (ev, protected_events_);
160 Create a new translator for a newly created child context. Triggered
161 by AnnounceNewContext events.
163 IMPLEMENT_LISTENER (Translator_group, create_child_translator);
165 Translator_group::create_child_translator (SCM sev)
167 Stream_event *ev = unsmob_stream_event (sev);
168 // get from AnnounceNewContext
169 SCM cs = ev->get_property ("context");
170 Context *new_context = unsmob_context (cs);
171 Context_def *def = unsmob_context_def (new_context->get_definition ());
172 SCM ops = new_context->get_definition_mods ();
174 SCM trans_names = def->get_translator_names (ops);
176 Translator_group *g = get_translator_group (def->get_translator_group_type ());
177 SCM trans_list = SCM_EOL;
179 for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
181 Translator *type = get_translator (scm_car (s));
183 warning (_f ("can't find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
186 Translator *tr = type->clone ();
187 SCM str = tr->self_scm ();
189 if (tr->must_be_last ())
191 SCM cons = scm_cons (str, SCM_EOL);
192 if (scm_is_pair (trans_list))
193 scm_set_cdr_x (scm_last_pair (trans_list), cons);
198 trans_list = scm_cons (str, trans_list);
200 tr->daddy_context_ = new_context;
205 /* Filter unwanted translator types. Required to make
206 \with {\consists "..."} work. */
207 if (dynamic_cast<Engraver_group *> (g))
208 g->simple_trans_list_ = filter_performers (trans_list);
209 else if (dynamic_cast<Performer_group *> (g))
210 g->simple_trans_list_ = filter_engravers (trans_list);
212 // TODO: scrap Context::implementation
213 new_context->implementation_ = g;
215 g->connect_to_context (new_context);
218 recurse_over_translators (new_context,
219 &Translator::initialize,
220 &Translator_group::initialize,
224 IMPLEMENT_LISTENER (Translator_group, eat_event);
226 Translator_group::eat_event (SCM sev)
228 Stream_event *ev = unsmob_stream_event (sev);
229 SCM sm = ev->get_property ("music");
230 Music *m = unsmob_music (sm);
235 Translator_group::try_music (Music *m)
237 SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
238 m->get_property_alist (false));
240 if (!scm_is_pair (name))
243 name = scm_cdr (name);
244 SCM accept_list = scm_hashq_ref (accept_hash_table_, name, SCM_UNDEFINED);
245 if (accept_list == SCM_BOOL_F)
247 accept_list = find_accept_translators (get_simple_trans_list (),
248 m->get_property ("types"));
249 scm_hashq_set_x (accept_hash_table_, name, accept_list);
252 for (SCM p = accept_list; scm_is_pair (p); p = scm_cdr (p))
254 Translator *t = unsmob_translator (scm_car (p));
255 if (t && t->try_music (m))
259 // We couldn't swallow the event in this context. Try parent.
260 Context *p = context ()->get_parent_context ();
261 // Global context's translator group is a dummy, so don't try it.
262 if (p->get_parent_context())
263 // ES todo: Make Translators listeners directly instead.
264 return p->implementation ()->try_music (m);
265 // 'junking event' warning is temporarily disabled during translator cleanup
268 // We have tried all possible contexts. Give up.
269 m->origin ()->warning (_f ("junking event: `%s'", m->name ()));
275 Translator_group::get_simple_trans_list ()
277 return simple_trans_list_;
281 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
284 = dynamic_cast<Translator_group *> (c->implementation ());
288 tg->precomputed_translator_foreach (idx);
289 tg->call_precomputed_self_method (idx);
292 for (SCM s = c->children_contexts (); scm_is_pair (s);
294 precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir);
298 tg->precomputed_translator_foreach (idx);
299 tg->call_precomputed_self_method (idx);
304 recurse_over_translators (Context *c, Translator_method ptr, Translator_group_method tg_ptr, Direction dir)
307 = dynamic_cast<Translator_group *> (c->implementation ());
312 translator_each (tg->get_simple_trans_list (), ptr);
315 for (SCM s = c->children_contexts (); scm_is_pair (s);
317 recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir);
321 translator_each (tg->get_simple_trans_list (),
328 Translator_group::Translator_group ()
330 simple_trans_list_ = SCM_EOL;
331 accept_hash_table_ = SCM_EOL;
332 protected_events_ = SCM_EOL;
336 accept_hash_table_ = scm_c_make_hash_table (19);
340 Translator_group::derived_mark () const
345 Translator_group::precompute_method_bindings ()
347 for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
349 Translator *tr = unsmob_translator (scm_car (s));
350 Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
351 tr->fetch_precomputable_methods (ptrs);
354 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
357 precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
361 fetch_precomputable_methods (precomputed_self_method_bindings_);
365 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
367 vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
368 for (vsize i = 0; i < bindings.size (); i++)
369 bindings[i].invoke ();
373 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
375 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
380 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
382 if (precomputed_self_method_bindings_[idx])
383 (*precomputed_self_method_bindings_[idx]) (this);
386 Translator_group::~Translator_group ()
390 #include "ly-smobs.icc"
392 IMPLEMENT_SMOBS (Translator_group);
393 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
394 IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
397 Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
399 Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
400 scm_puts ("#<Translator_group ", port);
401 scm_puts (me->class_name (), port);
402 scm_display (me->simple_trans_list_, port);
403 scm_puts (" >", port);
408 Translator_group::mark_smob (SCM smob)
410 Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
413 scm_gc_mark (me->accept_hash_table_);
414 scm_gc_mark (me->protected_events_);
415 return me->simple_trans_list_;