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--2000 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   t->add_processing ();
  74   t->do_creation_processing ();
  75   return list;
  76 }
  77 void
  78 Translator_group::add_group_translator (Translator *t)
  79 {
  80   trans_group_list_ = add_translator (trans_group_list_,t);
  81 }
  82
  83
  84
  85 bool
  86 Translator_group::removable_b() const
  87 {
  88   return trans_group_list_ == SCM_EOL && ! iterator_count_;
  89 }
  90
  91 Translator_group *
  92 Translator_group::find_existing_translator_l (String n, String id)
  93 {
  94   if (is_alias_b (n) && (id_str_ == id || id.empty_b ()))
  95     return this;
  96
  97   Translator_group* r = 0;
  98   for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = gh_cdr (p))
  99     {
 100       Translator *  t = unsmob_translator (gh_car (p));
 101
 102       r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
 103     }
 104
 105   return r;
 106 }
 107
 108
 109
 110
 111 Translator_group*
 112 Translator_group::find_create_translator_l (String n, String id)
 113 {
 114   Translator_group * existing = find_existing_translator_l (n,id);
 115   if (existing)
 116     return existing;
 117
 118   Link_array<Translator_def> path
 119     = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.ch_C()), output_def_l ());
 120
 121   if (path.size ())
 122     {
 123       Translator_group * current = this;
 124
 125       // start at 1.  The first one (index 0) will be us.
 126       for (int i=0; i < path.size (); i++)
 127         {
 128           Translator_group * new_group = path[i]->instantiate (output_def_l_);
 129
 130           current->add_group_translator (new_group);
 131           current = new_group;
 132         }
 133       current->id_str_ = id;
 134       return current;
 135     }
 136
 137   Translator_group *ret = 0;
 138   if (daddy_trans_l_)
 139     ret = daddy_trans_l_->find_create_translator_l (n,id);
 140   else
 141     {
 142       warning (_f ("can't find or create `%s' called `%s'", n, id));
 143       ret =0;
 144     }
 145   return ret;
 146 }
 147
 148 bool
 149 Translator_group::try_music_on_nongroup_children (Music *m)
 150 {
 151   bool hebbes_b =false;
 152
 153   for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = gh_cdr (p))
 154     {
 155       hebbes_b = unsmob_translator (gh_car (p))->try_music (m);
 156     }
 157   return hebbes_b;
 158 }
 159
 160 bool
 161 Translator_group::try_music (Music* m)
 162 {
 163   bool hebbes_b = try_music_on_nongroup_children (m);
 164
 165   if (!hebbes_b && daddy_trans_l_)
 166     hebbes_b = daddy_trans_l_->try_music (m);
 167   return hebbes_b ;
 168 }
 169
 170 int
 171 Translator_group::depth_i() const
 172 {
 173   return (daddy_trans_l_) ? daddy_trans_l_->depth_i()  + 1 : 0;
 174 }
 175
 176 Translator_group*
 177 Translator_group::ancestor_l (int level)
 178 {
 179   if (!level || !daddy_trans_l_)
 180     return this;
 181
 182   return daddy_trans_l_->ancestor_l (level-1);
 183 }
 184
 185 void
 186 Translator_group::terminate_translator (Translator*r_l)
 187 {
 188   r_l->removal_processing();
 189   /*
 190     Return value ignored. GC does the rest.
 191    */
 192   remove_translator_p (r_l);
 193 }
 194
 195
 196 /**
 197    Remove a translator from the hierarchy.
 198  */
 199 Translator *
 200 Translator_group::remove_translator_p (Translator*trans_l)
 201 {
 202   assert (trans_l);
 203
 204   trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_);
 205   trans_l->daddy_trans_l_ = 0;
 206   return trans_l;
 207 }
 208
 209 bool
 210 Translator_group::is_bottom_translator_b () const
 211 {
 212   return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
 213
 214 }
 215
 216 Translator_group*
 217 Translator_group::get_default_interpreter()
 218 {
 219   if (!is_bottom_translator_b ())
 220     {
 221       SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
 222       SCM st = output_def_l ()->find_translator_l (nm);
 223
 224       Translator_def *t = unsmob_translator_def (st);
 225       if (!t)
 226         {
 227           warning (_f ("can't find or create: `%s'", ly_scm2string (nm).ch_C()));
 228           t = unsmob_translator_def (this->definition_);
 229         }
 230       Translator_group *tg = t->instantiate (output_def_l_);
 231       add_group_translator (tg);
 232
 233       if (!tg->is_bottom_translator_b ())
 234         return tg->get_default_interpreter ();
 235       else
 236         return tg;
 237     }
 238   return this;
 239 }
 240
 241 static void
 242 static_each (SCM list, Method_pointer method)
 243 {
 244   for (SCM p = list; gh_pair_p (p); p = gh_cdr(p))
 245     (unsmob_translator (gh_car (p))->*method) ();
 246
 247 }
 248
 249 void
 250 Translator_group::each (Method_pointer method)
 251 {
 252   static_each (simple_trans_list_, method);
 253   static_each (trans_group_list_, method);
 254 }
 255
 256
 257
 258 void
 259 Translator_group::do_add_processing ()
 260 {
 261   unsmob_translator_def (definition_)->apply_property_operations (this);
 262   for (SCM s = simple_trans_list_; gh_pair_p (s) ; s = gh_cdr (s))
 263     {
 264       Translator * t = unsmob_translator (gh_car (s));
 265       t->add_processing ();
 266     }
 267 }
 268
 269 /*
 270   PROPERTIES
 271  */
 272 Translator_group*
 273 Translator_group::where_defined (SCM sym) const
 274 {
 275   if (properties_dict ()->elem_b (sym))
 276     {
 277       return (Translator_group*)this;
 278     }
 279
 280   return (daddy_trans_l_) ? daddy_trans_l_->where_defined (sym) : 0;
 281 }
 282
 283 /*
 284   return SCM_EOL when not found.
 285 */
 286 SCM
 287 Translator_group::get_property (SCM sym) const
 288 {
 289   SCM val =SCM_EOL;
 290   if (properties_dict ()->try_retrieve (sym, &val))
 291     return val;
 292
 293   if (daddy_trans_l_)
 294     return daddy_trans_l_->get_property (sym);
 295
 296   return val;
 297 }
 298
 299 void
 300 Translator_group::set_property (String id, SCM val)
 301 {
 302   set_property (ly_symbol2scm (id.ch_C()), val);
 303 }
 304
 305 void
 306 Translator_group::set_property (SCM sym, SCM val)
 307 {
 308   properties_dict ()->set (sym, val);
 309 }
 310
 311 /*
 312   Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL)
 313   entry from a translator property list by name of PROP
 314 */
 315 void
 316 Translator_group::execute_single_pushpop_property (SCM prop, SCM eltprop, SCM val)
 317 {
 318   if (gh_symbol_p(prop))
 319     {
 320       if (val != SCM_UNDEFINED)
 321         {
 322           SCM prev = get_property (prop);
 323
 324           if (gh_pair_p (prev) || prev == SCM_EOL)
 325             {
 326               bool ok = type_check_assignment (val, eltprop, ly_symbol2scm ("backend-type?"));
 327
 328
 329
 330               if (ok)
 331                 {
 332                   prev = gh_cons (gh_cons (eltprop, val), prev);
 333                   set_property (prop, prev);
 334                 }
 335             }
 336           else
 337             {
 338               // warning here.
 339             }
 340
 341         }
 342       else
 343         {
 344           SCM prev = get_property (prop);
 345
 346           SCM newprops= SCM_EOL ;
 347           while (gh_pair_p (prev) && gh_caar (prev) != eltprop)
 348             {
 349               newprops = gh_cons (gh_car (prev), newprops);
 350               prev = gh_cdr (prev);
 351             }
 352
 353           if (gh_pair_p (prev))
 354             {
 355               newprops = scm_reverse_x (newprops, gh_cdr (prev));
 356               set_property (prop, newprops);
 357             }
 358         }
 359     }
 360 }
 361
 362
 363
 364
 365
 366 /*
 367   STUBS
 368 */
 369 void
 370 Translator_group::stop_translation_timestep ()
 371 {
 372   each (&Translator::pre_move_processing);
 373 }
 374
 375 void
 376 Translator_group::start_translation_timestep ()
 377 {
 378   each (&Translator::post_move_processing);
 379 }
 380
 381 void
 382 Translator_group::do_announces ()
 383 {
 384   each (&Translator::announces);
 385 }
 386
 387 void
 388 Translator_group::do_creation_processing ()
 389 {
 390   each (&Translator::do_creation_processing);
 391 }
 392
 393 void
 394 Translator_group::do_removal_processing ()
 395 {
 396   each (&Translator::removal_processing);
 397 }
 398
 399
 400 bool
 401 type_check_assignment (SCM val, SCM sym,  SCM type_symbol)
 402 {
 403   bool ok = true;
 404   SCM type_p = SCM_EOL;
 405   SCM errport = scm_current_error_port ();
 406
 407   if (SCM_IMP(sym))
 408     type_p = scm_object_property (sym, type_symbol);
 409
 410   if (type_p != SCM_EOL && !gh_procedure_p (type_p))
 411       {
 412         scm_puts (_("Couldn't find property type-check for `").ch_C(),errport);
 413         scm_puts (String ("'").ch_C(), errport);
 414         scm_display (sym, errport);
 415
 416         scm_puts (_(". Perhaps you made a typing error?\n").ch_C(),errport);
 417       }
 418   else
 419     {
 420       if (val != SCM_EOL
 421           && gh_procedure_p (type_p)
 422           && gh_call1 (type_p, val) == SCM_BOOL_F)
 423         {
 424           ok = false;
 425           scm_puts (_("Failed typecheck for `").ch_C (),errport);
 426           scm_display (sym,errport);
 427           scm_puts ( _("', value `").ch_C (), errport);
 428           scm_write (val, errport);
 429           scm_puts (_("' must be of type ").ch_C (), errport);
 430           SCM typefunc = scm_eval2 (ly_symbol2scm ("type-name"), SCM_EOL);
 431           scm_display (gh_call1 (typefunc, type_p), errport);
 432           scm_puts ("\n", errport);
 433         }
 434     }
 435   return ok;
 436 }