2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
6 LilyPond is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 LilyPond is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
22 #include "context-def.hh"
23 #include "dispatcher.hh"
24 #include "global-context.hh"
25 #include "international.hh"
26 #include "ly-smobs.icc"
28 #include "output-def.hh"
30 #include "program-option.hh"
31 #include "scm-hash.hh"
32 #include "translator-group.hh"
36 Context::is_removable () const
38 return context_list_ == SCM_EOL && ! client_count_
39 && !dynamic_cast<Global_context const *> (daddy_context_);
43 Context::check_removal ()
45 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
47 Context *ctx = unsmob_context (scm_car (p));
49 ctx->check_removal ();
50 if (ctx->is_removable ())
52 recurse_over_translators (ctx, &Translator::finalize,
53 &Translator_group::finalize,
55 send_stream_event (ctx, "RemoveContext", 0, 0);
60 Context::Context (Context const & /* src */)
66 Context::properties_dict () const
68 return Scheme_hash_table::unsmob (properties_scm_);
72 Context::add_context (Context *child)
74 context_list_ = ly_append2 (context_list_,
75 scm_cons (child->self_scm (), SCM_EOL));
77 child->daddy_context_ = this;
78 this->events_below_->register_as_listener (child->events_below_);
87 properties_scm_ = SCM_EOL;
88 accepts_list_ = SCM_EOL;
89 context_list_ = SCM_EOL;
90 definition_ = SCM_EOL;
91 definition_mods_ = SCM_EOL;
97 Scheme_hash_table *tab = new Scheme_hash_table;
98 properties_scm_ = tab->unprotect ();
99 event_source_ = new Dispatcher ();
100 event_source_->unprotect ();
101 events_below_ = new Dispatcher ();
102 events_below_->unprotect ();
105 /* TODO: this shares code with find_create_context (). */
107 Context::create_unique_context (SCM name, string id, SCM operations)
110 Don't create multiple score contexts.
112 Global_context *gthis = dynamic_cast<Global_context *> (this);
113 if (gthis && gthis->get_score_context ())
114 return gthis->get_score_context ()->create_unique_context (name, id, operations);
116 vector<Context_def *> path = path_to_acceptable_context (name);
119 Context *current = this;
121 // Iterate through the path and create all of the implicit contexts.
122 for (vsize i = 0; i < path.size (); i++)
125 string id_str = "\\new";
126 if (i == path.size () - 1)
131 current = current->create_context (path[i],
140 Don't go up to Global_context, because global goes down to the
144 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
145 ret = daddy_context_->create_unique_context (name, id, operations);
148 warning (_f ("cannot find or create new `%s'",
149 ly_symbol2string (name).c_str ()));
156 Context::find_create_context (SCM n, string id, SCM operations)
159 Don't create multiple score contexts.
161 Global_context *gthis = dynamic_cast<Global_context *> (this);
162 if (gthis && gthis->get_score_context ())
163 return gthis->get_score_context ()->find_create_context (n, id, operations);
165 if (Context *existing = find_context_below (this, n, id))
168 if (n == ly_symbol2scm ("Bottom"))
170 Context *tg = get_default_interpreter (id);
174 vector<Context_def *> path = path_to_acceptable_context (n);
178 Context *current = this;
180 // start at 1. The first one (index 0) will be us.
181 for (vsize i = 0; i < path.size (); i++)
183 SCM ops = (i == path.size () - 1) ? operations : SCM_EOL;
186 if (i == path.size () - 1)
189 current = current->create_context (path[i],
198 Don't go up to Global_context, because global goes down to the
202 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
203 ret = daddy_context_->find_create_context (n, id, operations);
206 warning (_f ("cannot find or create `%s' called `%s'",
207 ly_symbol2string (n).c_str (), id));
213 IMPLEMENT_LISTENER (Context, acknowledge_infant);
215 Context::acknowledge_infant (SCM sev)
217 infant_event_ = unsmob_stream_event (sev);
220 IMPLEMENT_LISTENER (Context, set_property_from_event);
222 Context::set_property_from_event (SCM sev)
224 Stream_event *ev = unsmob_stream_event (sev);
226 SCM sym = ev->get_property ("symbol");
227 if (scm_is_symbol (sym))
229 SCM val = ev->get_property ("value");
232 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
234 set_property (sym, val);
238 IMPLEMENT_LISTENER (Context, unset_property_from_event);
240 Context::unset_property_from_event (SCM sev)
242 Stream_event *ev = unsmob_stream_event (sev);
244 SCM sym = ev->get_property ("symbol");
245 type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
246 unset_property (sym);
250 Creates a new context from a CreateContext event, and sends an
251 AnnounceNewContext event to this context.
253 IMPLEMENT_LISTENER (Context, create_context_from_event);
255 Context::create_context_from_event (SCM sev)
257 Stream_event *ev = unsmob_stream_event (sev);
259 string id = ly_scm2string (ev->get_property ("id"));
260 SCM ops = ev->get_property ("ops");
261 SCM type_scm = ev->get_property ("type");
262 string type = ly_symbol2string (type_scm);
264 vector<Context_def *> path = path_to_acceptable_context (type_scm);
266 if (path.size () != 1)
268 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
271 Context_def *cdef = path[0];
273 Context *new_context = cdef->instantiate (ops);
275 new_context->id_string_ = id;
277 /* Register various listeners:
278 - Make the new context hear events that universally affect contexts
279 - connect events_below etc. properly */
280 /* We want to be the first ones to hear our own events. Therefore, wait
281 before registering events_below_ */
282 new_context->event_source ()->
283 add_listener (GET_LISTENER (new_context->create_context_from_event),
284 ly_symbol2scm ("CreateContext"));
285 new_context->event_source ()->
286 add_listener (GET_LISTENER (new_context->remove_context),
287 ly_symbol2scm ("RemoveContext"));
288 new_context->event_source ()->
289 add_listener (GET_LISTENER (new_context->change_parent),
290 ly_symbol2scm ("ChangeParent"));
291 new_context->event_source ()->
292 add_listener (GET_LISTENER (new_context->set_property_from_event),
293 ly_symbol2scm ("SetProperty"));
294 new_context->event_source ()->
295 add_listener (GET_LISTENER (new_context->unset_property_from_event),
296 ly_symbol2scm ("UnsetProperty"));
298 new_context->events_below_->register_as_listener (new_context->event_source_);
299 this->add_context (new_context);
301 new_context->unprotect ();
303 Context_def *td = unsmob_context_def (new_context->definition_);
305 /* This cannot move before add_context (), because \override
306 operations require that we are in the hierarchy. */
307 td->apply_default_property_operations (new_context);
308 apply_property_operations (new_context, ops);
310 send_stream_event (this, "AnnounceNewContext", 0,
311 ly_symbol2scm ("context"), new_context->self_scm (),
312 ly_symbol2scm ("creator"), sev);
315 vector<Context_def *>
316 Context::path_to_acceptable_context (SCM name) const
318 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
319 // but the Context_def expects to see elements of the form ('accepts symbol).
320 SCM accepts = SCM_EOL;
321 for (SCM s = scm_reverse (definition_mods_); scm_is_pair (s); s = scm_cdr (s))
322 if (scm_caar (s) == ly_symbol2scm ("accepts"))
324 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
325 accepts = scm_cons (elt, accepts);
328 return unsmob_context_def (definition_)->path_to_acceptable_context (name,
335 Context::create_context (Context_def *cdef,
340 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
341 iterator specific stuff from the Context class */
343 add_listener (GET_LISTENER (acknowledge_infant),
344 ly_symbol2scm ("AnnounceNewContext"));
345 /* The CreateContext creates a new context, and sends an announcement of the
346 new context through another event. That event will be stored in
347 infant_event_ to create a return value. */
348 send_stream_event (this, "CreateContext", 0,
349 ly_symbol2scm ("ops"), ops,
350 ly_symbol2scm ("type"), cdef->get_context_name (),
351 ly_symbol2scm ("id"), ly_string2scm (id));
353 remove_listener (GET_LISTENER (acknowledge_infant),
354 ly_symbol2scm ("AnnounceNewContext"));
356 assert (infant_event_);
357 SCM infant_scm = infant_event_->get_property ("context");
358 Context *infant = unsmob_context (infant_scm);
360 if (!infant || infant->get_parent_context () != this)
362 programming_error ("create_context: can't locate newly created context");
370 Default child context as a SCM string, or something else if there is
374 Context::default_child_context_name () const
376 return scm_is_pair (accepts_list_)
377 ? scm_car (accepts_list_)
382 Context::is_bottom_context () const
384 return !scm_is_symbol (default_child_context_name ());
388 Context::get_default_interpreter (string context_id)
390 if (!is_bottom_context ())
392 SCM nm = default_child_context_name ();
393 SCM st = find_context_def (get_output_def (), nm);
395 string name = ly_symbol2string (nm);
396 Context_def *t = unsmob_context_def (st);
399 warning (_f ("cannot find or create: `%s'", name.c_str ()));
400 t = unsmob_context_def (this->definition_);
403 Context *tg = create_context (t, context_id, SCM_EOL);
404 return tg->get_default_interpreter (context_id);
413 Context::where_defined (SCM sym, SCM *value) const
416 if (profile_property_accesses)
417 note_property_access (&context_property_lookup_table, sym);
420 if (properties_dict ()->try_retrieve (sym, value))
421 return (Context *)this;
423 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
427 return SCM_EOL when not found.
430 Context::internal_get_property (SCM sym) const
433 if (profile_property_accesses)
434 note_property_access (&context_property_lookup_table, sym);
438 if (properties_dict ()->try_retrieve (sym, &val))
442 return daddy_context_->internal_get_property (sym);
448 Called by the send_stream_event macro. props is a 0-terminated array of
449 properties and corresponding values, interleaved. This method should not
450 be called from any other place than the send_stream_event macro.
453 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
455 Stream_event *e = new Stream_event (type, origin);
456 for (int i = 0; props[i]; i += 2)
458 e->set_property (props[i], props[i + 1]);
460 event_source_->broadcast (e);
465 Context::is_alias (SCM sym) const
467 if (sym == ly_symbol2scm ("Bottom")
468 && !scm_is_pair (accepts_list_))
470 if (sym == unsmob_context_def (definition_)->get_context_name ())
473 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
477 Context::add_alias (SCM sym)
479 aliases_ = scm_cons (sym, aliases_);
482 /* we don't (yet) instrument context properties */
484 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
486 internal_set_property (sym, val);
490 Context::internal_set_property (SCM sym, SCM val)
492 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
494 if (do_internal_type_checking_global)
495 assert (type_check_ok);
498 properties_dict ()->set (sym, val);
502 TODO: look up to check whether we have inherited var?
505 Context::unset_property (SCM sym)
507 properties_dict ()->remove (sym);
510 IMPLEMENT_LISTENER (Context, change_parent);
512 Context::change_parent (SCM sev)
514 Stream_event *ev = unsmob_stream_event (sev);
515 Context *to = unsmob_context (ev->get_property ("context"));
517 disconnect_from_parent ();
518 to->add_context (this);
522 Die. The next GC sweep should take care of the actual death.
524 IMPLEMENT_LISTENER (Context, remove_context);
526 Context::remove_context (SCM)
528 /* ugh, the translator group should listen to RemoveContext events by itself */
529 Translator_group *impl = implementation ();
531 impl->disconnect_from_context ();
532 disconnect_from_parent ();
536 Context::disconnect_from_parent ()
538 daddy_context_->events_below_->unregister_as_listener (this->events_below_);
539 daddy_context_->context_list_ = scm_delq_x (this->self_scm (), daddy_context_->context_list_);
544 ID == "" means accept any ID.
547 find_context_below (Context *where,
550 if (where->is_alias (type))
552 if (id == "" || where->id_string () == id)
557 for (SCM s = where->children_contexts ();
558 !found && scm_is_pair (s); s = scm_cdr (s))
560 Context *tr = unsmob_context (scm_car (s));
562 found = find_context_below (tr, type, id);
569 Context::properties_as_alist () const
571 return properties_dict ()->to_alist ();
575 Context::context_name_symbol () const
577 Context_def *td = unsmob_context_def (definition_);
578 return td->get_context_name ();
582 Context::context_name () const
584 return ly_symbol2string (context_name_symbol ());
588 Context::get_score_context () const
591 return daddy_context_->get_score_context ();
597 Context::get_output_def () const
599 return daddy_context_ ? daddy_context_->get_output_def () : 0;
607 Context::now_mom () const
609 Context const *p = this;
610 while (p->daddy_context_)
611 p = p->daddy_context_;
613 return p->now_mom ();
617 Context::print_smob (SCM s, SCM port, scm_print_state *)
619 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
621 scm_puts ("#<", port);
622 scm_puts (sc->class_name (), port);
623 if (Context_def *d = unsmob_context_def (sc->definition_))
625 scm_puts (" ", port);
626 scm_display (d->get_context_name (), port);
629 if (!sc->id_string_.empty ())
631 scm_puts ("=", port);
632 scm_puts (sc->id_string_.c_str (), port);
635 scm_puts (" ", port);
637 scm_display (sc->context_list_, port);
638 scm_puts (" >", port);
644 Context::mark_smob (SCM sm)
646 Context *me = (Context *) SCM_CELL_WORD_1 (sm);
648 scm_gc_mark (me->context_list_);
649 scm_gc_mark (me->aliases_);
650 scm_gc_mark (me->definition_);
651 scm_gc_mark (me->definition_mods_);
652 scm_gc_mark (me->properties_scm_);
653 scm_gc_mark (me->accepts_list_);
655 if (me->implementation_)
656 scm_gc_mark (me->implementation_->self_scm ());
658 if (me->event_source_)
659 scm_gc_mark (me->event_source_->self_scm ());
661 if (me->events_below_)
662 scm_gc_mark (me->events_below_->self_scm ());
664 return me->properties_scm_;
667 IMPLEMENT_SMOBS (Context);
668 IMPLEMENT_DEFAULT_EQUAL_P (Context);
669 IMPLEMENT_TYPE_P (Context, "ly:context?");
672 Context::get_global_context () const
674 if (dynamic_cast<Global_context *> ((Context *) this))
675 return dynamic_cast<Global_context *> ((Context *) this);
678 return daddy_context_->get_global_context ();
680 programming_error ("no Global context");
685 Context::get_parent_context () const
687 return daddy_context_;
691 Ugh. Where to put this?
694 measure_length (Context const *context)
696 SCM l = context->get_property ("measureLength");
698 if (unsmob_moment (l))
699 length = unsmob_moment (l)->main_part_;
704 measure_position (Context const *context)
706 SCM sm = context->get_property ("measurePosition");
709 if (unsmob_moment (sm))
711 m = *unsmob_moment (sm);
713 if (m.main_part_ < Rational (0))
715 Rational length (measure_length (context));
716 while (m.main_part_ < Rational (0))
717 m.main_part_ += length;
724 /* Finds the measure position after a note of length DUR that
725 begins at the current measure position. */
727 measure_position (Context const *context, Duration const *dur)
729 Moment pos = measure_position (context);
730 Rational dur_length = dur ? dur->get_length () : Rational (0);
732 Moment end_pos = pos.grace_part_ < Rational (0)
733 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
734 : Moment (pos.main_part_ + dur_length, 0);
740 measure_number (Context const *context)
742 SCM barnum = context->get_property ("internalBarNumber");
743 SCM smp = context->get_property ("measurePosition");
745 int bn = robust_scm2int (barnum, 0);
746 Moment mp = robust_scm2moment (smp, Moment (0));
747 if (mp.main_part_ < Rational (0))
754 set_context_property_on_children (Context *trans, SCM sym, SCM val)
756 trans->set_property (sym, ly_deep_copy (val));
757 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
759 Context *trg = unsmob_context (scm_car (p));
760 set_context_property_on_children (trg, sym, ly_deep_copy (val));
765 melisma_busy (Context *tr)
767 SCM melisma_properties = tr->get_property ("melismaBusyProperties");
770 for (; !busy && scm_is_pair (melisma_properties);
771 melisma_properties = scm_cdr (melisma_properties))
772 busy = busy || to_boolean (tr->internal_get_property (scm_car (melisma_properties)));
778 check_repeat_count_visibility (Context const *context, SCM count)
780 SCM proc = context->get_property ("repeatCountVisibility");
781 return (ly_is_procedure (proc)
782 && to_boolean (scm_call_2 (proc,
784 context->self_scm ())));