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 (ctx, &Translator::finalize,
53 &Translator_group::finalize,
55 send_stream_event (ctx, "RemoveContext", 0, 0);
61 Context::properties_dict () const
63 return unsmob<Scheme_hash_table> (properties_scm_);
67 Context::add_context (Context *child)
69 context_list_ = ly_append2 (context_list_,
70 scm_cons (child->self_scm (), SCM_EOL));
72 child->daddy_context_ = this;
73 events_below_->register_as_listener (child->events_below_);
82 properties_scm_ = SCM_EOL;
83 accepts_list_ = SCM_EOL;
84 default_child_ = SCM_EOL;
85 context_list_ = SCM_EOL;
86 definition_ = SCM_EOL;
87 definition_mods_ = SCM_EOL;
93 Scheme_hash_table *tab = new Scheme_hash_table;
94 properties_scm_ = tab->unprotect ();
95 event_source_ = new Dispatcher ();
96 event_source_->unprotect ();
97 events_below_ = new Dispatcher ();
98 events_below_->unprotect ();
101 /* TODO: this shares code with find_create_context (). */
103 Context::create_unique_context (SCM name, const string &id, SCM operations)
106 Don't create multiple score contexts.
108 Global_context *gthis = dynamic_cast<Global_context *> (this);
109 if (gthis && gthis->get_score_context ())
110 return gthis->get_score_context ()->create_unique_context (name, id, operations);
112 vector<Context_def *> path = path_to_acceptable_context (name);
115 Context *current = this;
117 // Iterate through the path and create all of the implicit contexts.
118 for (vsize i = 0; i < path.size (); i++)
121 string id_str = "\\new";
122 if (i == path.size () - 1)
127 current = current->create_context (path[i],
136 Don't go up to Global_context, because global goes down to the
140 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
141 ret = daddy_context_->create_unique_context (name, id, operations);
144 warning (_f ("cannot find or create new `%s'",
145 ly_symbol2string (name).c_str ()));
152 Context::find_create_context (SCM n, const string &id, SCM operations)
155 Don't create multiple score contexts.
157 Global_context *gthis = dynamic_cast<Global_context *> (this);
160 if (gthis->get_score_context ())
161 return gthis->get_score_context ()->find_create_context (n, id, operations);
163 // Special case: If we use \set Timing.xxx = whatever before
164 // Score is established, the alias of Score to Timing will not
165 // be taken into account. We check for this particular case
166 // here. Aliases apart from Score-level ones don't warrant
167 // context creation as they could create unwanted contexts, like
168 // RhythmicVoice instead of Voice. Creating a Score context,
169 // however, can't really do anything wrong.
171 SCM score_name = default_child_context_name ();
172 SCM score_def = find_context_def (get_output_def (), score_name);
174 if (Context_def *cd = unsmob<Context_def> (score_def))
176 if (cd->is_alias (n))
177 return create_context (cd, id, operations);
182 if (Context *existing = find_context_below (this, n, id))
185 if (scm_is_eq (n, ly_symbol2scm ("Bottom")))
187 Context *tg = get_default_interpreter (id);
191 vector<Context_def *> path = path_to_acceptable_context (n);
195 Context *current = this;
197 // start at 1. The first one (index 0) will be us.
198 for (vsize i = 0; i < path.size (); i++)
200 SCM ops = (i == path.size () - 1) ? operations : SCM_EOL;
203 if (i == path.size () - 1)
206 current = current->create_context (path[i],
215 Don't go up to Global_context, because global goes down to the
219 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
220 ret = daddy_context_->find_create_context (n, id, operations);
223 warning (_f ("cannot find or create `%s' called `%s'",
224 ly_symbol2string (n).c_str (), id));
231 Context::acknowledge_infant (SCM sev)
233 infant_event_ = unsmob<Stream_event> (sev);
237 Context::set_property_from_event (SCM sev)
239 Stream_event *ev = unsmob<Stream_event> (sev);
241 SCM sym = ev->get_property ("symbol");
242 if (scm_is_symbol (sym))
244 SCM val = ev->get_property ("value");
246 if (SCM_UNBNDP (val)) {
247 unset_property (sym);
252 ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
256 if (to_boolean (ev->get_property ("once")))
258 if (Global_context *g = get_global_context ())
260 SCM old_val = SCM_UNDEFINED;
261 if (here_defined (sym, &old_val))
262 g->add_finalization (scm_list_4 (ly_context_set_property_x_proc,
267 g->add_finalization (scm_list_3 (ly_context_unset_property_proc,
272 set_property (sym, val);
278 Context::unset_property_from_event (SCM sev)
280 Stream_event *ev = unsmob<Stream_event> (sev);
282 SCM sym = ev->get_property ("symbol");
283 bool ok = type_check_assignment (sym, SCM_EOL, ly_symbol2scm ("translation-type?"));
287 if (to_boolean (ev->get_property ("once")))
289 if (Global_context *g = get_global_context ())
291 SCM old_val = SCM_UNDEFINED;
292 if (here_defined (sym, &old_val))
293 g->add_finalization (scm_list_4 (ly_context_set_property_x_proc,
298 g->add_finalization (scm_list_3 (ly_context_unset_property_proc,
303 unset_property (sym);
308 Creates a new context from a CreateContext event, and sends an
309 AnnounceNewContext event to this context.
312 Context::create_context_from_event (SCM sev)
314 Stream_event *ev = unsmob<Stream_event> (sev);
316 string id = ly_scm2string (ev->get_property ("id"));
317 SCM ops = ev->get_property ("ops");
318 SCM type_scm = ev->get_property ("type");
319 string type = ly_symbol2string (type_scm);
321 vector<Context_def *> path = path_to_acceptable_context (type_scm);
323 if (path.size () != 1)
325 programming_error (to_string ("Invalid CreateContext event: Cannot create %s context", type.c_str ()));
328 Context_def *cdef = path[0];
330 Context *new_context = cdef->instantiate (ops);
332 new_context->id_string_ = id;
334 /* Register various listeners:
335 - Make the new context hear events that universally affect contexts
336 - connect events_below etc. properly */
337 /* We want to be the first ones to hear our own events. Therefore, wait
338 before registering events_below_ */
339 new_context->event_source ()->
340 add_listener (new_context->GET_LISTENER (Context, create_context_from_event),
341 ly_symbol2scm ("CreateContext"));
342 new_context->event_source ()->
343 add_listener (new_context->GET_LISTENER (Context, remove_context),
344 ly_symbol2scm ("RemoveContext"));
345 new_context->event_source ()->
346 add_listener (new_context->GET_LISTENER (Context, change_parent),
347 ly_symbol2scm ("ChangeParent"));
348 new_context->event_source ()->
349 add_listener (new_context->GET_LISTENER (Context, set_property_from_event),
350 ly_symbol2scm ("SetProperty"));
351 new_context->event_source ()->
352 add_listener (new_context->GET_LISTENER (Context, unset_property_from_event),
353 ly_symbol2scm ("UnsetProperty"));
355 new_context->events_below_->register_as_listener (new_context->event_source_);
356 add_context (new_context);
358 new_context->unprotect ();
360 Context_def *td = unsmob<Context_def> (new_context->definition_);
362 /* This cannot move before add_context (), because \override
363 operations require that we are in the hierarchy. */
364 td->apply_default_property_operations (new_context);
365 apply_property_operations (new_context, ops);
367 send_stream_event (this, "AnnounceNewContext", 0,
368 ly_symbol2scm ("context"), new_context->self_scm (),
369 ly_symbol2scm ("creator"), sev);
372 vector<Context_def *>
373 Context::path_to_acceptable_context (SCM name) const
375 // The 'accepts elements in definition_mods_ is a list of ('accepts string),
376 // but the Context_def expects to see elements of the form ('accepts symbol).
377 SCM accepts = SCM_EOL;
378 for (SCM s = definition_mods_; scm_is_pair (s); s = scm_cdr (s))
379 if (scm_is_eq (scm_caar (s), ly_symbol2scm ("accepts")))
381 SCM elt = scm_list_2 (scm_caar (s), scm_string_to_symbol (scm_cadar (s)));
382 accepts = scm_cons (elt, accepts);
385 return unsmob<Context_def> (definition_)->path_to_acceptable_context (name,
387 scm_reverse_x (accepts, SCM_EOL));
392 Context::create_context (Context_def *cdef,
397 /* TODO: This is fairly misplaced. We can fix this when we have taken out all
398 iterator specific stuff from the Context class */
400 add_listener (GET_LISTENER (Context, acknowledge_infant),
401 ly_symbol2scm ("AnnounceNewContext"));
402 /* The CreateContext creates a new context, and sends an announcement of the
403 new context through another event. That event will be stored in
404 infant_event_ to create a return value. */
405 send_stream_event (this, "CreateContext", 0,
406 ly_symbol2scm ("ops"), ops,
407 ly_symbol2scm ("type"), cdef->get_context_name (),
408 ly_symbol2scm ("id"), ly_string2scm (id));
410 remove_listener (GET_LISTENER (Context, acknowledge_infant),
411 ly_symbol2scm ("AnnounceNewContext"));
413 assert (infant_event_);
414 SCM infant_scm = infant_event_->get_property ("context");
415 Context *infant = unsmob<Context> (infant_scm);
417 if (!infant || infant->get_parent_context () != this)
419 programming_error ("create_context: can't locate newly created context");
427 Default child context as a SCM string, or something else if there is
431 Context::default_child_context_name () const
433 return default_child_;
437 Context::is_bottom_context () const
439 return !scm_is_symbol (default_child_context_name ());
443 Context::get_default_interpreter (const string &context_id)
445 if (!is_bottom_context ())
447 SCM nm = default_child_context_name ();
448 SCM st = find_context_def (get_output_def (), nm);
450 string name = ly_symbol2string (nm);
451 Context_def *t = unsmob<Context_def> (st);
454 warning (_f ("cannot find or create: `%s'", name.c_str ()));
455 t = unsmob<Context_def> (definition_);
457 if (scm_is_symbol (t->get_default_child (SCM_EOL)))
459 Context *tg = create_context (t, "\\new", SCM_EOL);
460 return tg->get_default_interpreter (context_id);
462 return create_context (t, context_id, SCM_EOL);
464 else if (!context_id.empty () && context_id != id_string ())
466 if (daddy_context_ && !dynamic_cast<Global_context *> (daddy_context_))
467 return daddy_context_->get_default_interpreter (context_id);
468 warning (_f ("cannot find or create new Bottom = \"%s\"",
469 context_id.c_str ()));
478 Context::where_defined (SCM sym, SCM *value) const
481 if (profile_property_accesses)
482 note_property_access (&context_property_lookup_table, sym);
485 if (properties_dict ()->try_retrieve (sym, value))
486 return (Context *)this;
488 return (daddy_context_) ? daddy_context_->where_defined (sym, value) : 0;
491 /* Quick variant of where_defined. Checks only the context itself. */
494 Context::here_defined (SCM sym, SCM *value) const
497 if (profile_property_accesses)
498 note_property_access (&context_property_lookup_table, sym);
501 return properties_dict ()->try_retrieve (sym, value);
505 return SCM_EOL when not found.
508 Context::internal_get_property (SCM sym) const
511 if (profile_property_accesses)
512 note_property_access (&context_property_lookup_table, sym);
516 if (properties_dict ()->try_retrieve (sym, &val))
520 return daddy_context_->internal_get_property (sym);
526 Called by the send_stream_event macro. props is a 0-terminated array of
527 properties and corresponding values, interleaved. This method should not
528 be called from any other place than the send_stream_event macro.
531 Context::internal_send_stream_event (SCM type, Input *origin, SCM props[])
533 Stream_event *e = new Stream_event (Lily::ly_make_event_class (type), origin);
534 for (int i = 0; props[i]; i += 2)
536 e->set_property (props[i], props[i + 1]);
538 event_source_->broadcast (e);
543 Context::is_alias (SCM sym) const
545 if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
546 return is_bottom_context ();
547 if (scm_is_eq (sym, context_name_symbol ()))
550 return scm_is_true (scm_c_memq (sym, aliases_));
554 Context::add_alias (SCM sym)
556 aliases_ = scm_cons (sym, aliases_);
559 /* we don't (yet) instrument context properties */
561 Context::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
563 internal_set_property (sym, val);
567 Context::internal_set_property (SCM sym, SCM val)
569 bool type_check_ok = type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"));
571 if (do_internal_type_checking_global)
572 assert (type_check_ok);
575 properties_dict ()->set (sym, val);
579 TODO: look up to check whether we have inherited var?
582 Context::unset_property (SCM sym)
584 properties_dict ()->remove (sym);
588 Context::change_parent (SCM sev)
590 Stream_event *ev = unsmob<Stream_event> (sev);
591 Context *to = unsmob<Context> (ev->get_property ("context"));
593 disconnect_from_parent ();
594 to->add_context (this);
598 Die. The next GC sweep should take care of the actual death.
601 Context::remove_context (SCM)
603 /* ugh, the translator group should listen to RemoveContext events by itself */
604 Translator_group *impl = implementation ();
606 impl->disconnect_from_context ();
607 disconnect_from_parent ();
611 Context::disconnect_from_parent ()
613 daddy_context_->events_below_->unregister_as_listener (events_below_);
614 daddy_context_->context_list_ = scm_delq_x (self_scm (), daddy_context_->context_list_);
619 find_context_above (Context *where, SCM type)
621 while (where && !where->is_alias (type))
622 where = where->get_parent_context ();
628 find_context_above_by_parent_type (Context *where, SCM parent_type)
630 for (Context *child = 0; where;
631 child = where, where = where->get_parent_context ())
632 if (where->is_alias (parent_type))
639 find_context_below (Context *where,
640 SCM type, const string &id)
642 if (where->is_alias (type))
644 if (id == "" || where->id_string () == id)
649 for (SCM s = where->children_contexts ();
650 !found && scm_is_pair (s); s = scm_cdr (s))
652 Context *tr = unsmob<Context> (scm_car (s));
654 found = find_context_below (tr, type, id);
661 find_context_near (Context *where,
662 SCM type, const string &id)
664 for ( ; where; where = where->get_parent_context ())
666 Context *found = find_context_below (where, type, id);
675 find_top_context (Context *where)
677 Context *top = where;
678 for ( ; where; where = where->get_parent_context())
684 Context::properties_as_alist () const
686 return properties_dict ()->to_alist ();
690 Context::context_name_symbol () const
692 Context_def *td = unsmob<Context_def> (definition_);
693 return td->get_context_name ();
697 Context::context_name () const
699 return ly_symbol2string (context_name_symbol ());
703 Context::get_score_context () const
706 return daddy_context_->get_score_context ();
712 Context::get_output_def () const
714 return daddy_context_ ? daddy_context_->get_output_def () : 0;
722 Context::now_mom () const
724 Context const *p = this;
725 while (p->daddy_context_)
726 p = p->daddy_context_;
728 return p->now_mom ();
732 Context::print_smob (SCM port, scm_print_state *) const
734 scm_puts ("#<", port);
735 scm_puts (class_name (), port);
736 if (Context_def *d = unsmob<Context_def> (definition_))
738 scm_puts (" ", port);
739 scm_display (d->get_context_name (), port);
742 if (!id_string_.empty ())
744 scm_puts ("=", port);
745 scm_puts (id_string_.c_str (), port);
748 scm_puts (" ", port);
750 scm_display (context_list_, port);
751 scm_puts (" >", port);
757 Context::mark_smob () const
759 scm_gc_mark (context_list_);
760 scm_gc_mark (aliases_);
761 scm_gc_mark (definition_);
762 scm_gc_mark (definition_mods_);
763 scm_gc_mark (properties_scm_);
764 scm_gc_mark (accepts_list_);
765 scm_gc_mark (default_child_);
768 scm_gc_mark (implementation_->self_scm ());
771 scm_gc_mark (event_source_->self_scm ());
774 scm_gc_mark (events_below_->self_scm ());
776 return properties_scm_;
779 const char Context::type_p_name_[] = "ly:context?";
782 Context::get_global_context () const
784 if (dynamic_cast<Global_context *> ((Context *) this))
785 return dynamic_cast<Global_context *> ((Context *) this);
788 return daddy_context_->get_global_context ();
790 programming_error ("no Global context");
795 Context::get_parent_context () const
797 return daddy_context_;
801 Ugh. Where to put this?
804 measure_length (Context const *context)
806 SCM l = context->get_property ("measureLength");
808 if (unsmob<Moment> (l))
809 length = unsmob<Moment> (l)->main_part_;
814 measure_position (Context const *context)
816 SCM sm = context->get_property ("measurePosition");
819 if (unsmob<Moment> (sm))
821 m = *unsmob<Moment> (sm);
823 if (m.main_part_ < Rational (0))
825 Rational length (measure_length (context));
826 while (m.main_part_ < Rational (0))
827 m.main_part_ += length;
834 /* Finds the measure position after a note of length DUR that
835 begins at the current measure position. */
837 measure_position (Context const *context, Duration const *dur)
839 Moment pos = measure_position (context);
840 Rational dur_length = dur ? dur->get_length () : Rational (0);
842 Moment end_pos = pos.grace_part_ < Rational (0)
843 ? Moment (pos.main_part_, pos.grace_part_ + dur_length)
844 : Moment (pos.main_part_ + dur_length, 0);
850 measure_number (Context const *context)
852 SCM barnum = context->get_property ("internalBarNumber");
853 SCM smp = context->get_property ("measurePosition");
855 int bn = robust_scm2int (barnum, 0);
856 Moment mp = robust_scm2moment (smp, Moment (0));
857 if (mp.main_part_ < Rational (0))
864 set_context_property_on_children (Context *trans, SCM sym, SCM val)
866 trans->set_property (sym, ly_deep_copy (val));
867 for (SCM p = trans->children_contexts (); scm_is_pair (p); p = scm_cdr (p))
869 Context *trg = unsmob<Context> (scm_car (p));
870 set_context_property_on_children (trg, sym, ly_deep_copy (val));
875 melisma_busy (Context *tr)
877 // When there are subcontexts, they are responsible for maintaining
879 SCM ch = tr->children_contexts ();
880 if (scm_is_pair (ch))
882 // all contexts need to have a busy melisma for this to evaluate
886 if (!melisma_busy (unsmob<Context> (scm_car (ch))))
889 } while (scm_is_pair (ch));
893 for (SCM melisma_properties = tr->get_property ("melismaBusyProperties");
894 scm_is_pair (melisma_properties);
895 melisma_properties = scm_cdr (melisma_properties))
896 if (to_boolean (tr->get_property (scm_car (melisma_properties))))
903 check_repeat_count_visibility (Context const *context, SCM count)
905 SCM proc = context->get_property ("repeatCountVisibility");
906 return (ly_is_procedure (proc)
907 && to_boolean (scm_call_2 (proc,
909 context->self_scm ())));