lily/context.cc

   1 /*
   2   context.cc --  implement Context
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #include "translator-group.hh"
  11 #include "context-def.hh"
  12 #include "context.hh"
  13 #include "warn.hh"
  14 #include "output-def.hh"
  15 #include "scm-hash.hh"
  16 #include "main.hh"
  17 #include "ly-smobs.icc"
  18 #include "score-context.hh"
  19
  20 bool
  21 Context::is_removable () const
  22 {
  23   return context_list_ == SCM_EOL && ! iterator_count_ &&
  24           !dynamic_cast<Score_context const*> (this)
  25     ;
  26 }
  27
  28 void
  29 Context::check_removal ()
  30 {
  31   for (SCM p = context_list_; ly_c_pair_p (p); p = ly_cdr (p))
  32     {
  33       Context *trg =  unsmob_context (ly_car (p));
  34
  35       trg->check_removal ();
  36       if (trg->is_removable ())
  37         {
  38           recurse_over_translators (trg, &Translator::finalize, UP);
  39           remove_context (trg);
  40         }
  41     }
  42 }
  43
  44 Context::Context (Context const&)
  45 {
  46   assert (false);
  47 }
  48
  49 Scheme_hash_table*
  50 Context::properties_dict () const
  51 {
  52   return Scheme_hash_table::unsmob (properties_scm_);
  53 }
  54
  55 void
  56 Context::add_context (Context*t)
  57 {
  58   SCM ts = t->self_scm ();
  59   context_list_ = ly_append2 (context_list_,
  60                               scm_cons (ts, SCM_EOL));
  61
  62   t->daddy_context_ = this;
  63   if (!t->init_)
  64     {
  65       t->init_ = true;
  66
  67       scm_gc_unprotect_object (ts);
  68       Context_def * td = unsmob_context_def (t->definition_);
  69
  70       /*
  71         this can not move before add_context (), because \override
  72         operations require that we are in the hierarchy.
  73       */
  74       td->apply_default_property_operations (t);
  75
  76       recurse_over_translators (t, &Translator::initialize, DOWN);
  77     }
  78 }
  79
  80 Context::Context ()
  81 {
  82   daddy_context_ = 0;
  83   init_ = false;
  84   aliases_ = SCM_EOL;
  85   iterator_count_  = 0;
  86   implementation_ = SCM_EOL;
  87   properties_scm_ = SCM_EOL;
  88   accepts_list_ = SCM_EOL;
  89   context_list_ = SCM_EOL;
  90   definition_ = SCM_EOL;
  91
  92   smobify_self ();
  93
  94   properties_scm_ = (new Scheme_hash_table)->self_scm ();
  95   scm_gc_unprotect_object (properties_scm_);
  96 }
  97
  98
  99
 100 Context*
 101 Context::find_create_context (SCM n, String id,
 102                               SCM operations)
 103 {
 104   /*
 105     Don't create multiple score contexts.
 106    */
 107   if (dynamic_cast<Global_context*> (this)
 108       && dynamic_cast<Global_context*> (this)->get_score_context ())
 109     return get_score_context ()->find_create_context (n, id, operations);
 110
 111
 112   Context * existing = find_context_below (this, n,id);
 113   if (existing)
 114     return existing;
 115
 116   if (n == ly_symbol2scm ("Bottom"))
 117     {
 118       Context* tg = get_default_interpreter ();
 119       tg->id_string_ = id;
 120       return tg;
 121     }
 122
 123   /*
 124     TODO: use accepts_list_.
 125    */
 126   Link_array<Context_def> path
 127     = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
 128
 129   if (path.size ())
 130     {
 131       Context * current = this;
 132
 133       // start at 1.  The first one (index 0) will be us.
 134       for (int i=0; i < path.size (); i++)
 135         {
 136           SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
 137
 138           Context * new_group
 139             = path[i]->instantiate (ops);
 140
 141           if (i == path.size () -1)
 142             {
 143               new_group->id_string_ = id;
 144             }
 145
 146           current->add_context (new_group);
 147           apply_property_operations (new_group, ops);
 148
 149           current = new_group;
 150         }
 151
 152       return current;
 153     }
 154
 155   /*
 156     Don't go up to Global_context, because global goes down to
 157     Score_context
 158    */
 159   Context *ret = 0;
 160   if (daddy_context_ && !dynamic_cast<Global_context*> (daddy_context_))
 161     ret = daddy_context_->find_create_context (n, id, operations);
 162   else
 163     {
 164       warning (_f ("Cannot find or create `%s' called `%s'",
 165                    ly_symbol2string (n).to_str0 (), id));
 166       ret =0;
 167     }
 168   return ret;
 169 }
 170
 171 /*
 172   Default child context as a SCM string, or something else if there is
 173   none.
 174 */
 175 SCM
 176 Context::default_child_context_name () const
 177 {
 178   return ly_c_pair_p (accepts_list_)
 179     ? ly_car (scm_last_pair (accepts_list_))
 180     : SCM_EOL;
 181 }
 182
 183
 184 bool
 185 Context::is_bottom_context () const
 186 {
 187   return !ly_c_symbol_p (default_child_context_name ());
 188 }
 189
 190 Context*
 191 Context::get_default_interpreter ()
 192 {
 193   if (!is_bottom_context ())
 194     {
 195       SCM nm = default_child_context_name ();
 196       SCM st = find_context_def (get_output_def (), nm);
 197
 198       Context_def *t = unsmob_context_def (st);
 199       if (!t)
 200         {
 201           warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
 202           t = unsmob_context_def (this->definition_);
 203         }
 204       Context *tg = t->instantiate (SCM_EOL);
 205       add_context (tg);
 206       if (!tg->is_bottom_context ())
 207         return tg->get_default_interpreter ();
 208       else
 209         return tg;
 210     }
 211   return this;
 212 }
 213
 214 /*
 215   PROPERTIES
 216  */
 217 Context*
 218 Context::where_defined (SCM sym) const
 219 {
 220   if (properties_dict ()->contains (sym))
 221     {
 222       return (Context*)this;
 223     }
 224
 225   return (daddy_context_) ? daddy_context_->where_defined (sym) : 0;
 226 }
 227
 228 /*
 229   return SCM_EOL when not found.
 230 */
 231 SCM
 232 Context::internal_get_property (SCM sym) const
 233 {
 234   SCM val =SCM_EOL;
 235   if (properties_dict ()->try_retrieve (sym, &val))
 236     return val;
 237
 238   if (daddy_context_)
 239     return daddy_context_->internal_get_property (sym);
 240
 241   return val;
 242 }
 243
 244 bool
 245 Context::is_alias (SCM sym) const
 246 {
 247   if (sym == ly_symbol2scm ("Bottom")
 248       && !ly_c_pair_p (accepts_list_))
 249     return true;
 250   if (sym == unsmob_context_def (definition_)->get_context_name ())
 251     return true;
 252
 253   return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
 254 }
 255
 256 void
 257 Context::add_alias (SCM sym)
 258 {
 259   aliases_ = scm_cons (sym, aliases_);
 260 }
 261
 262
 263
 264 void
 265 Context::internal_set_property (SCM sym, SCM val)
 266 {
 267 #ifndef NDEBUG
 268   if (internal_type_checking_global_b)
 269     assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
 270 #endif
 271
 272   properties_dict ()->set (sym, val);
 273 }
 274
 275 /*
 276   TODO: look up to check whether we have inherited var?
 277  */
 278 void
 279 Context::unset_property (SCM sym)
 280 {
 281   properties_dict ()->remove (sym);
 282 }
 283
 284 /**
 285    Remove a context from the hierarchy.
 286  */
 287 Context *
 288 Context::remove_context (Context*trans)
 289 {
 290   assert (trans);
 291
 292   context_list_ = scm_delq_x (trans->self_scm (), context_list_);
 293   trans->daddy_context_ = 0;
 294   return trans;
 295 }
 296
 297 /*
 298   ID == "" means accept any ID.
 299  */
 300 Context *
 301 find_context_below (Context * where,
 302                     SCM type, String id)
 303 {
 304   if (where->is_alias (type))
 305     {
 306       if (id == "" || where->id_string () == id)
 307         return where;
 308     }
 309
 310   Context * found = 0;
 311   for (SCM s = where->children_contexts ();
 312        !found && ly_c_pair_p (s); s = ly_cdr (s))
 313     {
 314       Context * tr = unsmob_context (ly_car (s));
 315
 316       found = find_context_below (tr, type, id);
 317     }
 318
 319   return found;
 320 }
 321
 322 SCM
 323 Context::properties_as_alist () const
 324 {
 325   return properties_dict ()->to_alist ();
 326 }
 327
 328 String
 329 Context::context_name () const
 330 {
 331   Context_def * td = unsmob_context_def (definition_ );
 332   return ly_symbol2string (td->get_context_name ());
 333 }
 334
 335
 336 Score_context*
 337 Context::get_score_context () const
 338 {
 339   if (Score_context *sc =dynamic_cast<Score_context*> ((Context*)this))
 340     return sc;
 341   else if (daddy_context_)
 342     return daddy_context_->get_score_context ();
 343   else
 344     return 0;
 345 }
 346
 347 Output_def *
 348 Context::get_output_def () const
 349 {
 350   return  (daddy_context_)
 351     ? daddy_context_->get_output_def () : 0;
 352 }
 353
 354 Context::~Context ()
 355 {
 356
 357 }
 358
 359 Moment
 360 Context::now_mom () const
 361 {
 362   return daddy_context_->now_mom ();
 363 }
 364
 365 int
 366 Context::print_smob (SCM s, SCM port, scm_print_state *)
 367 {
 368   Context *sc = (Context *) ly_cdr (s);
 369
 370   scm_puts ("#<", port);
 371   scm_puts (classname (sc), port);
 372   if (Context_def *d=unsmob_context_def (sc->definition_))
 373     {
 374       scm_puts (" ", port);
 375       scm_display (d->get_context_name (), port);
 376     }
 377
 378   if (Context *td=dynamic_cast<Context *> (sc))
 379     {
 380       scm_puts ("=", port);
 381       scm_puts (td->id_string_.to_str0 (), port);
 382     }
 383
 384
 385   scm_puts (" ", port);
 386
 387   scm_display (sc->context_list_, port);
 388   scm_puts (" >", port);
 389
 390   return 1;
 391 }
 392
 393 SCM
 394 Context::mark_smob (SCM sm)
 395 {
 396   Context * me = (Context*) SCM_CELL_WORD_1 (sm);
 397
 398   scm_gc_mark (me->context_list_);
 399   scm_gc_mark (me->aliases_);
 400   scm_gc_mark (me->definition_);
 401   scm_gc_mark (me->properties_scm_);
 402   scm_gc_mark (me->accepts_list_);
 403   scm_gc_mark (me->implementation_);
 404
 405   return me->properties_scm_;
 406 }
 407
 408 IMPLEMENT_SMOBS (Context);
 409 IMPLEMENT_DEFAULT_EQUAL_P (Context);
 410 IMPLEMENT_TYPE_P (Context,"ly:context?");
 411
 412 bool
 413 Context::try_music (Music* m)
 414 {
 415   Translator*  t = implementation ();
 416   if (!t)
 417     return false;
 418
 419   bool b = t->try_music (m);
 420   if (!b && daddy_context_)
 421     b = daddy_context_->try_music (m);
 422
 423   return b;
 424 }
 425
 426
 427 Global_context*
 428 Context::get_global_context () const
 429 {
 430   if (dynamic_cast<Global_context *>((Context*) this))
 431     return dynamic_cast<Global_context *> ((Context*) this);
 432
 433   if (daddy_context_)
 434     return daddy_context_->get_global_context ();
 435
 436   programming_error ("No Global context!");
 437   return 0;
 438 }
 439
 440 Context*
 441 Context::get_parent_context () const
 442 {
 443   return daddy_context_;
 444 }
 445
 446 Translator_group*
 447 Context::implementation () const
 448 {
 449   return dynamic_cast<Translator_group*> (unsmob_translator (implementation_));
 450 }