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,
40 &Translator_group::finalize,
47 Context::Context (Context const &)
53 Context::properties_dict () const
55 return Scheme_hash_table::unsmob (properties_scm_);
59 Context::add_context (Context *t)
61 SCM ts = t->self_scm ();
62 context_list_ = ly_append2 (context_list_,
63 scm_cons (ts, SCM_EOL));
65 t->daddy_context_ = this;
71 Context_def *td = unsmob_context_def (t->definition_);
73 /* This cannot move before add_context (), because \override
74 operations require that we are in the hierarchy. */
75 td->apply_default_property_operations (t);
77 recurse_over_translators (t,
78 &Translator::initialize,
79 &Translator_group::initialize,
85 Context::get_key () const
90 Context::Context (Object_key const *key)
98 properties_scm_ = SCM_EOL;
99 accepts_list_ = SCM_EOL;
100 context_list_ = SCM_EOL;
101 definition_ = SCM_EOL;
105 Scheme_hash_table *tab = new Scheme_hash_table;
106 properties_scm_ = tab->unprotect ();
113 ((Object_key*)key)->unprotect ();
116 /* TODO: this shares code with find_create_context (). */
118 Context::create_unique_context (SCM n, SCM operations)
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 ()->create_unique_context (n, operations);
128 TODO: use accepts_list_.
130 Link_array<Context_def> path
131 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
135 Context *current = this;
137 // start at 1. The first one (index 0) will be us.
138 for (int i = 0; i < path.size (); i++)
140 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
142 current = current->create_context (path[i],
151 Don't go up to Global_context, because global goes down to
155 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
156 ret = daddy_context_->create_unique_context (n, operations);
159 warning (_f ("can't find or create new `%s'",
160 ly_symbol2string (n).to_str0 ()));
167 Context::find_create_context (SCM n, String id, SCM operations)
170 Don't create multiple score contexts.
172 if (dynamic_cast<Global_context *> (this)
173 && dynamic_cast<Global_context *> (this)->get_score_context ())
174 return get_score_context ()->find_create_context (n, id, operations);
176 if (Context *existing = find_context_below (this, n, id))
179 if (n == ly_symbol2scm ("Bottom"))
181 Context *tg = get_default_interpreter ();
186 TODO: use accepts_list_.
188 Link_array<Context_def> path
189 = unsmob_context_def (definition_)->path_to_acceptable_context (n, get_output_def ());
193 Context *current = this;
195 // start at 1. The first one (index 0) will be us.
196 for (int i = 0; i < path.size (); i++)
198 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
201 if (i == path.size () -1)
206 current = current->create_context (path[i],
215 Don't go up to Global_context, because global goes down to
219 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
220 ret = daddy_context_->find_create_context (n, id, operations);
223 warning (_f ("can't find or create `%s' called `%s'",
224 ly_symbol2string (n).to_str0 (), id));
231 Context::create_context (Context_def *cdef,
235 String type = ly_symbol2string (cdef->get_context_name ());
236 Object_key const *key = get_context_key (type, id);
238 = cdef->instantiate (ops, key);
240 new_context->id_string_ = id;
241 add_context (new_context);
242 apply_property_operations (new_context, ops);
248 Context::get_context_key (String type, String id)
250 if (!use_object_keys)
253 String now_key = type + "@" + id;
255 int disambiguation_count = 0;
256 if (context_counts_.find (now_key) != context_counts_.end ())
258 disambiguation_count = context_counts_[now_key];
261 context_counts_[now_key] = disambiguation_count + 1;
263 return new Lilypond_context_key (get_key (),
266 disambiguation_count);
270 Context::get_grob_key (String name)
272 if (!use_object_keys)
275 int disambiguation_count = 0;
276 if (grob_counts_.find (name) != grob_counts_.end ())
278 disambiguation_count = grob_counts_[name];
280 grob_counts_[name] = disambiguation_count + 1;
282 Object_key *k = new Lilypond_grob_key (get_key (),
285 disambiguation_count);
291 Default child context as a SCM string, or something else if there is
295 Context::default_child_context_name () const
297 return scm_is_pair (accepts_list_)
298 ? scm_car (accepts_list_)
303 Context::is_bottom_context () const
305 return !scm_is_symbol (default_child_context_name ());
309 Context::get_default_interpreter ()
311 if (!is_bottom_context ())
313 SCM nm = default_child_context_name ();
314 SCM st = find_context_def (get_output_def (), nm);
316 String name = ly_symbol2string (nm);
317 Context_def *t = unsmob_context_def (st);
320 warning (_f ("can't find or create: `%s'", name.to_str0 ()));
321 t = unsmob_context_def (this->definition_);
324 Context *tg = create_context (t, "", SCM_EOL);
325 if (!tg->is_bottom_context ())
326 return tg->get_default_interpreter ();
337 Context::where_defined (SCM sym, SCM *value) const
339 if (properties_dict ()->try_retrieve (sym, value))
341 return (Context *)this;
344 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
347 SCM context_property_lookup_table;
348 LY_DEFINE(ly_context_property_lookup_stats, "ly:context-property-lookup-stats",
352 return context_property_lookup_table ? context_property_lookup_table
353 : scm_c_make_hash_table (1);
358 return SCM_EOL when not found.
361 Context::internal_get_property (SCM sym) const
364 if (profile_property_accesses)
366 extern void note_property_access (SCM *table, SCM sym);
367 note_property_access (&context_property_lookup_table, sym);
372 if (properties_dict ()->try_retrieve (sym, &val))
376 return daddy_context_->internal_get_property (sym);
382 Context::is_alias (SCM sym) const
384 if (sym == ly_symbol2scm ("Bottom")
385 && !scm_is_pair (accepts_list_))
387 if (sym == unsmob_context_def (definition_)->get_context_name ())
390 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
394 Context::add_alias (SCM sym)
396 aliases_ = scm_cons (sym, aliases_);
400 Context::internal_set_property (SCM sym, SCM val)
403 if (do_internal_type_checking_global)
404 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
407 properties_dict ()->set (sym, val);
411 TODO: look up to check whether we have inherited var?
414 Context::unset_property (SCM sym)
416 properties_dict ()->remove (sym);
420 Remove a context from the hierarchy.
423 Context::remove_context (Context *trans)
427 context_list_ = scm_delq_x (trans->self_scm (), context_list_);
428 trans->daddy_context_ = 0;
433 ID == "" means accept any ID.
436 find_context_below (Context *where,
439 if (where->is_alias (type))
441 if (id == "" || where->id_string () == id)
446 for (SCM s = where->children_contexts ();
447 !found && scm_is_pair (s); s = scm_cdr (s))
449 Context *tr = unsmob_context (scm_car (s));
451 found = find_context_below (tr, type, id);
458 Context::properties_as_alist () const
460 return properties_dict ()->to_alist ();
464 Context::context_name_symbol () const
466 Context_def *td = unsmob_context_def (definition_);
467 return td->get_context_name ();
471 Context::context_name () const
473 return ly_symbol2string (context_name_symbol ());
477 Context::get_score_context () const
479 if (Score_context *sc = dynamic_cast<Score_context *> ((Context *) this))
481 else if (daddy_context_)
482 return daddy_context_->get_score_context ();
488 Context::get_output_def () const
490 return daddy_context_ ? daddy_context_->get_output_def () : 0;
498 Context::now_mom () const
500 return daddy_context_->now_mom ();
504 Context::print_smob (SCM s, SCM port, scm_print_state *)
506 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
508 scm_puts ("#<", port);
509 scm_puts (classname (sc), port);
510 if (Context_def *d = unsmob_context_def (sc->definition_))
512 scm_puts (" ", port);
513 scm_display (d->get_context_name (), port);
516 if (!sc->id_string_.is_empty ())
518 scm_puts ("=", port);
519 scm_puts (sc->id_string_.to_str0 (), port);
522 scm_puts (" ", port);
524 scm_display (sc->context_list_, port);
525 scm_puts (" >", port);
531 Context::mark_smob (SCM sm)
533 Context *me = (Context *) SCM_CELL_WORD_1 (sm);
535 scm_gc_mark (me->key_->self_scm ());
537 scm_gc_mark (me->context_list_);
538 scm_gc_mark (me->aliases_);
539 scm_gc_mark (me->definition_);
540 scm_gc_mark (me->properties_scm_);
541 scm_gc_mark (me->accepts_list_);
542 if (me->implementation_)
543 scm_gc_mark (me->implementation_->self_scm ());
545 return me->properties_scm_;
548 IMPLEMENT_SMOBS (Context);
549 IMPLEMENT_DEFAULT_EQUAL_P (Context);
550 IMPLEMENT_TYPE_P (Context, "ly:context?");
553 Context::try_music (Music *m)
555 Translator_group *t = implementation ();
559 bool b = t->try_music (m);
560 if (!b && daddy_context_)
561 b = daddy_context_->try_music (m);
567 Context::get_global_context () const
569 if (dynamic_cast<Global_context *> ((Context *) this))
570 return dynamic_cast<Global_context *> ((Context *) this);
573 return daddy_context_->get_global_context ();
575 programming_error ("no Global context");
580 Context::get_parent_context () const
582 return daddy_context_;
586 Context::clear_key_disambiguations ()
588 if (!use_object_keys)
591 grob_counts_.clear ();
592 context_counts_.clear ();
593 for (SCM s = context_list_; scm_is_pair (s); s = scm_cdr (s))
595 unsmob_context (scm_car (s))->clear_key_disambiguations ();
601 Ugh. Where to put this?
604 measure_length (Context const *context)
606 SCM l = context->get_property ("measureLength");
608 if (unsmob_moment (l))
609 length = unsmob_moment (l)->main_part_;
614 measure_position (Context const *context)
616 SCM sm = context->get_property ("measurePosition");
619 if (unsmob_moment (sm))
621 m = *unsmob_moment (sm);
623 if (m.main_part_ < Rational (0))
625 Rational length (measure_length (context));
626 while (m.main_part_ < Rational (0))
627 m.main_part_ += length;