2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2012 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;
94 ancestor_lookup_ = SCM_UNDEFINED;
98 Scheme_hash_table *tab = new Scheme_hash_table;
99 properties_scm_ = tab->unprotect ();
100 event_source_ = new Dispatcher ();
101 event_source_->unprotect ();
102 events_below_ = new Dispatcher ();
103 events_below_->unprotect ();
106 /* TODO: this shares code with find_create_context (). */
108 Context::create_unique_context (SCM name, string id, SCM operations)
111 Don't create multiple score contexts.
113 Global_context *gthis = dynamic_cast<Global_context *> (this);
114 if (gthis && gthis->get_score_context ())
115 return gthis->get_score_context ()->create_unique_context (name, id, operations);
117 vector<Context_def *> path = path_to_acceptable_context (name);
120 Context *current = this;
122 // Iterate through the path and create all of the implicit contexts.
123 for (vsize i = 0; i < path.size (); i++)
126 string id_str = "\\new";
127 if (i == path.size () - 1)
132 current = current->create_context (path[i],
141 Don't go up to Global_context, because global goes down to the
145 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
146 ret = daddy_context_->create_unique_context (name, id, operations);
149 warning (_f ("cannot find or create new `%s'",
150 ly_symbol2string (name).c_str ()));
157 Context::find_create_context (SCM n, string id, SCM operations)
160 Don't create multiple score contexts.
162 Global_context *gthis = dynamic_cast<Global_context *> (this);
163 if (gthis && gthis->get_score_context ())
164 return gthis->get_score_context ()->find_create_context (n, id, operations);
166 if (Context *existing = find_context_below (this, n, id))
169 if (n == ly_symbol2scm ("Bottom"))
171 Context *tg = get_default_interpreter (id);
175 vector<Context_def *> path = path_to_acceptable_context (n);
179 Context *current = this;
181 // start at 1. The first one (index 0) will be us.
182 for (vsize i = 0; i < path.size (); i++)
184 SCM ops = (i == path.size () - 1) ? operations : SCM_EOL;
187 if (i == path.size () - 1)
190 current = current->create_context (path[i],
199 Don't go up to Global_context, because global goes down to the
203 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
204 ret = daddy_context_->find_create_context (n, id, operations);
207 warning (_f ("cannot find or create `%s' called `%s'",
208 ly_symbol2string (n).c_str (), id));
214 IMPLEMENT_LISTENER (Context, acknowledge_infant);
216 Context::acknowledge_infant (SCM sev)
218 infant_event_ = unsmob_stream_event (sev);
221 IMPLEMENT_LISTENER (Context, set_property_from_event);
223 Context::set_property_from_event (SCM sev)
225 Stream_event *ev = unsmob_stream_event (sev);
227 SCM sym = ev->get_property ("symbol");
228 if (scm_is_symbol (sym))
230 SCM val = ev->get_property ("value");
233 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
235 set_property (sym, val);
239 IMPLEMENT_LISTENER (Context, unset_property_from_event);
241 Context::unset_property_from_event (SCM sev)
243 Stream_event *ev = unsmob_stream_event (sev);
245 SCM sym = ev->get_property ("symbol");
246 type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
247 unset_property (sym);
251 Creates a new context from a CreateContext event, and sends an
252 AnnounceNewContext event to this context.
254 IMPLEMENT_LISTENER (Context, create_context_from_event);
256 Context::create_context_from_event (SCM sev)
258 Stream_event *ev = unsmob_stream_event (sev);
260 string id = ly_scm2string (ev->get_property ("id"));
261 SCM ops = ev->get_property ("ops");
262 SCM type_scm = ev->get_property ("type");
263 string type = ly_symbol2string (type_scm);
265 vector<Context_def *> path = path_to_acceptable_context (type_scm);
267 if (path.size () != 1)
269 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
272 Context_def *cdef = path[0];
274 Context *new_context = cdef->instantiate (ops);
276 new_context->id_string_ = id;
278 /* Register various listeners:
279 - Make the new context hear events that universally affect contexts
280 - connect events_below etc. properly */
281 /* We want to be the first ones to hear our own events. Therefore, wait
282 before registering events_below_ */
283 new_context->event_source ()->
284 add_listener (GET_LISTENER (new_context->create_context_from_event),
285 ly_symbol2scm ("CreateContext"));
286 new_context->event_source ()->
287 add_listener (GET_LISTENER (new_context->remove_context),
288 ly_symbol2scm ("RemoveContext"));
289 new_context->event_source ()->
290 add_listener (GET_LISTENER (new_context->change_parent),
291 ly_symbol2scm ("ChangeParent"));
292 new_context->event_source ()->
293 add_listener (GET_LISTENER (new_context->set_property_from_event),
294 ly_symbol2scm ("SetProperty"));
295 new_context->event_source ()->
296 add_listener (GET_LISTENER (new_context->unset_property_from_event),
297 ly_symbol2scm ("UnsetProperty"));
299 new_context->events_below_->register_as_listener (new_context->event_source_);
300 this->add_context (new_context);
302 new_context->unprotect ();
304 Context_def *td = unsmob_context_def (new_context->definition_);
306 /* This cannot move before add_context (), because \override
307 operations require that we are in the hierarchy. */
308 td->apply_default_property_operations (new_context);
309 apply_property_operations (new_context, ops);
311 send_stream_event (this, "AnnounceNewContext", 0,
312 ly_symbol2scm ("context"), new_context->self_scm (),
313 ly_symbol2scm ("creator"), sev);
316 vector<Context_def *>
317 Context::path_to_acceptable_context (SCM name) const
319 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
320 // but the Context_def expects to see elements of the form ('accepts symbol).
321 SCM accepts = SCM_EOL;
322 for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
323 if (scm_caar (s) == ly_symbol2scm ("accepts"))
325 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
326 accepts = scm_cons (elt, accepts);
329 return unsmob_context_def (definition_)->path_to_acceptable_context (name,
331 scm_reverse_x (accepts, SCM_EOL));
336 Context::create_context (Context_def *cdef,
341 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
342 iterator specific stuff from the Context class */
344 add_listener (GET_LISTENER (acknowledge_infant),
345 ly_symbol2scm ("AnnounceNewContext"));
346 /* The CreateContext creates a new context, and sends an announcement of the
347 new context through another event. That event will be stored in
348 infant_event_ to create a return value. */
349 send_stream_event (this, "CreateContext", 0,
350 ly_symbol2scm ("ops"), ops,
351 ly_symbol2scm ("type"), cdef->get_context_name (),
352 ly_symbol2scm ("id"), ly_string2scm (id));
354 remove_listener (GET_LISTENER (acknowledge_infant),
355 ly_symbol2scm ("AnnounceNewContext"));
357 assert (infant_event_);
358 SCM infant_scm = infant_event_->get_property ("context");
359 Context *infant = unsmob_context (infant_scm);
361 if (!infant || infant->get_parent_context () != this)
363 programming_error ("create_context: can't locate newly created context");
371 Default child context as a SCM string, or something else if there is
375 Context::default_child_context_name () const
377 return scm_is_pair (accepts_list_)
378 ? scm_car (accepts_list_)
383 Context::is_bottom_context () const
385 return !scm_is_symbol (default_child_context_name ());
389 Context::get_default_interpreter (string context_id)
391 if (!is_bottom_context ())
393 SCM nm = default_child_context_name ();
394 SCM st = find_context_def (get_output_def (), nm);
396 string name = ly_symbol2string (nm);
397 Context_def *t = unsmob_context_def (st);
400 warning (_f ("cannot find or create: `%s'", name.c_str ()));
401 t = unsmob_context_def (this->definition_);
404 Context *tg = create_context (t, context_id, SCM_EOL);
405 return tg->get_default_interpreter (context_id);
414 Context::where_defined (SCM sym, SCM *value) const
417 if (profile_property_accesses)
418 note_property_access (&context_property_lookup_table, sym);
421 if (properties_dict ()->try_retrieve (sym, value))
422 return (Context *)this;
424 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
428 return SCM_EOL when not found.
431 Context::internal_get_property (SCM sym) const
434 if (profile_property_accesses)
435 note_property_access (&context_property_lookup_table, sym);
439 if (properties_dict ()->try_retrieve (sym, &val))
443 return daddy_context_->internal_get_property (sym);
449 Called by the send_stream_event macro. props is a 0-terminated array of
450 properties and corresponding values, interleaved. This method should not
451 be called from any other place than the send_stream_event macro.
454 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
456 Stream_event *e = new Stream_event (make_event_class (type), origin);
457 for (int i = 0; props[i]; i += 2)
459 e->set_property (props[i], props[i + 1]);
461 event_source_->broadcast (e);
466 Context::is_alias (SCM sym) const
468 if (sym == ly_symbol2scm ("Bottom")
469 && !scm_is_pair (accepts_list_))
471 if (sym == unsmob_context_def (definition_)->get_context_name ())
474 return scm_c_memq (sym, aliases_) != SCM_BOOL_F;
478 Context::add_alias (SCM sym)
480 aliases_ = scm_cons (sym, aliases_);
483 /* we don't (yet) instrument context properties */
485 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
487 internal_set_property (sym, val);
491 Context::internal_set_property (SCM sym, SCM val)
493 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
495 if (do_internal_type_checking_global)
496 assert (type_check_ok);
499 properties_dict ()->set (sym, val);
503 TODO: look up to check whether we have inherited var?
506 Context::unset_property (SCM sym)
508 properties_dict ()->remove (sym);
511 IMPLEMENT_LISTENER (Context, change_parent);
513 Context::change_parent (SCM sev)
515 Stream_event *ev = unsmob_stream_event (sev);
516 Context *to = unsmob_context (ev->get_property ("context"));
518 disconnect_from_parent ();
519 to->add_context (this);
523 Die. The next GC sweep should take care of the actual death.
525 IMPLEMENT_LISTENER (Context, remove_context);
527 Context::remove_context (SCM)
529 /* ugh, the translator group should listen to RemoveContext events by itself */
530 Translator_group *impl = implementation ();
532 impl->disconnect_from_context ();
533 disconnect_from_parent ();
537 Context::disconnect_from_parent ()
539 daddy_context_->events_below_->unregister_as_listener (this->events_below_);
540 daddy_context_->context_list_ = scm_delq_x (this->self_scm (), daddy_context_->context_list_);
545 ID == "" means accept any ID.
548 find_context_below (Context *where,
551 if (where->is_alias (type))
553 if (id == "" || where->id_string () == id)
558 for (SCM s = where->children_contexts ();
559 !found && scm_is_pair (s); s = scm_cdr (s))
561 Context *tr = unsmob_context (scm_car (s));
563 found = find_context_below (tr, type, id);
570 Context::properties_as_alist () const
572 return properties_dict ()->to_alist ();
576 Context::context_name_symbol () const
578 Context_def *td = unsmob_context_def (definition_);
579 return td->get_context_name ();
583 Context::context_name () const
585 return ly_symbol2string (context_name_symbol ());
589 Context::get_score_context () const
592 return daddy_context_->get_score_context ();
598 Context::make_event_class (SCM event_type)
600 if (SCM_UNBNDP (ancestor_lookup_))
601 ancestor_lookup_ = get_global_context ()->ancestor_lookup_;
602 return scm_hashq_ref (ancestor_lookup_, event_type, SCM_EOL);
606 Context::get_output_def () const
608 return daddy_context_ ? daddy_context_->get_output_def () : 0;
616 Context::now_mom () const
618 Context const *p = this;
619 while (p->daddy_context_)
620 p = p->daddy_context_;
622 return p->now_mom ();
626 Context::print_smob (SCM s, SCM port, scm_print_state *)
628 Context *sc = (Context *) SCM_CELL_WORD_1 (s);
630 scm_puts ("#<", port);
631 scm_puts (sc->class_name (), port);
632 if (Context_def *d = unsmob_context_def (sc->definition_))
634 scm_puts (" ", port);
635 scm_display (d->get_context_name (), port);
638 if (!sc->id_string_.empty ())
640 scm_puts ("=", port);
641 scm_puts (sc->id_string_.c_str (), port);
644 scm_puts (" ", port);
646 scm_display (sc->context_list_, port);
647 scm_puts (" >", port);
653 Context::mark_smob (SCM sm)
655 Context *me = (Context *) SCM_CELL_WORD_1 (sm);
657 scm_gc_mark (me->context_list_);
658 scm_gc_mark (me->aliases_);
659 scm_gc_mark (me->definition_);
660 scm_gc_mark (me->definition_mods_);
661 scm_gc_mark (me->properties_scm_);
662 scm_gc_mark (me->accepts_list_);
664 if (me->implementation_)
665 scm_gc_mark (me->implementation_->self_scm ());
667 if (me->event_source_)
668 scm_gc_mark (me->event_source_->self_scm ());
670 if (me->events_below_)
671 scm_gc_mark (me->events_below_->self_scm ());
673 scm_gc_mark (me->ancestor_lookup_);
675 return me->properties_scm_;
678 IMPLEMENT_SMOBS (Context);
679 IMPLEMENT_DEFAULT_EQUAL_P (Context);
680 IMPLEMENT_TYPE_P (Context, "ly:context?");
683 Context::get_global_context () const
685 if (dynamic_cast<Global_context *> ((Context *) this))
686 return dynamic_cast<Global_context *> ((Context *) this);
689 return daddy_context_->get_global_context ();
691 programming_error ("no Global context");
696 Context::get_parent_context () const
698 return daddy_context_;
702 Ugh. Where to put this?
705 measure_length (Context const *context)
707 SCM l = context->get_property ("measureLength");
709 if (unsmob_moment (l))
710 length = unsmob_moment (l)->main_part_;
715 measure_position (Context const *context)
717 SCM sm = context->get_property ("measurePosition");
720 if (unsmob_moment (sm))
722 m = *unsmob_moment (sm);
724 if (m.main_part_ < Rational (0))
726 Rational length (measure_length (context));
727 while (m.main_part_ < Rational (0))
728 m.main_part_ += length;
735 /* Finds the measure position after a note of length DUR that
736 begins at the current measure position. */
738 measure_position (Context const *context, Duration const *dur)
740 Moment pos = measure_position (context);
741 Rational dur_length = dur ? dur->get_length () : Rational (0);
743 Moment end_pos = pos.grace_part_ < Rational (0)
744 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
745 : Moment (pos.main_part_ + dur_length, 0);
751 measure_number (Context const *context)
753 SCM barnum = context->get_property ("internalBarNumber");
754 SCM smp = context->get_property ("measurePosition");
756 int bn = robust_scm2int (barnum, 0);
757 Moment mp = robust_scm2moment (smp, Moment (0));
758 if (mp.main_part_ < Rational (0))
765 set_context_property_on_children (Context *trans, SCM sym, SCM val)
767 trans->set_property (sym, ly_deep_copy (val));
768 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
770 Context *trg = unsmob_context (scm_car (p));
771 set_context_property_on_children (trg, sym, ly_deep_copy (val));
776 melisma_busy (Context *tr)
778 SCM melisma_properties = tr->get_property ("melismaBusyProperties");
781 for (; !busy && scm_is_pair (melisma_properties);
782 melisma_properties = scm_cdr (melisma_properties))
783 busy = busy || to_boolean (tr->internal_get_property (scm_car (melisma_properties)));
789 check_repeat_count_visibility (Context const *context, SCM count)
791 SCM proc = context->get_property ("repeatCountVisibility");
792 return (ly_is_procedure (proc)
793 && to_boolean (scm_call_2 (proc,
795 context->self_scm ())));