2 Translator_group.cc -- implement Translator_group
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
9 #include "music-output-def.hh"
10 #include "translator-group.hh"
11 #include "translator.hh"
14 #include "scm-hash.hh"
15 #include "translator-def.hh"
19 Translator_group::Translator_group (Translator_group const&s)
24 Scheme_hash_table * tab = new Scheme_hash_table (*s.properties_dict ());
25 properties_scm_ = tab->self_scm ();
26 scm_gc_unprotect_object (tab->self_scm ());
30 Translator_group::properties_dict () const
32 return Scheme_hash_table::unsmob (properties_scm_);
35 Translator_group::~Translator_group ()
38 //assert (removable_b ());
42 Translator_group::Translator_group ()
45 Scheme_hash_table *tab = new Scheme_hash_table ;
46 properties_scm_ = tab->self_scm ();
48 scm_gc_unprotect_object (tab->self_scm ());
52 Translator_group::check_removal ()
55 for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
59 Translator_group *trg = dynamic_cast<Translator_group*> (unsmob_translator (ly_car (p)));
61 trg->check_removal ();
62 if (trg->removable_b ())
63 terminate_translator (trg);
68 Translator_group::add_translator (SCM list, Translator *t)
71 Must append, since list ordering must be preserved.
73 list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
74 t->daddy_trans_ = this;
75 t->output_def_ = output_def_;
82 Translator_group::add_used_group_translator (Translator *t)
84 trans_group_list_ = add_translator (trans_group_list_,t);
89 Translator_group::add_fresh_group_translator (Translator*t)
91 Translator_group*tg = dynamic_cast<Translator_group*> (t);
94 trans_group_list_ = add_translator (trans_group_list_,t);
95 unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
102 Translator_group::removable_b () const
104 return trans_group_list_ == SCM_EOL && ! iterator_count_;
108 Translator_group::find_existing_translator (SCM n, String id)
110 if ((is_alias_b (n) && (id_string_ == id || id.empty_b ())) || n == ly_symbol2scm ("Current"))
113 Translator_group* r = 0;
114 for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = ly_cdr (p))
116 Translator * t = unsmob_translator (ly_car (p));
118 r = dynamic_cast<Translator_group*> (t)->find_existing_translator (n, id);
126 Translator_group::find_create_translator (SCM n, String id)
128 Translator_group * existing = find_existing_translator (n,id);
132 Link_array<Translator_def> path
133 = unsmob_translator_def (definition_)->path_to_acceptable_translator (n, get_output_def ());
137 Translator_group * current = this;
139 // start at 1. The first one (index 0) will be us.
140 for (int i=0; i < path.size (); i++)
142 Translator_group * new_group = path[i]->instantiate (output_def_);
144 if (i == path.size () -1)
145 new_group->id_string_ = id;
146 current->add_fresh_group_translator (new_group);
153 Translator_group *ret = 0;
155 ret = daddy_trans_->find_create_translator (n,id);
158 warning (_f ("can't find or create `%s' called `%s'", ly_symbol2string (n).to_str0 (), id));
165 Translator_group::try_music (Music* m)
167 bool hebbes_b = try_music_on_nongroup_children (m);
169 if (!hebbes_b && daddy_trans_)
170 hebbes_b = daddy_trans_->try_music (m);
176 Translator_group::get_depth () const
178 return (daddy_trans_) ? daddy_trans_->get_depth () + 1 : 0;
182 Translator_group::get_ancestor (int level)
184 if (!level || !daddy_trans_)
187 return daddy_trans_->get_ancestor (level-1);
191 Translator_group::terminate_translator (Translator*r)
195 Return value ignored. GC does the rest.
197 remove_translator (r);
202 Remove a translator from the hierarchy.
205 Translator_group::remove_translator (Translator*trans)
209 trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_);
210 trans->daddy_trans_ = 0;
215 Translator_group::is_bottom_translator_b () const
217 return !gh_symbol_p (unsmob_translator_def (definition_)->default_child_context_name ());
221 Translator_group::get_default_interpreter ()
223 if (!is_bottom_translator_b ())
225 SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
226 SCM st = get_output_def ()->find_translator (nm);
228 Translator_def *t = unsmob_translator_def (st);
231 warning (_f ("can't find or create: `%s'", ly_scm2string (nm).to_str0 ()));
232 t = unsmob_translator_def (this->definition_);
234 Translator_group *tg = t->instantiate (output_def_);
235 add_fresh_group_translator (tg);
237 if (!tg->is_bottom_translator_b ())
238 return tg->get_default_interpreter ();
246 static_each (SCM list, Method_pointer method)
248 for (SCM p = list; gh_pair_p (p); p = ly_cdr (p))
249 (unsmob_translator (ly_car (p))->*method) ();
254 Translator_group::each (Method_pointer method)
256 static_each (simple_trans_list_, method);
257 static_each (trans_group_list_, method);
265 Translator_group::where_defined (SCM sym) const
267 if (properties_dict ()->elem_b (sym))
269 return (Translator_group*)this;
272 return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0;
276 return SCM_EOL when not found.
279 Translator_group::internal_get_property (SCM sym) const
282 if (properties_dict ()->try_retrieve (sym, &val))
286 return daddy_trans_->internal_get_property (sym);
292 Translator_group::internal_set_property (SCM sym, SCM val)
295 if (internal_type_checking_global_b)
296 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
299 properties_dict ()->set (sym, val);
303 TODO: look up to check whether we have inherited var?
306 Translator_group::unset_property (SCM sym)
308 properties_dict ()->remove (sym);
313 Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
314 entry from a translator property list by name of PROP
317 Translator_group::execute_pushpop_property (SCM prop, SCM eltprop, SCM val)
319 if (gh_symbol_p (prop))
321 if (val != SCM_UNDEFINED)
323 SCM prev = internal_get_property (prop);
325 if (gh_pair_p (prev) || prev == SCM_EOL)
327 bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
331 prev = gh_cons (gh_cons (eltprop, val), prev);
332 internal_set_property (prop, prev);
343 SCM prev = internal_get_property (prop);
346 TODO: should have scm_equal_something () for reverting
349 SCM newprops= SCM_EOL ;
350 while (gh_pair_p (prev) && !SCM_EQ_P(ly_caar (prev), eltprop))
352 newprops = gh_cons (ly_car (prev), newprops);
353 prev = ly_cdr (prev);
356 if (gh_pair_p (prev))
358 newprops = scm_reverse_x (newprops, ly_cdr (prev));
359 internal_set_property (prop, newprops);
371 Translator_group::stop_translation_timestep ()
373 each (&Translator::stop_translation_timestep);
377 Translator_group::start_translation_timestep ()
379 each (&Translator::start_translation_timestep);
383 Translator_group::do_announces ()
385 each (&Translator::do_announces);
389 Translator_group::initialize ()
391 SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F);
392 set_property ("acceptHashTable", tab);
393 each (&Translator::initialize);
397 Translator_group::finalize ()
399 each (&Translator::finalize);
404 bool translator_accepts_any_of (Translator*tr, SCM ifaces)
406 SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
407 tr->translator_description());
408 ack_ifs = gh_cdr (ack_ifs);
409 for (SCM s = ifaces; ly_pair_p (s); s = ly_cdr (s))
410 if (scm_memq (ly_car (s), ack_ifs) != SCM_BOOL_F)
416 find_accept_translators (SCM gravlist, SCM ifaces)
419 for (SCM s = gravlist; ly_pair_p (s); s = ly_cdr (s))
421 Translator* tr = unsmob_translator (ly_car (s));
422 if (translator_accepts_any_of (tr, ifaces))
423 l = scm_cons (tr->self_scm (), l);
425 l = scm_reverse_x (l, SCM_EOL);
431 Translator_group::try_music_on_nongroup_children (Music *m )
433 SCM tab = get_property ("acceptHashTable");
434 SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
435 m->get_property_alist (false));
437 if (!gh_pair_p (name))
440 name = gh_cdr (name);
441 SCM accept_list = scm_hashq_ref (tab, name, SCM_UNDEFINED);
442 if (accept_list == SCM_BOOL_F)
444 accept_list = find_accept_translators (simple_trans_list_,
445 m->get_mus_property ("types"));
446 scm_hashq_set_x (tab, name, accept_list);
449 for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p))
451 Translator * t = unsmob_translator (ly_car (p));
452 if (t && t->try_music (m))
459 Translator_group::properties_as_alist () const
461 return properties_dict()->to_alist();
465 Translator_group::context_name () const
467 Translator_def * td = unsmob_translator_def (definition_ );
468 return ly_symbol2string (td->type_name_);