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