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, SCM pre_init_ops)
  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_default_property_operations (tg);
  96   apply_property_operations (tg, pre_init_ops);
  97   t->initialize ();
  98 }
  99
 100
 101 bool
 102 Translator_group::is_removable () const
 103 {
 104   return trans_group_list_ == SCM_EOL && ! iterator_count_;
 105 }
 106
 107 Translator_group *
 108 Translator_group::find_existing_translator (SCM n, String id)
 109 {
 110   if ((is_alias (n) && (id_string_ == id || id.is_empty ())) || n == ly_symbol2scm ("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 Translator_group*
 126 Translator_group::find_create_translator (SCM n, String id, SCM operations)
 127 {
 128   Translator_group * existing = find_existing_translator (n,id);
 129   if (existing)
 130     return existing;
 131
 132   Link_array<Translator_def> path
 133     = unsmob_translator_def (definition_)->path_to_acceptable_translator (n, get_output_def ());
 134
 135   if (path.size ())
 136     {
 137       Translator_group * current = this;
 138
 139       // start at 1.  The first one (index 0) will be us.
 140       for (int i=0; i < path.size (); i++)
 141         {
 142           Translator_group * new_group = path[i]->instantiate (output_def_);
 143
 144           SCM ops = SCM_EOL;
 145           if (i == path.size () -1)
 146             {
 147               new_group->id_string_ = id;
 148               ops = operations;
 149             }
 150
 151           current->add_fresh_group_translator (new_group, ops);
 152           current = new_group;
 153         }
 154
 155       return current;
 156     }
 157
 158   Translator_group *ret = 0;
 159   if (daddy_trans_)
 160     ret = daddy_trans_->find_create_translator (n, id, operations);
 161   else
 162     {
 163       warning (_f ("can't find or create `%s' called `%s'", ly_symbol2string (n).to_str0 (), id));
 164       ret =0;
 165     }
 166   return ret;
 167 }
 168
 169 bool
 170 Translator_group::try_music (Music* m)
 171 {
 172   bool hebbes_b = try_music_on_nongroup_children (m);
 173
 174   if (!hebbes_b && daddy_trans_)
 175     hebbes_b = daddy_trans_->try_music (m);
 176
 177   return hebbes_b ;
 178 }
 179
 180 int
 181 Translator_group::get_depth () const
 182 {
 183   return (daddy_trans_) ? daddy_trans_->get_depth ()  + 1 : 0;
 184 }
 185
 186 Translator_group*
 187 Translator_group::get_ancestor (int level)
 188 {
 189   if (!level || !daddy_trans_)
 190     return this;
 191
 192   return daddy_trans_->get_ancestor (level-1);
 193 }
 194
 195 void
 196 Translator_group::terminate_translator (Translator*r)
 197 {
 198   r->finalize ();
 199   /*
 200     Return value ignored. GC does the rest.
 201    */
 202   remove_translator (r);
 203 }
 204
 205
 206 /**
 207    Remove a translator from the hierarchy.
 208  */
 209 Translator *
 210 Translator_group::remove_translator (Translator*trans)
 211 {
 212   assert (trans);
 213
 214   trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_);
 215   trans->daddy_trans_ = 0;
 216   return trans;
 217 }
 218
 219 bool
 220 Translator_group::is_bottom_translator_b () const
 221 {
 222   return !gh_symbol_p (unsmob_translator_def (definition_)->default_child_context_name ());
 223 }
 224
 225 Translator_group*
 226 Translator_group::get_default_interpreter ()
 227 {
 228   if (!is_bottom_translator_b ())
 229     {
 230       SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
 231       SCM st = get_output_def ()->find_translator (nm);
 232
 233       Translator_def *t = unsmob_translator_def (st);
 234       if (!t)
 235         {
 236           warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
 237           t = unsmob_translator_def (this->definition_);
 238         }
 239       Translator_group *tg = t->instantiate (output_def_);
 240       add_fresh_group_translator (tg, SCM_EOL);
 241
 242       if (!tg->is_bottom_translator_b ())
 243         return tg->get_default_interpreter ();
 244       else
 245         return tg;
 246     }
 247   return this;
 248 }
 249
 250 static void
 251 static_each (SCM list, Method_pointer method)
 252 {
 253   for (SCM p = list; gh_pair_p (p); p = ly_cdr (p))
 254     (unsmob_translator (ly_car (p))->*method) ();
 255
 256 }
 257
 258 void
 259 Translator_group::each (Method_pointer method)
 260 {
 261   static_each (simple_trans_list_, method);
 262   static_each (trans_group_list_, method);
 263 }
 264
 265
 266 /*
 267   PROPERTIES
 268  */
 269 Translator_group*
 270 Translator_group::where_defined (SCM sym) const
 271 {
 272   if (properties_dict ()->contains (sym))
 273     {
 274       return (Translator_group*)this;
 275     }
 276
 277   return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0;
 278 }
 279
 280 /*
 281   return SCM_EOL when not found.
 282 */
 283 SCM
 284 Translator_group::internal_get_property (SCM sym) const
 285 {
 286   SCM val =SCM_EOL;
 287   if (properties_dict ()->try_retrieve (sym, &val))
 288     return val;
 289
 290   if (daddy_trans_)
 291     return daddy_trans_->internal_get_property (sym);
 292
 293   return val;
 294 }
 295
 296 void
 297 Translator_group::internal_set_property (SCM sym, SCM val)
 298 {
 299 #ifndef NDEBUG
 300   if (internal_type_checking_global_b)
 301     assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
 302 #endif
 303
 304   properties_dict ()->set (sym, val);
 305 }
 306
 307 /*
 308   TODO: look up to check whether we have inherited var?
 309  */
 310 void
 311 Translator_group::unset_property (SCM sym)
 312 {
 313   properties_dict ()->remove (sym);
 314 }
 315
 316
 317 /*
 318   Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
 319   entry from a translator property list by name of PROP
 320 */
 321 void
 322 Translator_group::execute_pushpop_property (SCM prop, SCM eltprop, SCM val)
 323 {
 324   if (gh_symbol_p (prop))
 325     {
 326       if (val != SCM_UNDEFINED)
 327         {
 328           SCM prev = internal_get_property (prop);
 329
 330           if (gh_pair_p (prev) || prev == SCM_EOL)
 331             {
 332               bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
 333
 334               if (ok)
 335                 {
 336                   prev = gh_cons (gh_cons (eltprop, val), prev);
 337                   internal_set_property (prop, prev);
 338                 }
 339             }
 340           else
 341             {
 342               // warning here.
 343             }
 344
 345         }
 346       else
 347         {
 348           SCM prev = internal_get_property (prop);
 349
 350           /*
 351             TODO: should have scm_equal_something () for reverting
 352             autobeam properties.
 353            */
 354           SCM newprops= SCM_EOL ;
 355           while (gh_pair_p (prev) && !SCM_EQ_P(ly_caar (prev), eltprop))
 356             {
 357               newprops = gh_cons (ly_car (prev), newprops);
 358               prev = ly_cdr (prev);
 359             }
 360
 361           if (gh_pair_p (prev))
 362             {
 363               newprops = scm_reverse_x (newprops, ly_cdr (prev));
 364               internal_set_property (prop, newprops);
 365             }
 366         }
 367     }
 368 }
 369
 370
 371
 372 /*
 373   STUBS
 374 */
 375 void
 376 Translator_group::stop_translation_timestep ()
 377 {
 378   each (&Translator::stop_translation_timestep);
 379 }
 380
 381 void
 382 Translator_group::start_translation_timestep ()
 383 {
 384   each (&Translator::start_translation_timestep);
 385 }
 386
 387 void
 388 Translator_group::do_announces ()
 389 {
 390   each (&Translator::do_announces);
 391 }
 392
 393 void
 394 Translator_group::initialize ()
 395 {
 396   SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F);
 397   set_property ("acceptHashTable", tab);
 398   each (&Translator::initialize);
 399 }
 400
 401 void
 402 Translator_group::finalize ()
 403 {
 404   each (&Translator::finalize);
 405 }
 406
 407
 408
 409 bool translator_accepts_any_of (Translator*tr, SCM ifaces)
 410 {
 411   SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
 412                            tr->translator_description());
 413   ack_ifs = gh_cdr (ack_ifs);
 414   for (SCM s = ifaces; ly_pair_p (s); s = ly_cdr (s))
 415     if (scm_memq (ly_car (s), ack_ifs) != SCM_BOOL_F)
 416       return true;
 417   return false;
 418 }
 419
 420 SCM
 421 find_accept_translators (SCM gravlist, SCM ifaces)
 422 {
 423   SCM l = SCM_EOL;
 424   for (SCM s = gravlist; ly_pair_p (s);  s = ly_cdr (s))
 425     {
 426       Translator* tr = unsmob_translator (ly_car (s));
 427       if (translator_accepts_any_of (tr, ifaces))
 428         l = scm_cons (tr->self_scm (), l);
 429     }
 430   l = scm_reverse_x (l, SCM_EOL);
 431
 432   return l;
 433 }
 434
 435 bool
 436 Translator_group::try_music_on_nongroup_children (Music *m )
 437 {
 438   SCM tab = get_property ("acceptHashTable");
 439   SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
 440                               m->get_property_alist (false));
 441
 442   if (!gh_pair_p (name))
 443     return false;
 444
 445   name = gh_cdr (name);
 446   SCM accept_list = scm_hashq_ref (tab, name, SCM_UNDEFINED);
 447   if (accept_list == SCM_BOOL_F)
 448     {
 449       accept_list = find_accept_translators (simple_trans_list_,
 450                                              m->get_mus_property ("types"));
 451       scm_hashq_set_x (tab, name, accept_list);
 452     }
 453
 454   for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p))
 455     {
 456       Translator * t = unsmob_translator (ly_car (p));
 457       if (t && t->try_music (m))
 458         return true;
 459     }
 460   return false;
 461 }
 462
 463 SCM
 464 Translator_group::properties_as_alist () const
 465 {
 466   return properties_dict()->to_alist();
 467 }
 468
 469 String
 470 Translator_group::context_name () const
 471 {
 472   Translator_def * td = unsmob_translator_def (definition_ );
 473   return ly_symbol2string (td->get_context_name ());
 474 }
 475
 476 void
 477 apply_property_operations (Translator_group*tg, SCM pre_init_ops)
 478 {
 479   SCM correct_order = scm_reverse (pre_init_ops);
 480   for (SCM s = correct_order; gh_pair_p (s); s = ly_cdr (s))
 481     {
 482       SCM entry = ly_car (s);
 483       SCM type = ly_car (entry);
 484       entry = ly_cdr (entry);
 485
 486       if (type == ly_symbol2scm ("push") || type == ly_symbol2scm ("poppush"))
 487         {
 488           SCM val = ly_cddr (entry);
 489           val = gh_pair_p (val) ? ly_car (val) : SCM_UNDEFINED;
 490
 491           tg->execute_pushpop_property (ly_car (entry), ly_cadr (entry), val);
 492         }
 493       else if (type == ly_symbol2scm ("assign"))
 494         {
 495           tg->internal_set_property (ly_car (entry), ly_cadr (entry));
 496         }
 497     }
 498 }