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
  17 Translator_group::Translator_group (Translator_group const&s)
  18   : Translator(s)
  19 {
  20   consists_str_arr_ = s.consists_str_arr_;
  21   consists_end_str_arr_ = s.consists_end_str_arr_;
  22   accepts_str_arr_ = s.accepts_str_arr_;
  23   iterator_count_ =0;
  24   properties_dict_ = new Scheme_hash_table (*s.properties_dict_);
  25 }
  26
  27 Translator_group::~Translator_group ()
  28 {
  29   assert (removable_b());
  30   trans_p_list_.junk ();
  31   delete properties_dict_;
  32 }
  33
  34
  35 Translator_group::Translator_group()
  36 {
  37   iterator_count_  = 0;
  38   properties_dict_ = new Scheme_hash_table ;
  39 }
  40
  41 void
  42 Translator_group::check_removal()
  43 {
  44   Cons<Translator> *next =0;
  45   for (Cons<Translator> *p = trans_p_list_.head_; p; p = next)
  46     {
  47       next = p->next_;
  48       if (Translator_group *trg =  dynamic_cast <Translator_group *> (p->car_))
  49         {
  50           trg->check_removal ();
  51           if (trg->removable_b())
  52             terminate_translator (trg);
  53         }
  54     }
  55 }
  56
  57 void
  58 Translator_group::add_translator (Translator *trans_p)
  59 {
  60   trans_p_list_.append (new Killing_cons<Translator> (trans_p,0));
  61
  62   trans_p->daddy_trans_l_ = this;
  63   trans_p->output_def_l_ = output_def_l_;
  64   trans_p->add_processing ();
  65 }
  66
  67 void
  68 Translator_group::set_acceptor (String accepts, bool add)
  69 {
  70   if (add)
  71     accepts_str_arr_.push (accepts);
  72   else
  73     for (int i=accepts_str_arr_.size (); i--; )
  74       if (accepts_str_arr_[i] == accepts)
  75         accepts_str_arr_.del (i);
  76 }
  77
  78 void
  79 Translator_group::add_last_element (String s)
  80 {
  81   if (!get_translator_l (s))
  82     error (_ ("Program has no such type"));
  83
  84   for (int i=consists_end_str_arr_.size (); i--; )
  85     if (consists_end_str_arr_[i] == s)
  86       warning (_f ("Already contains: `%s'", s));
  87
  88   consists_end_str_arr_.push (s);
  89 }
  90
  91 void
  92 Translator_group::set_element (String s, bool add)
  93 {
  94   if (!get_translator_l (s))
  95     error (_ ("Program has no such type"));
  96
  97   if (add)
  98     {
  99       for (int i=consists_str_arr_.size (); i--; )
 100         if (consists_str_arr_[i] == s)
 101           warning (_f("Already contains: `%s'", s));
 102
 103       consists_str_arr_.push (s);
 104     }
 105   else
 106     {
 107       for (int i=consists_str_arr_.size (); i--; )
 108         if (consists_str_arr_[i] == s)
 109           consists_str_arr_.del (i);
 110       for (int i=consists_end_str_arr_.size (); i--; )
 111         if (consists_end_str_arr_[i] == s)
 112           consists_end_str_arr_.del (i);
 113     }
 114 }
 115 bool
 116 Translator_group::removable_b() const
 117 {
 118   for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
 119     {
 120       if (dynamic_cast <Translator_group *> (p->car_))
 121         return false;
 122     }
 123
 124   return !iterator_count_;
 125 }
 126
 127 Translator_group *
 128 Translator_group::find_existing_translator_l (String n, String id)
 129 {
 130   if (is_alias_b (n) && (id_str_ == id || id.empty_b ()))
 131     return this;
 132
 133   Translator_group* r = 0;
 134   for (Cons<Translator> *p = trans_p_list_.head_; !r && p; p = p->next_)
 135     {
 136       if (Translator_group *trg =  dynamic_cast <Translator_group *> (p->car_))
 137         r = trg->find_existing_translator_l (n, id);
 138     }
 139
 140   return r;
 141 }
 142
 143 Link_array<Translator_group>
 144 Translator_group::path_to_acceptable_translator (String type, Music_output_def* odef) const
 145 {
 146  Link_array<Translator_group> accepted_arr;
 147   for (int i=0; i < accepts_str_arr_.size (); i++)
 148     {
 149       Translator *t = odef->find_translator_l (accepts_str_arr_[i]);
 150       if (!t || !dynamic_cast <Translator_group *> (t))
 151         continue;
 152       accepted_arr.push (dynamic_cast <Translator_group *> (t));
 153     }
 154
 155
 156  for (int i=0; i < accepted_arr.size (); i++)
 157     if (accepted_arr[i]->type_str_ == type)
 158       {
 159         Link_array<Translator_group> retval;
 160         retval.push (accepted_arr[i]);
 161         return retval;
 162       }
 163
 164   Link_array<Translator_group> best_result;
 165   int best_depth= INT_MAX;
 166   for (int i=0; i < accepted_arr.size (); i++)
 167     {
 168       Translator_group * g = accepted_arr[i];
 169
 170       Link_array<Translator_group> result
 171         = g->path_to_acceptable_translator (type, odef);
 172       if (result.size () && result.size () < best_depth)
 173         {
 174           result.insert (g,0);
 175           best_result = result;
 176         }
 177     }
 178
 179   return best_result;
 180 }
 181
 182 Translator_group*
 183 Translator_group::find_create_translator_l (String n, String id)
 184 {
 185   Translator_group * existing = find_existing_translator_l (n,id);
 186   if (existing)
 187     return existing;
 188
 189   Link_array<Translator_group> path
 190     = path_to_acceptable_translator (n, output_def_l ());
 191
 192   if (path.size ())
 193     {
 194       Translator_group * current = this;
 195
 196       // start at 1.  The first one (index 0) will be us.
 197       for (int i=0; i < path.size (); i++)
 198         {
 199           Translator_group * new_group = dynamic_cast<Translator_group*>(path[i]->clone ());
 200
 201           current->add_translator (new_group);
 202           current = new_group;
 203         }
 204       current->id_str_ = id;
 205       return current;
 206     }
 207
 208   Translator_group *ret = 0;
 209   if (daddy_trans_l_)
 210     ret = daddy_trans_l_->find_create_translator_l (n,id);
 211   else
 212     {
 213       warning (_f ("can't find or create `%s' called `%s'", n, id));
 214       ret =0;
 215     }
 216   return ret;
 217 }
 218
 219 bool
 220 Translator_group::try_music_on_nongroup_children (Music *m)
 221 {
 222   bool hebbes_b =false;
 223
 224   for (Cons<Translator> *p = trans_p_list_.head_; !hebbes_b && p; p = p->next_)
 225     {
 226       if (!dynamic_cast <Translator_group *> (p->car_))
 227         {
 228           hebbes_b = p->car_->try_music (m);
 229         }
 230     }
 231   return hebbes_b;
 232 }
 233
 234 bool
 235 Translator_group::do_try_music (Music* m)
 236 {
 237   bool hebbes_b = try_music_on_nongroup_children (m);
 238
 239   if (!hebbes_b && daddy_trans_l_)
 240     hebbes_b = daddy_trans_l_->try_music (m);
 241   return hebbes_b ;
 242 }
 243
 244 int
 245 Translator_group::depth_i() const
 246 {
 247   return (daddy_trans_l_) ? daddy_trans_l_->depth_i()  + 1 : 0;
 248 }
 249
 250 Translator_group*
 251 Translator_group::ancestor_l (int level)
 252 {
 253   if (!level || !daddy_trans_l_)
 254     return this;
 255
 256   return daddy_trans_l_->ancestor_l (level-1);
 257 }
 258
 259
 260
 261
 262
 263 void
 264 Translator_group::terminate_translator (Translator*r_l)
 265 {
 266   r_l->removal_processing();
 267   Translator * trans_p =remove_translator_p (r_l);
 268
 269   delete trans_p;
 270 }
 271
 272
 273 /**
 274    Remove a translator from the hierarchy.
 275  */
 276 Translator *
 277 Translator_group::remove_translator_p (Translator*trans_l)
 278 {
 279   assert (trans_l);
 280
 281   for (Cons<Translator> **pp = &trans_p_list_.head_; *pp; pp = &(*pp)->next_)
 282     if ((*pp)->car_ == trans_l)
 283       {
 284         Cons<Translator> *r = trans_p_list_.remove_cons (pp);
 285         r->car_ =0;
 286         trans_l->daddy_trans_l_ =0;
 287         delete r;
 288         return trans_l;
 289       }
 290
 291   return 0;
 292 }
 293
 294
 295 Translator*
 296 Translator_group::get_simple_translator (String type) const
 297 {
 298   for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
 299     {
 300       if (classname (p->car_) == type)
 301         return p->car_;
 302     }
 303   if (daddy_trans_l_)
 304     return daddy_trans_l_->get_simple_translator (type);
 305   return 0;
 306 }
 307
 308
 309 bool
 310 Translator_group::is_bottom_translator_b () const
 311 {
 312   return !accepts_str_arr_.size ();
 313 }
 314
 315
 316
 317 Translator_group*
 318 Translator_group::get_default_interpreter()
 319 {
 320   if (accepts_str_arr_.size())
 321     {
 322       Translator*t = output_def_l ()->find_translator_l (accepts_str_arr_[0]);
 323       if (!t)
 324         {
 325           warning (_f ("can't find or create: `%s'", accepts_str_arr_[0]));
 326           t = this;
 327         }
 328       Translator_group * g= dynamic_cast <Translator_group*>(t->clone ());
 329       add_translator (g);
 330
 331       if (!g->is_bottom_translator_b ())
 332         return g->get_default_interpreter ();
 333       else
 334         return g;
 335     }
 336   return this;
 337 }
 338
 339 void
 340 Translator_group::each (Method_pointer method)
 341 {
 342   for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
 343     (p->car_->*method) ();
 344 }
 345
 346
 347 void
 348 Translator_group::each (Const_method_pointer method) const
 349 {
 350   for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
 351     (p->car_->*method) ();
 352 }
 353
 354 void
 355 Translator_group::do_print() const
 356 {
 357 #ifndef NPRINT
 358   if (!flower_dstream)
 359     return ;
 360
 361   gh_display (properties_dict_->self_scm_);
 362   if (status == ORPHAN)
 363     {
 364       DEBUG_OUT << "consists of: ";
 365       for (int i=0; i < consists_str_arr_.size (); i++)
 366         DEBUG_OUT << consists_str_arr_[i] << ", ";
 367       DEBUG_OUT << "\naccepts: ";
 368       for (int i=0; i < accepts_str_arr_.size (); i++)
 369         DEBUG_OUT << accepts_str_arr_[i] << ", ";
 370     }
 371   else
 372     {
 373       if (id_str_.length_i ())
 374         DEBUG_OUT << "ID: " << id_str_ ;
 375       DEBUG_OUT << " iterators: " << iterator_count_<< '\n';
 376     }
 377   each (&Translator::print);
 378 #endif
 379 }
 380
 381 void
 382 Translator_group::do_pre_move_processing ()
 383 {
 384   each (&Translator::pre_move_processing);
 385 }
 386
 387 void
 388 Translator_group::do_post_move_processing ()
 389 {
 390   each (&Translator::post_move_processing);
 391 }
 392
 393 void
 394 Translator_group::do_process_music ()
 395 {
 396   each (&Translator::process_music);
 397 }
 398
 399 void
 400 Translator_group::do_creation_processing ()
 401 {
 402   each (&Translator::creation_processing);
 403 }
 404
 405 void
 406 Translator_group::do_removal_processing ()
 407 {
 408   each (&Translator::removal_processing);
 409 }
 410
 411 void
 412 Translator_group::do_add_processing ()
 413 {
 414    for (int i=0; i < consists_str_arr_.size(); i++)
 415     {
 416       String s = consists_str_arr_[i];
 417       Translator * t = output_def_l ()->find_translator_l (s);
 418       if (!t)
 419         warning (_f ("can't find: `%s'", s));
 420       else
 421         add_translator (t->clone ());
 422     }
 423    for (int i=0; i-- < consists_end_str_arr_.size (); i++)
 424      {
 425        String s = consists_end_str_arr_[i];
 426        Translator * t = output_def_l ()->find_translator_l (s);
 427        if (!t)
 428          warning (_f ("can't find: `%s'", s));
 429        else
 430          add_translator (t->clone ());
 431     }
 432 }
 433
 434 Translator_group*
 435 Translator_group::where_defined (SCM sym) const
 436 {
 437   if (properties_dict_->elem_b (sym))
 438     {
 439       return (Translator_group*)this;
 440     }
 441
 442   return (daddy_trans_l_) ? daddy_trans_l_->where_defined (sym) : 0;
 443 }
 444
 445 SCM
 446 Translator_group::get_property (SCM sym) const
 447 {
 448   if (properties_dict_->elem_b (sym))
 449     {
 450       return properties_dict_->get (sym);
 451     }
 452
 453   if (daddy_trans_l_)
 454     return daddy_trans_l_->get_property (sym);
 455
 456   return SCM_UNDEFINED;
 457 }
 458
 459 void
 460 Translator_group::set_property (String id, SCM val)
 461 {
 462   properties_dict_->set (ly_symbol2scm (id.ch_C()), val);
 463 }
 464