]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator-group.cc
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / lily / translator-group.cc
index 0e5e9cb5335c146d2e5146619ba2e1ed4a4a0f3b..e2541996efcbc998c88a11da8a16ee9a22cb8979 100644 (file)
 /*
-  Translator_group.cc -- implement Translator_group
+  translator-group.cc -- implement Translator_group
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2002 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2006 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 "scm-hash.hh"
-#include "translator-def.hh"
-#include "main.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_gc_unprotect_object (tab->self_scm ());
-}
 
-Scheme_hash_table*
-Translator_group::properties_dict () const
-{
-  return Scheme_hash_table::unsmob (properties_scm_);
-}
+#include "context-def.hh"
+#include "context.hh"
+#include "dispatcher.hh"
+#include "international.hh"
+#include "main.hh"
+#include "music.hh"
+#include "output-def.hh"
+#include "scm-hash.hh"
+#include "stream-event.hh"
+#include "warn.hh"
 
-Translator_group::~Translator_group ()
+Translator_group *
+Translator_group::get_daddy_translator () const
 {
-  
-  //assert (removable_b ());
-}
-
-
-Translator_group::Translator_group ()
-{
-  iterator_count_  = 0;
-  Scheme_hash_table *tab = new Scheme_hash_table ;
-  properties_scm_ = tab->self_scm ();
-
-  scm_gc_unprotect_object (tab->self_scm ());
+  return context ()->get_parent_context ()->implementation ();
 }
 
 void
-Translator_group::check_removal ()
+translator_each (SCM list, Translator_method method)
 {
-  SCM next = SCM_EOL; 
-  for (SCM p = trans_group_list_; gh_pair_p (p); p = next)
-    {
-      next = ly_cdr (p);
-
-      Translator_group *trg =  dynamic_cast<Translator_group*> (unsmob_translator (ly_car (p)));
-
-      trg->check_removal ();
-      if (trg->removable_b ())
-       terminate_translator (trg);
-    }
+  for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
+    (unsmob_translator (scm_car (p))->*method) ();
 }
 
-SCM
-Translator_group::add_translator (SCM list, Translator *t)
+void
+Translator_group::initialize ()
 {
-  /*
-    Must append, since list ordering must be preserved.
-   */
-  list = gh_append2 (list, gh_cons (t->self_scm (), SCM_EOL));
-  t->daddy_trans_l_ = this;
-  t->output_def_l_ = output_def_l_;
-
-  return list;
+  precompute_method_bindings ();
 }
 
-
 void
-Translator_group::add_used_group_translator (Translator *t)
+Translator_group::connect_to_context (Context *c)
 {
-  trans_group_list_ = add_translator (trans_group_list_,t);
+  if (context_)
+    programming_error ("already connected to a context");
+  context_ = c;
+  c->event_source ()->add_listener (GET_LISTENER (eat_event), ly_symbol2scm ("MusicEvent"));
 }
 
-
 void
-Translator_group::add_fresh_group_translator (Translator*t)
+Translator_group::finalize ()
 {
-  Translator_group*tg = dynamic_cast<Translator_group*> (t);
-  assert (tg);
-
-  trans_group_list_ = add_translator (trans_group_list_,t); 
-  unsmob_translator_def (tg->definition_)->apply_property_operations (tg);
-  t->initialize ();
-  
 }
 
-
 bool
-Translator_group::removable_b () const
+translator_accepts_any_of (Translator *tr, SCM ifaces)
 {
-  return trans_group_list_ == SCM_EOL && ! iterator_count_;
+  SCM ack_ifs = scm_assoc (ly_symbol2scm ("events-accepted"),
+                          tr->translator_description ());
+  ack_ifs = scm_cdr (ack_ifs);
+  for (SCM s = ifaces; scm_is_pair (s); s = scm_cdr (s))
+    if (scm_c_memq (scm_car (s), ack_ifs) != SCM_BOOL_F)
+      return true;
+  return false;
 }
 
-Translator_group *
-Translator_group::find_existing_translator_l (String n, String id)
+SCM
+find_accept_translators (SCM gravlist, SCM ifaces)
 {
-  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 = ly_cdr (p))
+  SCM l = SCM_EOL;
+  for (SCM s = gravlist; scm_is_pair (s); s = scm_cdr (s))
     {
-      Translator *  t = unsmob_translator (ly_car (p));
-      
-      r = dynamic_cast<Translator_group*> (t)->find_existing_translator_l (n, id);
+      Translator *tr = unsmob_translator (scm_car (s));
+      if (translator_accepts_any_of (tr, ifaces))
+       l = scm_cons (tr->self_scm (), l);
     }
+  l = scm_reverse_x (l, SCM_EOL);
 
-  return r;
+  return l;
 }
 
