/*
- 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--2001 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 "killing-cons.tcc"
-#include "translator-def.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_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))
+ (Translator::unsmob (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<Translator_group*> (unsmob_translator (gh_car (p)));
+ programming_error ("translator group is already connected to context "
+ + context_->context_name ());
+ }
- trg->check_removal ();
- if (trg->removable_b ())
- terminate_translator (trg);
+ 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 = Translator::unsmob (scm_car (tr_list));
+ tr->connect_to_context (c);
}
}
-
-SCM
-Translator_group::add_translator (SCM list, Translator *t)
+void
+Translator_group::disconnect_from_context ()
{
- list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
- t->daddy_trans_l_ = this;
- t->output_def_l_ = output_def_l_;
- if (Translator_group*tg = dynamic_cast<Translator_group*> (t))
+ for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
{
- unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
+ Translator *tr = Translator::unsmob (scm_car (tr_list));
+ tr->disconnect_from_context (context_);
}
-
- t->initialize ();
- return list;
+ context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
+ ly_symbol2scm ("AnnounceNewContext"));
+ context_ = 0;
+ protected_events_ = SCM_EOL;
}
+
void
-Translator_group::add_group_translator (Translator *t)
+Translator_group::finalize ()
{
- trans_group_list_ = add_translator (trans_group_list_,t);
}
+/*
+ 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<Performer *> (Translator::unsmob (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 (Performer::is_smob (scm_car (*tail)))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
+ }
+ return ell;
}
-Translator_group *
-Translator_group::find_existing_translator_l (String n, String id)
+SCM
+filter_engravers (SCM ell)
{
- 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))
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- Translator * t = unsmob_translator (gh_car (p));
-
- r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
+ if (Engraver::is_smob (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_l (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_l (n,id);
- if (existing)
- return existing;
+ protected_events_ = scm_cons (ev, protected_events_);
+}
- Link_array<Translator_def> path
- = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.ch_C ()), output_def_l ());
+/*
+ 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 = Stream_event::unsmob (sev);
+ // get from AnnounceNewContext
+ SCM cs = ev->get_property ("context");
+ Context *new_context = Context::unsmob (cs);
+ Context_def *def = Context_def::unsmob (new_context->get_definition ());
+ SCM ops = new_context->get_definition_mods ();
- 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_);
-
- current->add_group_translator (new_group);
- current = new_group;
- }
- current->id_str_ = id;
- return current;
- }
+ SCM trans_names = def->get_translator_names (ops);
- 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;
- }
- 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 = gh_cdr (p))
+ for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
{
- hebbes_b = unsmob_translator (gh_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<Scheme_engraver *> (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_l_)
- hebbes_b = daddy_trans_l_->try_music (m);
- return hebbes_b ;
-}
+ /* 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);
-int
-Translator_group::depth_i () const
-{
- return (daddy_trans_l_) ? daddy_trans_l_->depth_i () + 1 : 0;
-}
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
-Translator_group*
-Translator_group::ancestor_l (int level)
-{
- if (!level || !daddy_trans_l_)
- return this;
+ g->connect_to_context (new_context);
+ g->unprotect ();
- return daddy_trans_l_->ancestor_l (level-1);
+ recurse_over_translators (new_context,
+ &Translator::initialize,
+ &Translator_group::initialize,
+ DOWN);
}
-void
-Translator_group::terminate_translator (Translator*r_l)
+SCM
+Translator_group::get_simple_trans_list ()
{
- r_l->removal_processing ();
- /*
- Return value ignored. GC does the rest.
- */
- remove_translator_p (r_l);
+ return simple_trans_list_;
}
-
-/**
- Remove a translator from the hierarchy.
- */
-Translator *
-Translator_group::remove_translator_p (Translator*trans_l)
+void
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
{
- 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;
-}
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-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 (Context::unsmob (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 = 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_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 = gh_cdr (p))
- (unsmob_translator (gh_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<Translator_group *> (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_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 (Context::unsmob (scm_car (s)), ptr, tg_ptr, dir);
-/*
- return SCM_EOL when not found.
-*/
-SCM
-Translator_group::get_property (SCM sym) const
-{
- SCM val =SCM_EOL;
- if (properties_dict ()->try_retrieve (sym, &val))
- return val;
-
- if (daddy_trans_l_)
- return daddy_trans_l_->get_property (sym);
-
- return val;
-}
+ if (tg && dir == UP)
+ {
+ translator_each (tg->get_simple_trans_list (),
+ ptr);
-void
-Translator_group::set_property (String id, SCM val)
-{
- set_property (ly_symbol2scm (id.ch_C ()), val);
+ (tg->*tg_ptr) ();
+ }
}
-
-void
-Translator_group::set_property (SCM sym, SCM val)
+Translator_group::Translator_group ()
{
- 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 = get_property (prop);
-
- if (gh_pair_p (prev) || prev == SCM_EOL)
- {
- bool ok = type_check_assignment (val, eltprop, ly_symbol2scm ("backend-type?"));
-
-
-
- if (ok)
- {
- prev = gh_cons (gh_cons (eltprop, val), prev);
- set_property (prop, prev);
- }
- }
- else
- {
- // warning here.
- }
-
- }
- else
- {
- 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);
- }
- }
+ Translator *tr = Translator::unsmob (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::pre_move_processing);
+ fetch_precomputable_methods (precomputed_self_method_bindings_);
}
void
-Translator_group::start_translation_timestep ()
+Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
{
- each (&Translator::post_move_processing);
+ vector<Translator_method_binding> &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::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);
}
-bool
-type_check_assignment (SCM val, SCM sym, SCM type_symbol)
-{
- bool ok = true;
- SCM type_p = SCM_EOL;
-
- if (gh_symbol_p (sym))
- type_p = scm_object_property (sym, type_symbol);
-
- if (type_p != SCM_EOL && !gh_procedure_p (type_p))
- {
- warning (_f ("Can't find property type-check for `%s'. Perhaps you made a typing error?",
- ly_symbol2string (sym).ch_C ()));
- }
- else
- {
- if (val != SCM_EOL
- && gh_procedure_p (type_p)
- && gh_call1 (type_p, val) == SCM_BOOL_F)
- {
- SCM errport = scm_current_error_port ();
- ok = false;
- SCM typefunc = scm_eval2 (ly_symbol2scm ("type-name"), SCM_EOL);
- SCM type_name = gh_call1 (typefunc, type_p);
-
- scm_puts (_f ("Type check for `%s' failed; value `%s' must be of type `%s'",
- ly_symbol2string (sym).ch_C (),
- ly_scm2string (ly_write2scm (val)).ch_C (),
- ly_scm2string (type_name).ch_C ()).ch_C (),
- errport);
- scm_puts ("\n", errport);
- }
- }
- return ok;
-}
+const char Translator_group::type_p_name_[] = "ly:translator-group?";
-SCM
-ly_get_trans_property (SCM context, SCM name)
-{
- Translator *t = unsmob_translator (context);
- Translator_group* tr= dynamic_cast<Translator_group*> (t);
- if (!t || !tr)
- {
- /* programming_error? */
- warning (_ ("ly-get-trans-property: expecting a Translator_group argument"));
- return SCM_EOL;
- }
- return tr->get_property (name);
-
-}
-SCM
-ly_set_trans_property (SCM context, SCM name, SCM val)
+int
+Translator_group::print_smob (SCM port, scm_print_state *)
{
-
- Translator *t = unsmob_translator (context);
- Translator_group* tr= dynamic_cast<Translator_group*> (t);
- if (tr)
- {
- tr->set_property (name, val);
- }
- return SCM_UNSPECIFIED;
+ scm_puts ("#<Translator_group ", port);
+ scm_puts (class_name (), port);
+ scm_display (simple_trans_list_, port);
+ scm_puts (" >", port);
+ return 1;
}
-
-
-
-void
-add_trans_scm_funcs ()
+SCM
+Translator_group::mark_smob ()
{
- scm_make_gsubr ("ly-get-trans-property", 2, 0, 0, (Scheme_function_unknown)ly_get_trans_property);
- scm_make_gsubr ("ly-set-trans-property", 3, 0, 0, (Scheme_function_unknown)ly_set_trans_property);
+ derived_mark ();
+ scm_gc_mark (protected_events_);
+ return simple_trans_list_;
}
-
-ADD_SCM_INIT_FUNC (trans_scm, add_trans_scm_funcs);