X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator-group.cc;h=ac4e97eb2a5ec8312b9a6b672bcd2602715e619e;hb=5a22d6233a39d3164e1ca043244794c268be4ad0;hp=f80b2c49de598672e9b21968e9fc269d0c48bde8;hpb=06aaa8f02f831cfc94fcac1fb99eeded3b3cc6cc;p=lilypond.git

diff --git a/lily/translator-group.cc b/lily/translator-group.cc
index f80b2c49de..1980da53d0 100644
--- a/lily/translator-group.cc
+++ b/lily/translator-group.cc
@@ -1,455 +1,332 @@
 /*
-  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--2009 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 "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_;
-  consists_end_str_arr_ = s.consists_end_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)
 {
-  Cons<Translator> *next =0;
-  for (Cons<Translator> *p = trans_p_list_.head_; p; p = next)
+  if (context_)
     {
-      next = p->next_;
-      if (Translator_group *trg =  dynamic_cast <Translator_group *> (p->car_))
-	{
-	  trg->check_removal ();
-	  if (trg->removable_b())
-	    terminate_translator (trg);
-	}
+      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::add_last_element (String s)
+Translator_group::finalize ()
 {
-  if (!get_translator_l (s))
-    error (_ ("Program has no such type"));
-
-  for (int i=consists_end_str_arr_.size (); i--; )
-    if (consists_end_str_arr_[i] == s)
-      warning (_f ("Already contains: `%s'", s));
-      
-  consists_end_str_arr_.push (s);
 }
 
-void
-Translator_group::set_element (String s, bool add)
-{
-  if (!get_translator_l (s))
-    error (_ ("Program has no such type"));
-
-  if (add)
-    {
-      for (int i=consists_str_arr_.size (); i--; )
-	if (consists_str_arr_[i] == s)
-	  warning (_f("Already contains: `%s'", s));
-      
-      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);
-      for (int i=consists_end_str_arr_.size (); i--; )
-	if (consists_end_str_arr_[i] == s)
-	  consists_end_str_arr_.del (i);
-    }
-}
-bool
-Translator_group::removable_b() const
+SCM
+filter_performers (SCM ell)
 {
-  for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
+  SCM *tail = &ell;
+  for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
     {
-      if (dynamic_cast <Translator_group *> (p->car_))
-	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;
-
-  Translator_group* r = 0;
-  for (Cons<Translator> *p = trans_p_list_.head_; !r && p; p = p->next_)
+  SCM *tail = &ell;
+  for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
     {
-      if (Translator_group *trg =  dynamic_cast <Translator_group *> (p->car_))
-	r = trg->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));
-    }
-
+/* 
+  Protects the parameter from being garbage collected. The object is
+  protected until the next disconnect_from_context call.
 
- 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;
-	}
-    }
-
-  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++)
+      SCM definition = scm_car (s);
+
+      Translator *type = 0;
+      if (ly_is_symbol (definition))
+	type = get_translator (definition);
+	 
+      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 *instance = type->clone ();
+
+	  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 ();
 	}
-      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);
 
-bool
-Translator_group::try_music_on_nongroup_children (Music *m)
-{
-  bool hebbes_b =false;
+  // TODO: scrap Context::implementation
+  new_context->implementation_ = g;
 
-  for (Cons<Translator> *p = trans_p_list_.head_; !hebbes_b && p; p = p->next_)
-    {
-      if (!dynamic_cast <Translator_group *> (p->car_))
-	{
-	  hebbes_b = p->car_->try_music (m);
-	}
-    }
-  return hebbes_b;
-}
+  g->connect_to_context (new_context);
+  g->unprotect ();
 
-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 ;
-}
-
-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)
+precomputed_recurse_over_translators (Context *c, Translator_precompute_index idx, Direction dir)
 {
-  DEBUG_OUT << "Removing " << classname (r_l) << " at " << now_mom () << '\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 ());
 
-/**
-   Remove a translator from the hierarchy.
- */
-Translator *
-Translator_group::remove_translator_p (Translator*trans_l)
-{
-  assert (trans_l);
-  
-  for (Cons<Translator> **pp = &trans_p_list_.head_; *pp; pp = &(*pp)->next_)
-    if ((*pp)->car_ == trans_l)
-      {
-	Cons<Translator> *r = trans_p_list_.remove_cons (pp);
-	r->car_ =0;
-	trans_l->daddy_trans_l_ =0;
-	delete r;
-	return trans_l;
-      }
-
-  return 0;
-}
+  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 (unsmob_context (scm_car (s)), idx, dir);
 
-Translator*
-Translator_group::get_simple_translator (String type) const
-{
-  for (Cons<Translator> *p = trans_p_list_.head_; p; p = p->next_)
+  if (tg && dir == UP)
     {
-      if (classname (p->car_) == type)
-	return p->car_;
+      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;
 }
 
-
-bool
-Translator_group::is_bottom_translator_b () const
+void
+recurse_over_translators (Context *c, Translator_method ptr,
+			  Translator_group_method tg_ptr, Direction dir)
 {
-  return !accepts_str_arr_.size ();
-}
+  Translator_group *tg
+    = dynamic_cast<Translator_group *> (c->implementation ());
 
+  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_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_; p; p = p->next_)
-    (p->car_->*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_; p; p = p->next_)
-    (p->car_->*method) ();
 }
 
 void
-Translator_group::do_print() const
+Translator_group::precompute_method_bindings ()
 {
-#ifndef NPRINT
-  if (!flower_dstream)
-    return ;
-
-  gh_display (properties_dict_.self_scm_);
-  if (status == ORPHAN)
+  for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
     {
-      DEBUG_OUT << "consists of: ";
-      for (int i=0; i < consists_str_arr_.size (); i++)
-	DEBUG_OUT << consists_str_arr_[i] << ", ";
-      DEBUG_OUT << "\naccepts: ";
-      for (int i=0; i < accepts_str_arr_.size (); i++)
-	DEBUG_OUT << accepts_str_arr_[i] << ", ";
-    }
-  else
-    {
-      if (id_str_.length_i ())
-	DEBUG_OUT << "ID: " << id_str_ ;
-      DEBUG_OUT << " 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 ()
+#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 *)
 {
-   for (int i=0; i < consists_str_arr_.size(); i++)
-    {
-      String s = consists_str_arr_[i];
-      Translator * t = output_def_l ()->find_translator_l (s);
-      if (!t)
-	warning (_f ("Can't find: `%s'", s));
-      else
-	add_translator (t->clone ());
-    }
-   for (int i=0; i-- < consists_end_str_arr_.size (); i++)
-     {
-       String s = consists_end_str_arr_[i];
-       Translator * t = output_def_l ()->find_translator_l (s);
-       if (!t)
-	 warning (_f ("Can't find: `%s'", s));
-       else
-	 add_translator (t->clone ());
-    }
+  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::get_property (SCM sym, Translator_group **where_l) const
+Translator_group::mark_smob (SCM smob)
 {
-  if (properties_dict_.elem_b (sym))
-    {
-      if (where_l)
-	*where_l = (Translator_group*) this; // ugh
-      return properties_dict_.get (sym);
-    }
-
-  if (daddy_trans_l_)
-    return daddy_trans_l_->get_property (sym, where_l);
-  
-  if (where_l)
-    *where_l = 0;
+  Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
 
-  return SCM_UNDEFINED;
-}
-
-void
-Translator_group::set_property (String id, SCM val)
-{
-  properties_dict_.set (ly_symbol2scm (id.ch_C()), val);
+  me->derived_mark ();
+  scm_gc_mark (me->protected_events_);
+  return me->simple_trans_list_;
 }