]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator-group.cc
2006-09-22 Erik Sandberg <mandolaerik@gmail.com>
[lilypond.git] / lily / translator-group.cc
index 2646dba0f8696005ce86658ae9f513b0912d3969..badd1b82e802da140b35901b97a953e4be1b2ecd 100644 (file)
@@ -3,18 +3,24 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>,
+                 Erik Sandberg <mandolaerik@gmail.com>
 */
 
 #include "translator-group.hh"
 
-#include "output-def.hh"
-#include "warn.hh"
-#include "scm-hash.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 "stream-event.hh"
+#include "warn.hh"
 
 Translator_group *
 Translator_group::get_daddy_translator () const
@@ -35,6 +41,43 @@ Translator_group::initialize ()
   precompute_method_bindings ();
 }
 
+void
+Translator_group::connect_to_context (Context *c)
+{
+  if (context_)
+    {
+      programming_error ("translator group is already connected to context "
+                        +  context_->context_name ());
+    }
+  
+  context_ = c;
+  c->event_source ()->add_listener (GET_LISTENER (eat_event),
+                                   ly_symbol2scm ("OldMusicEvent"));
+  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::disconnect_from_context ()
+{
+  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 (eat_event),
+                                             ly_symbol2scm ("OldMusicEvent"));
+  context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
+                                             ly_symbol2scm ("AnnounceNewContext"));
+  context_ = 0;
+  protected_events_ = SCM_EOL;
+}
+
 void
 Translator_group::finalize ()
 {
@@ -67,6 +110,127 @@ find_accept_translators (SCM gravlist, SCM ifaces)
   return l;
 }
 
+SCM
+filter_performers (SCM ell)
+{
+  SCM *tail = &ell;
+  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;
+}
+
+SCM
+filter_engravers (SCM ell)
+{
+  SCM *tail = &ell;
+  for (SCM p = ell; scm_is_pair (p); p = scm_cdr (p))
+    {
+      if (dynamic_cast<Engraver *> (unsmob_translator (scm_car (*tail))))
+       *tail = scm_cdr (*tail);
+      else
+       tail = SCM_CDRLOC (*tail);
+    }
+  return ell;
+}
+
+/* 
+  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_);
+}
+
+/*
+  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);
+
+  Translator_group *g = get_translator_group (def->get_translator_group_type ());
+  SCM trans_list = SCM_EOL;
+
+  for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
+    {
+      Translator *type = get_translator (scm_car (s));
+      if (!type)
+       warning (_f ("can't find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
+      else
+       {
+         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 ();
+       }
+    }
+
+  /* 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;
+
+  g->connect_to_context (new_context);
+  g->unprotect ();
+
+  recurse_over_translators (new_context,
+                           &Translator::initialize,
+                           &Translator_group::initialize,
+                           DOWN);
+}
+
+IMPLEMENT_LISTENER (Translator_group, eat_event);
+void
+Translator_group::eat_event (SCM sev)
+{
+  Stream_event *ev = unsmob_stream_event (sev);
+  SCM sm = ev->get_property ("music");
+  Music *m = unsmob_music (sm);
+  try_music (m);
+}
+
 bool
 Translator_group::try_music (Music *m)
 {
@@ -91,6 +255,19 @@ Translator_group::try_music (Music *m)
       if (t && t->try_music (m))
        return true;
     }
+    
+  // We couldn't swallow the event in this context. Try parent.
+  Context *p = context ()->get_parent_context ();
+  // Global context's translator group is a dummy, so don't try it.
+  if (p->get_parent_context())
+    // ES todo: Make Translators listeners directly instead.
+    return p->implementation ()->try_music (m);
+  // 'junking event' warning is temporarily disabled during translator cleanup
+  /*
+  else
+    // We have tried all possible contexts. Give up.
+    m->origin ()->warning (_f ("junking event: `%s'", m->name ()));
+  */
   return false;
 }
 
@@ -152,6 +329,7 @@ Translator_group::Translator_group ()
 {
   simple_trans_list_ = SCM_EOL;
   accept_hash_table_ = SCM_EOL;
+  protected_events_ = SCM_EOL;
   context_ = 0;
   smobify_self ();
 
@@ -176,7 +354,7 @@ Translator_group::precompute_method_bindings ()
       for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
        {
          if (ptrs[i])
-           precomputed_method_bindings_[i].push (Translator_method_binding (tr, ptrs[i]));
+           precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
        }
     }
 
@@ -186,8 +364,8 @@ Translator_group::precompute_method_bindings ()
 void
 Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
 {
-  Array<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
-  for (int i = 0; i < bindings.size (); i++)
+  vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
+  for (vsize i = 0; i < bindings.size (); i++)
     bindings[i].invoke ();
 }
 
@@ -233,6 +411,6 @@ Translator_group::mark_smob (SCM smob)
 
   me->derived_mark ();
   scm_gc_mark (me->accept_hash_table_);
+  scm_gc_mark (me->protected_events_);
   return me->simple_trans_list_;
 }
-