-
-
-
-Translator_group*
-Translator_group::find_create_translator_l (String n, String id)
+IMPLEMENT_LISTENER (Translator_group, eat_event);
+void
+Translator_group::eat_event (SCM sev)
 {
-  Translator_group * existing = find_existing_translator_l (n,id);
-  if (existing)
-    return existing;
-
-  Link_array<Translator_def> path
-    = unsmob_translator_def (definition_)->path_to_acceptable_translator (ly_str02scm ((char*)n.ch_C ()), output_def_l ());
-
-  if (path.size ())
-    {
-      Translator_group * current = this;
-
-      // start at 1.  The first one (index 0) will be us.
-      for (int i=0; i < path.size (); i++)
-       {
-         Translator_group * new_group = path[i]->instantiate (output_def_l_);
+  Stream_event *ev = unsmob_stream_event (sev);
+  SCM sm = ev->get_property ("music");
+  Music *m = unsmob_music (sm);
+  try_music (m);
+}
 
-         if (i == path.size () -1)
-           new_group->id_str_ = id;      
-         current->add_fresh_group_translator (new_group);
-         current = new_group;
-       }
+bool
+Translator_group::try_music (Music *m)
+{
+  SCM name = scm_sloppy_assq (ly_symbol2scm ("name"),
+                             m->get_property_alist (false));
 
-      return current;
-    }
+  if (!scm_is_pair (name))
+    return false;
 
-  Translator_group *ret = 0;
-  if (daddy_trans_l_)
-    ret = daddy_trans_l_->find_create_translator_l (n,id);
-  else
+  name = scm_cdr (name);
+  SCM accept_list = scm_hashq_ref (accept_hash_table_, name, SCM_UNDEFINED);
+  if (accept_list == SCM_BOOL_F)
     {
-      warning (_f ("can't find or create `%s' called `%s'", n, id));
-      ret =0;
+      accept_list = find_accept_translators (get_simple_trans_list (),
+                                            m->get_property ("types"));
+      scm_hashq_set_x (accept_hash_table_, name, accept_list);
     }
-  return ret;
-}
 
-bool
-Translator_group::try_music_on_nongroup_children (Music *m)
-{
-  bool hebbes_b =false;
-  
-  for (SCM p = simple_trans_list_; !hebbes_b && gh_pair_p (p); p = ly_cdr (p))
+  for (SCM p = accept_list; scm_is_pair (p); p = scm_cdr (p))
     {
-      hebbes_b = unsmob_translator (ly_car (p))->try_music (m);
+      Translator *t = unsmob_translator (scm_car (p));
+      if (t && t->try_music (m))
+       return true;
     }
-  return hebbes_b;
-}
-
-bool
-Translator_group::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;
+    
+  // 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);
+  else
+    // We have tried all possible contexts. Give up.
+    m->origin ()->warning (_f ("junking event: `%s'", m->name ()));
+  return false;
 }
 
