2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2004--2015 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"
27 #include "output-def.hh"
29 #include "program-option.hh"
30 #include "scm-hash.hh"
31 #include "translator-group.hh"
33 #include "lily-imports.hh"
36 Context::is_removable () const
38 return scm_is_null (context_list_) && ! 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
54 Callback0_wrapper::make_smob
55 <Translator, &Translator::finalize> (),
56 Callback0_wrapper::make_smob
57 <Translator_group, &Translator_group::finalize> (),
59 send_stream_event (ctx, "RemoveContext", 0, 0);
65 Context::properties_dict () const
67 return unsmob<Scheme_hash_table> (properties_scm_);
71 Context::add_context (Context *child)
73 context_list_ = ly_append2 (context_list_,
74 scm_cons (child->self_scm (), SCM_EOL));
76 child->daddy_context_ = this;
77 events_below_->register_as_listener (child->events_below_);
86 properties_scm_ = SCM_EOL;
87 accepts_list_ = SCM_EOL;
88 default_child_ = SCM_EOL;
89 context_list_ = SCM_EOL;
90 definition_ = SCM_EOL;
91 definition_mods_ = SCM_EOL;
97 properties_scm_ = Scheme_hash_table::make_smob ();
98 event_source_ = new Dispatcher ();
99 event_source_->unprotect ();
100 events_below_ = new Dispatcher ();
101 events_below_->unprotect ();
104 /* TODO: this shares code with find_create_context (). */
106 Context::create_unique_context (SCM name, const string &id, SCM operations)
109 Don't create multiple score contexts.
111 Global_context *gthis = dynamic_cast<Global_context *> (this);
112 if (gthis && gthis->get_score_context ())
113 return gthis->get_score_context ()->create_unique_context (name, id, operations);
115 vector<Context_def *> path = path_to_acceptable_context (name);
118 Context *current = this;
120 // Iterate through the path and create all of the implicit contexts.
121 for (vsize i = 0; i < path.size (); i++)
124 string id_str = "\\new";
125 if (i == path.size () - 1)
130 current = current->create_context (path[i],
139 Don't go up to Global_context, because global goes down to the
143 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
144 ret = daddy_context_->create_unique_context (name, id, operations);
147 warning (_f ("cannot find or create new `%s'",
148 ly_symbol2string (name).c_str ()));
155 Context::find_create_context (SCM n, const string &id, SCM operations)
158 Don't create multiple score contexts.
160 Global_context *gthis = dynamic_cast<Global_context *> (this);
163 if (gthis->get_score_context ())
164 return gthis->get_score_context ()->find_create_context (n, id, operations);
166 // Special case: If we use \set Timing.xxx = whatever before
167 // Score is established, the alias of Score to Timing will not
168 // be taken into account. We check for this particular case
169 // here. Aliases apart from Score-level ones don't warrant
170 // context creation as they could create unwanted contexts, like
171 // RhythmicVoice instead of Voice. Creating a Score context,
172 // however, can't really do anything wrong.
174 SCM score_name = default_child_context_name ();
175 SCM score_def = find_context_def (get_output_def (), score_name);
177 if (Context_def *cd = unsmob<Context_def> (score_def))
179 if (cd->is_alias (n))
180 return create_context (cd, id, operations);
185 if (Context *existing = find_context_below (this, n, id))
188 if (scm_is_eq (n, ly_symbol2scm ("Bottom")))
190 Context *tg = get_default_interpreter (id);
194 vector<Context_def *> path = path_to_acceptable_context (n);
198 Context *current = this;
200 // start at 1. The first one (index 0) will be us.
201 for (vsize i = 0; i < path.size (); i++)
203 SCM ops = (i == path.size () - 1) ? operations : SCM_EOL;
206 if (i == path.size () - 1)
209 current = current->create_context (path[i],
218 Don't go up to Global_context, because global goes down to the
222 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
223 ret = daddy_context_->find_create_context (n, id, operations);
226 warning (_f ("cannot find or create `%s' called `%s'",
227 ly_symbol2string (n).c_str (), id));
234 Context::acknowledge_infant (SCM sev)
236 infant_event_ = unsmob<Stream_event> (sev);
240 Context::set_property_from_event (SCM sev)
242 Stream_event *ev = unsmob<Stream_event> (sev);
244 SCM sym = ev->get_property ("symbol");
245 if (scm_is_symbol (sym))
247 SCM val = ev->get_property ("value");
249 if (SCM_UNBNDP (val)) {
250 unset_property (sym);
255 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
259 if (to_boolean (ev->get_property ("once")))
261 if (Global_context *g = get_global_context ())
263 SCM old_val = SCM_UNDEFINED;
264 if (here_defined (sym, &old_val))
265 g->add_finalization (scm_list_4 (ly_context_set_property_x_proc,
270 g->add_finalization (scm_list_3 (ly_context_unset_property_proc,
275 set_property (sym, val);
281 Context::unset_property_from_event (SCM sev)
283 Stream_event *ev = unsmob<Stream_event> (sev);
285 SCM sym = ev->get_property ("symbol");
286 bool ok = type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
290 if (to_boolean (ev->get_property ("once")))
292 if (Global_context *g = get_global_context ())
294 SCM old_val = SCM_UNDEFINED;
295 if (here_defined (sym, &old_val))
296 g->add_finalization (scm_list_4 (ly_context_set_property_x_proc,
301 g->add_finalization (scm_list_3 (ly_context_unset_property_proc,
306 unset_property (sym);
311 Creates a new context from a CreateContext event, and sends an
312 AnnounceNewContext event to this context.
315 Context::create_context_from_event (SCM sev)
317 Stream_event *ev = unsmob<Stream_event> (sev);
319 string id = ly_scm2string (ev->get_property ("id"));
320 SCM ops = ev->get_property ("ops");
321 SCM type_scm = ev->get_property ("type");
322 string type = ly_symbol2string (type_scm);
324 vector<Context_def *> path = path_to_acceptable_context (type_scm);
326 if (path.size () != 1)
328 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
331 Context_def *cdef = path[0];
333 Context *new_context = cdef->instantiate (ops);
335 new_context->id_string_ = id;
337 /* Register various listeners:
338 - Make the new context hear events that universally affect contexts
339 - connect events_below etc. properly */
340 /* We want to be the first ones to hear our own events. Therefore, wait
341 before registering events_below_ */
342 new_context->event_source ()->
343 add_listener (new_context->GET_LISTENER (Context, create_context_from_event),
344 ly_symbol2scm ("CreateContext"));
345 new_context->event_source ()->
346 add_listener (new_context->GET_LISTENER (Context, remove_context),
347 ly_symbol2scm ("RemoveContext"));
348 new_context->event_source ()->
349 add_listener (new_context->GET_LISTENER (Context, change_parent),
350 ly_symbol2scm ("ChangeParent"));
351 new_context->event_source ()->
352 add_listener (new_context->GET_LISTENER (Context, set_property_from_event),
353 ly_symbol2scm ("SetProperty"));
354 new_context->event_source ()->
355 add_listener (new_context->GET_LISTENER (Context, unset_property_from_event),
356 ly_symbol2scm ("UnsetProperty"));
358 new_context->events_below_->register_as_listener (new_context->event_source_);
359 add_context (new_context);
361 new_context->unprotect ();
363 Context_def *td = unsmob<Context_def> (new_context->definition_);
365 /* This cannot move before add_context (), because \override
366 operations require that we are in the hierarchy. */
367 td->apply_default_property_operations (new_context);
368 apply_property_operations (new_context, ops);
370 send_stream_event (this, "AnnounceNewContext", 0,
371 ly_symbol2scm ("context"), new_context->self_scm (),
372 ly_symbol2scm ("creator"), sev);
375 vector<Context_def *>
376 Context::path_to_acceptable_context (SCM name) const
378 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
379 // but the Context_def expects to see elements of the form ('accepts symbol).
380 SCM accepts = SCM_EOL;
381 for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
382 if (scm_is_eq (scm_caar (s), ly_symbol2scm ("accepts")))
384 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
385 accepts = scm_cons (elt, accepts);
388 return unsmob<Context_def> (definition_)->path_to_acceptable_context (name,
390 scm_reverse_x (accepts, SCM_EOL));
395 Context::create_context (Context_def *cdef,
400 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
401 iterator specific stuff from the Context class */
403 add_listener (GET_LISTENER (Context, acknowledge_infant),
404 ly_symbol2scm ("AnnounceNewContext"));
405 /* The CreateContext creates a new context, and sends an announcement of the
406 new context through another event. That event will be stored in
407 infant_event_ to create a return value. */
408 send_stream_event (this, "CreateContext", 0,
409 ly_symbol2scm ("ops"), ops,
410 ly_symbol2scm ("type"), cdef->get_context_name (),
411 ly_symbol2scm ("id"), ly_string2scm (id));
413 remove_listener (GET_LISTENER (Context, acknowledge_infant),
414 ly_symbol2scm ("AnnounceNewContext"));
416 assert (infant_event_);
417 SCM infant_scm = infant_event_->get_property ("context");
418 Context *infant = unsmob<Context> (infant_scm);
420 if (!infant || infant->get_parent_context () != this)
422 programming_error ("create_context: can't locate newly created context");
430 Default child context as a SCM string, or something else if there is
434 Context::default_child_context_name () const
436 return default_child_;
440 Context::is_bottom_context () const
442 return !scm_is_symbol (default_child_context_name ());
446 Context::get_default_interpreter (const string &context_id)
448 if (!is_bottom_context ())
450 SCM nm = default_child_context_name ();
451 SCM st = find_context_def (get_output_def (), nm);
453 string name = ly_symbol2string (nm);
454 Context_def *t = unsmob<Context_def> (st);
457 warning (_f ("cannot find or create: `%s'", name.c_str ()));
458 t = unsmob<Context_def> (definition_);
460 if (scm_is_symbol (t->get_default_child (SCM_EOL)))
462 Context *tg = create_context (t, "\\new", SCM_EOL);
463 return tg->get_default_interpreter (context_id);
465 return create_context (t, context_id, SCM_EOL);
467 else if (!context_id.empty () && context_id != id_string ())
469 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
470 return daddy_context_->get_default_interpreter (context_id);
471 warning (_f ("cannot find or create new Bottom = \"%s\"",
472 context_id.c_str ()));
481 Context::where_defined (SCM sym, SCM *value) const
484 if (profile_property_accesses)
485 note_property_access (&context_property_lookup_table, sym);
488 if (properties_dict ()->try_retrieve (sym, value))
489 return (Context *)this;
491 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
494 /* Quick variant of where_defined. Checks only the context itself. */
497 Context::here_defined (SCM sym, SCM *value) const
500 if (profile_property_accesses)
501 note_property_access (&context_property_lookup_table, sym);
504 return properties_dict ()->try_retrieve (sym, value);
508 return SCM_EOL when not found.
511 Context::internal_get_property (SCM sym) const
514 if (profile_property_accesses)
515 note_property_access (&context_property_lookup_table, sym);
519 if (properties_dict ()->try_retrieve (sym, &val))
523 return daddy_context_->internal_get_property (sym);
529 Called by the send_stream_event macro. props is a 0-terminated array of
530 properties and corresponding values, interleaved. This method should not
531 be called from any other place than the send_stream_event macro.
534 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
536 Stream_event *e = new Stream_event (Lily::ly_make_event_class (type), origin);
537 for (int i = 0; props[i]; i += 2)
539 e->set_property (props[i], props[i + 1]);
541 event_source_->broadcast (e);
546 Context::is_alias (SCM sym) const
548 if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
549 return is_bottom_context ();
550 if (scm_is_eq (sym, context_name_symbol ()))
553 return scm_is_true (scm_c_memq (sym, aliases_));
557 Context::add_alias (SCM sym)
559 aliases_ = scm_cons (sym, aliases_);
562 /* we don't (yet) instrument context properties */
564 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
566 internal_set_property (sym, val);
570 Context::internal_set_property (SCM sym, SCM val)
572 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
574 if (do_internal_type_checking_global)
575 assert (type_check_ok);
578 properties_dict ()->set (sym, val);
582 TODO: look up to check whether we have inherited var?
585 Context::unset_property (SCM sym)
587 properties_dict ()->remove (sym);
591 Context::change_parent (SCM sev)
593 Stream_event *ev = unsmob<Stream_event> (sev);
594 Context *to = unsmob<Context> (ev->get_property ("context"));
596 disconnect_from_parent ();
597 to->add_context (this);
601 Die. The next GC sweep should take care of the actual death.
604 Context::remove_context (SCM)
606 /* ugh, the translator group should listen to RemoveContext events by itself */
607 Translator_group *impl = implementation ();
609 impl->disconnect_from_context ();
610 disconnect_from_parent ();
614 Context::disconnect_from_parent ()
616 daddy_context_->events_below_->unregister_as_listener (events_below_);
617 daddy_context_->context_list_ = scm_delq_x (self_scm (), daddy_context_->context_list_);
622 find_context_above (Context *where, SCM type)
624 while (where && !where->is_alias (type))
625 where = where->get_parent_context ();
631 find_context_above_by_parent_type (Context *where, SCM parent_type)
633 for (Context *child = 0; where;
634 child = where, where = where->get_parent_context ())
635 if (where->is_alias (parent_type))
642 find_context_below (Context *where,
643 SCM type, const string &id)
645 if (where->is_alias (type))
647 if (id == "" || where->id_string () == id)
652 for (SCM s = where->children_contexts ();
653 !found && scm_is_pair (s); s = scm_cdr (s))
655 Context *tr = unsmob<Context> (scm_car (s));
657 found = find_context_below (tr, type, id);
664 find_context_near (Context *where,
665 SCM type, const string &id)
667 for ( ; where; where = where->get_parent_context ())
669 Context *found = find_context_below (where, type, id);
678 find_top_context (Context *where)
680 Context *top = where;
681 for ( ; where; where = where->get_parent_context())
687 Context::properties_as_alist () const
689 return properties_dict ()->to_alist ();
693 Context::context_name_symbol () const
695 Context_def *td = unsmob<Context_def> (definition_);
696 return td->get_context_name ();
700 Context::context_name () const
702 return ly_symbol2string (context_name_symbol ());
706 Context::get_score_context () const
709 return daddy_context_->get_score_context ();
715 Context::get_output_def () const
717 return daddy_context_ ? daddy_context_->get_output_def () : 0;
725 Context::now_mom () const
727 Context const *p = this;
728 while (p->daddy_context_)
729 p = p->daddy_context_;
731 return p->now_mom ();
735 Context::print_smob (SCM port, scm_print_state *) const
737 scm_puts ("#<", port);
738 scm_puts (class_name (), port);
739 if (Context_def *d = unsmob<Context_def> (definition_))
741 scm_puts (" ", port);
742 scm_display (d->get_context_name (), port);
745 if (!id_string_.empty ())
747 scm_puts ("=", port);
748 scm_puts (id_string_.c_str (), port);
751 scm_puts (" ", port);
753 scm_display (context_list_, port);
754 scm_puts (" >", port);
760 Context::derived_mark () const
765 Context::mark_smob () const
767 scm_gc_mark (context_list_);
768 scm_gc_mark (aliases_);
769 scm_gc_mark (definition_);
770 scm_gc_mark (definition_mods_);
771 scm_gc_mark (properties_scm_);
772 scm_gc_mark (accepts_list_);
773 scm_gc_mark (default_child_);
776 scm_gc_mark (implementation_->self_scm ());
779 scm_gc_mark (event_source_->self_scm ());
782 scm_gc_mark (events_below_->self_scm ());
786 return properties_scm_;
789 const char * const Context::type_p_name_ = "ly:context?";
792 Context::get_global_context () const
794 if (dynamic_cast<Global_context *> ((Context *) this))
795 return dynamic_cast<Global_context *> ((Context *) this);
798 return daddy_context_->get_global_context ();
800 programming_error ("no Global context");
805 Context::get_parent_context () const
807 return daddy_context_;
811 Ugh. Where to put this?
814 measure_length (Context const *context)
816 SCM l = context->get_property ("measureLength");
818 if (unsmob<Moment> (l))
819 length = unsmob<Moment> (l)->main_part_;
824 measure_position (Context const *context)
826 SCM sm = context->get_property ("measurePosition");
829 if (unsmob<Moment> (sm))
831 m = *unsmob<Moment> (sm);
833 if (m.main_part_ < Rational (0))
835 Rational length (measure_length (context));
836 while (m.main_part_ < Rational (0))
837 m.main_part_ += length;
844 /* Finds the measure position after a note of length DUR that
845 begins at the current measure position. */
847 measure_position (Context const *context, Duration const *dur)
849 Moment pos = measure_position (context);
850 Rational dur_length = dur ? dur->get_length () : Rational (0);
852 Moment end_pos = pos.grace_part_ < Rational (0)
853 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
854 : Moment (pos.main_part_ + dur_length, 0);
860 measure_number (Context const *context)
862 SCM barnum = context->get_property ("internalBarNumber");
863 SCM smp = context->get_property ("measurePosition");
865 int bn = robust_scm2int (barnum, 0);
866 Moment mp = robust_scm2moment (smp, Moment (0));
867 if (mp.main_part_ < Rational (0))
874 set_context_property_on_children (Context *trans, SCM sym, SCM val)
876 trans->set_property (sym, ly_deep_copy (val));
877 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
879 Context *trg = unsmob<Context> (scm_car (p));
880 set_context_property_on_children (trg, sym, ly_deep_copy (val));
885 melisma_busy (Context *tr)
887 // When there are subcontexts, they are responsible for maintaining
889 SCM ch = tr->children_contexts ();
890 if (scm_is_pair (ch))
892 // all contexts need to have a busy melisma for this to evaluate
896 if (!melisma_busy (unsmob<Context> (scm_car (ch))))
899 } while (scm_is_pair (ch));
903 for (SCM melisma_properties = tr->get_property ("melismaBusyProperties");
904 scm_is_pair (melisma_properties);
905 melisma_properties = scm_cdr (melisma_properties))
906 if (to_boolean (tr->get_property (scm_car (melisma_properties))))
913 check_repeat_count_visibility (Context const *context, SCM count)
915 SCM proc = context->get_property ("repeatCountVisibility");
916 return (ly_is_procedure (proc)
917 && to_boolean (scm_call_2 (proc,
919 context->self_scm ())));