/*
- Translator_group.cc -- implement Translator_group
+ translator-group.cc -- implement Translator_group
source file of the GNU LilyPond music typesetter
- (c) 1997 Han-Wen Nienhuys <hanwen@stack.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 "pcursor.hh"
-Translator_group::Translator_group (Translator_group const&s)
- : Translator(s)
-{
- consists_str_arr_ = s.consists_str_arr_;
- accepts_str_arr_ = s.accepts_str_arr_;
- iterator_count_ =0;
-}
+#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 ()
+
+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;
+ precompute_method_bindings ();
}
void
-Translator_group::check_removal()
+Translator_group::connect_to_context (Context *c)
{
- for (int i =0; i < group_l_arr ().size();)
+ if (context_)
{
- group_l_arr ()[i]->check_removal();
- if (group_l_arr ()[i]->removable_b())
- terminate_translator (group_l_arr ()[i]);
- else
- i++;
+ 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);
}
}
-
-
-IMPLEMENT_IS_TYPE_B1(Translator_group, Translator);
-
void
-Translator_group::add (Translator *trans_p)
+Translator_group::disconnect_from_context ()
{
- trans_p_list_.bottom().add (trans_p);
- trans_p->daddy_trans_l_ = this;
- trans_p->output_def_l_ = output_def_l_;
- trans_p->add_processing ();
+ 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;
}
-bool
-Translator_group::removable_b() const
+void
+Translator_group::finalize ()
{
- return !(iterator_count_ || group_l_arr ().size());
}
-Translator_group *
-Translator_group::find_existing_translator_l (String n, String id)
+SCM
+filter_performers (SCM ell)
{
- if (is_alias_b (n) && (id_str_ == id || !id))
- return this;
- Translator_group* r = 0;
- for (int i =0; !r && i < group_l_arr ().size(); i++)
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- r = group_l_arr ()[i]->find_existing_translator_l (n,id);
+ if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
}
-
- return r;
+ return ell;
}
-Link_array<Translator_group>
-Translator_group::path_to_acceptable_translator (String type) const
+SCM
+filter_engravers (SCM ell)
{
- Link_array<Translator_group> retval;
-
- if (type_str_ == type)
- {
- retval.push (output_def_l ()->find_translator_l (type)->group_l ());
- }
- else for (int i=0; i < accepts_str_arr_.size (); i++)
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- Translator *t = output_def_l ()->find_translator_l (accepts_str_arr_[i]);
- if (!t || !t->group_l ())
- continue;
-
- Translator_group * g = t->group_l ();
-
- Link_array<Translator_group> result
- = g->path_to_acceptable_translator (type);
- if (result.size ())
- {
- retval.push (output_def_l ()->find_translator_l (type_str_)->group_l ());
- retval.concat (result);
- break;
- }
+ if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
}
+ return ell;
+}
- return retval;
+/*
+ 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::protect_event (SCM ev)
+{
+ protected_events_ = scm_cons (ev, protected_events_);
}
-Translator_group*
-Translator_group::find_create_translator_l (String n, String id)
+/*
+ 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)
{
- Translator_group * existing = find_existing_translator_l (n,id);
- if (existing)
- return existing;
+ 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 ();
- Link_array<Translator_group> path = path_to_acceptable_translator (n);
-
- /*
- if path.size () == 1, then
- type_str_ == n, but not id == id_str_
- */
- if (path.size () > 1)
- {
- assert (path.size () > 1);
- Translator_group * current = this;
+ SCM trans_names = def->get_translator_names (ops);
+
+ 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=1; 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]->clone ()->group_l ();
- current->add (new_group);
- current = new_group;
+ Translator *tr = type->clone ();
+ SCM str = tr->self_scm ();
+
+ 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);
+
+ tr->daddy_context_ = new_context;
+ tr->unprotect ();
}
- 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 ("Can't find or create `" + n + "' called `" + id + "'\n");
- ret =0;
}
- return ret;
-}
+ /* 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);
-bool
-Translator_group::do_try_request (Request* req_l)
-{
- bool hebbes_b =false;
- for (int i =0; !hebbes_b && i < nongroup_l_arr ().size() ; i++)
- hebbes_b =nongroup_l_arr ()[i]->try_request (req_l);
- if (!hebbes_b && daddy_trans_l_)
- hebbes_b = daddy_trans_l_->try_request (req_l);
- return hebbes_b ;
-}
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
-int
-Translator_group::depth_i() const
-{
- return (daddy_trans_l_) ? daddy_trans_l_->depth_i() + 1 : 0;
+ g->connect_to_context (new_context);
+ g->unprotect ();
+
+ 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_;
}
-Link_array<Translator_group>
-Translator_group::group_l_arr () const
+void
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
{
- Link_array<Translator_group> groups;
- for (PCursor<Translator*> i (trans_p_list_.top ()); i.ok (); i++)
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
+
+ if (tg && dir == DOWN)
{
- if (i->group_l ())
- groups.push (i->group_l ());
+ tg->precomputed_translator_foreach (idx);
+ tg->call_precomputed_self_method (idx);
}
- return groups;
-}
-Link_array<Translator>
-Translator_group::nongroup_l_arr () const
-{
- Link_array<Translator> groups;
- for (PCursor<Translator*> i (trans_p_list_.top ()); i.ok (); i++)
+ 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 && dir == UP)
{
- if (!i->group_l ())
- groups.push (i.ptr ());
+ tg->precomputed_translator_foreach (idx);
+ tg->call_precomputed_self_method (idx);
}
- return groups;
}
void
-Translator_group::terminate_translator (Translator*r_l)
+recurse_over_translators (Context *c, Translator_method ptr,
+ Translator_group_method tg_ptr, Direction dir)
{
- DOUT << "Removing " << r_l->name() << " at " << now_moment () << "\n";
- r_l->removal_processing();
- Translator * trans_p =remove_translator_p (r_l);
-
- delete trans_p;
-}
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-Translator *
-Translator_group::remove_translator_p (Translator*trans_l)
-{
- PCursor<Translator*> trans_cur (trans_p_list_.find (trans_l));
- Translator * t = trans_cur.remove_p();
- /*
- For elegant design, we would do this too. Alas, it does not work yet..
-
- t-> removal_processing ();
- */
- t-> daddy_trans_l_ = 0;
- return t;
-}
+ if (tg && dir == DOWN)
+ {
+ (tg->*tg_ptr) ();
+ 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);
-Translator*
-Translator_group::get_simple_translator (char const *type) const
-{
- for (int i=0; i < nongroup_l_arr ().size(); i++)
+ if (tg && dir == UP)
{
- if (nongroup_l_arr ()[i]->name() == type)
- return nongroup_l_arr ()[i];
+ translator_each (tg->get_simple_trans_list (),
+ ptr);
+
+ (tg->*tg_ptr) ();
}
- if (daddy_trans_l_)
- return daddy_trans_l_->get_simple_translator (type);
- return 0;
}
-
-bool
-Translator_group::is_bottom_translator_b () const
+Translator_group::Translator_group ()
{
- return !accepts_str_arr_.size ();
-}
-
-
-
-Translator_group*
-Translator_group::get_default_interpreter()
-{
- if (accepts_str_arr_.size())
- {
- Translator*t = output_def_l ()->find_translator_l (accepts_str_arr_[0]);
- Translator_group * g= t->clone ()->group_l ();
- add (g);
-
- if (!g->is_bottom_translator_b ())
- return g->get_default_interpreter ();
- else
- return g;
- }
- return this;
+ simple_trans_list_ = SCM_EOL;
+ protected_events_ = SCM_EOL;
+ context_ = 0;
+ smobify_self ();
}
void
-Translator_group::each (Method_pointer method) const
+Translator_group::derived_mark () const
{
- for (PCursor<Translator*> i (trans_p_list_.top ()); i.ok (); i++)
- (i.ptr()->*method) ();
}
void
-Translator_group::do_print() const
+Translator_group::precompute_method_bindings ()
{
-#ifndef NPRINT
- if (!check_debug)
- return ;
- if (status == ORPHAN)
- {
- DOUT << "consists of: ";
- for (int i=0; i < consists_str_arr_.size (); i++)
- DOUT << consists_str_arr_[i] << ", ";
- DOUT << "\naccepts: ";
- for (int i=0; i < accepts_str_arr_.size (); i++)
- DOUT << accepts_str_arr_[i] << ", ";
- }
- else
+ for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
{
- if (id_str_)
- DOUT << "ID: " << id_str_ ;
- DOUT << " iterators: " << iterator_count_<< "\n";
+ Translator *tr = unsmob_translator (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]));
+ }
}
- each (&Translator::print);
-#endif
+
+ fetch_precomputable_methods (precomputed_self_method_bindings_);
}
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_requests ()
+Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
{
- each (&Translator::process_requests);
+ 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 ("#<Translator_group ", port);
+ scm_puts (me->class_name (), port);
+ scm_display (me->simple_trans_list_, port);
+ scm_puts (" >", port);
+ return 1;
}
-void
-Translator_group::do_add_processing ()
+SCM
+Translator_group::mark_smob (SCM smob)
{
- for (int i=0; i < consists_str_arr_.size(); i++)
- {
- Translator * t = output_def_l ()->find_translator_l (consists_str_arr_[i]);
- if (!t)
- warning ("Could not find `" +consists_str_arr_[i]+ "'");
- else
- add (t->clone ());
- }
+ Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
+
+ me->derived_mark ();
+ scm_gc_mark (me->protected_events_);
+ return me->simple_trans_list_;
}