2 context.cc -- implement Context
4 source file of the GNU LilyPond music typesetter
6 (c) 2004 Han-Wen Nienhuys <hanwen@xs4all.nl>
10 #include "object-key.hh"
11 #include "context-def.hh"
12 #include "context-selector.hh"
14 #include "ly-smobs.icc"
16 #include "output-def.hh"
17 #include "scm-hash.hh"
18 #include "score-context.hh"
19 #include "translator-group.hh"
21 #include "lilypond-key.hh"
24 Context::is_removable () const
26 return context_list_ == SCM_EOL && ! iterator_count_ &&
27 !dynamic_cast<Score_context const*> (this);
31 Context::check_removal ()
33 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
35 Context *trg = unsmob_context (scm_car (p));
37 trg->check_removal ();
38 if (trg->is_removable ())
40 recurse_over_translators (trg, &Translator::finalize, UP);
46 Context::Context (Context const&)
52 Context::properties_dict () const
54 return Scheme_hash_table::unsmob (properties_scm_);
58 Context::add_context (Context *t)
60 SCM ts = t->self_scm ();
61 context_list_ = ly_append2 (context_list_,
62 scm_cons (ts, SCM_EOL));
64 t->daddy_context_ = this;
69 Context_selector::register_context (t);
71 scm_gc_unprotect_object (ts);
72 Context_def *td = unsmob_context_def (t->definition_);
75 this can not move before add_context (), because \override
76 operations require that we are in the hierarchy.
78 td->apply_default_property_operations (t);
80 recurse_over_translators (t, &Translator::initialize, DOWN);
85 Context::get_key () const
90 Context::Context (Object_key const* key)
97 implementation_ = SCM_EOL;
98 properties_scm_ = SCM_EOL;
99 accepts_list_ = SCM_EOL;
100 context_list_ = SCM_EOL;
101 definition_ = SCM_EOL;
105 properties_scm_ = (new Scheme_hash_table)->self_scm ();
106 scm_gc_unprotect_object (properties_scm_);
112 Context::find_create_context (SCM n, String id, SCM operations)
115 Don't create multiple score contexts.
117 if (dynamic_cast<Global_context*> (this)
118 && dynamic_cast<Global_context*> (this)->get_score_context ())
119 return get_score_context ()->find_create_context (n, id, operations);
121 if (Context *existing = find_context_below (this, n, id))
124 if (n == ly_symbol2scm ("Bottom"))
126 Context* tg = get_default_interpreter ();
132 TODO: use accepts_list_.
134 Link_array<Context_def> path
135 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
139 Context * current = this;
141 // start at 1. The first one (index 0) will be us.
142 for (int i=0; i < path.size (); i++)
144 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
147 if (i == path.size () -1)
153 current = create_context (path[i],
162 Don't go up to Global_context, because global goes down to
166 if (daddy_context_ && !dynamic_cast<Global_context*> (daddy_context_))
167 ret = daddy_context_->find_create_context (n, id, operations);
170 warning (_f ("Cannot find or create `%s' called `%s'",
171 ly_symbol2string (n).to_str0 (), id));
179 Context::create_context (Context_def * cdef,
183 String type = ly_symbol2string (cdef->get_context_name());
184 Object_key const *key = get_context_key (type, id);
186 = cdef->instantiate (ops, key);
187 scm_gc_unprotect_object (key->self_scm ());
189 new_group->id_string_ = id;
190 add_context (new_group);
191 apply_property_operations (new_group, ops);
197 Context::get_context_key (String type, String id)
199 String now_key = type + "@" + id;
201 int disambiguation_count = 0;
202 if (context_counts_.find (now_key) != context_counts_.end ())
204 disambiguation_count = context_counts_[now_key];
207 context_counts_[now_key] = disambiguation_count + 1;
210 return new Lilypond_context_key (get_key (),
213 disambiguation_count);
217 Context::get_grob_key (String name)
219 int disambiguation_count = 0;
220 if (grob_counts_.find (name) != grob_counts_.end ())
222 disambiguation_count = grob_counts_[name];
224 grob_counts_[name] = disambiguation_count + 1;
226 Object_key * k = new Lilypond_grob_key (get_key(),
229 disambiguation_count);
237 Default child context as a SCM string, or something else if there is
241 Context::default_child_context_name () const
243 return scm_is_pair (accepts_list_)
244 ? scm_car (scm_last_pair (accepts_list_))
250 Context::is_bottom_context () const
252 return !scm_is_symbol (default_child_context_name ());
256 Context::get_default_interpreter ()
258 if (!is_bottom_context ())
260 SCM nm = default_child_context_name ();
261 SCM st = find_context_def (get_output_def (), nm);
263 String name = ly_symbol2string (nm);
264 Context_def *t = unsmob_context_def (st);
267 warning (_f ("can't find or create: `%s'", name.to_str0 ()));
268 t = unsmob_context_def (this->definition_);
271 Context *tg = create_context (t, "", SCM_EOL);
272 if (!tg->is_bottom_context ())
273 return tg->get_default_interpreter ();
284 Context::where_defined (SCM sym) const
286 if (properties_dict ()->contains (sym))
288 return (Context*)this;
291 return (daddy_context_) ? daddy_context_->where_defined (sym) : 0;
295 return SCM_EOL when not found.
298 Context::internal_get_property (SCM sym) const
301 if (properties_dict ()->try_retrieve (sym, &val))
305 return daddy_context_->internal_get_property (sym);
311 Context::is_alias (SCM sym) const
313 if (sym == ly_symbol2scm ("Bottom")
314 && !scm_is_pair (accepts_list_))
316 if (sym == unsmob_context_def (definition_)->get_context_name ())
319 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
323 Context::add_alias (SCM sym)
325 aliases_ = scm_cons (sym, aliases_);
331 Context::internal_set_property (SCM sym, SCM val)
334 if (internal_type_checking_global_b)
335 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
338 properties_dict ()->set (sym, val);
342 TODO: look up to check whether we have inherited var?
345 Context::unset_property (SCM sym)
347 properties_dict ()->remove (sym);
351 Remove a context from the hierarchy.
354 Context::remove_context (Context*trans)
358 context_list_ = scm_delq_x (trans->self_scm (), context_list_);
359 trans->daddy_context_ = 0;
364 ID == "" means accept any ID.
367 find_context_below (Context * where,
370 if (where->is_alias (type))
372 if (id == "" || where->id_string () == id)
377 for (SCM s = where->children_contexts ();
378 !found && scm_is_pair (s); s = scm_cdr (s))
380 Context *tr = unsmob_context (scm_car (s));
382 found = find_context_below (tr, type, id);
389 Context::properties_as_alist () const
391 return properties_dict ()->to_alist ();
395 Context::context_name_symbol () const
397 Context_def *td = unsmob_context_def (definition_);
398 return td->get_context_name ();
402 Context::context_name () const
404 return ly_symbol2string (context_name_symbol ());
408 Context::get_score_context () const
410 if (Score_context *sc = dynamic_cast<Score_context*> ((Context*) this))
412 else if (daddy_context_)
413 return daddy_context_->get_score_context ();
419 Context::get_output_def () const
421 return daddy_context_ ? daddy_context_->get_output_def () : 0;
430 Context::now_mom () const
432 return daddy_context_->now_mom ();
436 Context::print_smob (SCM s, SCM port, scm_print_state *)
438 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
440 scm_puts ("#<", port);
441 scm_puts (classname (sc), port);
442 if (Context_def *d = unsmob_context_def (sc->definition_))
444 scm_puts (" ", port);
445 scm_display (d->get_context_name (), port);
448 if (Context *td=dynamic_cast<Context *> (sc))
450 scm_puts ("=", port);
451 scm_puts (td->id_string_.to_str0 (), port);
455 scm_puts (" ", port);
457 scm_display (sc->context_list_, port);
458 scm_puts (" >", port);
464 Context::mark_smob (SCM sm)
466 Context *me = (Context*) SCM_CELL_WORD_1 (sm);
467 scm_gc_mark (me->key_->self_scm ());
468 scm_gc_mark (me->context_list_);
469 scm_gc_mark (me->aliases_);
470 scm_gc_mark (me->definition_);
471 scm_gc_mark (me->properties_scm_);
472 scm_gc_mark (me->accepts_list_);
473 scm_gc_mark (me->implementation_);
475 return me->properties_scm_;
478 IMPLEMENT_SMOBS (Context);
479 IMPLEMENT_DEFAULT_EQUAL_P (Context);
480 IMPLEMENT_TYPE_P (Context,"ly:context?");
483 Context::try_music (Music* m)
485 Translator* t = implementation ();
489 bool b = t->try_music (m);
490 if (!b && daddy_context_)
491 b = daddy_context_->try_music (m);
498 Context::get_global_context () const
500 if (dynamic_cast<Global_context *>((Context*) this))
501 return dynamic_cast<Global_context *> ((Context*) this);
504 return daddy_context_->get_global_context ();
506 programming_error ("No Global context!");
511 Context::get_parent_context () const
513 return daddy_context_;
517 Context::implementation () const
519 return dynamic_cast<Translator_group*> (unsmob_translator (implementation_));
523 Context::clear_key_disambiguations ()
525 grob_counts_.clear();
526 context_counts_.clear();
527 for (SCM s = context_list_; scm_is_pair (s); s = scm_cdr (s))
529 unsmob_context (scm_car (s))->clear_key_disambiguations();