X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator-group.cc;h=638c38bd9ce1c6d68aabe42a21dabf9f4c924520;hb=0b544cfb7332615ef809b71b57ab656741311ae1;hp=bd33135e10975935568de0ddfdb7b5790ea8b3d6;hpb=304b5f3aa7eee7b0ff8d4ba7526a1410735f6e74;p=lilypond.git diff --git a/lily/translator-group.cc b/lily/translator-group.cc index bd33135e10..638c38bd9c 100644 --- a/lily/translator-group.cc +++ b/lily/translator-group.cc @@ -1,124 +1,233 @@ /* - 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--2014 Han-Wen Nienhuys , + Erik Sandberg - (c) 1997--2004 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 "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" - -Translator_group* -Translator_group::get_daddy_translator () const -{ - Translator *t - = unsmob_translator (daddy_context_->daddy_context_->implementation_); - return dynamic_cast (t); -} - +#include "output-def.hh" +#include "performer.hh" +#include "performer-group.hh" +#include "scheme-engraver.hh" +#include "scm-hash.hh" +#include "warn.hh" void translator_each (SCM list, Translator_method method) { - for (SCM p = list; gh_pair_p (p); p = ly_cdr (p)) - (unsmob_translator (ly_car (p))->*method) (); + for (SCM p = list; scm_is_pair (p); p = scm_cdr (p)) + (unsmob_translator (scm_car (p))->*method) (); } - void Translator_group::initialize () { - SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F); - daddy_context_->set_property ("acceptHashTable", tab); + precompute_method_bindings (); } - -bool -translator_accepts_any_of (Translator*tr, SCM ifaces) +void +Translator_group::connect_to_context (Context *c) { - SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"), - tr->translator_description ()); - ack_ifs = gh_cdr (ack_ifs); - for (SCM s = ifaces; ly_pair_p (s); s = ly_cdr (s)) - if (scm_memq (ly_car (s), ack_ifs) != SCM_BOOL_F) - return true; - return false; + if (context_) + { + programming_error ("translator group is already connected to context " + + context_->context_name ()); + } + + 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); + } } -SCM -find_accept_translators (SCM gravlist, SCM ifaces) +void +Translator_group::disconnect_from_context () { - SCM l = SCM_EOL; - for (SCM s = gravlist; ly_pair_p (s); s = ly_cdr (s)) + for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list)) { - Translator* tr = unsmob_translator (ly_car (s)); - if (translator_accepts_any_of (tr, ifaces)) - l = scm_cons (tr->self_scm (), l); + Translator *tr = unsmob_translator (scm_car (tr_list)); + tr->disconnect_from_context (context_); } - l = scm_reverse_x (l, SCM_EOL); - - return l; + context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator), + ly_symbol2scm ("AnnounceNewContext")); + context_ = 0; + protected_events_ = SCM_EOL; } -bool -Translator_group::try_music (Music* m) +void +Translator_group::finalize () { - SCM tab = get_property ("acceptHashTable"); - SCM name = scm_sloppy_assq (ly_symbol2scm ("name"), - m->get_property_alist (false)); +} - if (!gh_pair_p (name)) - return false; +/* + Both filter_performers and filter_engravers used to use a direct dynamic_cast + on the unsmobbed translator to be filtered, i.e., - name = gh_cdr (name); - SCM accept_list = scm_hashq_ref (tab, name, SCM_UNDEFINED); - if (accept_list == SCM_BOOL_F) - { - accept_list = find_accept_translators (get_simple_trans_list (), - m->get_property ("types")); - scm_hashq_set_x (tab, name, accept_list); - } + if (dynamic_cast (unsmob_translator (scm_car (*tail)))) - for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p)) + but this caused mysterious optimisation issues in several GUB builds. See + issue #818 for the background to this change. +*/ +SCM +filter_performers (SCM ell) +{ + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) { - Translator * t = unsmob_translator (ly_car (p)); - if (t && t->try_music (m)) - return true; + if (unsmob_performer (scm_car (*tail))) + *tail = scm_cdr (*tail); + else + tail = SCM_CDRLOC (*tail); } - return false; + return ell; } SCM -names_to_translators (SCM namelist, Context*tg) +filter_engravers (SCM ell) { - SCM l = SCM_EOL; - for (SCM s = namelist; gh_pair_p (s) ; s = ly_cdr (s)) + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) { - Translator * t = get_translator (ly_car (s)); - if (!t) - warning (_f ("can't find: `%s'", s)); + if (unsmob_engraver (scm_car (*tail))) + *tail = scm_cdr (*tail); else - { - Translator * tr = t->clone (); - SCM str = tr->self_scm (); - l = gh_cons (str, l); - - tr->daddy_context_ = tg; - scm_gc_unprotect_object (str); - } + tail = SCM_CDRLOC (*tail); } - return l; + 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. + + TODO: Should the list also be flushed at the beginning of each new + moment? + */ +void +Translator_group::protect_event (SCM ev) +{ + protected_events_ = scm_cons (ev, protected_events_); } +/* + 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 (); + + SCM trans_names = def->get_translator_names (ops); + + Translator_group *g = get_translator_group (def->get_translator_group_type ()); + SCM trans_list = SCM_EOL; + + for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s)) + { + 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 (); + } + } + + /* 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); + + // TODO: scrap Context::implementation + new_context->implementation_ = g; + + g->connect_to_context (new_context); + g->unprotect (); + + recurse_over_translators (new_context, + &Translator::initialize, + &Translator_group::initialize, + DOWN); +} SCM Translator_group::get_simple_trans_list () @@ -126,36 +235,137 @@ Translator_group::get_simple_trans_list () return simple_trans_list_; } - void -recurse_down_translators (Context * c, Translator_method ptr, Direction dir) +precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir) { - Translator_group * tg - = dynamic_cast (unsmob_translator (c->implementation_)); + Translator_group *tg + = dynamic_cast (c->implementation ()); - - /* - Top down: - */ - if (dir == DOWN) + if (tg && dir == DOWN) { - translator_each (tg->get_simple_trans_list (), - ptr); + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); + } - (tg->*ptr) (); + 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); + + if (tg && dir == UP) + { + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); } +} - for (SCM s = c->context_list_ ; gh_pair_p (s); - s =gh_cdr (s)) +void +recurse_over_translators (Context *c, Translator_method ptr, + Translator_group_method tg_ptr, Direction dir) +{ + Translator_group *tg + = dynamic_cast (c->implementation ()); + + if (tg && dir == DOWN) { - recurse_down_translators (unsmob_context (gh_car (s)), ptr, dir); + (tg->*tg_ptr) (); + translator_each (tg->get_simple_trans_list (), ptr); } - if (dir == UP) + 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); + + if (tg && dir == UP) { translator_each (tg->get_simple_trans_list (), - ptr); + ptr); + + (tg->*tg_ptr) (); + } +} + +Translator_group::Translator_group () +{ + simple_trans_list_ = SCM_EOL; + protected_events_ = SCM_EOL; + context_ = 0; + smobify_self (); +} + +void +Translator_group::derived_mark () const +{ +} + +void +Translator_group::precompute_method_bindings () +{ + for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s)) + { + Translator *tr = unsmob_translator (scm_car (s)); + Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT]; + tr->fetch_precomputable_methods (ptrs); - (tg->*ptr) (); + 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])); + } } + + fetch_precomputable_methods (precomputed_self_method_bindings_); +} + +void +Translator_group::precomputed_translator_foreach (Translator_precompute_index idx) +{ + vector &bindings (precomputed_method_bindings_[idx]); + for (vsize i = 0; i < bindings.size (); i++) + bindings[i].invoke (); +} + +void +Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[]) +{ + for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++) + ptrs[i] = 0; +} + +void +Translator_group::call_precomputed_self_method (Translator_precompute_index idx) +{ + if (precomputed_self_method_bindings_[idx]) + (*precomputed_self_method_bindings_[idx]) (this); +} + +Translator_group::~Translator_group () +{ +} + +#include "ly-smobs.icc" + +IMPLEMENT_SMOBS (Translator_group); +IMPLEMENT_DEFAULT_EQUAL_P (Translator_group); +IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?"); + +int +Translator_group::print_smob (SCM s, SCM port, scm_print_state *) +{ + 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 +Translator_group::mark_smob (SCM smob) +{ + Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob); + + me->derived_mark (); + scm_gc_mark (me->protected_events_); + return me->simple_trans_list_; }