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--2001 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 "debug.hh"
  13 #include "moment.hh"
  14 #include "scm-hash.hh"
  15 #include "killing-cons.tcc"
  16 #include "translator-def.hh"
  17
  18 Translator_group::Translator_group (Translator_group const&s)
  19   : Translator (s)
  20 {
  21   iterator_count_ =0;
  22
  23   Scheme_hash_table * tab =  new Scheme_hash_table (*s.properties_dict ());
  24   properties_scm_ = tab->self_scm ();
  25   scm_unprotect_object (tab->self_scm ());
  26 }
  27
  28 Scheme_hash_table*
  29 Translator_group::properties_dict () const
  30 {
  31   return Scheme_hash_table::unsmob (properties_scm_);
  32 }
  33
  34 Translator_group::~Translator_group ()
  35 {
  36
  37   //assert (removable_b ());
  38 }
  39
  40
  41 Translator_group::Translator_group ()
  42 {
  43   iterator_count_  = 0;
  44   Scheme_hash_table *tab = new Scheme_hash_table ;
  45   properties_scm_ = tab->self_scm ();
  46
  47   scm_unprotect_object (tab->self_scm ());
  48 }
  49
  50 void
  51 Translator_group::check_removal ()
  52 {
  53   SCM next = SCM_EOL;
  54   for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
  55     {
  56       next = gh_cdr (p);
  57
  58       Translator_group *trg =  dynamic_cast<Translator_group*> (unsmob_translator (gh_car (p)));
  59
  60       trg->check_removal ();
  61       if (trg->removable_b ())
  62         terminate_translator (trg);
  63     }
  64 }
  65
  66
  67 SCM
  68 Translator_group::add_translator (SCM list, Translator *t)
  69 {
  70   list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
  71   t->daddy_trans_l_ = this;
  72   t->output_def_l_ = output_def_l_;
  73   if (Translator_group*tg = dynamic_cast<Translator_group*> (t))
  74     {
  75       unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
  76     }
  77
  78   t->initialize ();
  79   return list;
  80 }
  81 void
  82 Translator_group::add_group_translator (Translator *t)
  83 {
  84   trans_group_list_ = add_translator (trans_group_list_,t);
  85 }
  86
  87
  88
  89 bool
  90 Translator_group::removable_b () const
  91 {
  92   return trans_group_list_ == SCM_EOL && ! iterator_count_;
  93 }
  94
  95 Translator_group *
  96 Translator_group::find_existing_translator_l (String n, String id)
  97 {
  98   if (is_alias_b (n) && (id_str_ == id || id.empty_b ()))
  99     return this;
 100
 101   Translator_group* r = 0;
 102   for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = gh_cdr (p))
 103     {
 104       Translator *  t = unsmob_translator (gh_car (p));
 105
 106       r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
 107     }
 108
 109   return r;
 110 }
 111
 112
 113
 114
 115 Translator_group*
 116 Translator_group::find_create_translator_l (String n, String id)
 117 {
 118   Translator_group * existing = find_existing_translator_l (n,id);
 119   if (existing)
 120     return existing;
 121
 122   Link_array<Translator_def> path
 123     = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.ch_C ()), output_def_l ());
 124
 125   if (path.size ())
 126     {
 127       Translator_group * current = this;
 128
 129       // start at 1.  The first one (index 0) will be us.
 130       for (int i=0; i < path.size (); i++)
 131         {
 132           Translator_group * new_group = path[i]->instantiate (output_def_l_);
 133
 134           current->add_group_translator (new_group);
 135           current = new_group;
 136         }
 137       current->id_str_ = id;
 138       return current;
 139     }
 140
 141   Translator_group *ret = 0;
 142   if (daddy_trans_l_)
 143     ret = daddy_trans_l_->find_create_translator_l (n,id);
 144   else
 145     {
 146       warning (_f ("can't find or create `%s' called `%s'", n, id));
 147       ret =0;
 148     }
 149   return ret;
 150 }
 151
 152 bool
 153 Translator_group::try_music_on_nongroup_children (Music *m)
 154 {
 155   bool hebbes_b =false;
 156
 157   for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = gh_cdr (p))
 158     {
 159       hebbes_b = unsmob_translator (gh_car (p))->try_music (m);
 160     }
 161   return hebbes_b;
 162 }
 163
 164 bool
 165 Translator_group::try_music (Music* m)
 166 {
 167   bool hebbes_b = try_music_on_nongroup_children (m);
 168
 169   if (!hebbes_b && daddy_trans_l_)
 170     hebbes_b = daddy_trans_l_->try_music (m);
 171   return hebbes_b ;
 172 }
 173
 174 int
 175 Translator_group::depth_i () const
 176 {
 177   return (daddy_trans_l_) ? daddy_trans_l_->depth_i ()  + 1 : 0;
 178 }
 179
 180 Translator_group*
 181 Translator_group::ancestor_l (int level)
 182 {
 183   if (!level || !daddy_trans_l_)
 184     return this;
 185
 186   return daddy_trans_l_->ancestor_l (level-1);
 187 }
 188
 189 void
 190 Translator_group::terminate_translator (Translator*r_l)
 191 {
 192   r_l->removal_processing ();
 193   /*
 194     Return value ignored. GC does the rest.
 195    */
 196   remove_translator_p (r_l);
 197 }
 198
 199
 200 /**
 201    Remove a translator from the hierarchy.
 202  */
 203 Translator *
 204 Translator_group::remove_translator_p (Translator*trans_l)
 205 {
 206   assert (trans_l);
 207
 208   trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_);
 209   trans_l->daddy_trans_l_ = 0;
 210   return trans_l;
 211 }
 212
 213 bool
 214 Translator_group::is_bottom_translator_b () const
 215 {
 216   return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
 217
 218 }
 219
 220 Translator_group*
 221 Translator_group::get_default_interpreter ()
 222 {
 223   if (!is_bottom_translator_b ())
 224     {
 225       SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
 226       SCM st = output_def_l ()->find_translator_l (nm);
 227
 228       Translator_def *t = unsmob_translator_def (st);
 229       if (!t)
 230         {
 231           warning (_f ("can't find or create: `%s'", ly_scm2string (nm).ch_C ()));
 232           t = unsmob_translator_def (this->definition_);
 233         }
 234       Translator_group *tg = t->instantiate (output_def_l_);
 235       add_group_translator (tg);
 236
 237       if (!tg->is_bottom_translator_b ())
 238         return tg->get_default_interpreter ();
 239       else
 240         return tg;
 241     }
 242   return this;
 243 }
 244
 245 static void
 246 static_each (SCM list, Method_pointer method)
 247 {
 248   for (SCM p = list; gh_pair_p (p); p = gh_cdr (p))
 249  (unsmob_translator (gh_car (p))->*method) ();
 250
 251 }
 252
 253 void
 254 Translator_group::each (Method_pointer method)
 255 {
 256   static_each (simple_trans_list_, method);
 257   static_each (trans_group_list_, method);
 258 }
 259
 260
 261 /*
 262   PROPERTIES
 263  */
 264 Translator_group*
 265 Translator_group::where_defined (SCM sym) const
 266 {
 267   if (properties_dict ()->elem_b (sym))
 268     {
 269       return (Translator_group*)this;
 270     }
 271
 272   return (daddy_trans_l_) ? daddy_trans_l_->where_defined (sym) : 0;
 273 }
 274
 275 /*
 276   return SCM_EOL when not found.
 277 */
 278 SCM
 279 Translator_group::get_property (SCM sym) const
 280 {
 281   SCM val =SCM_EOL;
 282   if (properties_dict ()->try_retrieve (sym, &val))
 283     return val;
 284
 285   if (daddy_trans_l_)
 286     return daddy_trans_l_->get_property (sym);
 287
 288   return val;
 289 }
 290
 291 void
 292 Translator_group::set_property (String id, SCM val)
 293 {
 294   set_property (ly_symbol2scm (id.ch_C ()), val);
 295 }
 296
 297
 298 void
 299 Translator_group::set_property (SCM sym, SCM val)
 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 = get_property (prop);
 326
 327           if (gh_pair_p (prev) || prev == SCM_EOL)
 328             {
 329               bool ok = type_check_assignment (val, eltprop, ly_symbol2scm ("backend-type?"));
 330
 331
 332
 333               if (ok)
 334                 {
 335                   prev = gh_cons (gh_cons (eltprop, val), prev);
 336                   set_property (prop, prev);
 337                 }
 338             }
 339           else
 340             {
 341               // warning here.
 342             }
 343
 344         }
 345       else
 346         {
 347           SCM prev = get_property (prop);
 348
 349           SCM newprops= SCM_EOL ;
 350           while (gh_pair_p (prev) && gh_caar (prev) != eltprop)
 351             {
 352               newprops = gh_cons (gh_car (prev), newprops);
 353               prev = gh_cdr (prev);
 354             }
 355
 356           if (gh_pair_p (prev))
 357             {
 358               newprops = scm_reverse_x (newprops, gh_cdr (prev));
 359               set_property (prop, newprops);
 360             }
 361         }
 362     }
 363 }
 364
 365
 366
 367
 368
 369 /*
 370   STUBS
 371 */
 372 void
 373 Translator_group::stop_translation_timestep ()
 374 {
 375   each (&Translator::stop_translation_timestep);
 376 }
 377
 378 void
 379 Translator_group::start_translation_timestep ()
 380 {
 381   each (&Translator::start_translation_timestep);
 382 }
 383
 384 void
 385 Translator_group::do_announces ()
 386 {
 387   each (&Translator::announces);
 388 }
 389
 390 void
 391 Translator_group::initialize ()
 392 {
 393   each (&Translator::initialize);
 394 }
 395
 396 void
 397 Translator_group::finalize ()
 398 {
 399   each (&Translator::removal_processing);
 400 }
 401
 402
 403 bool
 404 type_check_assignment (SCM val, SCM sym,  SCM type_symbol)
 405 {
 406   bool ok = true;
 407   SCM type_p = SCM_EOL;
 408
 409   if (gh_symbol_p (sym))
 410     type_p = scm_object_property (sym, type_symbol);
 411
 412   if (type_p != SCM_EOL && !gh_procedure_p (type_p))
 413       {
 414         warning (_f ("Can't find property type-check for `%s'.  Perhaps you made a typing error? Doing assignment anyway.",
 415                      ly_symbol2string (sym).ch_C ()));
 416       }
 417   else
 418     {
 419       if (val != SCM_EOL
 420           && gh_procedure_p (type_p)
 421           && gh_call1 (type_p, val) == SCM_BOOL_F)
 422         {
 423           SCM errport = scm_current_error_port ();
 424           ok = false;
 425           SCM typefunc = scm_eval2 (ly_symbol2scm ("type-name"), SCM_EOL);
 426           SCM type_name = gh_call1 (typefunc, type_p);
 427
 428           scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
 429                         ly_symbol2string (sym).ch_C (),
 430                         ly_scm2string (ly_write2scm (val)).ch_C (),
 431                         ly_scm2string (type_name).ch_C ()).ch_C (),
 432                     errport);
 433           scm_puts ("\n", errport);
 434         }
 435     }
 436   return ok;
 437 }
 438
 439 SCM
 440 ly_get_trans_property (SCM context, SCM name)
 441 {
 442   Translator *t = unsmob_translator (context);
 443   Translator_group* tr=   dynamic_cast<Translator_group*> (t);
 444   if (!t || !tr)
 445     {
 446       /* programming_error? */
 447       warning (_ ("ly-get-trans-property: expecting a Translator_group argument"));
 448       return SCM_EOL;
 449     }
 450   return tr->get_property (name);
 451
 452 }
 453 SCM
 454 ly_set_trans_property (SCM context, SCM name, SCM val)
 455 {
 456
 457   Translator *t = unsmob_translator (context);
 458   Translator_group* tr=   dynamic_cast<Translator_group*> (t);
 459   if (tr)
 460     {
 461       tr->set_property (name, val);
 462     }
 463   return SCM_UNSPECIFIED;
 464 }
 465
 466
 467
 468
 469 void
 470 add_trans_scm_funcs ()
 471 {
 472   scm_make_gsubr ("ly-get-trans-property", 2, 0, 0, (Scheme_function_unknown)ly_get_trans_property);
 473   scm_make_gsubr ("ly-set-trans-property", 3, 0, 0, (Scheme_function_unknown)ly_set_trans_property);
 474 }
 475
 476 ADD_SCM_INIT_FUNC (trans_scm, add_trans_scm_funcs);