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"
25 Translator_group::get_daddy_translator () const
27 return context ()->get_parent_context ()->implementation ();
31 translator_each (SCM list, Translator_method method)
33 for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
34 (unsmob_translator (scm_car (p))->*method) ();
38 Translator_group::initialize ()
40 precompute_method_bindings ();
44 Translator_group::connect_to_context (Context *c)
48 programming_error ("translator group is already connected to context "
49 + context_->context_name ());
53 c->event_source ()->add_listener (GET_LISTENER (create_child_translator),
54 ly_symbol2scm ("AnnounceNewContext"));
55 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
57 Translator *tr = unsmob_translator (scm_car (tr_list));
58 tr->connect_to_context (c);
63 Translator_group::disconnect_from_context ()
65 for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
67 Translator *tr = unsmob_translator (scm_car (tr_list));
68 tr->disconnect_from_context (context_);
70 context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
71 ly_symbol2scm ("AnnounceNewContext"));
73 protected_events_ = SCM_EOL;
77 Translator_group::finalize ()
82 filter_performers (SCM ell)
85 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
87 if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
88 *tail = scm_cdr (*tail);
90 tail = SCM_CDRLOC (*tail);
96 filter_engravers (SCM ell)
99 for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
101 if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
102 *tail = scm_cdr (*tail);
104 tail = SCM_CDRLOC (*tail);
110 Protects the parameter from being garbage collected. The object is
111 protected until the next disconnect_from_context call.
113 Whenever a child translator hears an event, the event is added to
114 this list. This eliminates the need for derived_mark methods in most
115 translators; all incoming events are instead protected by the
118 TODO: Should the list also be flushed at the beginning of each new
122 Translator_group::protect_event (SCM ev)
124 protected_events_ = scm_cons (ev, protected_events_);
128 Create a new translator for a newly created child context. Triggered
129 by AnnounceNewContext events.
131 IMPLEMENT_LISTENER (Translator_group, create_child_translator);
133 Translator_group::create_child_translator (SCM sev)
135 Stream_event *ev = unsmob_stream_event (sev);
136 // get from AnnounceNewContext
137 SCM cs = ev->get_property ("context");
138 Context *new_context = unsmob_context (cs);
139 Context_def *def = unsmob_context_def (new_context->get_definition ());
140 SCM ops = new_context->get_definition_mods ();
142 SCM trans_names = def->get_translator_names (ops);
144 Translator_group *g = get_translator_group (def->get_translator_group_type ());
145 SCM trans_list = SCM_EOL;
147 for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
149 Translator *type = get_translator (scm_car (s));
151 warning (_f ("can't find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
154 Translator *tr = type->clone ();
155 SCM str = tr->self_scm ();
157 if (tr->must_be_last ())
159 SCM cons = scm_cons (str, SCM_EOL);
160 if (scm_is_pair (trans_list))
161 scm_set_cdr_x (scm_last_pair (trans_list), cons);
166 trans_list = scm_cons (str, trans_list);
168 tr->daddy_context_ = new_context;
173 /* Filter unwanted translator types. Required to make
174 \with {\consists "..."} work. */
175 if (dynamic_cast<Engraver_group *> (g))
176 g->simple_trans_list_ = filter_performers (trans_list);
177 else if (dynamic_cast<Performer_group *> (g))
178 g->simple_trans_list_ = filter_engravers (trans_list);
180 // TODO: scrap Context::implementation
181 new_context->implementation_ = g;
183 g->connect_to_context (new_context);
186 recurse_over_translators (new_context,
187 &Translator::initialize,
188 &Translator_group::initialize,
193 Translator_group::get_simple_trans_list ()
195 return simple_trans_list_;
199 precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
202 = dynamic_cast<Translator_group *> (c->implementation ());
204 if (tg && dir == DOWN)
206 tg->precomputed_translator_foreach (idx);
207 tg->call_precomputed_self_method (idx);
210 for (SCM s = c->children_contexts (); scm_is_pair (s);
212 precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir);
216 tg->precomputed_translator_foreach (idx);
217 tg->call_precomputed_self_method (idx);
222 recurse_over_translators (Context *c, Translator_method ptr, Translator_group_method tg_ptr, Direction dir)
225 = dynamic_cast<Translator_group *> (c->implementation ());
227 if (tg && dir == DOWN)
230 translator_each (tg->get_simple_trans_list (), ptr);
233 for (SCM s = c->children_contexts (); scm_is_pair (s);
235 recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir);
239 translator_each (tg->get_simple_trans_list (),
246 Translator_group::Translator_group ()
248 simple_trans_list_ = SCM_EOL;
249 protected_events_ = SCM_EOL;
255 Translator_group::derived_mark () const
260 Translator_group::precompute_method_bindings ()
262 for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
264 Translator *tr = unsmob_translator (scm_car (s));
265 Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
266 tr->fetch_precomputable_methods (ptrs);
269 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
272 precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
276 fetch_precomputable_methods (precomputed_self_method_bindings_);
280 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
282 vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
283 for (vsize i = 0; i < bindings.size (); i++)
284 bindings[i].invoke ();
288 Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
290 for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
295 Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
297 if (precomputed_self_method_bindings_[idx])
298 (*precomputed_self_method_bindings_[idx]) (this);
301 Translator_group::~Translator_group ()
305 #include "ly-smobs.icc"
307 IMPLEMENT_SMOBS (Translator_group);
308 IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
309 IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
312 Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
314 Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
315 scm_puts ("#<Translator_group ", port);
316 scm_puts (me->class_name (), port);
317 scm_display (me->simple_trans_list_, port);
318 scm_puts (" >", port);
323 Translator_group::mark_smob (SCM smob)
325 Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
328 scm_gc_mark (me->protected_events_);
329 return me->simple_trans_list_;