2 Translator_group.cc -- implement Translator_group
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2000 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 "killing-cons.tcc"
17 Translator_group::Translator_group (Translator_group const&s)
22 Scheme_hash_table * tab = new Scheme_hash_table (*s.properties_dict ());
23 properties_scm_ = tab->self_scm ();
24 scm_unprotect_object (tab->self_scm( ));
28 Translator_group::properties_dict () const
30 return Scheme_hash_table::unsmob (properties_scm_);
33 Translator_group::~Translator_group ()
35 assert (removable_b());
39 Translator_group::Translator_group()
42 Scheme_hash_table *tab = new Scheme_hash_table ;
43 properties_scm_ = tab->self_scm ();
45 scm_unprotect_object (tab->self_scm ());
49 Translator_group::check_removal()
52 for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
56 Translator_group *trg = dynamic_cast<Translator_group*> (unsmob_translator (gh_car (p)));
58 trg->check_removal ();
59 if (trg->removable_b())
60 terminate_translator (trg);
66 Translator_group::add_translator (SCM list, Translator *t)
68 list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
69 t->daddy_trans_l_ = this;
70 t->output_def_l_ = output_def_l_;
76 Translator_group::add_group_translator (Translator *t)
78 trans_group_list_ = add_translator (trans_group_list_,t);
84 Translator_group::removable_b() const
86 return trans_group_list_ == SCM_EOL && ! iterator_count_;
90 Translator_group::find_existing_translator_l (String n, String id)
92 if (is_alias_b (n) && (id_str_ == id || id.empty_b ()))
95 Translator_group* r = 0;
96 for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = gh_cdr (p))
98 Translator * t = unsmob_translator (gh_car (p));
100 r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
106 Link_array<Translator_group>
107 Translator_group::path_to_acceptable_translator (String type, Music_output_def* odef) const
109 Link_array<Translator_group> accepted_arr;
110 for (SCM s = accepts_name_list_; gh_pair_p (s); s = gh_cdr (s))
113 Translator *t = odef->find_translator_l (ly_scm2string (gh_car (s)));
114 if (!t || !dynamic_cast <Translator_group *> (t))
116 accepted_arr.push (dynamic_cast <Translator_group *> (t));
120 for (int i=0; i < accepted_arr.size (); i++)
121 if (accepted_arr[i]->type_str_ == type)
123 Link_array<Translator_group> retval;
124 retval.push (accepted_arr[i]);
128 Link_array<Translator_group> best_result;
129 int best_depth= INT_MAX;
130 for (int i=0; i < accepted_arr.size (); i++)
132 Translator_group * g = accepted_arr[i];
134 Link_array<Translator_group> result
135 = g->path_to_acceptable_translator (type, odef);
136 if (result.size () && result.size () < best_depth)
139 best_result = result;
147 Translator_group::find_create_translator_l (String n, String id)
149 Translator_group * existing = find_existing_translator_l (n,id);
153 Link_array<Translator_group> path
154 = path_to_acceptable_translator (n, output_def_l ());
158 Translator_group * current = this;
160 // start at 1. The first one (index 0) will be us.
161 for (int i=0; i < path.size (); i++)
163 Translator_group * new_group = dynamic_cast<Translator_group*>(path[i]->clone ());
165 current->add_group_translator (new_group);
168 current->id_str_ = id;
172 Translator_group *ret = 0;
174 ret = daddy_trans_l_->find_create_translator_l (n,id);
177 warning (_f ("can't find or create `%s' called `%s'", n, id));
184 Translator_group::try_music_on_nongroup_children (Music *m)
186 bool hebbes_b =false;
189 for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = gh_cdr (p))
191 hebbes_b = unsmob_translator (gh_car (p))->try_music (m);
197 Translator_group::do_try_music (Music* m)
199 bool hebbes_b = try_music_on_nongroup_children (m);
201 if (!hebbes_b && daddy_trans_l_)
202 hebbes_b = daddy_trans_l_->try_music (m);
207 Translator_group::depth_i() const
209 return (daddy_trans_l_) ? daddy_trans_l_->depth_i() + 1 : 0;
213 Translator_group::ancestor_l (int level)
215 if (!level || !daddy_trans_l_)
218 return daddy_trans_l_->ancestor_l (level-1);
222 Translator_group::terminate_translator (Translator*r_l)
224 r_l->removal_processing();
225 Translator * trans_p =remove_translator_p (r_l);
227 forget trans_p, GC does the rest.
233 Remove a translator from the hierarchy.
236 Translator_group::remove_translator_p (Translator*trans_l)
240 trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_);
241 trans_l->daddy_trans_l_ = 0;
247 should not use, instead: use properties to communicate between engravers.
250 Translator_group::get_simple_translator (String type) const
252 for (SCM p = simple_trans_list_; gh_pair_p (p); p =gh_cdr (p))
254 if (classname (unsmob_translator (gh_car (p))) == type)
255 return unsmob_translator (gh_car (p));
258 return daddy_trans_l_->get_simple_translator (type);
264 Translator_group::is_bottom_translator_b () const
266 return accepts_name_list_ == SCM_EOL;
272 Translator_group::get_default_interpreter()
274 if (gh_pair_p (accepts_name_list_))
276 String str = ly_scm2string (gh_car (accepts_name_list_));
277 Translator*t = output_def_l ()->find_translator_l (str);
280 warning (_f ("can't find or create: `%s'", str));
283 Translator_group * g= dynamic_cast <Translator_group*>(t->clone ());
284 add_group_translator (g);
286 if (!g->is_bottom_translator_b ())
287 return g->get_default_interpreter ();
295 static_each (SCM list, Method_pointer method)
297 for (SCM p = list; gh_pair_p (p); p = gh_cdr(p))
298 (unsmob_translator (gh_car (p))->*method) ();
303 Translator_group::each (Method_pointer method)
305 static_each (simple_trans_list_, method);
306 static_each (trans_group_list_, method);
310 Translator_group::do_print() const
317 trans_list (SCM namelist, Music_output_def *mdef)
320 for (SCM s = namelist; gh_pair_p (s) ; s = gh_cdr (s))
322 Translator * t = mdef->find_translator_l (ly_scm2string (gh_car (s)));
324 warning (_f ("can't find: `%s'", s));
327 Translator * tr = t->clone ();
328 SCM str = tr->self_scm ();
329 l = gh_cons (str, l);
330 scm_unprotect_object (str);
338 Translator_group::do_add_processing ()
340 assert (simple_trans_list_== SCM_EOL);
342 SCM correct_order = scm_reverse (property_pushes_); // pity of the mem.
343 for (SCM s = correct_order; gh_pair_p (s); s = gh_cdr (s))
345 SCM entry = gh_car (s);
346 SCM val = gh_cddr (entry);
347 val = gh_pair_p (val) ? gh_car (val) : SCM_UNDEFINED;
349 Translator_group_initializer::apply_pushpop_property (this, gh_car (entry),
354 SCM l1 = trans_list (consists_name_list_, output_def_l ());
355 SCM l2 =trans_list (end_consists_name_list_, output_def_l ());
356 l1 = scm_reverse_x (l1, l2);
358 simple_trans_list_ = l1;
359 for (SCM s = l1; gh_pair_p (s) ; s = gh_cdr (s))
361 Translator * t = unsmob_translator (gh_car (s));
363 t->daddy_trans_l_ = this;
364 t->output_def_l_ = output_def_l_;
365 t->add_processing ();
375 Translator_group::where_defined (SCM sym) const
377 if (properties_dict ()->elem_b (sym))
379 return (Translator_group*)this;
382 return (daddy_trans_l_) ? daddy_trans_l_->where_defined (sym) : 0;
386 Translator_group::get_property (SCM sym) const
388 if (properties_dict ()->elem_b (sym))
390 return properties_dict ()->get (sym);
394 return daddy_trans_l_->get_property (sym);
396 return SCM_UNDEFINED;
400 Translator_group::set_property (String id, SCM val)
402 set_property (ly_symbol2scm (id.ch_C()), val);
406 Translator_group::set_property (SCM sym, SCM val)
408 properties_dict ()->set (sym, val);
412 Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
413 entry from a translator property list by name of PROP
416 Translator_group::execute_single_pushpop_property (SCM prop, SCM eltprop, SCM val)
418 if (gh_symbol_p(prop))
420 if (val != SCM_UNDEFINED)
422 SCM prev = get_property (prop);
424 prev = gh_cons (gh_cons (eltprop, val), prev);
425 set_property (prop, prev);
429 SCM prev = get_property (prop);
431 SCM newprops= SCM_EOL ;
432 while (gh_pair_p (prev) && gh_caar (prev) != eltprop)
434 newprops = gh_cons (gh_car (prev), newprops);
435 prev = gh_cdr (prev);
438 if (gh_pair_p (prev))
440 newprops = scm_reverse_x (newprops, gh_cdr (prev));
441 set_property (prop, newprops);
455 Translator_group::do_pre_move_processing ()
457 each (&Translator::pre_move_processing);
461 Translator_group::do_post_move_processing ()
463 each (&Translator::post_move_processing);
467 Translator_group::do_process_music ()
469 each (&Translator::process_music);
473 Translator_group::do_creation_processing ()
475 each (&Translator::creation_processing);
479 Translator_group::do_removal_processing ()
481 each (&Translator::removal_processing);