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"
39 Context::is_removable () const
41 return scm_is_null (context_list_) && ! client_count_
42 && !dynamic_cast<Global_context const *> (daddy_context_);
46 Context::check_removal ()
48 for (SCM p = context_list_; scm_is_pair (p); p = scm_cdr (p))
50 Context *ctx = unsmob<Context> (scm_car (p));
52 ctx->check_removal ();
53 if (ctx->is_removable ())
55 recurse_over_translators (ctx, &Translator::finalize,
56 &Translator_group::finalize,
58 send_stream_event (ctx, "RemoveContext", 0, 0);
64 Context::properties_dict () const
66 return unsmob<Scheme_hash_table> (properties_scm_);
70 Context::add_context (Context *child)
72 context_list_ = ly_append2 (context_list_,
73 scm_cons (child->self_scm (), SCM_EOL));
75 child->daddy_context_ = this;
76 events_below_->register_as_listener (child->events_below_);
85 properties_scm_ = SCM_EOL;
86 accepts_list_ = SCM_EOL;
87 default_child_ = SCM_EOL;
88 context_list_ = SCM_EOL;
89 definition_ = SCM_EOL;
90 definition_mods_ = SCM_EOL;
96 Scheme_hash_table *tab = new Scheme_hash_table;
97 properties_scm_ = tab->unprotect ();
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?"));
258 set_property (sym, val);
263 Context::unset_property_from_event (SCM sev)
265 Stream_event *ev = unsmob<Stream_event> (sev);
267 SCM sym = ev->get_property ("symbol");
268 type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
269 unset_property (sym);
273 Creates a new context from a CreateContext event, and sends an
274 AnnounceNewContext event to this context.
277 Context::create_context_from_event (SCM sev)
279 Stream_event *ev = unsmob<Stream_event> (sev);
281 string id = ly_scm2string (ev->get_property ("id"));
282 SCM ops = ev->get_property ("ops");
283 SCM type_scm = ev->get_property ("type");
284 string type = ly_symbol2string (type_scm);
286 vector<Context_def *> path = path_to_acceptable_context (type_scm);
288 if (path.size () != 1)
290 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
293 Context_def *cdef = path[0];
295 Context *new_context = cdef->instantiate (ops);
297 new_context->id_string_ = id;
299 /* Register various listeners:
300 - Make the new context hear events that universally affect contexts
301 - connect events_below etc. properly */
302 /* We want to be the first ones to hear our own events. Therefore, wait
303 before registering events_below_ */
304 new_context->event_source ()->
305 add_listener (new_context->GET_LISTENER (Context, create_context_from_event),
306 ly_symbol2scm ("CreateContext"));
307 new_context->event_source ()->
308 add_listener (new_context->GET_LISTENER (Context, remove_context),
309 ly_symbol2scm ("RemoveContext"));
310 new_context->event_source ()->
311 add_listener (new_context->GET_LISTENER (Context, change_parent),
312 ly_symbol2scm ("ChangeParent"));
313 new_context->event_source ()->
314 add_listener (new_context->GET_LISTENER (Context, set_property_from_event),
315 ly_symbol2scm ("SetProperty"));
316 new_context->event_source ()->
317 add_listener (new_context->GET_LISTENER (Context, unset_property_from_event),
318 ly_symbol2scm ("UnsetProperty"));
320 new_context->events_below_->register_as_listener (new_context->event_source_);
321 add_context (new_context);
323 new_context->unprotect ();
325 Context_def *td = unsmob<Context_def> (new_context->definition_);
327 /* This cannot move before add_context (), because \override
328 operations require that we are in the hierarchy. */
329 td->apply_default_property_operations (new_context);
330 apply_property_operations (new_context, ops);
332 send_stream_event (this, "AnnounceNewContext", 0,
333 ly_symbol2scm ("context"), new_context->self_scm (),
334 ly_symbol2scm ("creator"), sev);
337 vector<Context_def *>
338 Context::path_to_acceptable_context (SCM name) const
340 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
341 // but the Context_def expects to see elements of the form ('accepts symbol).
342 SCM accepts = SCM_EOL;
343 for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
344 if (scm_is_eq (scm_caar (s), ly_symbol2scm ("accepts")))
346 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
347 accepts = scm_cons (elt, accepts);
350 return unsmob<Context_def> (definition_)->path_to_acceptable_context (name,
352 scm_reverse_x (accepts, SCM_EOL));
357 Context::create_context (Context_def *cdef,
362 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
363 iterator specific stuff from the Context class */
365 add_listener (GET_LISTENER (Context, acknowledge_infant),
366 ly_symbol2scm ("AnnounceNewContext"));
367 /* The CreateContext creates a new context, and sends an announcement of the
368 new context through another event. That event will be stored in
369 infant_event_ to create a return value. */
370 send_stream_event (this, "CreateContext", 0,
371 ly_symbol2scm ("ops"), ops,
372 ly_symbol2scm ("type"), cdef->get_context_name (),
373 ly_symbol2scm ("id"), ly_string2scm (id));
375 remove_listener (GET_LISTENER (Context, acknowledge_infant),
376 ly_symbol2scm ("AnnounceNewContext"));
378 assert (infant_event_);
379 SCM infant_scm = infant_event_->get_property ("context");
380 Context *infant = unsmob<Context> (infant_scm);
382 if (!infant || infant->get_parent_context () != this)
384 programming_error ("create_context: can't locate newly created context");
392 Default child context as a SCM string, or something else if there is
396 Context::default_child_context_name () const
398 return default_child_;
402 Context::is_bottom_context () const
404 return !scm_is_symbol (default_child_context_name ());
408 Context::get_default_interpreter (const string &context_id)
410 if (!is_bottom_context ())
412 SCM nm = default_child_context_name ();
413 SCM st = find_context_def (get_output_def (), nm);
415 string name = ly_symbol2string (nm);
416 Context_def *t = unsmob<Context_def> (st);
419 warning (_f ("cannot find or create: `%s'", name.c_str ()));
420 t = unsmob<Context_def> (definition_);
422 if (scm_is_symbol (t->get_default_child (SCM_EOL)))
424 Context *tg = create_context (t, "\\new", SCM_EOL);
425 return tg->get_default_interpreter (context_id);
427 return create_context (t, context_id, SCM_EOL);
429 else if (!context_id.empty () && context_id != id_string ())
431 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
432 return daddy_context_->get_default_interpreter (context_id);
433 warning (_f ("cannot find or create new Bottom = \"%s\"",
434 context_id.c_str ()));
443 Context::where_defined (SCM sym, SCM *value) const
446 if (profile_property_accesses)
447 note_property_access (&context_property_lookup_table, sym);
450 if (properties_dict ()->try_retrieve (sym, value))
451 return (Context *)this;
453 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
456 /* Quick variant of where_defined. Checks only the context itself. */
459 Context::here_defined (SCM sym, SCM *value) const
462 if (profile_property_accesses)
463 note_property_access (&context_property_lookup_table, sym);
466 return properties_dict ()->try_retrieve (sym, value);
470 return SCM_EOL when not found.
473 Context::internal_get_property (SCM sym) const
476 if (profile_property_accesses)
477 note_property_access (&context_property_lookup_table, sym);
481 if (properties_dict ()->try_retrieve (sym, &val))
485 return daddy_context_->internal_get_property (sym);
491 Called by the send_stream_event macro. props is a 0-terminated array of
492 properties and corresponding values, interleaved. This method should not
493 be called from any other place than the send_stream_event macro.
496 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
498 Stream_event *e = new Stream_event (Lily::ly_make_event_class (type), origin);
499 for (int i = 0; props[i]; i += 2)
501 e->set_property (props[i], props[i + 1]);
503 event_source_->broadcast (e);
508 Context::is_alias (SCM sym) const
510 if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
511 return is_bottom_context ();
512 if (scm_is_eq (sym, context_name_symbol ()))
515 return scm_is_true (scm_c_memq (sym, aliases_));
519 Context::add_alias (SCM sym)
521 aliases_ = scm_cons (sym, aliases_);
524 /* we don't (yet) instrument context properties */
526 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
528 internal_set_property (sym, val);
532 Context::internal_set_property (SCM sym, SCM val)
534 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
536 if (do_internal_type_checking_global)
537 assert (type_check_ok);
540 properties_dict ()->set (sym, val);
544 TODO: look up to check whether we have inherited var?
547 Context::unset_property (SCM sym)
549 properties_dict ()->remove (sym);
553 Context::change_parent (SCM sev)
555 Stream_event *ev = unsmob<Stream_event> (sev);
556 Context *to = unsmob<Context> (ev->get_property ("context"));
558 disconnect_from_parent ();
559 to->add_context (this);
563 Die. The next GC sweep should take care of the actual death.
566 Context::remove_context (SCM)
568 /* ugh, the translator group should listen to RemoveContext events by itself */
569 Translator_group *impl = implementation ();
571 impl->disconnect_from_context ();
572 disconnect_from_parent ();
576 Context::disconnect_from_parent ()
578 daddy_context_->events_below_->unregister_as_listener (events_below_);
579 daddy_context_->context_list_ = scm_delq_x (self_scm (), daddy_context_->context_list_);
584 find_context_above (Context *where, SCM type)
586 while (where && !where->is_alias (type))
587 where = where->get_parent_context ();
593 find_context_above_by_parent_type (Context *where, SCM parent_type)
595 for (Context *child = 0; where;
596 child = where, where = where->get_parent_context ())
597 if (where->is_alias (parent_type))
604 find_context_below (Context *where,
605 SCM type, const string &id)
607 if (where->is_alias (type))
609 if (id == "" || where->id_string () == id)
614 for (SCM s = where->children_contexts ();
615 !found && scm_is_pair (s); s = scm_cdr (s))
617 Context *tr = unsmob<Context> (scm_car (s));
619 found = find_context_below (tr, type, id);
626 find_context_near (Context *where,
627 SCM type, const string &id)
629 for ( ; where; where = where->get_parent_context ())
631 Context *found = find_context_below (where, type, id);
640 find_top_context (Context *where)
642 Context *top = where;
643 for ( ; where; where = where->get_parent_context())
649 Context::properties_as_alist () const
651 return properties_dict ()->to_alist ();
655 Context::context_name_symbol () const
657 Context_def *td = unsmob<Context_def> (definition_);
658 return td->get_context_name ();
662 Context::context_name () const
664 return ly_symbol2string (context_name_symbol ());
668 Context::get_score_context () const
671 return daddy_context_->get_score_context ();
677 Context::get_output_def () const
679 return daddy_context_ ? daddy_context_->get_output_def () : 0;
687 Context::now_mom () const
689 Context const *p = this;
690 while (p->daddy_context_)
691 p = p->daddy_context_;
693 return p->now_mom ();
697 Context::print_smob (SCM port, scm_print_state *) const
699 scm_puts ("#<", port);
700 scm_puts (class_name (), port);
701 if (Context_def *d = unsmob<Context_def> (definition_))
703 scm_puts (" ", port);
704 scm_display (d->get_context_name (), port);
707 if (!id_string_.empty ())
709 scm_puts ("=", port);
710 scm_puts (id_string_.c_str (), port);
713 scm_puts (" ", port);
715 scm_display (context_list_, port);
716 scm_puts (" >", port);
722 Context::mark_smob () const
724 scm_gc_mark (context_list_);
725 scm_gc_mark (aliases_);
726 scm_gc_mark (definition_);
727 scm_gc_mark (definition_mods_);
728 scm_gc_mark (properties_scm_);
729 scm_gc_mark (accepts_list_);
730 scm_gc_mark (default_child_);
733 scm_gc_mark (implementation_->self_scm ());
736 scm_gc_mark (event_source_->self_scm ());
739 scm_gc_mark (events_below_->self_scm ());
741 return properties_scm_;
744 const char Context::type_p_name_[] = "ly:context?";
747 Context::get_global_context () const
749 if (dynamic_cast<Global_context *> ((Context *) this))
750 return dynamic_cast<Global_context *> ((Context *) this);
753 return daddy_context_->get_global_context ();
755 programming_error ("no Global context");
760 Context::get_parent_context () const
762 return daddy_context_;
766 Ugh. Where to put this?
769 measure_length (Context const *context)
771 SCM l = context->get_property ("measureLength");
773 if (unsmob<Moment> (l))
774 length = unsmob<Moment> (l)->main_part_;
779 measure_position (Context const *context)
781 SCM sm = context->get_property ("measurePosition");
784 if (unsmob<Moment> (sm))
786 m = *unsmob<Moment> (sm);
788 if (m.main_part_ < Rational (0))
790 Rational length (measure_length (context));
791 while (m.main_part_ < Rational (0))
792 m.main_part_ += length;
799 /* Finds the measure position after a note of length DUR that
800 begins at the current measure position. */
802 measure_position (Context const *context, Duration const *dur)
804 Moment pos = measure_position (context);
805 Rational dur_length = dur ? dur->get_length () : Rational (0);
807 Moment end_pos = pos.grace_part_ < Rational (0)
808 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
809 : Moment (pos.main_part_ + dur_length, 0);
815 measure_number (Context const *context)
817 SCM barnum = context->get_property ("internalBarNumber");
818 SCM smp = context->get_property ("measurePosition");
820 int bn = robust_scm2int (barnum, 0);
821 Moment mp = robust_scm2moment (smp, Moment (0));
822 if (mp.main_part_ < Rational (0))
829 set_context_property_on_children (Context *trans, SCM sym, SCM val)
831 trans->set_property (sym, ly_deep_copy (val));
832 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
834 Context *trg = unsmob<Context> (scm_car (p));
835 set_context_property_on_children (trg, sym, ly_deep_copy (val));
840 melisma_busy (Context *tr)
842 // When there are subcontexts, they are responsible for maintaining
844 SCM ch = tr->children_contexts ();
845 if (scm_is_pair (ch))
847 // all contexts need to have a busy melisma for this to evaluate
851 if (!melisma_busy (unsmob<Context> (scm_car (ch))))
854 } while (scm_is_pair (ch));
858 for (SCM melisma_properties = tr->get_property ("melismaBusyProperties");
859 scm_is_pair (melisma_properties);
860 melisma_properties = scm_cdr (melisma_properties))
861 if (to_boolean (tr->get_property (scm_car (melisma_properties))))
868 check_repeat_count_visibility (Context const *context, SCM count)
870 SCM proc = context->get_property ("repeatCountVisibility");
871 return (ly_is_procedure (proc)
872 && to_boolean (scm_call_2 (proc,
874 context->self_scm ())));