/*
- 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--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>,
+ Erik Sandberg <mandolaerik@gmail.com>
- (c) 1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ 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 <http://www.gnu.org/licenses/>.
*/
-#include "music-output-def.hh"
#include "translator-group.hh"
-#include "translator.hh"
-#include "debug.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, SCM method)
{
-
- //assert (removable_b ());
+ for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
+ scm_call_1 (method, scm_car (p));
}
-
-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<Translator_group*> (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_l_ = this;
- t->output_def_l_ = output_def_l_;
-
- return list;
+ context_ = c;
+ c->event_source ()->add_listener (GET_LISTENER (Translator_group, 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 (Translator_group, create_child_translator),
+ ly_symbol2scm ("AnnounceNewContext"));
+ context_ = 0;
+ protected_events_ = SCM_EOL;
}
-
void
-Translator_group::add_fresh_group_translator (Translator*t)
-{
- Translator_group*tg = dynamic_cast<Translator_group*> (t);
- assert (tg);
-
- trans_group_list_ = add_translator (trans_group_list_,t);
- unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
- t->initialize ();
-
-}
-
-
-bool
-Translator_group::removable_b () const
-{
- return trans_group_list_ == SCM_EOL && ! iterator_count_;
-}
-
-Translator_group *
-Translator_group::find_existing_translator_l (String n, String id)
+Translator_group::finalize ()
{
- 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 = ly_cdr (p))
- {
- Translator * t = unsmob_translator (ly_car (p));
-
- r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
- }
-
- return r;
}
+/*
+ Both filter_performers and filter_engravers used to use a direct dynamic_cast
+ on the unsmobbed translator to be filtered, i.e.,
+ if (unsmob<Performer> (scm_car (*tail)))
-
-Translator_group*
-Translator_group::find_create_translator_l (String n, String id)
+ but this caused mysterious optimisation issues in several GUB builds. See
+ issue #818 for the background to this change.
+*/
+SCM
+filter_performers (SCM ell)
{
- Translator_group * existing = find_existing_translator_l (n,id);
- if (existing)
- return existing;
-
- Link_array<Translator_def> path
- = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.ch_C ()), output_def_l ());
-
- 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_l_);
-
- if (i == path.size () -1)
- new_group->id_str_ = id;
- current->add_fresh_group_translator (new_group);
- current = new_group;
- }
-
- return current;
- }
-
- Translator_group *ret = 0;
- if (daddy_trans_l_)
- ret = daddy_trans_l_->find_create_translator_l (n,id);
- else
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- warning (_f ("can't find or create `%s' called `%s'", n, id));
- ret =0;
+ if (unsmob<Performer> (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 = ly_cdr (p))
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- hebbes_b = unsmob_translator (ly_car (p))->try_music (m);
+ if (unsmob<Engraver> (scm_car (*tail)))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
}
- return hebbes_b;
+ return ell;
}
-bool
-Translator_group::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 ;
-}
-
-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;
+/*
+ Protects the parameter from being garbage collected. The object is
+ protected until the next disconnect_from_context call.
- return daddy_trans_l_->ancestor_l (level-1);
-}
+ 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 ();
- /*
- Return value ignored. GC does the rest.
- */
- remove_translator_p (r_l);
+ 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)
+void
+Translator_group::create_child_translator (SCM sev)
{
- assert (trans_l);
+ 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 ();
- trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_);
- trans_l->daddy_trans_l_ = 0;
- return trans_l;
-}
+ SCM trans_names = def->get_translator_names (ops);
-bool
-Translator_group::is_bottom_translator_b () const
-{
- return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
+ Translator_group *g = get_translator_group (def->get_translator_group_type ());
+ SCM trans_list = SCM_EOL;
-}
-
-Translator_group*
-Translator_group::get_default_interpreter ()
-{
- if (!is_bottom_translator_b ())
+ for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
{
- SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
- SCM st = output_def_l ()->find_translator_l (nm);
-
- Translator_def *t = unsmob_translator_def (st);
- if (!t)
- {
- warning (_f ("can't find or create: `%s'", ly_scm2string (nm).ch_C ()));
- t = unsmob_translator_def (this->definition_);
- }
- Translator_group *tg = t->instantiate (output_def_l_);
- add_fresh_group_translator (tg);
-
- if (!tg->is_bottom_translator_b ())
- return tg->get_default_interpreter ();
+ SCM trans = scm_car (s);
+
+ if (ly_is_symbol (trans))
+ trans = get_translator_creator (trans);
+ if (ly_is_procedure (trans))
+ trans = scm_call_1 (trans, cs);
+ if (ly_cheap_is_list (trans))
+ trans = (new Scheme_engraver (trans, new_context))->unprotect ();
+ Translator *instance = unsmob<Translator> (trans);
+ if (!instance)
+ {
+ warning (_f ("cannot find: `%s'", ly_scm_write_string (trans).c_str ()));
+ continue;
+ }
+
+ if (instance->must_be_last ())
+ {
+ SCM cons = scm_cons (trans, SCM_EOL);
+ if (scm_is_pair (trans_list))
+ scm_set_cdr_x (scm_last_pair (trans_list), cons);
+ else
+ trans_list = cons;
+ }
else
- return tg;
- }
- return this;
-}
+ trans_list = scm_cons (trans, trans_list);
-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)
-{
- static_each (simple_trans_list_, method);
- static_each (trans_group_list_, method);
-}
+ /* Filter unwanted translator types. Required to make
+ \with { \consists "..." } work. */
+ if (dynamic_cast<Engraver_group *> (g))
+ g->simple_trans_list_ = filter_performers (trans_list);
+ else if (dynamic_cast<Performer_group *> (g))
+ g->simple_trans_list_ = filter_engravers (trans_list);
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
-/*
- PROPERTIES
- */
-Translator_group*
-Translator_group::where_defined (SCM sym) const
-{
- if (properties_dict ()->elem_b (sym))
- {
- return (Translator_group*)this;
- }
+ g->connect_to_context (new_context);
+ g->unprotect ();
- return (daddy_trans_l_) ? daddy_trans_l_->where_defined (sym) : 0;
+ recurse_over_translators
+ (new_context,
+ Callback0_wrapper::make_smob<Translator, &Translator::initialize> (),
+ Callback0_wrapper::make_smob<Translator_group, &Translator_group::initialize> (),
+ DOWN);
}
-/*
- return SCM_EOL when not found.
-*/
SCM
-Translator_group::internal_get_property (SCM sym) const
+Translator_group::get_simple_trans_list ()
{
- SCM val =SCM_EOL;
- if (properties_dict ()->try_retrieve (sym, &val))
- return val;
-
- if (daddy_trans_l_)
- return daddy_trans_l_->internal_get_property (sym);
-
- return val;
+ return simple_trans_list_;
}
void
-Translator_group::internal_set_property (SCM sym, SCM val)
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
{
-#ifndef NDEBUG
- if (internal_type_checking_global_b)
- assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
-#endif
-
- properties_dict ()->set (sym, val);
-}
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-/*
- TODO: look up to check whether we have inherited var?
- */
-void
-Translator_group::unset_property (SCM sym)
-{
- properties_dict ()->remove (sym);
-}
+ if (tg && dir == DOWN)
+ {
+ tg->precomputed_translator_foreach (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);
-/*
- 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)
-{
- if (gh_symbol_p (prop))
+ if (tg && dir == UP)
{
- 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);
- }
- }
+ tg->precomputed_translator_foreach (idx);
}
}
+void
+recurse_over_translators (Context *c, SCM ptr,
+ SCM tg_ptr, Direction dir)
+{
+ Translator_group *tg = c->implementation ();
+ SCM tg_scm = tg ? tg->self_scm () : SCM_UNDEFINED;
+ if (tg && dir == DOWN)
+ {
+ scm_call_1 (tg_ptr, tg_scm);
+ translator_each (tg->get_simple_trans_list (), ptr);
+ }
+ 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);
-/*
- STUBS
-*/
-void
-Translator_group::stop_translation_timestep ()
-{
- each (&Translator::stop_translation_timestep);
+ scm_call_1 (tg_ptr, tg_scm);
+ }
}
-void
-Translator_group::start_translation_timestep ()
+Translator_group::Translator_group ()
{
- each (&Translator::start_translation_timestep);
+ simple_trans_list_ = SCM_EOL;
+ protected_events_ = SCM_EOL;
+ context_ = 0;
+ smobify_self ();
}
void
-Translator_group::do_announces ()
+Translator_group::derived_mark () const
{
- each (&Translator::announces);
}
void
-Translator_group::initialize ()
+Translator_group::precompute_method_bindings ()
{
- each (&Translator::initialize);
+ for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
+ {
+ Translator *tr = unsmob<Translator> (scm_car (s));
+ SCM ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
+ tr->fetch_precomputable_methods (ptrs);
+
+ assert (tr);
+ for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
+ {
+ if (!SCM_UNBNDP (ptrs[i]))
+ precomputed_method_bindings_[i].push_back (Method_instance (ptrs[i], tr));
+ }
+ }
+
}
void
-Translator_group::finalize ()
+Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
{
- each (&Translator::removal_processing);
+ vector<Method_instance> &bindings (precomputed_method_bindings_[idx]);
+ for (vsize i = 0; i < bindings.size (); i++)
+ bindings[i]();
}
-
-SCM
-ly_get_trans_property (SCM context, SCM name)
+Translator_group::~Translator_group ()
{
- Translator *t = unsmob_translator (context);
- Translator_group* tr= dynamic_cast<Translator_group*> (t);
- SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Translator group");
- SCM_ASSERT_TYPE(gh_symbol_p(name), name, SCM_ARG2, __FUNCTION__, "symbol");
-
- return tr->internal_get_property (name);
-
}
-SCM
-ly_set_trans_property (SCM context, SCM name, SCM val)
-{
- Translator *t = unsmob_translator (context);
- Translator_group* tr= dynamic_cast<Translator_group*> (t);
- SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Translator group");
- tr->internal_set_property (name, val);
-
- return SCM_UNSPECIFIED;
-}
+const char * const Translator_group::type_p_name_ = "ly:translator-group?";
-
-
-void
-add_trans_scm_funcs ()
+int
+Translator_group::print_smob (SCM port, scm_print_state *) const
{
- scm_c_define_gsubr ("ly-get-trans-property", 2, 0, 0, (Scheme_function_unknown)ly_get_trans_property);
- scm_c_define_gsubr ("ly-set-trans-property", 3, 0, 0, (Scheme_function_unknown)ly_set_trans_property);
+ scm_puts ("#<Translator_group ", port);
+ scm_puts (class_name (), port);
+ scm_display (simple_trans_list_, port);
+ scm_puts (" >", port);
+ return 1;
}
-ADD_SCM_INIT_FUNC (trans_scm, add_trans_scm_funcs);
-
+SCM
+Translator_group::mark_smob () const
+{
+ derived_mark ();
+ scm_gc_mark (protected_events_);
+ return simple_trans_list_;
+}
projects / lilypond.git / blobdiff