/*
- Translator_group.cc -- implement Translator_group
+ translator-group.cc -- implement Translator_group
source file of the GNU LilyPond music typesetter
- (c) 1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>,
+ Erik Sandberg <mandolaerik@gmail.com>
*/
-#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 "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"
-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_);
-}
-Translator_group::~Translator_group ()
+void
+translator_each (SCM list, Translator_method method)
{
-
- //assert (is_removable ());
+ 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<Translator_group*> (unsmob_translator (ly_car (p)));
-
- trg->check_removal ();
- if (trg->is_removable ())
- 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)
-{
- /*
- 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;
-}
-
-
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<Translator_group*> (t);
-
- trans_group_list_ = add_translator (trans_group_list_,t);
-
- Translator_def * td = unsmob_translator_def (tg->definition_);
- td->apply_default_property_operations (tg);
-
- t->initialize ();
}
-
-bool
-Translator_group::is_removable () const
+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 (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
+ }
+ return ell;
}
-Translator_group *
-Translator_group::find_existing_translator (SCM n, String id)
+SCM
+filter_engravers (SCM ell)
{
- if ((is_alias (n) && (id_string_ == id || id.is_empty ())) || n == ly_symbol2scm ("Current"))
- 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<Translator_group*> (t)->find_existing_translator (n, id);
+ if (dynamic_cast<Engraver *> (unsmob_translator (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.
-Translator_group*
-Translator_group::find_create_translator (SCM n, String id, SCM operations)
+ 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)
{
- Translator_group * existing = find_existing_translator (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 (n, get_output_def ());
+/*
+ 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);
- if (path.size ())
- {
- Translator_group * current = this;
+ Translator_group *g = get_translator_group (def->get_translator_group_type ());
+ SCM trans_list = SCM_EOL;
- // start at 1. The first one (index 0) will be us.
- for (int i=0; i < path.size (); i++)
+ for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
+ {
+ Translator *type = get_translator (scm_car (s));
+ if (!type)
+ warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
+ else
{
- SCM ops = (i == path.size () -1) ? operations : SCM_EOL;
-
- Translator_group * new_group
- = path[i]->instantiate (output_def_, ops);
+ Translator *tr = type->clone ();
+ SCM str = tr->self_scm ();
- if (i == path.size () -1)
+ if (tr->must_be_last ())
{
- new_group->id_string_ = id;
+ 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);
- current->add_fresh_group_translator (new_group);
- apply_property_operations (new_group, ops);
-
- current = new_group;
+ tr->daddy_context_ = new_context;
+ tr->unprotect ();
}
-
- return current;
}
- Translator_group *ret = 0;
- if (daddy_trans_)
- ret = daddy_trans_->find_create_translator (n, id, operations);
- else
- {
- warning (_f ("can't find or create `%s' called `%s'", ly_symbol2string (n).to_str0 (), id));
- ret =0;
- }
- return ret;
-}
-
-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 ;
-}
-
-int
-Translator_group::get_depth () const
-{
- return (daddy_trans_) ? daddy_trans_->get_depth () + 1 : 0;
-}
+ /* 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);
-Translator_group*
-Translator_group::get_ancestor (int level)
-{
- if (!level || !daddy_trans_)
- return this;
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
- return daddy_trans_->get_ancestor (level-1);
-}
+ g->connect_to_context (new_context);
+ g->unprotect ();
-void
-Translator_group::terminate_translator (Translator*r)
-{
- r->finalize ();
- /*
- Return value ignored. GC does the rest.
- */
- remove_translator (r);
+ recurse_over_translators (new_context,
+ &Translator::initialize,
+ &Translator_group::initialize,
+ DOWN);
}
-
-/**
- Remove a translator from the hierarchy.
- */
-Translator *
-Translator_group::remove_translator (Translator*trans)
+SCM
+Translator_group::get_simple_trans_list ()
{
- assert (trans);
-
- trans_group_list_ = scm_delq_x (trans->self_scm (), trans_group_list_);
- trans->daddy_trans_ = 0;
- return trans;
+ return simple_trans_list_;
}
-bool
-Translator_group::is_bottom_translator_b () const
+void
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
{
- return !gh_symbol_p (unsmob_translator_def (definition_)->default_child_context_name ());
-}
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-Translator_group*
-Translator_group::get_default_interpreter ()
-{
- if (!is_bottom_translator_b ())
+ if (tg && dir == DOWN)
{
- SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
- SCM st = get_output_def ()->find_translator (nm);
+ tg->precomputed_translator_foreach (idx);
+ tg->call_precomputed_self_method (idx);
+ }
- Translator_def *t = unsmob_translator_def (st);
- if (!t)
- {
- warning (_f ("can't find or create: `%s'", ly_symbol2string (nm).to_str0 ()));
- t = unsmob_translator_def (this->definition_);
- }
- Translator_group *tg = t->instantiate (output_def_, SCM_EOL);
- add_fresh_group_translator (tg);
+ 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->is_bottom_translator_b ())
- return tg->get_default_interpreter ();
- else
- return tg;
+ if (tg && dir == UP)
+ {
+ 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<Translator_group *> (c->implementation ());
-/*
- PROPERTIES
- */
-Translator_group*
-Translator_group::where_defined (SCM sym) const
-{
- if (properties_dict ()->contains (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 (tg && dir == UP)
+ {
+ translator_each (tg->get_simple_trans_list (),
+ ptr);
- if (daddy_trans_)
- return daddy_trans_->internal_get_property (sym);
-
- return val;
+ (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_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);
+ Translator *tr = unsmob_translator (scm_car (s));
+ Translator_void_method_ptr ptrs[TRANSLATOR_METHOD_PRECOMPUTE_COUNT];
+ tr->fetch_precomputable_methods (ptrs);
- 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
+ assert (tr);
+ for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
{
- SCM prev = internal_get_property (prop);
-
- /*
- TODO: should have scm_equal_something () for reverting
- autobeam properties.
- */
- SCM newprops= SCM_EOL ;
- while (gh_pair_p (prev) && !SCM_EQ_P(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);
- }
+ 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<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::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)
{
- SCM tab = scm_make_vector (gh_int2scm (19), SCM_BOOL_F);
- set_property ("acceptHashTable", tab);
- 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::finalize);
}
+#include "ly-smobs.icc"
+IMPLEMENT_SMOBS (Translator_group);
+IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
+IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
-bool translator_accepts_any_of (Translator*tr, SCM ifaces)
+int
+Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
{
- 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;
+ Translator_group *me = (Translator_group *) SCM_CELL_WORD_1 (s);
+ scm_puts ("#<Translator_group ", port);
+ scm_puts (me->class_name (), port);
+ scm_display (me->simple_trans_list_, port);
+ scm_puts (" >", port);
+ return 1;
}
SCM
-find_accept_translators (SCM gravlist, SCM ifaces)
+Translator_group::mark_smob (SCM smob)
{
- SCM l = SCM_EOL;
- for (SCM s = gravlist; ly_pair_p (s); s = ly_cdr (s))
- {
- Translator* tr = unsmob_translator (ly_car (s));
- if (translator_accepts_any_of (tr, ifaces))
- l = scm_cons (tr->self_scm (), l);
- }
- l = scm_reverse_x (l, SCM_EOL);
+ Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
- return l;
-}
-
-bool
-Translator_group::try_music_on_nongroup_children (Music *m )
-{
- 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;
-
- 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 (simple_trans_list_,
- m->get_mus_property ("types"));
- scm_hashq_set_x (tab, name, accept_list);
- }
-
- for (SCM p = accept_list; gh_pair_p (p); p = ly_cdr (p))
- {
- Translator * t = unsmob_translator (ly_car (p));
- if (t && t->try_music (m))
- return true;
- }
- return false;
-}
-
-SCM
-Translator_group::properties_as_alist () const
-{
- return properties_dict()->to_alist();
-}
-
-String
-Translator_group::context_name () const
-{
- Translator_def * td = unsmob_translator_def (definition_ );
- return ly_symbol2string (td->get_context_name ());
-}
-
-/*
- PRE_INIT_OPS is in the order specified, and hence must be reversed.
- */
-void
-apply_property_operations (Translator_group*tg, SCM pre_init_ops)
-{
- SCM correct_order = scm_reverse (pre_init_ops);
- for (SCM s = correct_order; gh_pair_p (s); s = ly_cdr (s))
- {
- SCM entry = ly_car (s);
- SCM type = ly_car (entry);
- entry = ly_cdr (entry);
-
- if (type == ly_symbol2scm ("push") || type == ly_symbol2scm ("poppush"))
- {
- SCM val = ly_cddr (entry);
- val = gh_pair_p (val) ? ly_car (val) : SCM_UNDEFINED;
-
- tg->execute_pushpop_property (ly_car (entry), ly_cadr (entry), val);
- }
- else if (type == ly_symbol2scm ("assign"))
- {
- tg->internal_set_property (ly_car (entry), ly_cadr (entry));
- }
- }
+ me->derived_mark ();
+ scm_gc_mark (me->protected_events_);
+ return me->simple_trans_list_;
}
projects / lilypond.git / blobdiff