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"
35 Context::is_removable () const
37 return scm_is_null (context_list_) && ! client_count_
38 && !dynamic_cast<Global_context const *> (daddy_context_);
42 Context::check_removal ()
44 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
46 Context *ctx = Context::unsmob (scm_car (p));
48 ctx->check_removal ();
49 if (ctx->is_removable ())
51 recurse_over_translators (ctx, &Translator::finalize,
52 &Translator_group::finalize,
54 send_stream_event (ctx, "RemoveContext", 0, 0);
60 Context::properties_dict () const
62 return Scheme_hash_table::unsmob (properties_scm_);
66 Context::add_context (Context *child)
68 context_list_ = ly_append2 (context_list_,
69 scm_cons (child->self_scm (), SCM_EOL));
71 child->daddy_context_ = this;
72 this->events_below_->register_as_listener (child->events_below_);
81 properties_scm_ = SCM_EOL;
82 accepts_list_ = SCM_EOL;
83 default_child_ = SCM_EOL;
84 context_list_ = SCM_EOL;
85 definition_ = SCM_EOL;
86 definition_mods_ = SCM_EOL;
92 Scheme_hash_table *tab = new Scheme_hash_table;
93 properties_scm_ = tab->unprotect ();
94 event_source_ = new Dispatcher ();
95 event_source_->unprotect ();
96 events_below_ = new Dispatcher ();
97 events_below_->unprotect ();
100 /* TODO: this shares code with find_create_context (). */
102 Context::create_unique_context (SCM name, const string &id, SCM operations)
105 Don't create multiple score contexts.
107 Global_context *gthis = dynamic_cast<Global_context *> (this);
108 if (gthis && gthis->get_score_context ())
109 return gthis->get_score_context ()->create_unique_context (name, id, operations);
111 vector<Context_def *> path = path_to_acceptable_context (name);
114 Context *current = this;
116 // Iterate through the path and create all of the implicit contexts.
117 for (vsize i = 0; i < path.size (); i++)
120 string id_str = "\\new";
121 if (i == path.size () - 1)
126 current = current->create_context (path[i],
135 Don't go up to Global_context, because global goes down to the
139 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
140 ret = daddy_context_->create_unique_context (name, id, operations);
143 warning (_f ("cannot find or create new `%s'",
144 ly_symbol2string (name).c_str ()));
151 Context::find_create_context (SCM n, const string &id, SCM operations)
154 Don't create multiple score contexts.
156 Global_context *gthis = dynamic_cast<Global_context *> (this);
159 if (gthis->get_score_context ())
160 return gthis->get_score_context ()->find_create_context (n, id, operations);
162 // Special case: If we use \set Timing.xxx = whatever before
163 // Score is established, the alias of Score to Timing will not
164 // be taken into account. We check for this particular case
165 // here. Aliases apart from Score-level ones don't warrant
166 // context creation as they could create unwanted contexts, like
167 // RhythmicVoice instead of Voice. Creating a Score context,
168 // however, can't really do anything wrong.
170 SCM score_name = default_child_context_name ();
171 SCM score_def = find_context_def (get_output_def (), score_name);
173 if (Context_def *cd = Context_def::unsmob (score_def))
175 if (cd->is_alias (n))
176 return create_context (cd, id, operations);
181 if (Context *existing = find_context_below (this, n, id))
184 if (scm_is_eq (n, ly_symbol2scm ("Bottom")))
186 Context *tg = get_default_interpreter (id);
190 vector<Context_def *> path = path_to_acceptable_context (n);
194 Context *current = this;
196 // start at 1. The first one (index 0) will be us.
197 for (vsize i = 0; i < path.size (); i++)
199 SCM ops = (i == path.size () - 1) ? operations : SCM_EOL;
202 if (i == path.size () - 1)
205 current = current->create_context (path[i],
214 Don't go up to Global_context, because global goes down to the
218 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
219 ret = daddy_context_->find_create_context (n, id, operations);
222 warning (_f ("cannot find or create `%s' called `%s'",
223 ly_symbol2string (n).c_str (), id));
230 Context::acknowledge_infant (SCM sev)
232 infant_event_ = Stream_event::unsmob (sev);
236 Context::set_property_from_event (SCM sev)
238 Stream_event *ev = Stream_event::unsmob (sev);
240 SCM sym = ev->get_property ("symbol");
241 if (scm_is_symbol (sym))
243 SCM val = ev->get_property ("value");
245 if (SCM_UNBNDP (val)) {
246 unset_property (sym);
251 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
254 set_property (sym, val);
259 Context::unset_property_from_event (SCM sev)
261 Stream_event *ev = Stream_event::unsmob (sev);
263 SCM sym = ev->get_property ("symbol");
264 type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
265 unset_property (sym);
269 Creates a new context from a CreateContext event, and sends an
270 AnnounceNewContext event to this context.
273 Context::create_context_from_event (SCM sev)
275 Stream_event *ev = Stream_event::unsmob (sev);
277 string id = ly_scm2string (ev->get_property ("id"));
278 SCM ops = ev->get_property ("ops");
279 SCM type_scm = ev->get_property ("type");
280 string type = ly_symbol2string (type_scm);
282 vector<Context_def *> path = path_to_acceptable_context (type_scm);
284 if (path.size () != 1)
286 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
289 Context_def *cdef = path[0];
291 Context *new_context = cdef->instantiate (ops);
293 new_context->id_string_ = id;
295 /* Register various listeners:
296 - Make the new context hear events that universally affect contexts
297 - connect events_below etc. properly */
298 /* We want to be the first ones to hear our own events. Therefore, wait
299 before registering events_below_ */
300 new_context->event_source ()->
301 add_listener (new_context->GET_LISTENER (Context, create_context_from_event),
302 ly_symbol2scm ("CreateContext"));
303 new_context->event_source ()->
304 add_listener (new_context->GET_LISTENER (Context, remove_context),
305 ly_symbol2scm ("RemoveContext"));
306 new_context->event_source ()->
307 add_listener (new_context->GET_LISTENER (Context, change_parent),
308 ly_symbol2scm ("ChangeParent"));
309 new_context->event_source ()->
310 add_listener (new_context->GET_LISTENER (Context, set_property_from_event),
311 ly_symbol2scm ("SetProperty"));
312 new_context->event_source ()->
313 add_listener (new_context->GET_LISTENER (Context, unset_property_from_event),
314 ly_symbol2scm ("UnsetProperty"));
316 new_context->events_below_->register_as_listener (new_context->event_source_);
317 this->add_context (new_context);
319 new_context->unprotect ();
321 Context_def *td = Context_def::unsmob (new_context->definition_);
323 /* This cannot move before add_context (), because \override
324 operations require that we are in the hierarchy. */
325 td->apply_default_property_operations (new_context);
326 apply_property_operations (new_context, ops);
328 send_stream_event (this, "AnnounceNewContext", 0,
329 ly_symbol2scm ("context"), new_context->self_scm (),
330 ly_symbol2scm ("creator"), sev);
333 vector<Context_def *>
334 Context::path_to_acceptable_context (SCM name) const
336 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
337 // but the Context_def expects to see elements of the form ('accepts symbol).
338 SCM accepts = SCM_EOL;
339 for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
340 if (scm_is_eq (scm_caar (s), ly_symbol2scm ("accepts")))
342 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
343 accepts = scm_cons (elt, accepts);
346 return Context_def::unsmob (definition_)->path_to_acceptable_context (name,
348 scm_reverse_x (accepts, SCM_EOL));
353 Context::create_context (Context_def *cdef,
358 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
359 iterator specific stuff from the Context class */
361 add_listener (GET_LISTENER (Context, acknowledge_infant),
362 ly_symbol2scm ("AnnounceNewContext"));
363 /* The CreateContext creates a new context, and sends an announcement of the
364 new context through another event. That event will be stored in
365 infant_event_ to create a return value. */
366 send_stream_event (this, "CreateContext", 0,
367 ly_symbol2scm ("ops"), ops,
368 ly_symbol2scm ("type"), cdef->get_context_name (),
369 ly_symbol2scm ("id"), ly_string2scm (id));
371 remove_listener (GET_LISTENER (Context, acknowledge_infant),
372 ly_symbol2scm ("AnnounceNewContext"));
374 assert (infant_event_);
375 SCM infant_scm = infant_event_->get_property ("context");
376 Context *infant = Context::unsmob (infant_scm);
378 if (!infant || infant->get_parent_context () != this)
380 programming_error ("create_context: can't locate newly created context");
388 Default child context as a SCM string, or something else if there is
392 Context::default_child_context_name () const
394 return default_child_;
398 Context::is_bottom_context () const
400 return !scm_is_symbol (default_child_context_name ());
404 Context::get_default_interpreter (const string &context_id)
406 if (!is_bottom_context ())
408 SCM nm = default_child_context_name ();
409 SCM st = find_context_def (get_output_def (), nm);
411 string name = ly_symbol2string (nm);
412 Context_def *t = Context_def::unsmob (st);
415 warning (_f ("cannot find or create: `%s'", name.c_str ()));
416 t = Context_def::unsmob (this->definition_);
418 if (scm_is_symbol (t->get_default_child (SCM_EOL)))
420 Context *tg = create_context (t, "\\new", SCM_EOL);
421 return tg->get_default_interpreter (context_id);
423 return create_context (t, context_id, SCM_EOL);
425 else if (!context_id.empty () && context_id != id_string ())
427 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
428 return daddy_context_->get_default_interpreter (context_id);
429 warning (_f ("cannot find or create new Bottom = \"%s\"",
430 context_id.c_str ()));
439 Context::where_defined (SCM sym, SCM *value) const
442 if (profile_property_accesses)
443 note_property_access (&context_property_lookup_table, sym);
446 if (properties_dict ()->try_retrieve (sym, value))
447 return (Context *)this;
449 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
452 /* Quick variant of where_defined. Checks only the context itself. */
455 Context::here_defined (SCM sym, SCM *value) const
458 if (profile_property_accesses)
459 note_property_access (&context_property_lookup_table, sym);
462 return properties_dict ()->try_retrieve (sym, value);
466 return SCM_EOL when not found.
469 Context::internal_get_property (SCM sym) const
472 if (profile_property_accesses)
473 note_property_access (&context_property_lookup_table, sym);
477 if (properties_dict ()->try_retrieve (sym, &val))
481 return daddy_context_->internal_get_property (sym);
487 Called by the send_stream_event macro. props is a 0-terminated array of
488 properties and corresponding values, interleaved. This method should not
489 be called from any other place than the send_stream_event macro.
492 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
494 Stream_event *e = new Stream_event
495 (scm_call_1 (ly_lily_module_constant ("ly:make-event-class"), type),
497 for (int i = 0; props[i]; i += 2)
499 e->set_property (props[i], props[i + 1]);
501 event_source_->broadcast (e);
506 Context::is_alias (SCM sym) const
508 if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
509 return is_bottom_context ();
510 if (scm_is_eq (sym, context_name_symbol ()))
513 return scm_is_true (scm_c_memq (sym, aliases_));
517 Context::add_alias (SCM sym)
519 aliases_ = scm_cons (sym, aliases_);
522 /* we don't (yet) instrument context properties */
524 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
526 internal_set_property (sym, val);
530 Context::internal_set_property (SCM sym, SCM val)
532 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
534 if (do_internal_type_checking_global)
535 assert (type_check_ok);
538 properties_dict ()->set (sym, val);
542 TODO: look up to check whether we have inherited var?
545 Context::unset_property (SCM sym)
547 properties_dict ()->remove (sym);
551 Context::change_parent (SCM sev)
553 Stream_event *ev = Stream_event::unsmob (sev);
554 Context *to = Context::unsmob (ev->get_property ("context"));
556 disconnect_from_parent ();
557 to->add_context (this);
561 Die. The next GC sweep should take care of the actual death.
564 Context::remove_context (SCM)
566 /* ugh, the translator group should listen to RemoveContext events by itself */
567 Translator_group *impl = implementation ();
569 impl->disconnect_from_context ();
570 disconnect_from_parent ();
574 Context::disconnect_from_parent ()
576 daddy_context_->events_below_->unregister_as_listener (this->events_below_);
577 daddy_context_->context_list_ = scm_delq_x (this->self_scm (), daddy_context_->context_list_);
582 ID == "" means accept any ID.
585 find_context_below (Context *where,
586 SCM type, const string &id)
588 if (where->is_alias (type))
590 if (id == "" || where->id_string () == id)
595 for (SCM s = where->children_contexts ();
596 !found && scm_is_pair (s); s = scm_cdr (s))
598 Context *tr = Context::unsmob (scm_car (s));
600 found = find_context_below (tr, type, id);
607 Context::properties_as_alist () const
609 return properties_dict ()->to_alist ();
613 Context::context_name_symbol () const
615 Context_def *td = Context_def::unsmob (definition_);
616 return td->get_context_name ();
620 Context::context_name () const
622 return ly_symbol2string (context_name_symbol ());
626 Context::get_score_context () const
629 return daddy_context_->get_score_context ();
635 Context::get_output_def () const
637 return daddy_context_ ? daddy_context_->get_output_def () : 0;
645 Context::now_mom () const
647 Context const *p = this;
648 while (p->daddy_context_)
649 p = p->daddy_context_;
651 return p->now_mom ();
655 Context::print_smob (SCM port, scm_print_state *)
657 scm_puts ("#<", port);
658 scm_puts (class_name (), port);
659 if (Context_def *d = Context_def::unsmob (definition_))
661 scm_puts (" ", port);
662 scm_display (d->get_context_name (), port);
665 if (!id_string_.empty ())
667 scm_puts ("=", port);
668 scm_puts (id_string_.c_str (), port);
671 scm_puts (" ", port);
673 scm_display (context_list_, port);
674 scm_puts (" >", port);
680 Context::mark_smob ()
682 scm_gc_mark (context_list_);
683 scm_gc_mark (aliases_);
684 scm_gc_mark (definition_);
685 scm_gc_mark (definition_mods_);
686 scm_gc_mark (properties_scm_);
687 scm_gc_mark (accepts_list_);
688 scm_gc_mark (default_child_);
691 scm_gc_mark (implementation_->self_scm ());
694 scm_gc_mark (event_source_->self_scm ());
697 scm_gc_mark (events_below_->self_scm ());
699 return properties_scm_;
702 const char Context::type_p_name_[] = "ly:context?";
705 Context::get_global_context () const
707 if (dynamic_cast<Global_context *> ((Context *) this))
708 return dynamic_cast<Global_context *> ((Context *) this);
711 return daddy_context_->get_global_context ();
713 programming_error ("no Global context");
718 Context::get_parent_context () const
720 return daddy_context_;
724 Ugh. Where to put this?
727 measure_length (Context const *context)
729 SCM l = context->get_property ("measureLength");
731 if (Moment::is_smob (l))
732 length = Moment::unsmob (l)->main_part_;
737 measure_position (Context const *context)
739 SCM sm = context->get_property ("measurePosition");
742 if (Moment::is_smob (sm))
744 m = *Moment::unsmob (sm);
746 if (m.main_part_ < Rational (0))
748 Rational length (measure_length (context));
749 while (m.main_part_ < Rational (0))
750 m.main_part_ += length;
757 /* Finds the measure position after a note of length DUR that
758 begins at the current measure position. */
760 measure_position (Context const *context, Duration const *dur)
762 Moment pos = measure_position (context);
763 Rational dur_length = dur ? dur->get_length () : Rational (0);
765 Moment end_pos = pos.grace_part_ < Rational (0)
766 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
767 : Moment (pos.main_part_ + dur_length, 0);
773 measure_number (Context const *context)
775 SCM barnum = context->get_property ("internalBarNumber");
776 SCM smp = context->get_property ("measurePosition");
778 int bn = robust_scm2int (barnum, 0);
779 Moment mp = robust_scm2moment (smp, Moment (0));
780 if (mp.main_part_ < Rational (0))
787 set_context_property_on_children (Context *trans, SCM sym, SCM val)
789 trans->set_property (sym, ly_deep_copy (val));
790 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
792 Context *trg = Context::unsmob (scm_car (p));
793 set_context_property_on_children (trg, sym, ly_deep_copy (val));
798 melisma_busy (Context *tr)
800 // When there are subcontexts, they are responsible for maintaining
802 SCM ch = tr->children_contexts ();
803 if (scm_is_pair (ch))
805 // all contexts need to have a busy melisma for this to evaluate
809 if (!melisma_busy (Context::unsmob (scm_car (ch))))
812 } while (scm_is_pair (ch));
816 for (SCM melisma_properties = tr->get_property ("melismaBusyProperties");
817 scm_is_pair (melisma_properties);
818 melisma_properties = scm_cdr (melisma_properties))
819 if (to_boolean (tr->get_property (scm_car (melisma_properties))))
826 check_repeat_count_visibility (Context const *context, SCM count)
828 SCM proc = context->get_property ("repeatCountVisibility");
829 return (ly_is_procedure (proc)
830 && to_boolean (scm_call_2 (proc,
832 context->self_scm ())));