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