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