X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator-group.cc;h=ab79d1347696c3d8ea18ae9cc1871ecd0bbe964f;hb=d8f40e4ee05a7a7175711859c36c1bb5a0f305ec;hp=8a1e58d746014946b35a36cfa9d63c9c9e4bfa66;hpb=a6ee9dcd388111e842064a8d46ab06c4897a00d2;p=lilypond.git diff --git a/lily/translator-group.cc b/lily/translator-group.cc index 8a1e58d746..ab79d13476 100644 --- a/lily/translator-group.cc +++ b/lily/translator-group.cc @@ -1,438 +1,371 @@ /* - Translator_group.cc -- implement Translator_group + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2012 Han-Wen Nienhuys , + Erik Sandberg - (c) 1997--2002 Han-Wen Nienhuys + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . */ -#include "music-output-def.hh" #include "translator-group.hh" -#include "translator.hh" -#include "warn.hh" -#include "moment.hh" -#include "scm-hash.hh" -#include "translator-def.hh" -#include "main.hh" - -Translator_group::Translator_group (Translator_group const&s) - : Translator (s) -{ - iterator_count_ =0; - - Scheme_hash_table * tab = new Scheme_hash_table (*s.properties_dict ()); - properties_scm_ = tab->self_scm (); - scm_gc_unprotect_object (tab->self_scm ()); -} -Scheme_hash_table* -Translator_group::properties_dict () const -{ - return Scheme_hash_table::unsmob (properties_scm_); -} +#include "context-def.hh" +#include "context.hh" +#include "dispatcher.hh" +#include "engraver.hh" +#include "engraver-group.hh" +#include "international.hh" +#include "main.hh" +#include "music.hh" +#include "output-def.hh" +#include "performer.hh" +#include "performer-group.hh" +#include "scheme-engraver.hh" +#include "scm-hash.hh" +#include "warn.hh" -Translator_group::~Translator_group () +void +translator_each (SCM list, Translator_method method) { - - //assert (removable_b ()); + for (SCM p = list; scm_is_pair (p); p = scm_cdr (p)) + (unsmob_translator (scm_car (p))->*method) (); } - -Translator_group::Translator_group () +void +Translator_group::initialize () { - iterator_count_ = 0; - Scheme_hash_table *tab = new Scheme_hash_table ; - properties_scm_ = tab->self_scm (); - - scm_gc_unprotect_object (tab->self_scm ()); + precompute_method_bindings (); } void -Translator_group::check_removal () +Translator_group::connect_to_context (Context *c) { - SCM next = SCM_EOL; - for (SCM p = trans_group_list_; gh_pair_p (p); p = next) + if (context_) { - next = ly_cdr (p); - - Translator_group *trg = dynamic_cast (unsmob_translator (ly_car (p))); - - trg->check_removal (); - if (trg->removable_b ()) - terminate_translator (trg); + programming_error ("translator group is already connected to context " + + context_->context_name ()); } -} -SCM -Translator_group::add_translator (SCM list, Translator *t) -{ - /* - Must append, since list ordering must be preserved. - */ - list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL)); - t->daddy_trans_ = this; - t->output_def_ = output_def_; - - return list; + context_ = c; + c->event_source ()->add_listener (GET_LISTENER (create_child_translator), + ly_symbol2scm ("AnnounceNewContext")); + for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list)) + { + Translator *tr = unsmob_translator (scm_car (tr_list)); + tr->connect_to_context (c); + } } - void -Translator_group::add_used_group_translator (Translator *t) +Translator_group::disconnect_from_context () { - trans_group_list_ = add_translator (trans_group_list_,t); + for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list)) + { + Translator *tr = unsmob_translator (scm_car (tr_list)); + tr->disconnect_from_context (context_); + } + context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator), + ly_symbol2scm ("AnnounceNewContext")); + context_ = 0; + protected_events_ = SCM_EOL; } - void -Translator_group::add_fresh_group_translator (Translator*t) +Translator_group::finalize () { - Translator_group*tg = dynamic_cast (t); - assert (tg); - - trans_group_list_ = add_translator (trans_group_list_,t); - unsmob_translator_def (tg->definition_)->apply_property_operations (tg); - t->initialize (); - } +/* + Both filter_performers and filter_engravers used to use a direct dynamic_cast + on the unsmobbed translator to be filtered, i.e., + + if (dynamic_cast (unsmob_translator (scm_car (*tail)))) -bool -Translator_group::removable_b () const + but this caused mysterious optimisation issues in several GUB builds. See + issue #818 for the background to this change. +*/ +SCM +filter_performers (SCM ell) { - return trans_group_list_ == SCM_EOL && ! iterator_count_; + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) + { + if (unsmob_performer (scm_car (*tail))) + *tail = scm_cdr (*tail); + else + tail = SCM_CDRLOC (*tail); + } + return ell; } -Translator_group * -Translator_group::find_existing_translator (String n, String id) +SCM +filter_engravers (SCM ell) { - if (is_alias_b (n) && (id_string_ == id || id.empty_b ())) - return this; - - Translator_group* r = 0; - for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = ly_cdr (p)) + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) { - Translator * t = unsmob_translator (ly_car (p)); - - r = dynamic_cast (t)->find_existing_translator (n, id); + if (unsmob_engraver (scm_car (*tail))) + *tail = scm_cdr (*tail); + else + tail = SCM_CDRLOC (*tail); } - - return r; + return ell; } +/* + Protects the parameter from being garbage collected. The object is + protected until the next disconnect_from_context call. + Whenever a child translator hears an event, the event is added to + this list. This eliminates the need for derived_mark methods in most + translators; all incoming events are instead protected by the + translator group. - -Translator_group* -Translator_group::find_create_translator (String n, String id) + TODO: Should the list also be flushed at the beginning of each new + moment? + */ +void +Translator_group::protect_event (SCM ev) { - Translator_group * existing = find_existing_translator (n,id); - if (existing) - return existing; - - Link_array path - = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.to_str0 ()), get_output_def ()); - - if (path.size ()) - { - Translator_group * current = this; - - // start at 1. The first one (index 0) will be us. - for (int i=0; i < path.size (); i++) - { - Translator_group * new_group = path[i]->instantiate (output_def_); + protected_events_ = scm_cons (ev, protected_events_); +} - if (i == path.size () -1) - new_group->id_string_ = id; - current->add_fresh_group_translator (new_group); - current = new_group; - } +/* + Create a new translator for a newly created child context. Triggered + by AnnounceNewContext events. + */ +IMPLEMENT_LISTENER (Translator_group, create_child_translator); +void +Translator_group::create_child_translator (SCM sev) +{ + Stream_event *ev = unsmob_stream_event (sev); + // get from AnnounceNewContext + SCM cs = ev->get_property ("context"); + Context *new_context = unsmob_context (cs); + Context_def *def = unsmob_context_def (new_context->get_definition ()); + SCM ops = new_context->get_definition_mods (); - return current; - } + SCM trans_names = def->get_translator_names (ops); - Translator_group *ret = 0; - if (daddy_trans_) - ret = daddy_trans_->find_create_translator (n,id); - else - { - warning (_f ("can't find or create `%s' called `%s'", n, id)); - ret =0; - } - return ret; -} + Translator_group *g = get_translator_group (def->get_translator_group_type ()); + SCM trans_list = SCM_EOL; -bool -Translator_group::try_music_on_nongroup_children (Music *m) -{ - bool hebbes_b =false; - - for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = ly_cdr (p)) + for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s)) { - hebbes_b = unsmob_translator (ly_car (p))->try_music (m); + SCM definition = scm_car (s); + bool is_scheme = false; + + Translator *type = 0; + if (ly_is_symbol (definition)) + type = get_translator (definition); + else if (ly_is_pair (definition)) + { + type = get_translator (ly_symbol2scm ("Scheme_engraver")); + is_scheme = true; + } + else if (ly_is_procedure (definition)) + { + // `definition' is a procedure, which takes the context as + // an argument and evaluates to an a-list scheme engraver + // definition. + definition = scm_call_1 (definition, cs); + type = get_translator (ly_symbol2scm ("Scheme_engraver")); + is_scheme = true; + } + + if (!type) + warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ())); + else + { + Translator *instance = type->clone (); + if (is_scheme) + dynamic_cast (instance)->init_from_scheme (definition); + + SCM str = instance->self_scm (); + + if (instance->must_be_last ()) + { + SCM cons = scm_cons (str, SCM_EOL); + if (scm_is_pair (trans_list)) + scm_set_cdr_x (scm_last_pair (trans_list), cons); + else + trans_list = cons; + } + else + trans_list = scm_cons (str, trans_list); + + instance->daddy_context_ = new_context; + instance->unprotect (); + } } - return hebbes_b; -} -bool -Translator_group::try_music (Music* m) -{ - bool hebbes_b = try_music_on_nongroup_children (m); - - if (!hebbes_b && daddy_trans_) - hebbes_b = daddy_trans_->try_music (m); - return hebbes_b ; -} + /* Filter unwanted translator types. Required to make + \with { \consists "..." } work. */ + if (dynamic_cast (g)) + g->simple_trans_list_ = filter_performers (trans_list); + else if (dynamic_cast (g)) + g->simple_trans_list_ = filter_engravers (trans_list); -int -Translator_group::get_depth () const -{ - return (daddy_trans_) ? daddy_trans_->get_depth () + 1 : 0; -} + // TODO: scrap Context::implementation + new_context->implementation_ = g; -Translator_group* -Translator_group::get_ancestor (int level) -{ - if (!level || !daddy_trans_) - return this; + g->connect_to_context (new_context); + g->unprotect (); - return daddy_trans_->get_ancestor (level-1); + recurse_over_translators (new_context, + &Translator::initialize, + &Translator_group::initialize, + DOWN); } -void -Translator_group::terminate_translator (Translator*r) +SCM +Translator_group::get_simple_trans_list () { - r->removal_processing (); - /* - Return value ignored. GC does the rest. - */ - remove_translator (r); + return simple_trans_list_; } - -/** - Remove a translator from the hierarchy. - */ -Translator * -Translator_group::remove_translator (Translator*trans) +void +precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir) { - assert (trans); + Translator_group *tg + = dynamic_cast (c->implementation ()); - trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_); - trans->daddy_trans_ = 0; - return trans; -} - -bool -Translator_group::is_bottom_translator_b () const -{ - return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ()); + if (tg && dir == DOWN) + { + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); + } -} + for (SCM s = c->children_contexts (); scm_is_pair (s); + s = scm_cdr (s)) + precomputed_recurse_over_translators (unsmob_context (scm_car (s)), idx, dir); -Translator_group* -Translator_group::get_default_interpreter () -{ - if (!is_bottom_translator_b ()) + if (tg && dir == UP) { - SCM nm = unsmob_translator_def (definition_)->default_child_context_name (); - SCM st = get_output_def ()->find_translator (nm); - - Translator_def *t = unsmob_translator_def (st); - if (!t) - { - warning (_f ("can't find or create: `%s'", ly_scm2string (nm).to_str0 ())); - t = unsmob_translator_def (this->definition_); - } - Translator_group *tg = t->instantiate (output_def_); - add_fresh_group_translator (tg); - - if (!tg->is_bottom_translator_b ()) - return tg->get_default_interpreter (); - else - return tg; + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); } - return this; -} - -static void -static_each (SCM list, Method_pointer method) -{ - for (SCM p = list; gh_pair_p (p); p = ly_cdr (p)) - (unsmob_translator (ly_car (p))->*method) (); - } void -Translator_group::each (Method_pointer method) +recurse_over_translators (Context *c, Translator_method ptr, + Translator_group_method tg_ptr, Direction dir) { - static_each (simple_trans_list_, method); - static_each (trans_group_list_, method); -} + Translator_group *tg + = dynamic_cast (c->implementation ()); - -/* - PROPERTIES - */ -Translator_group* -Translator_group::where_defined (SCM sym) const -{ - if (properties_dict ()->elem_b (sym)) + if (tg && dir == DOWN) { - return (Translator_group*)this; + (tg->*tg_ptr) (); + translator_each (tg->get_simple_trans_list (), ptr); } - return (daddy_trans_) ? daddy_trans_->where_defined (sym) : 0; -} + for (SCM s = c->children_contexts (); scm_is_pair (s); + s = scm_cdr (s)) + recurse_over_translators (unsmob_context (scm_car (s)), ptr, tg_ptr, dir); -/* - return SCM_EOL when not found. -*/ -SCM -Translator_group::internal_get_property (SCM sym) const -{ - SCM val =SCM_EOL; - if (properties_dict ()->try_retrieve (sym, &val)) - return val; - - if (daddy_trans_) - return daddy_trans_->internal_get_property (sym); - - return val; + if (tg && dir == UP) + { + translator_each (tg->get_simple_trans_list (), + ptr); + + (tg->*tg_ptr) (); + } } -void -Translator_group::internal_set_property (SCM sym, SCM val) +Translator_group::Translator_group () { -#ifndef NDEBUG - if (internal_type_checking_global_b) - assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?"))); -#endif - - properties_dict ()->set (sym, val); + simple_trans_list_ = SCM_EOL; + protected_events_ = SCM_EOL; + context_ = 0; + smobify_self (); } -/* - TODO: look up to check whether we have inherited var? - */ void -Translator_group::unset_property (SCM sym) +Translator_group::derived_mark () const { - properties_dict ()->remove (sym); } - -/* - Push or pop (depending on value of VAL) a single entry (ELTPROP . VAL) - entry from a translator property list by name of PROP -*/ void -Translator_group::execute_single_pushpop_property (SCM prop, SCM eltprop, SCM val) +Translator_group::precompute_method_bindings () { - if (gh_symbol_p (prop)) + for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s)) { - if (val != SCM_UNDEFINED) - { - SCM prev = internal_get_property (prop); - - if (gh_pair_p (prev) || prev == SCM_EOL) - { - bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?")); - - if (ok) - { - prev = gh_cons (gh_cons (eltprop, val), prev); - internal_set_property (prop, prev); - } - } - else - { - // warning here. - } - - } - else - { - SCM prev = internal_get_property (prop); - - SCM newprops= SCM_EOL ; - while (gh_pair_p (prev) && ly_caar (prev) != eltprop) - { - newprops = gh_cons (ly_car (prev), newprops); - prev = ly_cdr (prev); - } - - if (gh_pair_p (prev)) - { - newprops = scm_reverse_x (newprops, ly_cdr (prev)); - internal_set_property (prop, newprops); - } - } + Translator *tr = unsmob_translator (scm_car (s)); + Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT]; + tr->fetch_precomputable_methods (ptrs); + + assert (tr); + for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++) + { + if (ptrs[i]) + precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i])); + } } -} - - - - -/* - STUBS -*/ -void -Translator_group::stop_translation_timestep () -{ - each (&Translator::stop_translation_timestep); + fetch_precomputable_methods (precomputed_self_method_bindings_); } void -Translator_group::start_translation_timestep () +Translator_group::precomputed_translator_foreach (Translator_precompute_index idx) { - each (&Translator::start_translation_timestep); + vector &bindings (precomputed_method_bindings_[idx]); + for (vsize i = 0; i < bindings.size (); i++) + bindings[i].invoke (); } void -Translator_group::do_announces () +Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[]) { - each (&Translator::do_announces); + for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++) + ptrs[i] = 0; } void -Translator_group::initialize () +Translator_group::call_precomputed_self_method (Translator_precompute_index idx) { - each (&Translator::initialize); + if (precomputed_self_method_bindings_[idx]) + (*precomputed_self_method_bindings_[idx]) (this); } -void -Translator_group::finalize () +Translator_group::~Translator_group () { - each (&Translator::removal_processing); } -LY_DEFINE(ly_get_context_property, - "ly-get-context-property", 2, 0, 0, - (SCM context, SCM name), - "retrieve the value of @var{sym} from context @var{tr}") -{ - Translator *t = unsmob_translator (context); - Translator_group* tr= dynamic_cast (t); - SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Translator group"); - SCM_ASSERT_TYPE(gh_symbol_p (name), name, SCM_ARG2, __FUNCTION__, "symbol"); +#include "ly-smobs.icc" - return tr->internal_get_property (name); - -} +IMPLEMENT_SMOBS (Translator_group); +IMPLEMENT_DEFAULT_EQUAL_P (Translator_group); +IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?"); -LY_DEFINE(ly_set_context_property, - "ly-set-context-property", 3, 0, 0, - (SCM context, SCM name, SCM val), - "set value of property @var{sym} in context @var{tr} to @var{val}. -") +int +Translator_group::print_smob (SCM s, SCM port, scm_print_state *) { - Translator *t = unsmob_translator (context); - Translator_group* tr= dynamic_cast (t); + Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s); + scm_puts ("#class_name (), port); + scm_display (me->simple_trans_list_, port); + scm_puts (" >", port); + return 1; +} - SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Context"); - tr->internal_set_property (name, val); +SCM +Translator_group::mark_smob (SCM smob) +{ + Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob); - return SCM_UNSPECIFIED; + me->derived_mark (); + scm_gc_mark (me->protected_events_); + return me->simple_trans_list_; }