/*
- Translator_group.cc -- implement Translator_group
+ translator-group.cc -- implement Translator_group
source file of the GNU LilyPond music typesetter
- (c) 1997--1999 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 "rational.hh"
-#include "dictionary-iter.hh"
-#include "killing-cons.tcc"
+#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)
-{
- consists_str_arr_ = s.consists_str_arr_;
- accepts_str_arr_ = s.accepts_str_arr_;
- iterator_count_ =0;
- properties_dict_ = s.properties_dict_;
-}
-Translator_group::~Translator_group ()
+void
+translator_each (SCM list, Translator_method method)
{
- assert (removable_b());
- trans_p_list_.junk ();
+ 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)
{
- Link_array<Translator_group> groups (group_l_arr ());
-
- for (int i =0; i < groups.size(); i++)
+ if (context_)
{
- groups[i]->check_removal();
- if (groups[i]->removable_b())
- terminate_translator (groups[i]);
+ programming_error ("translator group is already connected to context "
+ + context_->context_name ());
}
-}
-
-
-
-
-
-void
-Translator_group::add_translator (Translator *trans_p)
-{
- trans_p_list_.append (new Killing_cons<Translator> (trans_p,0));
- trans_p->daddy_trans_l_ = this;
- trans_p->output_def_l_ = output_def_l_;
- trans_p->add_processing ();
+ 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::set_acceptor (String accepts, bool add)
+Translator_group::disconnect_from_context ()
{
- if (add)
- accepts_str_arr_.push (accepts);
- else
- for (int i=accepts_str_arr_.size (); i--; )
- if (accepts_str_arr_[i] == accepts)
- accepts_str_arr_.del (i);
+ 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::set_element (String s, bool add)
+Translator_group::finalize ()
{
- if (!get_translator_l (s))
- error ("Program has no such type");
-
- if (add)
- consists_str_arr_.push (s);
- else
- for (int i=consists_str_arr_.size (); i--; )
- if (consists_str_arr_[i] == s)
- consists_str_arr_.del (i);
}
-bool
-Translator_group::removable_b() const
+SCM
+filter_performers (SCM ell)
{
- for (Cons<Translator> *p = trans_p_list_.head_cons_p_; p; p = p->next_cons_p_)
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- if (dynamic_cast <Translator_group *> (p->car_p_))
- return false;
+ if (dynamic_cast<Performer *> (unsmob_translator (scm_car (*tail))))
+ *tail = scm_cdr (*tail);
+ else
+ tail = SCM_CDRLOC (*tail);
}
-
- return !iterator_count_;
+ 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;
-
- Link_array<Translator_group> groups (group_l_arr ());
- Translator_group* r = 0;
- for (int i =0; !r && i < groups.size(); i++)
+ SCM *tail = ℓ
+ for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
{
- r = groups[i]->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;
}
-Link_array<Translator_group>
-Translator_group::path_to_acceptable_translator (String type) const
-{
- Link_array<Translator_group> accepted_arr;
- for (int i=0; i < accepts_str_arr_.size (); i++)
- {
- Translator *t = output_def_l ()->find_translator_l (accepts_str_arr_[i]);
- if (!t || !dynamic_cast <Translator_group *> (t))
- continue;
- accepted_arr.push (dynamic_cast <Translator_group *> (t));
- }
-
-
- for (int i=0; i < accepted_arr.size (); i++)
- if (accepted_arr[i]->type_str_ == type)
- {
- Link_array<Translator_group> retval;
- retval.push (accepted_arr[i]);
- return retval;
- }
-
- Link_array<Translator_group> best_result;
- int best_depth= INT_MAX;
- for (int i=0; i < accepted_arr.size (); i++)
- {
- Translator_group * g = accepted_arr[i];
-
- Link_array<Translator_group> result
- = g->path_to_acceptable_translator (type);
- if (result.size () && result.size () < best_depth)
- {
- result.insert (g,0);
- best_result = result;
- }
- }
+/*
+ Protects the parameter from being garbage collected. The object is
+ protected until the next disconnect_from_context call.
- return best_result;
+ 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)
-{
- Translator_group * existing = find_existing_translator_l (n,id);
- if (existing)
- return existing;
+/*
+ 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);
- Link_array<Translator_group> path = path_to_acceptable_translator (n);
+ Translator_group *g = get_translator_group (def->get_translator_group_type ());
+ SCM trans_list = SCM_EOL;
- if (path.size ())
+ for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
{
- Translator_group * current = this;
-
- // start at 1. The first one (index 0) will be us.
- for (int i=0; i < path.size (); i++)
+ 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 = dynamic_cast<Translator_group*>(path[i]->clone ());
- current->add_translator (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 (_f ("can't find or create `%s\' called `%s\'", n, id));
- 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);
+ // TODO: scrap Context::implementation
+ new_context->implementation_ = g;
-bool
-Translator_group::do_try_music (Music* req_l)
-{
- bool hebbes_b =false;
+ g->connect_to_context (new_context);
+ g->unprotect ();
- Link_array<Translator> nongroups (nongroup_l_arr ());
-
- for (int i =0; !hebbes_b && i < nongroups.size() ; i++)
- hebbes_b =nongroups[i]->try_music (req_l);
- if (!hebbes_b && daddy_trans_l_)
- hebbes_b = daddy_trans_l_->try_music (req_l);
- return hebbes_b ;
+ recurse_over_translators (new_context,
+ &Translator::initialize,
+ &Translator_group::initialize,
+ DOWN);
}
-int
-Translator_group::depth_i() const
+SCM
+Translator_group::get_simple_trans_list ()
{
- return (daddy_trans_l_) ? daddy_trans_l_->depth_i() + 1 : 0;
+ return simple_trans_list_;
}
-Translator_group*
-Translator_group::ancestor_l (int level)
+void
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
{
- if (!level || !daddy_trans_l_)
- return this;
-
- return daddy_trans_l_->ancestor_l (level-1);
-}
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-Link_array<Translator_group>
-Translator_group::group_l_arr () const
-{
- Link_array<Translator_group> groups;
- for (Cons<Translator> *p = trans_p_list_.head_cons_p_; p; p = p->next_cons_p_)
+ if (tg && dir == DOWN)
{
- if (dynamic_cast <Translator_group *> (p->car_p_))
- groups.push (dynamic_cast <Translator_group *> (p->car_p_));
+ 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 (Cons<Translator> *p = trans_p_list_.head_cons_p_; p; p = p->next_cons_p_)
+ 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 (!dynamic_cast <Translator_group *> (p->car_p_))
- groups.push (p->car_p_);
+ tg->precomputed_translator_foreach (idx);
+ tg->call_precomputed_self_method (idx);
}
- return groups;
}
-/**
- End translator: call "destructor", remove from hierarchy, and delete
- */
void
-Translator_group::terminate_translator (Translator*r_l)
-{
- DOUT << "Removing " << classname (r_l) << " at " << now_mom () << '\n';
- r_l->removal_processing();
- Translator * trans_p =remove_translator_p (r_l);
-
- delete trans_p;
-}
-
-
-/**
- Remove a translator from the hierarchy.
- */
-Translator *
-Translator_group::remove_translator_p (Translator*trans_l)
+recurse_over_translators (Context *c, Translator_method ptr,
+ Translator_group_method tg_ptr, Direction dir)
{
- assert (trans_l);
-
- for (Cons<Translator> **pp = &trans_p_list_.head_cons_p_; *pp; pp = &(*pp)->next_cons_p_)
- if ((*pp)->car_p_ == trans_l)
- {
- Cons<Translator> *r = trans_p_list_.remove_cons_p (pp);
- r->car_p_ =0;
- trans_l->daddy_trans_l_ =0;
- delete r;
- return trans_l;
- }
-
- return 0;
-}
-
+ Translator_group *tg
+ = dynamic_cast<Translator_group *> (c->implementation ());
-Translator*
-Translator_group::get_simple_translator (String type) const
-{
- Link_array<Translator> nongroups (nongroup_l_arr ());
- for (int i=0; i < nongroups.size(); i++)
+ if (tg && dir == DOWN)
{
- if (classname (nongroups[i]) == type)
- return nongroups[i];
+ (tg->*tg_ptr) ();
+ translator_each (tg->get_simple_trans_list (), ptr);
}
- if (daddy_trans_l_)
- return daddy_trans_l_->get_simple_translator (type);
- return 0;
-}
-
-
-bool
-Translator_group::is_bottom_translator_b () const
-{
- return !accepts_str_arr_.size ();
-}
-
+ 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_group*
-Translator_group::get_default_interpreter()
-{
- if (accepts_str_arr_.size())
+ if (tg && dir == UP)
{
- Translator*t = output_def_l ()->find_translator_l (accepts_str_arr_[0]);
- if (!t)
- {
- warning (_f ("can't find or create `%s\'", accepts_str_arr_[0]));
- t = this;
- }
- Translator_group * g= dynamic_cast <Translator_group*>(t->clone ());
- add_translator (g);
+ translator_each (tg->get_simple_trans_list (),
+ ptr);
- if (!g->is_bottom_translator_b ())
- return g->get_default_interpreter ();
- else
- return g;
+ (tg->*tg_ptr) ();
}
- return this;
}
-void
-Translator_group::each (Method_pointer method)
+Translator_group::Translator_group ()
{
- for (Cons<Translator> *p = trans_p_list_.head_cons_p_; p; p = p->next_cons_p_)
- (p->car_p_->*method) ();
+ simple_trans_list_ = SCM_EOL;
+ protected_events_ = SCM_EOL;
+ context_ = 0;
+ smobify_self ();
}
-
void
-Translator_group::each (Const_method_pointer method) const
+Translator_group::derived_mark () const
{
- for (Cons<Translator> *p = trans_p_list_.head_cons_p_; p; p = p->next_cons_p_)
- (p->car_p_->*method) ();
}
void
-Translator_group::do_print() const
+Translator_group::precompute_method_bindings ()
{
-#ifndef NPRINT
- if (!check_debug)
- return ;
- for (Dictionary_iter<Scalar> i (properties_dict_); i.ok (); i++)
+ for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
{
- DOUT << i.key () << "=" << i.val () << '\n';
- }
- 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
- {
- if (id_str_.length_i ())
- 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
-}
-void
-Translator_group::do_pre_move_processing ()
-{
- each (&Translator::pre_move_processing);
+ fetch_precomputable_methods (precomputed_self_method_bindings_);
}
void
-Translator_group::do_post_move_processing ()
+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_process_requests ()
+Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
{
- each (&Translator::process_requests);
+ for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
+ ptrs[i] = 0;
}
void
-Translator_group::do_creation_processing ()
+Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
{
- each (&Translator::creation_processing);
+ if (precomputed_self_method_bindings_[idx])
+ (*precomputed_self_method_bindings_[idx]) (this);
}
-void
-Translator_group::do_removal_processing ()
+Translator_group::~Translator_group ()
{
- each (&Translator::removal_processing);
}
-void
-Translator_group::do_add_processing ()
-{
- 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 (_f ("can't find `%s\'", consists_str_arr_[i]));
- else
- add_translator (t->clone ());
- }
-}
+#include "ly-smobs.icc"
-Scalar
-Translator_group::get_property (String id,
- Translator_group **where_l) const
-{
- if (properties_dict_.elem_b (id))
- {
- if (where_l)
- *where_l = (Translator_group*) this; // ugh
- return properties_dict_[id];
- }
-
- if (daddy_trans_l_)
- return daddy_trans_l_->get_property (id, where_l);
+IMPLEMENT_SMOBS (Translator_group);
+IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
+IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
- if (where_l)
- *where_l = 0;
- return "";
+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;
}
-void
-Translator_group::set_property (String id, Scalar val)
+SCM
+Translator_group::mark_smob (SCM smob)
{
- properties_dict_[id] = val;
+ 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