/*
- 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 <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 "debug.hh"
-#include "moment.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 "killing-cons.tcc"
-#include "translator-def.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_unprotect_object (tab->self_scm( ));
-}
-Scheme_hash_table*
-Translator_group::properties_dict () const
+void
+translator_each (SCM list, Translator_method method)
{
- return Scheme_hash_table::unsmob (properties_scm_);
+ 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 ()
{
-
- //assert (removable_b());
+ precompute_method_bindings ();
}
-
-Translator_group::Translator_group()
+void
+Translator_group::connect_to_context (Context *c)
{
- iterator_count_ = 0;
- Scheme_hash_table *tab = new Scheme_hash_table ;
- properties_scm_ = tab->self_scm ();
-
- scm_unprotect_object (tab->self_scm ());
+ 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);
+ }
}
void
-Translator_group::check_removal()
+Translator_group::disconnect_from_context ()
{
- SCM next = SCM_EOL;
- for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
+ for (SCM tr_list = simple_trans_list_; scm_is_pair (tr_list); tr_list = scm_cdr (tr_list))
{
- next = gh_cdr (p);
-
- Translator_group *trg = dynamic_cast<Translator_group*> (unsmob_translator (gh_car (p)));
-
- trg->check_removal ();
- if (trg->removable_b())
- terminate_translator (trg);
+ 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;
}
-
-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_group_translator (Translator *t)
+Translator_group::finalize ()
{
- trans_group_list_ = add_translator (trans_group_list_,t);
}
-
-
-bool
-Translator_group::removable_b() 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_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 (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_l (String n, String id)
+ 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_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 = 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
{
- Translator_group * new_group = path[i]->instantiate (output_def_l_);
+ Translator *tr = type->clone ();
+ SCM str = tr->self_scm ();
- current->add_group_translator (new_group);
- current = new_group;
- }
- current->id_str_ = id;
- return current;
- }
+ if (tr->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 *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;
+ tr->daddy_context_ = new_context;
+ tr->unprotect ();
+ }
}
- return ret;
-}
-bool
-Translator_group::try_music_on_nongroup_children (Music *m)
-{
- bool hebbes_b =false;
+ /* 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);
-
- for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = gh_cdr (p))
- {
- hebbes_b = unsmob_translator (gh_car (p))->try_music (m);
- }
- return hebbes_b;
-}
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
-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 ;
-}
+ g->connect_to_context (new_context);
+ g->unprotect ();
-int
-Translator_group::depth_i() const
-{
- return (daddy_trans_l_) ? daddy_trans_l_->depth_i() + 1 : 0;
+ recurse_over_translators (new_context,
+ &Translator::initialize,
+ &Translator_group::initialize,
+ DOWN);
}
-Translator_group*
-Translator_group::ancestor_l (int level)
+SCM
+Translator_group::get_simple_trans_list ()
{
- if (!level || !daddy_trans_l_)
- return this;
-
- return daddy_trans_l_->ancestor_l (level-1);
+ return simple_trans_list_;
}
void
-Translator_group::terminate_translator (Translator*r_l)
-{
- r_l->removal_processing();
- /*
- Return value ignored. GC does the rest.
- */
- remove_translator_p (r_l);
-}
-
-
-/**
- Remove a translator from the hierarchy.
- */
-Translator *
-Translator_group::remove_translator_p (Translator*trans_l)
+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 ());
-#if 0
-/*
- should not use, instead: use properties to communicate between engravers.
- */
-Translator*
-Translator_group::get_simple_translator (String type) const
-{
- for (SCM p = simple_trans_list_; gh_pair_p (p); p =gh_cdr (p))
+ if (tg && dir == DOWN)
{
- if (classname (unsmob_translator (gh_car (p))) == type)
- return unsmob_translator (gh_car (p));
+ tg->precomputed_translator_foreach (idx);
+ tg->call_precomputed_self_method (idx);
}
- if (daddy_trans_l_)
- return daddy_trans_l_->get_simple_translator (type);
- return 0;
-}
-#endif
-bool
-Translator_group::is_bottom_translator_b () const
-{
- return unsmob_translator_def (definition_)->accepts_name_list_ == SCM_EOL;
-}
+ 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);
-Translator_group*
-Translator_group::get_default_interpreter()
-{
- if (!is_bottom_translator_b ())
+ if (tg && dir == UP)
{
- SCM nm = unsmob_translator_def (definition_)->accepts_name_list_;
- SCM st = output_def_l ()->find_translator_l (gh_car (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 ());
-void
-Translator_group::do_print() const
-{
-#ifndef NPRINT
-#endif
-}
-
-void
-Translator_group::do_add_processing ()
-{
- for (SCM s = simple_trans_list_; gh_pair_p (s) ; s = gh_cdr (s))
+ if (tg && dir == DOWN)
{
- Translator * t = unsmob_translator (gh_car (s));
- t->add_processing ();
- }
-}
-
-/*
- PROPERTIES
- */
-Translator_group*
-Translator_group::where_defined (SCM sym) const
-{
- if (properties_dict ()->elem_b (sym))
- {
- 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<Translator_method_binding> &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 *)
+{
+ 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
+Translator_group::mark_smob (SCM smob)
{
- each (&Translator::removal_processing);
+ Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
+
+ me->derived_mark ();
+ scm_gc_mark (me->protected_events_);
+ return me->simple_trans_list_;
}
projects / lilypond.git / blobdiff