]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/translator-group.cc
unsmob_pitch -> Pitch::unsmob and related
[lilypond.git] / lily / translator-group.cc
index 700f078f16f5048c8d6d05924cefc379951effcd..8735fa9f26c1648f7a1c687d86243fc013c940fc 100644 (file)
@@ -1,10 +1,21 @@
 /*
-  translator-group.cc -- implement Translator_group
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
-
-  (c) 1997--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>,
+  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>,
                  Erik Sandberg <mandolaerik@gmail.com>
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "translator-group.hh"
 #include "context-def.hh"
 #include "context.hh"
 #include "dispatcher.hh"
+#include "engraver.hh"
 #include "engraver-group.hh"
 #include "international.hh"
 #include "main.hh"
 #include "music.hh"
 #include "output-def.hh"
+#include "performer.hh"
 #include "performer-group.hh"
+#include "scheme-engraver.hh"
 #include "scm-hash.hh"
 #include "warn.hh"
 
-
 void
 translator_each (SCM list, Translator_method method)
 {
   for (SCM p = list; scm_is_pair (p); p = scm_cdr (p))
-    (unsmob_translator (scm_car (p))->*method) ();
+    (Translator::unsmob (scm_car (p))->*method) ();
 }
 
 void
@@ -41,15 +54,15 @@ Translator_group::connect_to_context (Context *c)
   if (context_)
     {
       programming_error ("translator group is already connected to context "
-                         context_->context_name ());
+                         + context_->context_name ());
     }
-  
+
   context_ = c;
   c->event_source ()->add_listener (GET_LISTENER (create_child_translator),
-                                   ly_symbol2scm ("AnnounceNewContext"));
+                                    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));
+      Translator *tr = Translator::unsmob (scm_car (tr_list));
       tr->connect_to_context (c);
     }
 }
@@ -59,11 +72,11 @@ 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));
+      Translator *tr = Translator::unsmob (scm_car (tr_list));
       tr->disconnect_from_context (context_);
     }
   context_->event_source ()->remove_listener (GET_LISTENER (create_child_translator),
-                                             ly_symbol2scm ("AnnounceNewContext"));
+                                              ly_symbol2scm ("AnnounceNewContext"));
   context_ = 0;
   protected_events_ = SCM_EOL;
 }
@@ -73,16 +86,25 @@ Translator_group::finalize ()
 {
 }
 
+/*
+  Both filter_performers and filter_engravers used to use a direct dynamic_cast
+  on the unsmobbed translator to be filtered, i.e.,
+
+  if (dynamic_cast<Performer *> (Translator::unsmob (scm_car (*tail))))
+
+  but this caused mysterious optimisation issues in several GUB builds.  See
+  issue #818 for the background to this change.
+*/
 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);
+      if (unsmob_performer (scm_car (*tail)))
+        *tail = scm_cdr (*tail);
       else
-       tail = SCM_CDRLOC (*tail);
+        tail = SCM_CDRLOC (*tail);
     }
   return ell;
 }
@@ -93,15 +115,15 @@ 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);
+      if (unsmob_engraver (scm_car (*tail)))
+        *tail = scm_cdr (*tail);
       else
-       tail = SCM_CDRLOC (*tail);
+        tail = SCM_CDRLOC (*tail);
     }
   return ell;
 }
 
-/* 
+/*
   Protects the parameter from being garbage collected. The object is
   protected until the next disconnect_from_context call.
 
@@ -109,7 +131,7 @@ filter_engravers (SCM ell)
   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?
  */
@@ -130,10 +152,10 @@ 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 ());
+  Context *new_context = Context::unsmob (cs);
+  Context_def *def = Context_def::unsmob (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 ());
@@ -141,32 +163,55 @@ Translator_group::create_child_translator (SCM sev)
 
   for (SCM s = trans_names; scm_is_pair (s); s = scm_cdr (s))
     {
-      Translator *type = get_translator (scm_car (s));
+      SCM definition = scm_car (s);
+      bool is_scheme = false;
+
+      Translator *type = 0;
+      if (ly_is_symbol (definition))
+        type = get_translator (definition);
+      else if (ly_is_pair (definition))
+        {
+          type = get_translator (ly_symbol2scm ("Scheme_engraver"));
+          is_scheme = true;
+        }
+      else if (ly_is_procedure (definition))
+        {
+          // `definition' is a procedure, which takes the context as
+          // an argument and evaluates to an a-list scheme engraver
+          // definition.
+          definition = scm_call_1 (definition, cs);
+          type = get_translator (ly_symbol2scm ("Scheme_engraver"));
+          is_scheme = true;
+        }
+
       if (!type)
-       warning (_f ("cannot find: `%s'", ly_symbol2string (scm_car (s)).c_str ()));
+        warning (_f ("cannot 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 ();
-       }
+        {
+          Translator *instance = type->clone ();
+          if (is_scheme)
+            dynamic_cast<Scheme_engraver *> (instance)->init_from_scheme (definition);
+
+          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 ();
+        }
     }
 
   /* Filter unwanted translator types. Required to make
-     \with {\consists "..."} work. */
+     \with { \consists "..." } work. */
   if (dynamic_cast<Engraver_group *> (g))
     g->simple_trans_list_ = filter_performers (trans_list);
   else if (dynamic_cast<Performer_group *> (g))
@@ -179,9 +224,9 @@ Translator_group::create_child_translator (SCM sev)
   g->unprotect ();
 
   recurse_over_translators (new_context,
-                           &Translator::initialize,
-                           &Translator_group::initialize,
-                           DOWN);
+                            &Translator::initialize,
+                            &Translator_group::initialize,
+                            DOWN);
 }
 
 SCM
@@ -204,7 +249,7 @@ precomputed_recurse_over_translators (Context *c, Translator_precompute_index id
 
   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);
+    precomputed_recurse_over_translators (Context::unsmob (scm_car (s)), idx, dir);
 
   if (tg && dir == UP)
     {
@@ -215,7 +260,7 @@ precomputed_recurse_over_translators (Context *c, Translator_precompute_index id
 
 void
 recurse_over_translators (Context *c, Translator_method ptr,
-                         Translator_group_method tg_ptr, Direction dir)
+                          Translator_group_method tg_ptr, Direction dir)
 {
   Translator_group *tg
     = dynamic_cast<Translator_group *> (c->implementation ());
@@ -228,12 +273,12 @@ recurse_over_translators (Context *c, Translator_method 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);
+    recurse_over_translators (Context::unsmob (scm_car (s)), ptr, tg_ptr, dir);
 
   if (tg && dir == UP)
     {
       translator_each (tg->get_simple_trans_list (),
-                      ptr);
+                       ptr);
 
       (tg->*tg_ptr) ();
     }
@@ -257,16 +302,16 @@ Translator_group::precompute_method_bindings ()
 {
   for (SCM s = simple_trans_list_; scm_is_pair (s); s = scm_cdr (s))
     {
-      Translator *tr = unsmob_translator (scm_car (s));
+      Translator *tr = Translator::unsmob (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]));
-       }
+        {
+          if (ptrs[i])
+            precomputed_method_bindings_[i].push_back (Translator_method_binding (tr, ptrs[i]));
+        }
     }
 
   fetch_precomputable_methods (precomputed_self_method_bindings_);