X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator-group.cc;h=ac4e97eb2a5ec8312b9a6b672bcd2602715e619e;hb=5a22d6233a39d3164e1ca043244794c268be4ad0;hp=d2b7c83a04dbcd637bdf31ac8ab7759d81a9ed23;hpb=f1346920f64c571a1475d3ded295b9637560c6bc;p=lilypond.git diff --git a/lily/translator-group.cc b/lily/translator-group.cc index d2b7c83a04..1980da53d0 100644 --- a/lily/translator-group.cc +++ b/lily/translator-group.cc @@ -1,484 +1,332 @@ /* - Translator_group.cc -- implement Translator_group + translator-group.cc -- implement Translator_group source file of the GNU LilyPond music typesetter - (c) 1997--2000 Han-Wen Nienhuys + (c) 1997--2009 Han-Wen Nienhuys , + Erik Sandberg */ -#include "music-output-def.hh" #include "translator-group.hh" -#include "translator.hh" -#include "debug.hh" -#include "moment.hh" -#include "scm-hash.hh" -#include "killing-cons.tcc" -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_unprotect_object (tab->self_scm( )); -} +#include "context-def.hh" +#include "context.hh" +#include "dispatcher.hh" +#include "engraver-group.hh" +#include "international.hh" +#include "main.hh" +#include "music.hh" +#include "output-def.hh" +#include "performer-group.hh" +#include "scm-hash.hh" +#include "warn.hh" -Scheme_hash_table* -Translator_group::properties_dict () const -{ - return Scheme_hash_table::unsmob (properties_scm_); -} -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_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 = gh_cdr (p); - - Translator_group *trg = dynamic_cast (unsmob_translator (gh_car (p))); - - trg->check_removal (); - if (trg->removable_b()) - terminate_translator (trg); + 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 -Translator_group::add_translator (SCM list, Translator *t) -{ - list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL)); - t->daddy_trans_l_ = this; - t->output_def_l_ = output_def_l_; - t->add_processing (); - - return list; -} -void -Translator_group::add_simple_translator (Translator*t) -{ - simple_trans_list_ = add_translator (simple_trans_list_, t); -} void -Translator_group::add_group_translator (Translator *t) -{ - trans_group_list_ = add_translator (trans_group_list_,t); -} - - - -bool -Translator_group::removable_b() const +Translator_group::disconnect_from_context () { - return trans_group_list_ == SCM_EOL && ! iterator_count_; -} - -Translator_group * -Translator_group::find_existing_translator_l (String n, String id) -{ - if (is_alias_b (n) && (id_str_ == id || id.empty_b ())) - return this; - - Translator_group* r = 0; - for (SCM p = trans_group_list_; !r && gh_pair_p (p); p = gh_cdr (p)) + for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list)) { - Translator * t = unsmob_translator (gh_car (p)); - - r = dynamic_cast (t)->find_existing_translator_l (n, id); + Translator *tr = unsmob_translator (scm_car (tr_list)); + tr->disconnect_from_context (context_); } - - return r; + context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator), + ly_symbol2scm ("AnnounceNewContext")); + context_ = 0; + protected_events_ = SCM_EOL; } -Link_array -Translator_group::path_to_acceptable_translator (String type, Music_output_def* odef) const +void +Translator_group::finalize () { - Link_array accepted_arr; - for (SCM s = accepts_name_list_; gh_pair_p (s); s = gh_cdr (s)) - { - - Translator *t = odef->find_translator_l (ly_scm2string (gh_car (s))); - if (!t || !dynamic_cast (t)) - continue; - accepted_arr.push (dynamic_cast (t)); - } - - - for (int i=0; i < accepted_arr.size (); i++) - if (accepted_arr[i]->type_str_ == type) - { - Link_array retval; - retval.push (accepted_arr[i]); - return retval; - } - - Link_array best_result; - int best_depth= INT_MAX; - for (int i=0; i < accepted_arr.size (); i++) - { - Translator_group * g = accepted_arr[i]; - - Link_array result - = g->path_to_acceptable_translator (type, odef); - if (result.size () && result.size () < best_depth) - { - result.insert (g,0); - best_result = result; - } - } - - return best_result; } -Translator_group* -Translator_group::find_create_translator_l (String n, String id) +SCM +filter_performers (SCM ell) { - Translator_group * existing = find_existing_translator_l (n,id); - if (existing) - return existing; - - Link_array path - = path_to_acceptable_translator (n, output_def_l ()); - - if (path.size ()) + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) { - 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 = dynamic_cast(path[i]->clone ()); - - current->add_group_translator (new_group); - current = new_group; - } - current->id_str_ = id; - return current; - } - - Translator_group *ret = 0; - if (daddy_trans_l_) - ret = daddy_trans_l_->find_create_translator_l (n,id); - else - { - warning (_f ("can't find or create `%s' called `%s'", n, id)); - ret =0; + if (dynamic_cast (unsmob_translator (scm_car (*tail)))) + *tail = scm_cdr (*tail); + else + tail = SCM_CDRLOC (*tail); } - return ret; + return ell; } -bool -Translator_group::try_music_on_nongroup_children (Music *m) +SCM +filter_engravers (SCM ell) { - bool hebbes_b =false; - - - for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = gh_cdr (p)) + SCM *tail = ℓ + for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p)) { - hebbes_b = unsmob_translator (gh_car (p))->try_music (m); + if (dynamic_cast (unsmob_translator (scm_car (*tail)))) + *tail = scm_cdr (*tail); + else + tail = SCM_CDRLOC (*tail); } - return hebbes_b; -} - -bool -Translator_group::do_try_music (Music* m) -{ - bool hebbes_b = try_music_on_nongroup_children (m); - - if (!hebbes_b && daddy_trans_l_) - hebbes_b = daddy_trans_l_->try_music (m); - return hebbes_b ; + return ell; } -int -Translator_group::depth_i() const -{ - return (daddy_trans_l_) ? daddy_trans_l_->depth_i() + 1 : 0; -} - -Translator_group* -Translator_group::ancestor_l (int level) -{ - if (!level || !daddy_trans_l_) - return this; - - return daddy_trans_l_->ancestor_l (level-1); -} +/* + 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::terminate_translator (Translator*r_l) +Translator_group::protect_event (SCM ev) { - r_l->removal_processing(); - Translator * trans_p =remove_translator_p (r_l); - /* - forget trans_p, GC does the rest. - */ + protected_events_ = scm_cons (ev, protected_events_); } - -/** - Remove a translator from the hierarchy. +/* + Create a new translator for a newly created child context. Triggered + by AnnounceNewContext events. */ -Translator * -Translator_group::remove_translator_p (Translator*trans_l) -{ - assert (trans_l); - - trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_); - trans_l->daddy_trans_l_ = 0; - return trans_l; -} +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; -Translator* -Translator_group::get_simple_translator (String type) const -{ - for (SCM p = simple_trans_list_; gh_pair_p (p); p =gh_cdr (p)) + for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s)) { - if (classname (unsmob_translator (gh_car (p))) == type) - return unsmob_translator (gh_car (p)); - } - if (daddy_trans_l_) - return daddy_trans_l_->get_simple_translator (type); - return 0; -} - - -bool -Translator_group::is_bottom_translator_b () const -{ - return accepts_name_list_ == SCM_EOL; -} + SCM definition = scm_car (s); + + Translator *type = 0; + if (ly_is_symbol (definition)) + type = get_translator (definition); + + if (!type) + warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ())); + else + { + Translator *instance = type->clone (); + 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); -Translator_group* -Translator_group::get_default_interpreter() -{ - if (gh_pair_p (accepts_name_list_)) - { - String str = ly_scm2string (gh_car (accepts_name_list_)); - Translator*t = output_def_l ()->find_translator_l (str); - if (!t) - { - warning (_f ("can't find or create: `%s'", str)); - t = this; + instance->daddy_context_ = new_context; + instance->unprotect (); } - Translator_group * g= dynamic_cast (t->clone ()); - add_group_translator (g); - - if (!g->is_bottom_translator_b ()) - return g->get_default_interpreter (); - else - return g; } - return this; -} -static void -static_each (SCM list, Method_pointer method) -{ - for (SCM p = list; gh_pair_p (p); p = gh_cdr(p)) - (unsmob_translator (gh_car (p))->*method) (); - -} + /* 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); -void -Translator_group::each (Method_pointer method) -{ - static_each (simple_trans_list_, method); - static_each (trans_group_list_, method); -} + // TODO: scrap Context::implementation + new_context->implementation_ = g; -void -Translator_group::do_print() const -{ -#ifndef NPRINT -#endif + g->connect_to_context (new_context); + g->unprotect (); + + recurse_over_translators (new_context, + &Translator::initialize, + &Translator_group::initialize, + DOWN); } -static SCM -trans_list (SCM namelist, Music_output_def *mdef) +SCM +Translator_group::get_simple_trans_list () { - SCM l = SCM_EOL; - for (SCM s = namelist; gh_pair_p (s) ; s = gh_cdr (s)) - { - Translator * t = mdef->find_translator_l (ly_scm2string (gh_car (s))); - if (!t) - warning (_f ("can't find: `%s'", s)); - else - { - Translator * tr = t->clone (); - SCM str = tr->self_scm (); - l = gh_cons (str, l); - scm_unprotect_object (str); - } - } - return l; + return simple_trans_list_; } - void -Translator_group::do_add_processing () +precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir) { - assert (simple_trans_list_== SCM_EOL); + Translator_group *tg + = dynamic_cast (c->implementation ()); - SCM correct_order = scm_reverse (property_pushes_); // pity of the mem. - for (SCM s = correct_order; gh_pair_p (s); s = gh_cdr (s)) + if (tg && dir == DOWN) { - SCM entry = gh_car (s); - SCM val = gh_cddr (entry); - val = gh_pair_p (val) ? gh_car (val) : SCM_UNDEFINED; - - Translator_group_initializer::apply_pushpop_property (this, gh_car (entry), - gh_cadr (entry), - val); + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); } - SCM l1 = trans_list (consists_name_list_, output_def_l ()); - SCM l2 =trans_list (end_consists_name_list_, output_def_l ()); - l1 = scm_reverse_x (l1, l2); - - simple_trans_list_ = l1; - for (SCM s = l1; gh_pair_p (s) ; s = gh_cdr (s)) - { - Translator * t = unsmob_translator (gh_car (s)); + 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); - t->daddy_trans_l_ = this; - t->output_def_l_ = output_def_l_; - t->add_processing (); + if (tg && dir == UP) + { + tg->precomputed_translator_foreach (idx); + tg->call_precomputed_self_method (idx); } - - } -/* - PROPERTIES - */ -Translator_group* -Translator_group::where_defined (SCM sym) const +void +recurse_over_translators (Context *c, Translator_method ptr, + Translator_group_method tg_ptr, Direction dir) { - if (properties_dict ()->elem_b (sym)) + Translator_group *tg + = dynamic_cast (c->implementation ()); + + if (tg && dir == DOWN) { - return (Translator_group*)this; + (tg->*tg_ptr) (); + translator_each (tg->get_simple_trans_list (), ptr); } - return (daddy_trans_l_) ? daddy_trans_l_->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); -SCM -Translator_group::get_property (SCM sym) const -{ - if (properties_dict ()->elem_b (sym)) + if (tg && dir == UP) { - return properties_dict ()->get (sym); - } + translator_each (tg->get_simple_trans_list (), + ptr); - if (daddy_trans_l_) - return daddy_trans_l_->get_property (sym); - - return SCM_UNDEFINED; + (tg->*tg_ptr) (); + } } -void -Translator_group::set_property (String id, SCM val) +Translator_group::Translator_group () { - set_property (ly_symbol2scm (id.ch_C()), val); + simple_trans_list_ = SCM_EOL; + protected_events_ = SCM_EOL; + context_ = 0; + smobify_self (); } void -Translator_group::set_property (SCM sym, SCM val) +Translator_group::derived_mark () const { - properties_dict ()->set (sym, val); } -/* - 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 = get_property (prop); + Translator *tr = unsmob_translator (scm_car (s)); + Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT]; + tr->fetch_precomputable_methods (ptrs); - prev = gh_cons (gh_cons (eltprop, val), prev); - set_property (prop, prev); - } - else + assert (tr); + for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++) { - SCM prev = get_property (prop); - - SCM newprops= SCM_EOL ; - while (gh_pair_p (prev) && gh_caar (prev) != eltprop) - { - newprops = gh_cons (gh_car (prev), newprops); - prev = gh_cdr (prev); - } - - if (gh_pair_p (prev)) - { - newprops = scm_reverse_x (newprops, gh_cdr (prev)); - set_property (prop, newprops); - } + if (ptrs[i]) + precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i])); } } -} - - - + fetch_precomputable_methods (precomputed_self_method_bindings_); +} -/* - STUBS -*/ void -Translator_group::do_pre_move_processing () +Translator_group::precomputed_translator_foreach (Translator_precompute_index idx) { - each (&Translator::pre_move_processing); + vector &bindings (precomputed_method_bindings_[idx]); + for (vsize i = 0; i < bindings.size (); i++) + bindings[i].invoke (); } void -Translator_group::do_post_move_processing () +Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[]) { - each (&Translator::post_move_processing); + for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++) + ptrs[i] = 0; } void -Translator_group::do_process_music () +Translator_group::call_precomputed_self_method (Translator_precompute_index idx) { - each (&Translator::process_music); + if (precomputed_self_method_bindings_[idx]) + (*precomputed_self_method_bindings_[idx]) (this); } -void -Translator_group::do_creation_processing () +Translator_group::~Translator_group () { - each (&Translator::creation_processing); } -void -Translator_group::do_removal_processing () +#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 *) { - each (&Translator::removal_processing); + 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_; }