2 context.cc -- implement Context
4 source file of the GNU LilyPond music typesetter
6 (c) 2004--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
11 #include "context-def.hh"
12 #include "dispatcher.hh"
13 #include "global-context.hh"
14 #include "international.hh"
15 #include "ly-smobs.icc"
17 #include "output-def.hh"
19 #include "program-option.hh"
20 #include "scm-hash.hh"
21 #include "translator-group.hh"
25 Context::is_removable () const
27 return context_list_ == SCM_EOL && ! iterator_count_
28 && !dynamic_cast<Global_context const *> (daddy_context_);
32 Context::check_removal ()
34 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
36 Context *ctx = unsmob_context (scm_car (p));
38 ctx->check_removal ();
39 if (ctx->is_removable ())
41 recurse_over_translators (ctx, &Translator::finalize,
42 &Translator_group::finalize,
44 send_stream_event (ctx, "RemoveContext", 0, 0);
49 Context::Context (Context const & /* src */)
55 Context::properties_dict () const
57 return Scheme_hash_table::unsmob (properties_scm_);
61 Context::add_context (Context *child)
63 context_list_ = ly_append2 (context_list_,
64 scm_cons (child->self_scm (), SCM_EOL));
66 child->daddy_context_ = this;
67 this->events_below_->register_as_listener (child->events_below_);
77 properties_scm_ = SCM_EOL;
78 accepts_list_ = SCM_EOL;
79 context_list_ = SCM_EOL;
80 definition_ = SCM_EOL;
81 definition_mods_ = SCM_EOL;
87 Scheme_hash_table *tab = new Scheme_hash_table;
88 properties_scm_ = tab->unprotect ();
89 event_source_ = new Dispatcher ();
90 event_source_->unprotect ();
91 events_below_ = new Dispatcher ();
92 events_below_->unprotect ();
95 /* TODO: this shares code with find_create_context (). */
97 Context::create_unique_context (SCM name, string id, SCM operations)
100 Don't create multiple score contexts.
102 Global_context *gthis = dynamic_cast<Global_context *> (this);
103 if (gthis && gthis->get_score_context ())
104 return gthis->get_score_context ()->create_unique_context (name, id, operations);
106 vector<Context_def*> path = path_to_acceptable_context (name);
109 Context *current = this;
111 // Iterate through the path and create all of the implicit contexts.
112 for (vsize i = 0; i < path.size (); i++)
115 string id_str = "\\new";
116 if (i == path.size () - 1)
121 current = current->create_context (path[i],
130 Don't go up to Global_context, because global goes down to the
134 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
135 ret = daddy_context_->create_unique_context (name, id, operations);
138 warning (_f ("cannot find or create new `%s'",
139 ly_symbol2string (name).c_str ()));
146 Context::find_create_context (SCM n, string id, SCM operations)
149 Don't create multiple score contexts.
151 Global_context *gthis = dynamic_cast<Global_context *> (this);
152 if (gthis && gthis->get_score_context ())
153 return gthis->get_score_context ()->find_create_context (n, id, operations);
155 if (Context *existing = find_context_below (this, n, id))
158 if (n == ly_symbol2scm ("Bottom"))
160 Context *tg = get_default_interpreter ();
164 vector<Context_def*> path = path_to_acceptable_context (n);
168 Context *current = this;
170 // start at 1. The first one (index 0) will be us.
171 for (vsize i = 0; i < path.size (); i++)
173 SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
176 if (i == path.size () -1)
179 current = current->create_context (path[i],
188 Don't go up to Global_context, because global goes down to the
192 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
193 ret = daddy_context_->find_create_context (n, id, operations);
196 warning (_f ("cannot find or create `%s' called `%s'",
197 ly_symbol2string (n).c_str (), id));
203 IMPLEMENT_LISTENER (Context, acknowledge_infant);
205 Context::acknowledge_infant (SCM sev)
207 infant_event_ = unsmob_stream_event (sev);
210 IMPLEMENT_LISTENER (Context, set_property_from_event);
212 Context::set_property_from_event (SCM sev)
214 Stream_event *ev = unsmob_stream_event (sev);
216 SCM sym = ev->get_property ("symbol");
217 if (scm_is_symbol (sym))
219 SCM val = ev->get_property ("value");
222 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
224 set_property (sym, val);
228 IMPLEMENT_LISTENER (Context, unset_property_from_event);
230 Context::unset_property_from_event (SCM sev)
232 Stream_event *ev = unsmob_stream_event (sev);
234 SCM sym = ev->get_property ("symbol");
235 type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
236 unset_property (sym);
240 Creates a new context from a CreateContext event, and sends an
241 AnnounceNewContext event to this context.
243 IMPLEMENT_LISTENER (Context, create_context_from_event);
245 Context::create_context_from_event (SCM sev)
247 Stream_event *ev = unsmob_stream_event (sev);
249 string id = ly_scm2string (ev->get_property ("id"));
250 SCM ops = ev->get_property ("ops");
251 SCM type_scm = ev->get_property ("type");
252 string type = ly_symbol2string (type_scm);
254 vector<Context_def*> path = path_to_acceptable_context (type_scm);
256 if (path.size () != 1)
258 programming_error (_f ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
261 Context_def *cdef = path[0];
263 Context *new_context = cdef->instantiate (ops);
265 new_context->id_string_ = id;
267 /* Register various listeners:
268 - Make the new context hear events that universally affect contexts
269 - connect events_below etc. properly */
270 /* We want to be the first ones to hear our own events. Therefore, wait
271 before registering events_below_ */
272 new_context->event_source ()->
273 add_listener (GET_LISTENER (new_context->create_context_from_event),
274 ly_symbol2scm ("CreateContext"));
275 new_context->event_source ()->
276 add_listener (GET_LISTENER (new_context->remove_context),
277 ly_symbol2scm ("RemoveContext"));
278 new_context->event_source ()->
279 add_listener (GET_LISTENER (new_context->change_parent),
280 ly_symbol2scm ("ChangeParent"));
281 new_context->event_source ()->
282 add_listener (GET_LISTENER (new_context->set_property_from_event),
283 ly_symbol2scm ("SetProperty"));
284 new_context->event_source ()->
285 add_listener (GET_LISTENER (new_context->unset_property_from_event),
286 ly_symbol2scm ("UnsetProperty"));
288 new_context->events_below_->register_as_listener (new_context->event_source_);
289 this->add_context (new_context);
291 new_context->unprotect ();
293 Context_def *td = unsmob_context_def (new_context->definition_);
295 /* This cannot move before add_context (), because \override
296 operations require that we are in the hierarchy. */
297 td->apply_default_property_operations (new_context);
298 apply_property_operations (new_context, ops);
300 send_stream_event (this, "AnnounceNewContext", 0,
301 ly_symbol2scm ("context"), new_context->self_scm (),
302 ly_symbol2scm ("creator"), sev);
306 Context::path_to_acceptable_context (SCM name) const
308 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
309 // but the Context_def expects to see elements of the form ('accepts symbol).
310 SCM accepts = SCM_EOL;
311 for (SCM s = scm_reverse (definition_mods_); scm_is_pair (s); s = scm_cdr (s))
312 if (scm_caar (s) == ly_symbol2scm ("accepts"))
314 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
315 accepts = scm_cons (elt, accepts);
318 return unsmob_context_def (definition_)->path_to_acceptable_context (name,
325 Context::create_context (Context_def *cdef,
330 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
331 iterator specific stuff from the Context class */
333 add_listener (GET_LISTENER (acknowledge_infant),
334 ly_symbol2scm ("AnnounceNewContext"));
335 /* The CreateContext creates a new context, and sends an announcement of the
336 new context through another event. That event will be stored in
337 infant_event_ to create a return value. */
338 send_stream_event (this, "CreateContext", 0,
339 ly_symbol2scm ("ops"), ops,
340 ly_symbol2scm ("type"), cdef->get_context_name (),
341 ly_symbol2scm ("id"), ly_string2scm (id));
343 remove_listener (GET_LISTENER (acknowledge_infant),
344 ly_symbol2scm ("AnnounceNewContext"));
346 assert (infant_event_);
347 SCM infant_scm = infant_event_->get_property ("context");
348 Context *infant = unsmob_context (infant_scm);
350 if (!infant || infant->get_parent_context () != this)
352 programming_error ("create_context: can't locate newly created context");
360 Default child context as a SCM string, or something else if there is
364 Context::default_child_context_name () const
366 return scm_is_pair (accepts_list_)
367 ? scm_car (accepts_list_)
372 Context::is_bottom_context () const
374 return !scm_is_symbol (default_child_context_name ());
378 Context::get_default_interpreter ()
380 if (!is_bottom_context ())
382 SCM nm = default_child_context_name ();
383 SCM st = find_context_def (get_output_def (), nm);
385 string name = ly_symbol2string (nm);
386 Context_def *t = unsmob_context_def (st);
389 warning (_f ("cannot find or create: `%s'", name.c_str ()));
390 t = unsmob_context_def (this->definition_);
393 Context *tg = create_context (t, "", SCM_EOL);
394 return tg->get_default_interpreter ();
403 Context::where_defined (SCM sym, SCM *value) const
406 if (profile_property_accesses)
407 note_property_access (&context_property_lookup_table, sym);
410 if (properties_dict ()->try_retrieve (sym, value))
411 return (Context *)this;
413 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
417 return SCM_EOL when not found.
420 Context::internal_get_property (SCM sym) const
423 if (profile_property_accesses)
424 note_property_access (&context_property_lookup_table, sym);
428 if (properties_dict ()->try_retrieve (sym, &val))
432 return daddy_context_->internal_get_property (sym);
438 Called by the send_stream_event macro. props is a 0-terminated array of
439 properties and corresponding values, interleaved. This method should not
440 be called from any other place than the send_stream_event macro.
443 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
445 Stream_event *e = new Stream_event (type, origin);
446 for (int i = 0; props[i]; i += 2)
448 e->set_property (props[i], props[i+1]);
450 event_source_->broadcast (e);
455 Context::is_alias (SCM sym) const
457 if (sym == ly_symbol2scm ("Bottom")
458 && !scm_is_pair (accepts_list_))
460 if (sym == unsmob_context_def (definition_)->get_context_name ())
463 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
467 Context::add_alias (SCM sym)
469 aliases_ = scm_cons (sym, aliases_);
472 /* we don't (yet) instrument context properties */
474 Context::instrumented_set_property (SCM sym, SCM val, const char*, int, const char*)
476 internal_set_property (sym, val);
480 Context::internal_set_property (SCM sym, SCM val)
482 if (do_internal_type_checking_global)
483 assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
485 properties_dict ()->set (sym, val);
489 TODO: look up to check whether we have inherited var?
492 Context::unset_property (SCM sym)
494 properties_dict ()->remove (sym);
497 IMPLEMENT_LISTENER (Context, change_parent);
499 Context::change_parent (SCM sev)
501 Stream_event *ev = unsmob_stream_event (sev);
502 Context *to = unsmob_context (ev->get_property ("context"));
504 disconnect_from_parent ();
505 to->add_context (this);
509 Die. The next GC sweep should take care of the actual death.
511 IMPLEMENT_LISTENER (Context, remove_context);
513 Context::remove_context (SCM)
515 /* ugh, the translator group should listen to RemoveContext events by itself */
516 Translator_group *impl = implementation ();
518 impl->disconnect_from_context ();
519 disconnect_from_parent ();
523 Context::disconnect_from_parent ()
525 daddy_context_->events_below_->unregister_as_listener (this->events_below_);
526 daddy_context_->context_list_ = scm_delq_x (this->self_scm (), daddy_context_->context_list_);
531 ID == "" means accept any ID.
534 find_context_below (Context *where,
537 if (where->is_alias (type))
539 if (id == "" || where->id_string () == id)
544 for (SCM s = where->children_contexts ();
545 !found && scm_is_pair (s); s = scm_cdr (s))
547 Context *tr = unsmob_context (scm_car (s));
549 found = find_context_below (tr, type, id);
556 Context::properties_as_alist () const
558 return properties_dict ()->to_alist ();
562 Context::context_name_symbol () const
564 Context_def *td = unsmob_context_def (definition_);
565 return td->get_context_name ();
569 Context::context_name () const
571 return ly_symbol2string (context_name_symbol ());
575 Context::get_score_context () const
578 return daddy_context_->get_score_context ();
584 Context::get_output_def () const
586 return daddy_context_ ? daddy_context_->get_output_def () : 0;
594 Context::now_mom () const
596 Context const *p = this;
597 while (p->daddy_context_)
598 p = p->daddy_context_;
600 return p->now_mom ();
604 Context::print_smob (SCM s, SCM port, scm_print_state *)
606 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
608 scm_puts ("#<", port);
609 scm_puts (sc->class_name (), port);
610 if (Context_def *d = unsmob_context_def (sc->definition_))
612 scm_puts (" ", port);
613 scm_display (d->get_context_name (), port);
616 if (!sc->id_string_.empty ())
618 scm_puts ("=", port);
619 scm_puts (sc->id_string_.c_str (), port);
622 scm_puts (" ", port);
624 scm_display (sc->context_list_, port);
625 scm_puts (" >", port);
631 Context::mark_smob (SCM sm)
633 Context *me = (Context *) SCM_CELL_WORD_1 (sm);
635 scm_gc_mark (me->context_list_);
636 scm_gc_mark (me->aliases_);
637 scm_gc_mark (me->definition_);
638 scm_gc_mark (me->definition_mods_);
639 scm_gc_mark (me->properties_scm_);
640 scm_gc_mark (me->accepts_list_);
642 if (me->implementation_)
643 scm_gc_mark (me->implementation_->self_scm ());
645 if (me->event_source_)
646 scm_gc_mark (me->event_source_->self_scm ());
648 if (me->events_below_)
649 scm_gc_mark (me->events_below_->self_scm ());
651 return me->properties_scm_;
654 IMPLEMENT_SMOBS (Context);
655 IMPLEMENT_DEFAULT_EQUAL_P (Context);
656 IMPLEMENT_TYPE_P (Context, "ly:context?");
659 Context::get_global_context () const
661 if (dynamic_cast<Global_context *> ((Context *) this))
662 return dynamic_cast<Global_context *> ((Context *) this);
665 return daddy_context_->get_global_context ();
667 programming_error ("no Global context");
672 Context::get_parent_context () const
674 return daddy_context_;
678 Ugh. Where to put this?
681 measure_length (Context const *context)
683 SCM l = context->get_property ("measureLength");
685 if (unsmob_moment (l))
686 length = unsmob_moment (l)->main_part_;
691 measure_position (Context const *context)
693 SCM sm = context->get_property ("measurePosition");
696 if (unsmob_moment (sm))
698 m = *unsmob_moment (sm);
700 if (m.main_part_ < Rational (0))
702 Rational length (measure_length (context));
703 while (m.main_part_ < Rational (0))
704 m.main_part_ += length;
711 /* Finds the measure position after a note of length DUR that
712 begins at the current measure position. */
714 measure_position (Context const *context, Duration const *dur)
716 Moment pos = measure_position (context);
717 Rational dur_length = dur ? dur->get_length () : Rational (0);
719 Moment end_pos = pos.grace_part_ < Rational(0)
720 ? Moment(pos.main_part_, pos.grace_part_ + dur_length)
721 : Moment(pos.main_part_ + dur_length, 0);
727 measure_number (Context const *context)
729 SCM barnum = context->get_property ("internalBarNumber");
730 SCM smp = context->get_property ("measurePosition");
732 int bn = robust_scm2int (barnum, 0);
733 Moment mp = robust_scm2moment (smp, Moment (0));
734 if (mp.main_part_ < Rational (0))
742 set_context_property_on_children (Context *trans, SCM sym, SCM val)
744 trans->set_property (sym, ly_deep_copy (val));
745 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
747 Context *trg = unsmob_context (scm_car (p));
748 set_context_property_on_children (trg, sym, ly_deep_copy (val));
753 melisma_busy (Context *tr)
755 SCM melisma_properties = tr->get_property ("melismaBusyProperties");
758 for (; !busy && scm_is_pair (melisma_properties);
759 melisma_properties = scm_cdr (melisma_properties))
760 busy = busy || to_boolean (tr->internal_get_property (scm_car (melisma_properties)));