]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.hh
Issue 4835: Move Callback_wrapper class to separate file and simplify
[lilypond.git] / lily / include / translator.hh
index 885198a7200bda4108826e068e5e08f222b42b02..118220772ab72b758ea467f67e616bbff6946230 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 1997--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 1997--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
   LilyPond is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
 #include "std-vector.hh"
 #include "protected-scm.hh"
 
-struct Acknowledge_information
-{
-  SCM symbol_;
-  Engraver_void_function_engraver_grob_info function_;
-
-  Acknowledge_information ()
-  {
-    symbol_ = SCM_EOL;
-    function_ = 0;
-  }
-};
-
-/*
-  Each translator class has a static list of listener records. Each
-  record makes one explains how to register one of the class's stream event
-  listeners to a context.
-*/
-typedef struct translator_listener_record
-{
-  Listener (*get_listener_) (void *, SCM event_class);
-  SCM event_class_;
-  struct translator_listener_record *next_;
-
-  translator_listener_record ()
-  {
-    next_ = 0;
-    event_class_ = SCM_EOL;
-    get_listener_ = 0;
-  }
-
-} translator_listener_record;
-
-#define TRANSLATOR_DECLARATIONS_NO_LISTENER(NAME)                       \
-private:                                                                \
+#define TRANSLATOR_FAMILY_DECLARATIONS(NAME)                            \
   public:                                                               \
-  NAME ();                                                              \
   VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME);                          \
-  static SCM static_description_;                                       \
   static Drul_array<vector<Acknowledge_information> > acknowledge_static_array_drul_; \
-  virtual void fetch_precomputable_methods (Translator_void_method_ptr methods[]); \
-  virtual SCM static_translator_description () const;                   \
-  virtual SCM translator_description () const;                          \
-  static Engraver_void_function_engraver_grob_info static_get_acknowledger (SCM sym); \
-  static Engraver_void_function_engraver_grob_info static_get_end_acknowledger(SCM); \
-  virtual Engraver_void_function_engraver_grob_info get_acknowledger (SCM sym) \
+  virtual void fetch_precomputable_methods (Callback methods[]);        \
+  static Grob_info_callback static_get_acknowledger (SCM sym);          \
+  static Grob_info_callback static_get_end_acknowledger(SCM);           \
+  virtual Grob_info_callback get_acknowledger (SCM sym)                 \
   {                                                                     \
     return static_get_acknowledger (sym);                               \
   }                                                                     \
-  virtual Engraver_void_function_engraver_grob_info get_end_acknowledger (SCM sym) \
+  virtual Grob_info_callback get_end_acknowledger (SCM sym)             \
   {                                                                     \
     return static_get_end_acknowledger (sym);                           \
-  } \
+  }                                                                     \
   /* end #define */
 
+/*
+  Each translator class has a static alist of event class symbols
+  mapping to callbacks that are called with a translator instance and
+  a stream event when an event of the appropriate event class is
+  announced in a context.
+*/
+
 #define TRANSLATOR_DECLARATIONS(NAME)                                   \
-  TRANSLATOR_DECLARATIONS_NO_LISTENER(NAME)                             \
-private:                                                                \
-  static translator_listener_record *listener_list_;                    \
+  TRANSLATOR_FAMILY_DECLARATIONS(NAME)                                  \
+  static SCM static_description_;                                       \
+  static Protected_scm listener_list_;                                  \
 public:                                                                 \
-  virtual translator_listener_record *get_listener_list () const        \
+  NAME ();                                                              \
+  virtual SCM static_translator_description () const;                   \
+  virtual SCM translator_description () const;                          \
+  virtual SCM get_listener_list () const                                \
   {                                                                     \
     return listener_list_;                                              \
   }                                                                     \
@@ -97,10 +70,7 @@ public:                                                                 \
 public:                                                 \
 inline void listen_ ## m (Stream_event *);              \
 /* Should be private */                                 \
-static void _internal_declare_ ## m ();                 \
-private:                                                \
- static Listener _get_ ## m ## _listener (void *, SCM); \
-DECLARE_LISTENER (_listen_scm_ ## m);
+static void _internal_declare_ ## m ();
 
 #define DECLARE_ACKNOWLEDGER(x) public : void acknowledge_ ## x (Grob_info); protected:
 #define DECLARE_END_ACKNOWLEDGER(x) public : void acknowledge_end_ ## x (Grob_info); protected:
@@ -120,8 +90,13 @@ enum Translator_precompute_index
 class Translator : public Smob<Translator>
 {
 public:
-  int print_smob (SCM, scm_print_state *);
-  SCM mark_smob ();
+  // We don't make Grob_info_callback specific to Engraver since we
+  // otherwise get into a circular mess with regard to the definitions
+  // as the timing of Engraver is exercised from within Translator
+  typedef void (Translator::*Grob_info_callback) (Grob_info);
+  typedef void (Translator::*Callback) (void);
+  int print_smob (SCM, scm_print_state *) const;
+  SCM mark_smob () const;
   static const char type_p_name_[];
   virtual ~Translator ();
 private:
@@ -158,20 +133,43 @@ public:
 protected:                      // should be private.
   Context *daddy_context_;
   void protect_event (SCM ev);
+
+  template <class T, void (T::*callback)(Stream_event *)>
+  static SCM trampoline (SCM target, SCM event)
+  {
+    T *t = unsmob<T> (target);
+    LY_ASSERT_SMOB (T, target, 1);
+    LY_ASSERT_SMOB (Stream_event, event, 2);
+
+    t->protect_event (event);
+    (t->*callback) (unsmob<Stream_event> (event));
+    return SCM_UNSPECIFIED;
+  }
+
   virtual void derived_mark () const;
-  static void add_translator_listener (translator_listener_record **listener_list,
-                                       translator_listener_record *r,
-                                       Listener (*get_listener) (void *, SCM),
-                                       const char *ev_class);
+  static SCM event_class_symbol (const char *ev_class);
   SCM static_translator_description (const char *grobs,
                                      const char *desc,
-                                     translator_listener_record *listener_list,
+                                     SCM listener_list,
                                      const char *read,
                                      const char *write) const;
 
   friend class Translator_group;
 };
 
+struct Acknowledge_information
+{
+  SCM symbol_;
+  Translator::Grob_info_callback function_;
+
+  Acknowledge_information ()
+  {
+    symbol_ = SCM_EOL;
+    function_ = 0;
+  }
+};
+
+
 void add_translator (Translator *trans);
 
 Translator *get_translator (SCM s);