-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)
 {
-  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)
-{
-  assert (trans_l);
+  Translator_group *tg
+    = dynamic_cast<Translator_group *> (c->implementation ());
 
-  trans_group_list_ = scm_delq_x (trans_l->self_scm (), trans_group_list_);
-  trans_l->daddy_trans_l_ = 0;
-  return trans_l;
-}
-
-bool
-Translator_group::is_bottom_translator_b () const
-{
-  return !gh_string_p (unsmob_translator_def (definition_)->default_child_context_name ());
-
-}
-
-Translator_group*
-Translator_group::get_default_interpreter ()
-{
-  if (!is_bottom_translator_b ())
+  if (dir == DOWN)
     {
-      SCM nm = unsmob_translator_def (definition_)->default_child_context_name ();
-      SCM st = output_def_l ()->find_translator_l (nm);
+      tg->precomputed_translator_foreach (idx);
+      tg->call_precomputed_self_method (idx);
+    }
 
-      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_fresh_group_translator (tg);
+  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->is_bottom_translator_b ())
-       return tg->get_default_interpreter ();
-      else
-       return tg;
+  if (dir == UP)
+    {
+      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 = ly_cdr (p))
-    (unsmob_translator (ly_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 ());
 
-/*
-  PROPERTIES
- */
-Translator_group*
-Translator_group::where_defined (SCM sym) const
-{
-  if (properties_dict ()->elem_b (sym))
+  if (dir == DOWN)
     {
-      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);
 
-/*
-  return SCM_EOL when not found.
-*/
-SCM
-Translator_group::internal_get_property (SCM sym) const
-{
-  SCM val =SCM_EOL;
-  if (properties_dict ()->try_retrieve (sym, &val))
-    return val;
-
-  if (daddy_trans_l_)
-    return daddy_trans_l_->internal_get_property (sym);
-  
-  return val;
+  if (dir == UP)
+    {
+      translator_each (tg->get_simple_trans_list (),
+                      ptr);
+
+      (tg->*tg_ptr) ();
+    }
 }
 
-void
-Translator_group::internal_set_property (SCM sym, SCM val)
+Translator_group::Translator_group ()
 {
-#ifndef NDEBUG
-  if (internal_type_checking_global_b)
-    assert (type_check_assignment (sym, val, ly_symbol2scm ("translation-type?")));
-#endif
-  
-  properties_dict ()->set (sym, val);
+  simple_trans_list_ = SCM_EOL;
+  accept_hash_table_ = SCM_EOL;
+  context_ = 0;
+  smobify_self ();
+
+  accept_hash_table_ = scm_c_make_hash_table (19);
 }
 
-/*
-  TODO: look up to check whether we have inherited var? 
- */
 void
-Translator_group::unset_property (SCM sym)
+Translator_group::derived_mark () const
 {
-  properties_dict ()->remove (sym);
 }
 
-
-/*
-  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 = internal_get_property (prop);
-
-         if (gh_pair_p (prev) || prev == SCM_EOL)
-           {
-             bool ok = type_check_assignment (eltprop, val, ly_symbol2scm ("backend-type?"));
-             
-             if (ok)
-               {
-                 prev = gh_cons (gh_cons (eltprop, val), prev);
-                 internal_set_property (prop, prev);
-               }
-           }
-         else
-           {
-             // warning here.
-           }
-         
-       }
-      else
+      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++)
        {
-         SCM prev = internal_get_property (prop);
-
-         SCM newprops= SCM_EOL ;
-         while (gh_pair_p (prev) && ly_caar (prev) != eltprop)
-           {
-             newprops = gh_cons (ly_car (prev), newprops);
-             prev = ly_cdr (prev);
-           }
-         
-         if (gh_pair_p (prev))
-           {
-             newprops = scm_reverse_x (newprops, ly_cdr (prev));
-             internal_set_property (prop, newprops);
-           }
+         if (ptrs[i])
+           precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
        }
     }
-}
-
-
-
 
-
-/*
-  STUBS
-*/
-void
-Translator_group::stop_translation_timestep ()
-{
-  each (&Translator::stop_translation_timestep);
+  fetch_precomputable_methods (precomputed_self_method_bindings_);
 }
 
 void
-Translator_group::start_translation_timestep ()
+Translator_group::precomputed_translator_foreach (Translator_precompute_index idx)
 {
-  each (&Translator::start_translation_timestep);
+  vector<Translator_method_binding> &bindings (precomputed_method_bindings_[idx]);
+  for (vsize i = 0; i < bindings.size (); i++)
+    bindings[i].invoke ();
 }
 
 void
-Translator_group::do_announces ()
+Translator_group::fetch_precomputable_methods (Translator_group_void_method ptrs[])
 {
-  each (&Translator::announces);
+  for (int i = 0; i < TRANSLATOR_METHOD_PRECOMPUTE_COUNT; i++)
+    ptrs[i] = 0;
 }
 
 void
-Translator_group::initialize ()
+Translator_group::call_precomputed_self_method (Translator_precompute_index idx)
 {
-  each (&Translator::initialize);
+  if (precomputed_self_method_bindings_[idx])
+    (*precomputed_self_method_bindings_[idx]) (this);
 }
 
-void
-Translator_group::finalize ()
+Translator_group::~Translator_group ()
 {
-  each (&Translator::removal_processing);
 }
 
-LY_DEFINE(ly_get_context_property,
-         "ly-get-context-property", 2, 0, 0,
-         (SCM context, SCM name),
-         "retrieve the value of @var{sym} from context @var{tr}")
-{
-  Translator *t = unsmob_translator (context);
-  Translator_group* tr=   dynamic_cast<Translator_group*> (t);
-  SCM_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Translator group");
-  SCM_ASSERT_TYPE(gh_symbol_p(name), name, SCM_ARG2, __FUNCTION__, "symbol");
+#include "ly-smobs.icc"
 
-  return tr->internal_get_property (name);
-  
-}
+IMPLEMENT_SMOBS (Translator_group);
+IMPLEMENT_DEFAULT_EQUAL_P (Translator_group);
+IMPLEMENT_TYPE_P (Translator_group, "ly:translator-group?");
 
-LY_DEFINE(ly_set_context_property,
-         "ly-set-context-property", 3, 0, 0,
-         (SCM context, SCM name, SCM val),
-         "set value of property @var{sym} in context @var{tr} to @var{val}.
-")
+int
+Translator_group::print_smob (SCM s, SCM port, scm_print_state *)
 {
-  Translator *t = unsmob_translator (context);
-  Translator_group* tr=   dynamic_cast<Translator_group*> (t);
+  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_ASSERT_TYPE(tr, context, SCM_ARG1, __FUNCTION__, "Context");
-  tr->internal_set_property (name, val);
+SCM
+Translator_group::mark_smob (SCM smob)
+{
+  Translator_group *me = (Translator_group *)SCM_CELL_WORD_1 (smob);
 
-  return SCM_UNSPECIFIED;
+  me->derived_mark ();
+  scm_gc_mark (me->accept_hash_table_);
+  return me->simple_trans_list_;
 }