]> git.donarmstrong.com Git - lilypond.git/blob - lily/translator-group.cc
* mf/feta18.mf: design size is 18 not 22.5
[lilypond.git] / lily / translator-group.cc
1 /*
2   Translator_group.cc -- implement Translator_group
3
4   source file of the GNU LilyPond music typesetter
5
6   (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
7 */
8
9 #include "music-output-def.hh"
10 #include "translator-group.hh"
11 #include "translator.hh"
12 #include "warn.hh"
13 #include "moment.hh"
14 #include "scm-hash.hh"
15 #include "translator-def.hh"
16 #include "main.hh"
17 #include "music.hh"
18
19 Translator_group::Translator_group (Translator_group const&s)
20   : Translator (s)
21 {
22   iterator_count_ =0;
23   
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 ());
27 }
28
29 Scheme_hash_table*
30 Translator_group::properties_dict () const
31 {
32   return Scheme_hash_table::unsmob (properties_scm_);
33 }
34
35 Translator_group::~Translator_group ()
36 {
37   
38   //assert (is_removable ());
39 }
40
41
42 Translator_group::Translator_group ()
43 {
44   iterator_count_  = 0;
45   Scheme_hash_table *tab = new Scheme_hash_table ;
46   properties_scm_ = tab->self_scm ();
47
48   scm_gc_unprotect_object (tab->self_scm ());
49 }
50
51 void
52 Translator_group::check_removal ()
53 {
54   SCM next = SCM_EOL; 
55   for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
56     {
57       next = ly_cdr (p);
58
59       Translator_group *trg =  dynamic_cast<Translator_group*> (unsmob_translator (ly_car (p)));
60
61       trg->check_removal ();
62       if (trg->is_removable ())
63         terminate_translator (trg);
64     }
65 }
66
67 SCM
68 Translator_group::add_translator (SCM list, Translator *t)
69 {
70   /*
71     Must append, since list ordering must be preserved.
72    */
73   list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
74   t->daddy_trans_ = this;
75   t->output_def_ = output_def_;
76
77   return list;
78 }
79
80
81 void
82 Translator_group::add_used_group_translator (Translator *t)
83 {
84   trans_group_list_ = add_translator (trans_group_list_,t);
85 }
86
87
88 void
89 Translator_group::add_fresh_group_translator (Translator*t)
90 {
91   Translator_group*tg = dynamic_cast<Translator_group*> (t);
92   trans_group_list_ = add_translator (trans_group_list_,t); 
93   Context_def * td = unsmob_context_def (tg->definition_);
94
95   /*
96     this can not move before add_translator(), because \override
97     operations require that we are in the hierarchy.
98    */
99   td->apply_default_property_operations (tg);
100
101   t->initialize ();
102 }
103
104 bool
105 Translator_group::is_removable () const
106 {
107   return trans_group_list_ == SCM_EOL && ! iterator_count_;
108 }
109
110 Translator_group *
111 Translator_group::find_existing_translator (SCM n, String id)
112 {
113   if ((is_alias (n) && (id_string_ == id || id.is_empty ())) || n == ly_symbol2scm ("Current"))
114     return this;
115
116   Translator_group* r = 0;
117   for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = ly_cdr (p))
118     {
119       Translator *  t = unsmob_translator (ly_car (p));
120       
121       r = dynamic_cast<Translator_group*> (t)->find_existing_translator (n, id);    }
122
123   return r;
124 }
125
126
127 Translator_group*
128 Translator_group::find_create_translator (SCM n, String id, SCM operations)
129 {
130   Translator_group * existing = find_existing_translator (n,id);
131   if (existing)
132     return existing;
133
134   Link_array<Context_def> path
135     = unsmob_context_def (definition_)->path_to_acceptable_translator (n, get_output_def ());
136
137   if (path.size ())
138     {
139       Translator_group * current = this;
140
141       // start at 1.  The first one (index 0) will be us.
142       for (int i=0; i < path.size (); i++)
143         {
144           SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
145
146           Translator_group * new_group
147             = path[i]->instantiate (output_def_, ops);
148
149           if (i == path.size () -1)
150             {
151               new_group->id_string_ = id;
152             }
153
154           current->add_fresh_group_translator (new_group);
155           apply_property_operations (new_group, ops);
156           
157           current = new_group;
158         }
159
160       return current;
161     }
162
163   Translator_group *ret = 0;
164   if (daddy_trans_)
165     ret = daddy_trans_->find_create_translator (n, id, operations);
166   else
167     {
168       warning (_f ("can't find or create `%s' called `%s'", ly_symbol2string (n).to_str0 (), id));
169       ret =0;
170     }
171   return ret;
172 }
173
174 bool
175 Translator_group::try_music (Music* m)
176 {
177   bool hebbes_b = try_music_on_nongroup_children (m);
178   
179   if (!hebbes_b && daddy_trans_)
180     hebbes_b = daddy_trans_->try_music (m);
181   
182   return hebbes_b ;
183 }
184
185 int
186 Translator_group::get_depth () const
187 {
188   return (daddy_trans_) ? daddy_trans_->get_depth ()  + 1 : 0;
189 }
190
191 void
192 Translator_group::terminate_translator (Translator*r)
193 {
194   r->finalize ();
195   /*
196     Return value ignored. GC does the rest.
197    */
198   remove_translator (r);
199 }
200
201
202 /**
203    Remove a translator from the hierarchy.
204  */
205 Translator *
206 Translator_group::remove_translator (Translator*trans)
207 {
208   assert (trans);
209
210   trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_);
211   trans->daddy_trans_ = 0;
212   return trans;
213 }
214
215 bool
216 Translator_group::is_bottom_translator_b () const
217 {
218   return !gh_symbol_p (unsmob_context_def (definition_)->default_child_context_name ());
219 }
220
221 Translator_group*
222 Translator_group::get_default_interpreter ()
223 {
224   if (!is_bottom_translator_b ())
225     {
226       SCM nm = unsmob_context_def (definition_)->default_child_context_name ();
227       SCM st = get_output_def ()->find_translator (nm);
228
229       Context_def *t = unsmob_context_def (st);
230       if (!t)
231         {
232           warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
233           t = unsmob_context_def (this->definition_);
234         }
235       Translator_group *tg = t->instantiate (output_def_, SCM_EOL);
236       add_fresh_group_translator (tg);
237
238       if (!tg->is_bottom_translator_b ())
239         return tg->get_default_interpreter ();
240       else
241         return tg;
242     }
243   return this;
244 }
245
246 static void
247 static_each (SCM list, Method_pointer method)
248 {
249   for (SCM p = list; gh_pair_p (p); p = ly_cdr (p))
250     (unsmob_translator (ly_car (p))->*method) ();
251   
252 }
253
254 void
255 Translator_group::each (Method_pointer method) 
256 {
257   static_each (get_simple_trans_list (), method);
258   static_each (trans_group_list_, method);
259 }
260
261
262 /*
263   PROPERTIES
264  */
265 Translator_group*
266 Translator_group::where_defined (SCM sym) const
267 {
268   if (properties_dict ()->contains (sym))
269     {
270       return (Translator_group*)this;
271     }
272
273   return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0;
274 }
275
276 /*
277   return SCM_EOL when not found.
278 */
279 SCM
280 Translator_group::internal_get_property (SCM sym) const
281 {
282   SCM val =SCM_EOL;
283   if (properties_dict ()->try_retrieve (sym, &val))
284     return val;
285
286   if (daddy_trans_)
287     return daddy_trans_->internal_get_property (sym);
288   
289   return val;
290 }
291
292 void
293 Translator_group::internal_set_property (SCM sym, SCM val)
294 {
295 #ifndef NDEBUG
296   if (internal_type_checking_global_b)
297     assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
298 #endif
299   
300   properties_dict ()->set (sym, val);
301 }
302
303 /*
304   TODO: look up to check whether we have inherited var? 
305  */
306 void
307 Translator_group::unset_property (SCM sym)
308 {
309   properties_dict ()->remove (sym);
310 }
311
312
313 /*
314   Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
315   entry from a translator property list by name of PROP
316 */
317 void
318 Translator_group::execute_pushpop_property (SCM prop, SCM eltprop, SCM val)
319 {
320   if (gh_symbol_p (prop))
321     {
322       if (val != SCM_UNDEFINED)
323         {
324           SCM prev = internal_get_property (prop);
325
326           if (gh_pair_p (prev) || prev == SCM_EOL)
327             {
328               bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
329               
330               if (ok)
331                 {
332                   prev = gh_cons (gh_cons (eltprop, val), prev);
333                   internal_set_property (prop, prev);
334                 }
335             }
336           else
337             {
338               // warning here.
339             }
340           
341         }
342       else
343         {
344           SCM prev = internal_get_property (prop);
345
346           /*
347             TODO: should have scm_equal_something () for reverting
348             autobeam properties.
349            */
350           SCM newprops= SCM_EOL ;
351           while (gh_pair_p (prev) && !SCM_EQ_P(ly_caar (prev), eltprop))
352             {
353               newprops = gh_cons (ly_car (prev), newprops);
354               prev = ly_cdr (prev);
355             }
356           
357           if (gh_pair_p (prev))
358             {
359               newprops = scm_reverse_x (newprops, ly_cdr (prev));
360               internal_set_property (prop, newprops);
361             }
362         }
363     }
364 }
365
366
367
368 /*
369   STUBS
370 */
371 void
372 Translator_group::stop_translation_timestep ()
373 {
374   each (&Translator::stop_translation_timestep);
375 }
376
377 void
378 Translator_group::start_translation_timestep ()
379 {
380   each (&Translator::start_translation_timestep);
381 }
382
383 void
384 Translator_group::do_announces ()
385 {
386   each (&Translator::do_announces);
387 }
388
389 void
390 Translator_group::initialize ()
391 {
392   SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F);
393   set_property ("acceptHashTable", tab);
394   each (&Translator::initialize);
395 }
396
397 void
398 Translator_group::finalize ()
399 {
400   each (&Translator::finalize);
401 }
402
403 bool
404 translator_accepts_any_of (Translator*tr, SCM ifaces)
405 {
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)
411       return true;
412   return false;
413 }
414
415 SCM
416 find_accept_translators (SCM gravlist, SCM ifaces)
417 {
418   SCM l = SCM_EOL;
419   for (SCM s = gravlist; ly_pair_p (s);  s = ly_cdr (s))
420     {
421       Translator* tr = unsmob_translator (ly_car (s));
422       if (translator_accepts_any_of (tr, ifaces))
423         l = scm_cons (tr->self_scm (), l); 
424     }
425   l = scm_reverse_x (l, SCM_EOL);
426
427   return l;
428 }
429
430 bool
431 Translator_group::try_music_on_nongroup_children (Music *m )
432 {
433   SCM tab = get_property ("acceptHashTable");
434   SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
435                               m->get_property_alist (false));
436
437   if (!gh_pair_p (name))
438     return false;
439
440   name = gh_cdr (name);
441   SCM accept_list = scm_hashq_ref (tab, name, SCM_UNDEFINED);
442   if (accept_list == SCM_BOOL_F)
443     {
444       accept_list = find_accept_translators (get_simple_trans_list (),
445                                              m->get_mus_property ("types"));
446       scm_hashq_set_x (tab, name, accept_list);
447     }
448
449   for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p))
450     {
451       Translator * t = unsmob_translator (ly_car (p));
452       if (t && t->try_music (m))
453         return true;
454     }
455   return false;
456 }
457
458 SCM
459 Translator_group::properties_as_alist () const
460 {
461   return properties_dict()->to_alist();
462 }
463
464 String
465 Translator_group::context_name () const
466 {
467   Context_def * td = unsmob_context_def (definition_ );
468   return ly_symbol2string (td->get_context_name ());
469 }
470
471 /*
472   PRE_INIT_OPS is in the order specified, and hence must be reversed.
473  */
474 void
475 apply_property_operations (Translator_group*tg, SCM pre_init_ops)
476 {
477   SCM correct_order = scm_reverse (pre_init_ops);
478   for (SCM s = correct_order; gh_pair_p (s); s = ly_cdr (s))
479     {
480       SCM entry = ly_car (s);
481       SCM type = ly_car (entry);
482       entry = ly_cdr (entry); 
483       
484       if (type == ly_symbol2scm ("push") || type == ly_symbol2scm ("poppush"))
485         {
486           SCM val = ly_cddr (entry);
487           val = gh_pair_p (val) ? ly_car (val) : SCM_UNDEFINED;
488
489           tg->execute_pushpop_property (ly_car (entry), ly_cadr (entry), val);
490         }
491       else if (type == ly_symbol2scm ("assign"))
492         {
493           tg->internal_set_property (ly_car (entry), ly_cadr (entry));
494         }
495     }
496 }
497
498 SCM
499 names_to_translators (SCM namelist, Translator_group*tg)
500 {
501   SCM l = SCM_EOL;
502   for (SCM s = namelist; gh_pair_p (s) ; s = ly_cdr (s))
503     {
504       Translator * t = get_translator (ly_car (s));
505       if (!t)
506         warning (_f ("can't find: `%s'", s));
507       else
508         {
509           Translator * tr = t->clone ();
510           SCM str = tr->self_scm ();
511           l = gh_cons (str, l);
512
513           tr->daddy_trans_ = tg;
514           tr->output_def_  = tg->output_def_;
515
516           scm_gc_unprotect_object (str);
517         }
518     }
519   return l;
520 }
521
522
523 SCM
524 Translator_group::get_simple_trans_list ()
525 {
526   return simple_trans_list_;
527
528 }
529
530
531   
532 #if 0
533 SCM
534 Translator_group::get_simple_trans_list ()
535 {
536   if (simple_trans_list_ != SCM_BOOL_F)
537     return simple_trans_list_;
538   
539   Context_def * td = unsmob_context_def (definition_);
540
541   /*
542     The following cannot work, since start_translation_timestep ()
543     triggers this code, and start_translation_timestep happens before
544     \property Voice.Voice =#'()
545     
546    */
547       trans_names = td->get_translator_names (SCM_EOL); 
548   
549   SCM trans_names = internal_get_property (td->get_context_name ());
550   if (!gh_pair_p (trans_names))
551     {
552     }
553
554   simple_trans_list_ = names_to_translators (trans_names, this);
555
556   
557   static_each (simple_trans_list_, &Translator::initialize);
558   return simple_trans_list_;
559 }
560 #endif