Run `make grand-replace'.

[lilypond.git] / lily / include / translator.hh

diff --git a/lily/include/translator.hh b/lily/include/translator.hh
index 8566f0e3a27fc141da2ca84f5969e38e5f6fadbf..67b1e51bb1c23cf9744f9958c788ca1304cbabe6 100644 (file)
--- a/lily/include/translator.hh
+++ b/lily/include/translator.hh
@@ -3,19 +3,19 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  (c) 1997--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
 #ifndef TRANSLATOR_HH
 #define TRANSLATOR_HH
 
 #include "global-ctor.hh"
-#include "std-string.hh"
 #include "lily-proto.hh"
 #include "virtual-methods.hh"
-#include "input.hh"
+#include "input.hh"            // for error reporting
 #include "smobs.hh"
 #include "std-vector.hh"
+#include "protected-scm.hh"
 
 struct Acknowledge_information
 {
@@ -23,12 +23,26 @@ struct Acknowledge_information
   Engraver_void_function_engraver_grob_info function_;
 };
 
+
+/*
+  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_;
+  struct translator_listener_record *next_;
+} translator_listener_record;
+
 #define TRANSLATOR_DECLARATIONS(NAME)                                  \
+private:                                                               \
+  static translator_listener_record *listener_list_;                   \
   public:                                                              \
   NAME ();                                                             \
   VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME);                         \
   static SCM static_description_;                                      \
-  static vector<Acknowledge_information> acknowledge_static_array_;    \
+  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;                         \
@@ -36,9 +50,30 @@ struct Acknowledge_information
   {                                                                    \
     return static_get_acknowledger (sym);                              \
   }                                                                    \
-  static Engraver_void_function_engraver_grob_info static_get_acknowledger (SCM sym);
+  virtual Engraver_void_function_engraver_grob_info get_end_acknowledger (SCM sym) \
+  {                                                                    \
+    return static_get_end_acknowledger (sym);                          \
+  } \
+  static Engraver_void_function_engraver_grob_info static_get_acknowledger (SCM sym); \
+  static Engraver_void_function_engraver_grob_info static_get_end_acknowledger(SCM); \
+public:                                                                        \
+  virtual translator_listener_record *get_listener_list () const       \
+  {                                                                    \
+    return listener_list_;                                             \
+  }                                                                    \
+  /* end #define */
+
+#define DECLARE_TRANSLATOR_LISTENER(m)                 \
+public:                                                        \
+inline void listen_ ## m (Stream_event *);             \
+/* Should be private */                                        \
+static void _internal_declare_ ## m ();                        \
+private:                                               \
+static Listener _get_ ## m ## _listener (void *);      \
+DECLARE_LISTENER (_listen_scm_ ## 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:
 
 enum Translator_precompute_index
   {
@@ -72,30 +107,50 @@ public:
   virtual Translator_group *get_daddy_translator ()const;
   virtual Moment now_mom () const;
 
-  virtual bool try_music (Music *req);
   virtual void initialize ();
   virtual void finalize ();
 
+  /*should maybe be virtual*/
+  void connect_to_context (Context *c);
+  void disconnect_from_context (Context *c);
+
   void stop_translation_timestep ();
   void start_translation_timestep ();
   void process_music ();
   void process_acknowledged ();
 
-  Score_context *get_score_context () const;
+  Context *get_score_context () const;
   Global_context *get_global_context () const;
 
   TRANSLATOR_DECLARATIONS (Translator);
-  DECLARE_SMOBS (Translator, dummy);
+  DECLARE_SMOBS (Translator);
 
 protected:                     // should be private.
   Context *daddy_context_;
+  void protect_event (SCM ev);
   virtual void derived_mark () const;
-
-  friend class Context_def;
-  friend class Context;
+  static void add_translator_listener (translator_listener_record **listener_list, translator_listener_record *r, Listener (*get_listener) (void *), const char *ev_class);
+  SCM static_translator_description (const char *grobs, 
+                                    const char *desc,
+                                    translator_listener_record *listener_list,
+                                    const char *read, 
+                                    const char *write) const;
+
+  friend class Translator_group;
 };
 void add_translator (Translator *trans);
 
 Translator *get_translator (SCM s);
+Moment get_event_length (Stream_event *s, Moment now);
+Moment get_event_length (Stream_event *s);
 DECLARE_UNSMOB (Translator, translator);
+
+
+/*
+  This helper is only meaningful inside listen_* methods.
+*/
+extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function);
+#define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__)
+
+
 #endif // TRANSLATOR_HH