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_over_translators (trg, &Translator::finalize, UP);
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_over_translators (t, &Translator::initialize, DOWN);
86 implementation_ = SCM_EOL;
87 properties_scm_ = SCM_EOL;
88 accepts_list_ = SCM_EOL;
89 context_list_ = SCM_EOL;
90 definition_ = SCM_EOL;
94 properties_scm_ = (new Scheme_hash_table)->self_scm ();
95 scm_gc_unprotect_object (properties_scm_);
99 Context::find_existing_context (SCM n, String id)
101 if ((is_alias (n) && (id_string_ == id || id.is_empty ())))
105 for (SCM p = context_list_; !r && gh_pair_p (p); p = ly_cdr (p))
107 Context * t = unsmob_context (ly_car (p));
109 r = dynamic_cast<Context*> (t)->find_existing_context (n, id);
117 Context::find_create_context (SCM n, String id,
121 Don't create multiple score contexts.
123 if (dynamic_cast<Global_context*> (this)
124 && dynamic_cast<Global_context*> (this)->get_score_context ())
125 return get_score_context ()->find_create_context (n, id, operations);
128 Context * existing = find_existing_context (n,id);
132 if (n == ly_symbol2scm ("Bottom"))
134 Context* tg = get_default_interpreter ();
140 TODO: use accepts_list_.
142 Link_array<Context_def> path
143 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
147 Context * current = this;
149 // start at 1. The first one (index 0) will be us.
150 for (int i=0; i < path.size (); i++)
152 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
155 = path[i]->instantiate (ops);
157 if (i == path.size () -1)
159 new_group->id_string_ = id;
162 current->add_context (new_group);
163 apply_property_operations (new_group, ops);
172 Don't go up to Global_context, because global goes down to
176 if (daddy_context_ && !dynamic_cast<Global_context*> (daddy_context_))
177 ret = daddy_context_->find_create_context (n, id, operations);
180 warning (_f ("Cannot find or create `%s' called `%s'",
181 ly_symbol2string (n).to_str0 (), id));
188 Default child context as a SCM string, or something else if there is
192 default_child_context_name (Context const *tg)
194 return gh_pair_p (tg->accepts_list_)
195 ? ly_car (scm_last_pair (tg->accepts_list_))
201 Context::is_bottom_context () const
203 return !gh_symbol_p (default_child_context_name (this));
207 Context::get_default_interpreter ()
209 if (!is_bottom_context ())
211 SCM nm = default_child_context_name (this);
212 SCM st = get_output_def ()->find_context_def (nm);
214 Context_def *t = unsmob_context_def (st);
217 warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
218 t = unsmob_context_def (this->definition_);
220 Context *tg = t->instantiate (SCM_EOL);
222 if (!tg->is_bottom_context ())
223 return tg->get_default_interpreter ();
234 Context::where_defined (SCM sym) const
236 if (properties_dict ()->contains (sym))
238 return (Context*)this;
241 return (daddy_context_) ? daddy_context_->where_defined (sym) : 0;
245 return SCM_EOL when not found.
248 Context::internal_get_property (SCM sym) const
251 if (properties_dict ()->try_retrieve (sym, &val))
255 return daddy_context_->internal_get_property (sym);
261 Context::is_alias (SCM sym) const
263 if (sym == ly_symbol2scm ("Bottom")
264 && !gh_pair_p (accepts_list_))
266 if (sym == unsmob_context_def (definition_)->get_context_name ())
269 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
273 Context::add_alias (SCM sym)
275 aliases_ = scm_cons (sym, aliases_);
281 Context::internal_set_property (SCM sym, SCM val)
284 if (internal_type_checking_global_b)
285 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
288 properties_dict ()->set (sym, val);
292 TODO: look up to check whether we have inherited var?
295 Context::unset_property (SCM sym)
297 properties_dict ()->remove (sym);
301 Remove a context from the hierarchy.
304 Context::remove_context (Context*trans)
308 context_list_ = scm_delq_x (trans->self_scm (), context_list_);
309 trans->daddy_context_ = 0;
314 ID == "" means accept any ID.
317 find_context_below (Context * where,
318 String type, String id)
320 if (where->is_alias (ly_symbol2scm (type.to_str0 ())))
322 if (id == "" || where->id_string_ == id)
327 for (SCM s = where->context_list_;
328 !found && gh_pair_p (s); s = gh_cdr (s))
330 Context * tr = unsmob_context (gh_car (s));
332 found = find_context_below (tr, type, id);
339 Context::properties_as_alist () const
341 return properties_dict ()->to_alist ();
345 Context::context_name () const
347 Context_def * td = unsmob_context_def (definition_ );
348 return ly_symbol2string (td->get_context_name ());
353 Context::get_score_context () const
355 if (Score_context *sc =dynamic_cast<Score_context*> ((Context*)this))
357 else if (daddy_context_)
358 return daddy_context_->get_score_context ();
364 Context::get_output_def () const
366 return (daddy_context_)
367 ? daddy_context_->get_output_def () : 0;
376 Context::now_mom () const
378 return daddy_context_->now_mom ();
382 Context::print_smob (SCM s, SCM port, scm_print_state *)
384 Context *sc = (Context *) ly_cdr (s);
386 scm_puts ("#<", port);
387 scm_puts (classname (sc), port);
388 if (Context_def *d=unsmob_context_def (sc->definition_))
390 scm_puts (" ", port);
391 scm_display (d->get_context_name (), port);
394 if (Context *td=dynamic_cast<Context *> (sc))
396 scm_puts ("=", port);
397 scm_puts (td->id_string_.to_str0 (), port);
401 scm_puts (" ", port);
403 scm_display (sc->context_list_, port);
404 scm_puts (" >", port);
410 Context::mark_smob (SCM sm)
412 Context * me = (Context*) SCM_CELL_WORD_1 (sm);
414 scm_gc_mark (me->context_list_);
415 scm_gc_mark (me->aliases_);
416 scm_gc_mark (me->definition_);
417 scm_gc_mark (me->properties_scm_);
418 scm_gc_mark (me->accepts_list_);
419 scm_gc_mark (me->implementation_);
421 return me->properties_scm_;
424 IMPLEMENT_SMOBS (Context);
425 IMPLEMENT_DEFAULT_EQUAL_P (Context);
426 IMPLEMENT_TYPE_P (Context,"ly:context?");
429 Context::try_music (Music* m)
431 Translator* t = unsmob_translator (implementation_);
435 bool b = t->try_music (m);
436 if (!b && daddy_context_)
437 b = daddy_context_->try_music (m);
444 Context::get_global_context () const
446 if (dynamic_cast<Global_context *>((Context*) this))
447 return dynamic_cast<Global_context *> ((Context*) this);
450 return daddy_context_->get_global_context ();
452 programming_error ("No Global context!");