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--2002 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 (removable_b ());
  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->removable_b ())
  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   assert (tg);
  93
  94   trans_group_list_ = add_translator (trans_group_list_,t);
  95   unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
  96   t->initialize ();
  97
  98 }
  99
 100
 101 bool
 102 Translator_group::removable_b () const
 103 {
 104   return trans_group_list_ == SCM_EOL && ! iterator_count_;
 105 }
 106
 107 Translator_group *
 108 Translator_group::find_existing_translator (String n, String id)
 109 {
 110   if ((is_alias_b (n) && (id_string_ == id || id.empty_b ())) || n == "Current")
 111     return this;
 112
 113   Translator_group* r = 0;
 114   for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = ly_cdr (p))
 115     {
 116       Translator *  t = unsmob_translator (ly_car (p));
 117
 118       r = dynamic_cast<Translator_group*> (t)->find_existing_translator (n, id);
 119     }
 120
 121   return r;
 122 }
 123
 124
 125
 126
 127 Translator_group*
 128 Translator_group::find_create_translator (String n, String id)
 129 {
 130   Translator_group * existing = find_existing_translator (n,id);
 131   if (existing)
 132     return existing;
 133
 134   Link_array<Translator_def> path
 135     = unsmob_translator_def (definition_)->path_to_acceptable_translator (scm_makfrom0str ((char*)n.to_str0 ()), 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           Translator_group * new_group = path[i]->instantiate (output_def_);
 145
 146           if (i == path.size () -1)
 147             new_group->id_string_ = id;
 148           current->add_fresh_group_translator (new_group);
 149           current = new_group;
 150         }
 151
 152       return current;
 153     }
 154
 155   Translator_group *ret = 0;
 156   if (daddy_trans_)
 157     ret = daddy_trans_->find_create_translator (n,id);
 158   else
 159     {
 160       warning (_f ("can't find or create `%s' called `%s'", n, id));
 161       ret =0;
 162     }
 163   return ret;
 164 }
 165
 166 bool
 167 Translator_group::try_music (Music* m)
 168 {
 169   bool hebbes_b = try_music_on_nongroup_children (m);
 170
 171   if (!hebbes_b && daddy_trans_)
 172     hebbes_b = daddy_trans_->try_music (m);
 173   return hebbes_b ;
 174 }
 175
 176 int
 177 Translator_group::get_depth () const
 178 {
 179   return (daddy_trans_) ? daddy_trans_->get_depth ()  + 1 : 0;
 180 }
 181
 182 Translator_group*
 183 Translator_group::get_ancestor (int level)
 184 {
 185   if (!level || !daddy_trans_)
 186     return this;
 187
 188   return daddy_trans_->get_ancestor (level-1);
 189 }
 190
 191 void
 192 Translator_group::terminate_translator (Translator*r)
 193 {
 194   r->removal_processing ();
 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_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
 219
 220 }
 221
 222 Translator_group*
 223 Translator_group::get_default_interpreter ()
 224 {
 225   if (!is_bottom_translator_b ())
 226     {
 227       SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
 228       SCM st = get_output_def ()->find_translator (nm);
 229
 230       Translator_def *t = unsmob_translator_def (st);
 231       if (!t)
 232         {
 233           warning (_f ("can't find or create: `%s'", ly_scm2string (nm).to_str0 ()));
 234           t = unsmob_translator_def (this->definition_);
 235         }
 236       Translator_group *tg = t->instantiate (output_def_);
 237       add_fresh_group_translator (tg);
 238
 239       if (!tg->is_bottom_translator_b ())
 240         return tg->get_default_interpreter ();
 241       else
 242         return tg;
 243     }
 244   return this;
 245 }
 246
 247 static void
 248 static_each (SCM list, Method_pointer method)
 249 {
 250   for (SCM p = list; gh_pair_p (p); p = ly_cdr (p))
 251     (unsmob_translator (ly_car (p))->*method) ();
 252
 253 }
 254
 255 void
 256 Translator_group::each (Method_pointer method)
 257 {
 258   static_each (simple_trans_list_, method);
 259   static_each (trans_group_list_, method);
 260 }
 261
 262
 263 /*
 264   PROPERTIES
 265  */
 266 Translator_group*
 267 Translator_group::where_defined (SCM sym) const
 268 {
 269   if (properties_dict ()->elem_b (sym))
 270     {
 271       return (Translator_group*)this;
 272     }
 273
 274   return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0;
 275 }
 276
 277 /*
 278   return SCM_EOL when not found.
 279 */
 280 SCM
 281 Translator_group::internal_get_property (SCM sym) const
 282 {
 283   SCM val =SCM_EOL;
 284   if (properties_dict ()->try_retrieve (sym, &val))
 285     return val;
 286
 287   if (daddy_trans_)
 288     return daddy_trans_->internal_get_property (sym);
 289
 290   return val;
 291 }
 292
 293 void
 294 Translator_group::internal_set_property (SCM sym, SCM val)
 295 {
 296 #ifndef NDEBUG
 297   if (internal_type_checking_global_b)
 298     assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
 299 #endif
 300
 301   properties_dict ()->set (sym, val);
 302 }
 303
 304 /*
 305   TODO: look up to check whether we have inherited var?
 306  */
 307 void
 308 Translator_group::unset_property (SCM sym)
 309 {
 310   properties_dict ()->remove (sym);
 311 }
 312
 313
 314 /*
 315   Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
 316   entry from a translator property list by name of PROP
 317 */
 318 void
 319 Translator_group::execute_single_pushpop_property (SCM prop, SCM eltprop, SCM val)
 320 {
 321   if (gh_symbol_p (prop))
 322     {
 323       if (val != SCM_UNDEFINED)
 324         {
 325           SCM prev = internal_get_property (prop);
 326
 327           if (gh_pair_p (prev) || prev == SCM_EOL)
 328             {
 329               bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
 330
 331               if (ok)
 332                 {
 333                   prev = gh_cons (gh_cons (eltprop, val), prev);
 334                   internal_set_property (prop, prev);
 335                 }
 336             }
 337           else
 338             {
 339               // warning here.
 340             }
 341
 342         }
 343       else
 344         {
 345           SCM prev = internal_get_property (prop);
 346
 347           SCM newprops= SCM_EOL ;
 348           while (gh_pair_p (prev) && ly_caar (prev) != eltprop)
 349             {
 350               newprops = gh_cons (ly_car (prev), newprops);
 351               prev = ly_cdr (prev);
 352             }
 353
 354           if (gh_pair_p (prev))
 355             {
 356               newprops = scm_reverse_x (newprops, ly_cdr (prev));
 357               internal_set_property (prop, newprops);
 358             }
 359         }
 360     }
 361 }
 362
 363
 364
 365
 366
 367 /*
 368   STUBS
 369 */
 370 void
 371 Translator_group::stop_translation_timestep ()
 372 {
 373   each (&Translator::stop_translation_timestep);
 374 }
 375
 376 void
 377 Translator_group::start_translation_timestep ()
 378 {
 379   each (&Translator::start_translation_timestep);
 380 }
 381
 382 void
 383 Translator_group::do_announces ()
 384 {
 385   each (&Translator::do_announces);
 386 }
 387
 388 void
 389 Translator_group::initialize ()
 390 {
 391   SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F);
 392   set_property ("acceptHashTable", tab);
 393   each (&Translator::initialize);
 394 }
 395
 396 void
 397 Translator_group::finalize ()
 398 {
 399   each (&Translator::removal_processing);
 400 }
 401
 402
 403
 404 bool 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_assq ( ly_symbol2scm ("name"), m->get_property_alist (false));
 435
 436   if (!gh_pair_p (name))
 437     return false;
 438
 439   name = gh_car (name);
 440   SCM accept_list = scm_hashq_ref (tab, name, SCM_UNDEFINED);
 441   if (accept_list == SCM_BOOL_F)
 442     {
 443       accept_list = find_accept_translators (simple_trans_list_,
 444                                              m->get_mus_property ("types"));
 445       scm_hashq_set_x (tab, name, accept_list);
 446     }
 447
 448   for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p))
 449     {
 450       Translator * t = unsmob_translator (ly_car (p));
 451       if (t && t->try_music (m))
 452         return true;
 453     }
 454   return false;
 455 }