2 context.cc -- implement Context
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "program-option.hh"
12 #include "context-def.hh"
13 #include "ly-smobs.icc"
15 #include "output-def.hh"
16 #include "scm-hash.hh"
17 #include "score-context.hh"
18 #include "translator-group.hh"
20 #include "lilypond-key.hh"
23 Context::is_removable () const
25 return context_list_ == SCM_EOL && ! iterator_count_
26 && !dynamic_cast<Score_context const *> (this);
30 Context::check_removal ()
32 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
34 Context *trg = unsmob_context (scm_car (p));
36 trg->check_removal ();
37 if (trg->is_removable ())
39 recurse_over_translators (trg, &Translator::finalize, UP);
45 Context::Context (Context const &)
51 Context::properties_dict () const
53 return Scheme_hash_table::unsmob (properties_scm_);
57 Context::add_context (Context *t)
59 SCM ts = t->self_scm ();
60 context_list_ = ly_append2 (context_list_,
61 scm_cons (ts, SCM_EOL));
63 t->daddy_context_ = this;
68 scm_gc_unprotect_object (ts);
69 Context_def *td = unsmob_context_def (t->definition_);
71 /* This cannot move before add_context (), because \override
72 operations require that we are in the hierarchy. */
73 td->apply_default_property_operations (t);
75 recurse_over_translators (t, &Translator::initialize, DOWN);
80 Context::get_key () const
85 Context::Context (Object_key const *key)
92 implementation_ = SCM_EOL;
93 properties_scm_ = SCM_EOL;
94 accepts_list_ = SCM_EOL;
95 context_list_ = SCM_EOL;
96 definition_ = SCM_EOL;
99 properties_scm_ = (new Scheme_hash_table)->self_scm ();
100 scm_gc_unprotect_object (properties_scm_);
103 scm_gc_unprotect_object (key_->self_scm ());
106 /* TODO: this shares code with find_create_context (). */
108 Context::create_unique_context (SCM n, SCM operations)
111 Don't create multiple score contexts.
113 if (dynamic_cast<Global_context *> (this)
114 && dynamic_cast<Global_context *> (this)->get_score_context ())
115 return get_score_context ()->create_unique_context (n, operations);
118 TODO: use accepts_list_.
120 Link_array<Context_def> path
121 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
125 Context *current = this;
127 // start at 1. The first one (index 0) will be us.
128 for (int i = 0; i < path.size (); i++)
130 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
132 current = current->create_context (path[i],
141 Don't go up to Global_context, because global goes down to
145 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
146 ret = daddy_context_->create_unique_context (n, operations);
149 warning (_f ("can't find or create new `%s'",
150 ly_symbol2string (n).to_str0 ()));
157 Context::find_create_context (SCM n, String id, SCM operations)
160 Don't create multiple score contexts.
162 if (dynamic_cast<Global_context *> (this)
163 && dynamic_cast<Global_context *> (this)->get_score_context ())
164 return get_score_context ()->find_create_context (n, id, operations);
166 if (Context *existing = find_context_below (this, n, id))
169 if (n == ly_symbol2scm ("Bottom"))
171 Context *tg = get_default_interpreter ();
176 TODO: use accepts_list_.
178 Link_array<Context_def> path
179 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
183 Context *current = this;
185 // start at 1. The first one (index 0) will be us.
186 for (int i = 0; i < path.size (); i++)
188 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
191 if (i == path.size () -1)
196 current = current->create_context (path[i],
205 Don't go up to Global_context, because global goes down to
209 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
210 ret = daddy_context_->find_create_context (n, id, operations);
213 warning (_f ("can't find or create `%s' called `%s'",
214 ly_symbol2string (n).to_str0 (), id));
221 Context::create_context (Context_def *cdef,
225 String type = ly_symbol2string (cdef->get_context_name ());
226 Object_key const *key = get_context_key (type, id);
228 = cdef->instantiate (ops, key);
230 new_context->id_string_ = id;
231 add_context (new_context);
232 apply_property_operations (new_context, ops);
238 Context::get_context_key (String type, String id)
240 if (!use_object_keys)
243 String now_key = type + "@" + id;
245 int disambiguation_count = 0;
246 if (context_counts_.find (now_key) != context_counts_.end ())
248 disambiguation_count = context_counts_[now_key];
251 context_counts_[now_key] = disambiguation_count + 1;
253 return new Lilypond_context_key (get_key (),
256 disambiguation_count);
260 Context::get_grob_key (String name)
262 if (!use_object_keys)
265 int disambiguation_count = 0;
266 if (grob_counts_.find (name) != grob_counts_.end ())
268 disambiguation_count = grob_counts_[name];
270 grob_counts_[name] = disambiguation_count + 1;
272 Object_key *k = new Lilypond_grob_key (get_key (),
275 disambiguation_count);
281 Default child context as a SCM string, or something else if there is
285 Context::default_child_context_name () const
287 return scm_is_pair (accepts_list_)
288 ? scm_car (accepts_list_)
293 Context::is_bottom_context () const
295 return !scm_is_symbol (default_child_context_name ());
299 Context::get_default_interpreter ()
301 if (!is_bottom_context ())
303 SCM nm = default_child_context_name ();
304 SCM st = find_context_def (get_output_def (), nm);
306 String name = ly_symbol2string (nm);
307 Context_def *t = unsmob_context_def (st);
310 warning (_f ("can't find or create: `%s'", name.to_str0 ()));
311 t = unsmob_context_def (this->definition_);
314 Context *tg = create_context (t, "", SCM_EOL);
315 if (!tg->is_bottom_context ())
316 return tg->get_default_interpreter ();
327 Context::where_defined (SCM sym) const
329 if (properties_dict ()->contains (sym))
331 return (Context *)this;
334 return (daddy_context_) ? daddy_context_->where_defined (sym) : 0;
338 return SCM_EOL when not found.
341 Context::internal_get_property (SCM sym) const
344 if (properties_dict ()->try_retrieve (sym, &val))
348 return daddy_context_->internal_get_property (sym);
354 Context::is_alias (SCM sym) const
356 if (sym == ly_symbol2scm ("Bottom")
357 && !scm_is_pair (accepts_list_))
359 if (sym == unsmob_context_def (definition_)->get_context_name ())
362 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
366 Context::add_alias (SCM sym)
368 aliases_ = scm_cons (sym, aliases_);
372 Context::internal_set_property (SCM sym, SCM val)
375 if (do_internal_type_checking_global)
376 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
379 properties_dict ()->set (sym, val);
383 TODO: look up to check whether we have inherited var?
386 Context::unset_property (SCM sym)
388 properties_dict ()->remove (sym);
392 Remove a context from the hierarchy.
395 Context::remove_context (Context *trans)
399 context_list_ = scm_delq_x (trans->self_scm (), context_list_);
400 trans->daddy_context_ = 0;
405 ID == "" means accept any ID.
408 find_context_below (Context *where,
411 if (where->is_alias (type))
413 if (id == "" || where->id_string () == id)
418 for (SCM s = where->children_contexts ();
419 !found && scm_is_pair (s); s = scm_cdr (s))
421 Context *tr = unsmob_context (scm_car (s));
423 found = find_context_below (tr, type, id);
430 Context::properties_as_alist () const
432 return properties_dict ()->to_alist ();
436 Context::context_name_symbol () const
438 Context_def *td = unsmob_context_def (definition_);
439 return td->get_context_name ();
443 Context::context_name () const
445 return ly_symbol2string (context_name_symbol ());
449 Context::get_score_context () const
451 if (Score_context *sc = dynamic_cast<Score_context *> ((Context *) this))
453 else if (daddy_context_)
454 return daddy_context_->get_score_context ();
460 Context::get_output_def () const
462 return daddy_context_ ? daddy_context_->get_output_def () : 0;
470 Context::now_mom () const
472 return daddy_context_->now_mom ();
476 Context::print_smob (SCM s, SCM port, scm_print_state *)
478 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
480 scm_puts ("#<", port);
481 scm_puts (classname (sc), port);
482 if (Context_def *d = unsmob_context_def (sc->definition_))
484 scm_puts (" ", port);
485 scm_display (d->get_context_name (), port);
488 if (Context *td = dynamic_cast<Context *> (sc))
490 scm_puts ("=", port);
491 scm_puts (td->id_string_.to_str0 (), port);
494 scm_puts (" ", port);
496 scm_display (sc->context_list_, port);
497 scm_puts (" >", port);
503 Context::mark_smob (SCM sm)
505 Context *me = (Context *) SCM_CELL_WORD_1 (sm);
507 scm_gc_mark (me->key_->self_scm ());
509 scm_gc_mark (me->context_list_);
510 scm_gc_mark (me->aliases_);
511 scm_gc_mark (me->definition_);
512 scm_gc_mark (me->properties_scm_);
513 scm_gc_mark (me->accepts_list_);
514 scm_gc_mark (me->implementation_);
516 return me->properties_scm_;
519 IMPLEMENT_SMOBS (Context);
520 IMPLEMENT_DEFAULT_EQUAL_P (Context);
521 IMPLEMENT_TYPE_P (Context, "ly:context?");
524 Context::try_music (Music *m)
526 Translator *t = implementation ();
530 bool b = t->try_music (m);
531 if (!b && daddy_context_)
532 b = daddy_context_->try_music (m);
538 Context::get_global_context () const
540 if (dynamic_cast<Global_context *> ((Context *) this))
541 return dynamic_cast<Global_context *> ((Context *) this);
544 return daddy_context_->get_global_context ();
546 programming_error ("no Global context");
551 Context::get_parent_context () const
553 return daddy_context_;
557 Context::implementation () const
559 return dynamic_cast<Translator_group *> (unsmob_translator (implementation_));
563 Context::clear_key_disambiguations ()
565 if (!use_object_keys)
568 grob_counts_.clear ();
569 context_counts_.clear ();
570 for (SCM s = context_list_; scm_is_pair (s); s = scm_cdr (s))
572 unsmob_context (scm_car (s))->clear_key_disambiguations ();