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 "translator-group.hh"
11 #include "context-def.hh"
14 #include "music-output-def.hh"
15 #include "scm-hash.hh"
17 #include "ly-smobs.icc"
18 #include "score-context.hh"
21 Context::is_removable () const
23 return context_list_ == SCM_EOL && ! iterator_count_ &&
24 !dynamic_cast<Score_context const*> (this)
29 Context::check_removal ()
31 for (SCM p = context_list_; gh_pair_p (p); p = gh_cdr (p))
33 Context *trg = unsmob_context (ly_car (p));
35 trg->check_removal ();
36 if (trg->is_removable ())
38 recurse_down_translators (trg, &Translator::finalize, DOWN);
44 Context::Context (Context const&)
50 Context::properties_dict () const
52 return Scheme_hash_table::unsmob (properties_scm_);
56 Context::add_context (Context*t)
58 SCM ts = t->self_scm ();
59 context_list_ = gh_append2 (context_list_,
60 gh_cons (ts, SCM_EOL));
62 t->daddy_context_ = this;
67 scm_gc_unprotect_object (ts);
68 Context_def * td = unsmob_context_def (t->definition_);
71 this can not move before add_context(), because \override
72 operations require that we are in the hierarchy.
74 td->apply_default_property_operations (t);
76 recurse_down_translators (t, &Translator::initialize, DOWN);
85 implementation_ = SCM_EOL;
86 properties_scm_ = SCM_EOL;
87 accepts_list_ = SCM_EOL;
88 context_list_ = SCM_EOL;
89 definition_ = SCM_EOL;
93 properties_scm_ = (new Scheme_hash_table)->self_scm ();
94 scm_gc_unprotect_object (properties_scm_);
98 Context::find_existing_context (SCM n, String id)
100 if ((is_alias (n) && (id_string_ == id || id.is_empty ())))
104 for (SCM p = context_list_; !r && gh_pair_p (p); p = ly_cdr (p))
106 Context * t = unsmob_context (ly_car (p));
108 r = dynamic_cast<Context*> (t)->find_existing_context (n, id);
116 Context::find_create_context (SCM n, String id,
120 Don't create multiple score contexts.
122 if (dynamic_cast<Global_context*> (this)
123 && dynamic_cast<Global_context*> (this)->get_score_context ())
124 return get_score_context ()->find_create_context (n, id, operations);
127 Context * existing = find_existing_context (n,id);
131 if (n == ly_symbol2scm ("Bottom"))
133 Context* tg = get_default_interpreter ();
139 TODO: use accepts_list_.
141 Link_array<Context_def> path
142 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
146 Context * current = this;
148 // start at 1. The first one (index 0) will be us.
149 for (int i=0; i < path.size (); i++)
151 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
154 = path[i]->instantiate (ops);
156 if (i == path.size () -1)
158 new_group->id_string_ = id;
161 current->add_context (new_group);
162 apply_property_operations (new_group, ops);
171 Don't go up to Global_context, because global goes down to
175 if (daddy_context_ && !dynamic_cast<Global_context*> (daddy_context_))
176 ret = daddy_context_->find_create_context (n, id, operations);
179 warning (_f ("Cannot find or create `%s' called `%s'",
180 ly_symbol2string (n).to_str0 (), id));
187 Default child context as a SCM string, or something else if there is
191 default_child_context_name (Context const *tg)
193 return gh_pair_p (tg->accepts_list_)
194 ? ly_car (scm_last_pair (tg->accepts_list_))
200 Context::is_bottom_context () const
202 return !gh_symbol_p (default_child_context_name (this));
206 Context::get_default_interpreter ()
208 if (!is_bottom_context ())
210 SCM nm = default_child_context_name (this);
211 SCM st = get_output_def ()->find_context_def (nm);
213 Context_def *t = unsmob_context_def (st);
216 warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
217 t = unsmob_context_def (this->definition_);
219 Context *tg = t->instantiate (SCM_EOL);
221 if (!tg->is_bottom_context ())
222 return tg->get_default_interpreter ();
233 Context::where_defined (SCM sym) const
235 if (properties_dict ()->contains (sym))
237 return (Context*)this;
240 return (daddy_context_) ? daddy_context_->where_defined (sym) : 0;
244 return SCM_EOL when not found.
247 Context::internal_get_property (SCM sym) const
250 if (properties_dict ()->try_retrieve (sym, &val))
254 return daddy_context_->internal_get_property (sym);
260 Context::is_alias (SCM sym) const
262 if (sym == ly_symbol2scm ("Bottom")
263 && !gh_pair_p (accepts_list_))
265 return unsmob_context_def (definition_)->is_alias (sym);
269 Context::internal_set_property (SCM sym, SCM val)
272 if (internal_type_checking_global_b)
273 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
276 properties_dict ()->set (sym, val);
280 TODO: look up to check whether we have inherited var?
283 Context::unset_property (SCM sym)
285 properties_dict ()->remove (sym);
289 Remove a context from the hierarchy.
292 Context::remove_context (Context*trans)
296 context_list_ = scm_delq_x (trans->self_scm (), context_list_);
297 trans->daddy_context_ = 0;
302 ID == "" means accept any ID.
305 find_context_below (Context * where,
306 String type, String id)
308 if (where->is_alias (ly_symbol2scm (type.to_str0 ())))
310 if (id == "" || where->id_string_ == id)
315 for (SCM s = where->context_list_;
316 !found && gh_pair_p (s); s = gh_cdr (s))
318 Context * tr = unsmob_context (gh_car (s));
320 found = find_context_below (tr, type, id);
327 Context::properties_as_alist () const
329 return properties_dict()->to_alist();
333 Context::context_name () const
335 Context_def * td = unsmob_context_def (definition_ );
336 return ly_symbol2string (td->get_context_name ());
341 Context::get_score_context () const
343 if (Score_context *sc =dynamic_cast<Score_context*> ((Context*)this))
345 else if (daddy_context_)
346 return daddy_context_->get_score_context ();
352 Context::get_output_def () const
354 return (daddy_context_)
355 ? daddy_context_->get_output_def () : 0;
364 Context::now_mom () const
366 return daddy_context_->now_mom();
370 Context::print_smob (SCM s, SCM port, scm_print_state *)
372 Context *sc = (Context *) ly_cdr (s);
374 scm_puts ("#<", port);
375 scm_puts (classname (sc), port);
376 if (Context_def *d=unsmob_context_def (sc->definition_))
378 scm_puts (" ", port);
379 scm_display (d->get_context_name (), port);
382 if (Context *td=dynamic_cast<Context *> (sc))
384 scm_puts ("=", port);
385 scm_puts (td->id_string_.to_str0 (), port);
389 scm_puts (" ", port);
391 scm_display (sc->context_list_, port);
392 scm_puts (" >", port);
398 Context::mark_smob (SCM sm)
400 Context * me = (Context*) SCM_CELL_WORD_1 (sm);
402 scm_gc_mark (me->context_list_);
403 scm_gc_mark (me->definition_);
404 scm_gc_mark (me->properties_scm_);
405 scm_gc_mark (me->accepts_list_);
406 scm_gc_mark (me->implementation_);
408 return me->properties_scm_;
411 IMPLEMENT_SMOBS (Context);
412 IMPLEMENT_DEFAULT_EQUAL_P (Context);
413 IMPLEMENT_TYPE_P(Context,"ly:context?");
416 Context::try_music (Music* m)
418 Translator* t = unsmob_translator (implementation_);
422 bool b = t->try_music (m);
423 if (!b && daddy_context_)
424 b = daddy_context_->try_music (m);
431 Context::get_global_context () const
433 if (dynamic_cast<Global_context *>((Context*) this))
434 return dynamic_cast<Global_context *> ((Context*) this);
437 return daddy_context_->get_global_context ();
439 programming_error ("No Global context!");