2 Translator_group.cc -- implement Translator_group
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2002 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"
18 Translator_group::Translator_group (Translator_group const&s)
23 Scheme_hash_table * tab = new Scheme_hash_table (*s.properties_dict ());
24 properties_scm_ = tab->self_scm ();
25 scm_gc_unprotect_object (tab->self_scm ());
29 Translator_group::properties_dict () const
31 return Scheme_hash_table::unsmob (properties_scm_);
34 Translator_group::~Translator_group ()
37 //assert (removable_b ());
41 Translator_group::Translator_group ()
44 Scheme_hash_table *tab = new Scheme_hash_table ;
45 properties_scm_ = tab->self_scm ();
47 scm_gc_unprotect_object (tab->self_scm ());
51 Translator_group::check_removal ()
54 for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
58 Translator_group *trg = dynamic_cast<Translator_group*> (unsmob_translator (ly_car (p)));
60 trg->check_removal ();
61 if (trg->removable_b ())
62 terminate_translator (trg);
67 Translator_group::add_translator (SCM list, Translator *t)
70 Must append, since list ordering must be preserved.
72 list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
73 t->daddy_trans_ = this;
74 t->output_def_ = output_def_;
81 Translator_group::add_used_group_translator (Translator *t)
83 trans_group_list_ = add_translator (trans_group_list_,t);
88 Translator_group::add_fresh_group_translator (Translator*t)
90 Translator_group*tg = dynamic_cast<Translator_group*> (t);
93 trans_group_list_ = add_translator (trans_group_list_,t);
94 unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
101 Translator_group::removable_b () const
103 return trans_group_list_ == SCM_EOL && ! iterator_count_;
107 Translator_group::find_existing_translator (String n, String id)
109 if (is_alias_b (n) && (id_string_ == id || id.empty_b ()))
112 Translator_group* r = 0;
113 for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = ly_cdr (p))
115 Translator * t = unsmob_translator (ly_car (p));
117 r = dynamic_cast<Translator_group*> (t)->find_existing_translator (n, id);
127 Translator_group::find_create_translator (String n, String id)
129 Translator_group * existing = find_existing_translator (n,id);
133 Link_array<Translator_def> path
134 = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.to_str0 ()), get_output_def ());
138 Translator_group * current = this;
140 // start at 1. The first one (index 0) will be us.
141 for (int i=0; i < path.size (); i++)
143 Translator_group * new_group = path[i]->instantiate (output_def_);
145 if (i == path.size () -1)
146 new_group->id_string_ = id;
147 current->add_fresh_group_translator (new_group);
154 Translator_group *ret = 0;
156 ret = daddy_trans_->find_create_translator (n,id);
159 warning (_f ("can't find or create `%s' called `%s'", n, id));
166 Translator_group::try_music_on_nongroup_children (Music *m)
168 bool hebbes_b =false;
170 for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = ly_cdr (p))
172 hebbes_b = unsmob_translator (ly_car (p))->try_music (m);
178 Translator_group::try_music (Music* m)
180 bool hebbes_b = try_music_on_nongroup_children (m);
182 if (!hebbes_b && daddy_trans_)
183 hebbes_b = daddy_trans_->try_music (m);
188 Translator_group::get_depth () const
190 return (daddy_trans_) ? daddy_trans_->get_depth () + 1 : 0;
194 Translator_group::get_ancestor (int level)
196 if (!level || !daddy_trans_)
199 return daddy_trans_->get_ancestor (level-1);
203 Translator_group::terminate_translator (Translator*r)
205 r->removal_processing ();
207 Return value ignored. GC does the rest.
209 remove_translator (r);
214 Remove a translator from the hierarchy.
217 Translator_group::remove_translator (Translator*trans)
221 trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_);
222 trans->daddy_trans_ = 0;
227 Translator_group::is_bottom_translator_b () const
229 return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
234 Translator_group::get_default_interpreter ()
236 if (!is_bottom_translator_b ())
238 SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
239 SCM st = get_output_def ()->find_translator (nm);
241 Translator_def *t = unsmob_translator_def (st);
244 warning (_f ("can't find or create: `%s'", ly_scm2string (nm).to_str0 ()));
245 t = unsmob_translator_def (this->definition_);
247 Translator_group *tg = t->instantiate (output_def_);
248 add_fresh_group_translator (tg);
250 if (!tg->is_bottom_translator_b ())
251 return tg->get_default_interpreter ();
259 static_each (SCM list, Method_pointer method)
261 for (SCM p = list; gh_pair_p (p); p = ly_cdr (p))
262 (unsmob_translator (ly_car (p))->*method) ();
267 Translator_group::each (Method_pointer method)
269 static_each (simple_trans_list_, method);
270 static_each (trans_group_list_, method);
278 Translator_group::where_defined (SCM sym) const
280 if (properties_dict ()->elem_b (sym))
282 return (Translator_group*)this;
285 return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0;
289 return SCM_EOL when not found.
292 Translator_group::internal_get_property (SCM sym) const
295 if (properties_dict ()->try_retrieve (sym, &val))
299 return daddy_trans_->internal_get_property (sym);
305 Translator_group::internal_set_property (SCM sym, SCM val)
308 if (internal_type_checking_global_b)
309 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
312 properties_dict ()->set (sym, val);
316 TODO: look up to check whether we have inherited var?
319 Translator_group::unset_property (SCM sym)
321 properties_dict ()->remove (sym);
326 Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
327 entry from a translator property list by name of PROP
330 Translator_group::execute_single_pushpop_property (SCM prop, SCM eltprop, SCM val)
332 if (gh_symbol_p (prop))
334 if (val != SCM_UNDEFINED)
336 SCM prev = internal_get_property (prop);
338 if (gh_pair_p (prev) || prev == SCM_EOL)
340 bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
344 prev = gh_cons (gh_cons (eltprop, val), prev);
345 internal_set_property (prop, prev);
356 SCM prev = internal_get_property (prop);
358 SCM newprops= SCM_EOL ;
359 while (gh_pair_p (prev) && ly_caar (prev) != eltprop)
361 newprops = gh_cons (ly_car (prev), newprops);
362 prev = ly_cdr (prev);
365 if (gh_pair_p (prev))
367 newprops = scm_reverse_x (newprops, ly_cdr (prev));
368 internal_set_property (prop, newprops);
382 Translator_group::stop_translation_timestep ()
384 each (&Translator::stop_translation_timestep);
388 Translator_group::start_translation_timestep ()
390 each (&Translator::start_translation_timestep);
394 Translator_group::do_announces ()
396 each (&Translator::do_announces);
400 Translator_group::initialize ()
402 each (&Translator::initialize);
406 Translator_group::finalize ()
408 each (&Translator::removal_processing);
411 LY_DEFINE(ly_get_context_property,
412 "ly-get-context-property", 2, 0, 0,
413 (SCM context, SCM name),
414 "retrieve the value of @var{sym} from context @var{tr}")
416 Translator *t = unsmob_translator (context);
417 Translator_group* tr= dynamic_cast<Translator_group*> (t);
418 SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Translator group");
419 SCM_ASSERT_TYPE(gh_symbol_p (name), name, SCM_ARG2, __FUNCTION__, "symbol");
421 return tr->internal_get_property (name);
425 LY_DEFINE(ly_set_context_property,
426 "ly-set-context-property", 3, 0, 0,
427 (SCM context, SCM name, SCM val),
428 "set value of property @var{sym} in context @var{tr} to @var{val}.
431 Translator *t = unsmob_translator (context);
432 Translator_group* tr= dynamic_cast<Translator_group*> (t);
434 SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Context");
435 tr->internal_set_property (name, val);
437 return SCM_UNSPECIFIED;