* lily/ various: Introduce stream events of types Prepare,

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

diff --git a/lily/include/translator.hh b/lily/include/translator.hh
index bfcf734e307007a63cf610844bc29637e9048edb..f6b3c8881936de24e34292e515a69ae2fc3154e5 100644 (file)
--- a/lily/include/translator.hh
+++ b/lily/include/translator.hh
@@ -3,40 +3,106 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
 */
 
-
 #ifndef TRANSLATOR_HH
 #define TRANSLATOR_HH
 
-#include "string.hh"
+#include "global-ctor.hh"
+#include "std-string.hh"
 #include "lily-proto.hh"
 #include "virtual-methods.hh"
+#include "input.hh"
+#include "smobs.hh"
+#include "std-vector.hh"
+
+struct Acknowledge_information
+{
+  SCM symbol_;
+  Engraver_void_function_engraver_grob_info function_;
+};
+
+#define TRANSLATOR_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;                         \
+  virtual Engraver_void_function_engraver_grob_info get_acknowledger (SCM sym) \
+  {                                                                    \
+    return static_get_acknowledger (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); \
+  /* end #define */
+
+
+#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
+  {
+    START_TRANSLATION_TIMESTEP,
+    STOP_TRANSLATION_TIMESTEP,
+    PROCESS_MUSIC,
+    PROCESS_ACKNOWLEDGED,
+    TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
+  };
+
+/*
+  Translate music into grobs.
+*/
+class Translator
+{
+  void init ();
+
+protected:
+  bool must_be_last_;
 
-/** Make some kind of #Element#s from Requests. Elements are made by
-  hierarchically grouped #Translator#s
-  */
-class Translator {
 public:
-  String id_str_;
-    
-  int iterator_count_;
-    
-  virtual Global_translator *global_l() { return 0; }
-
-  virtual void print() const;
-    
-  /// Score_register = 0, Staff_registers = 1, etc)
-  virtual int depth_i() const=0;
-  virtual bool is_bottom_engraver_b() const { return false; }
-  virtual bool try_request (Request*);
-  virtual Translator *find_get_translator_l (String name, String id)=0;
-  virtual Translator *ancestor_l (int l=1)=0;
-  virtual ~Translator(){}
-  DECLARE_MY_RUNTIME_TYPEINFO;
-  Translator();
-  virtual Translator *get_default_interpreter()=0;
+  bool must_be_last () const;
+
+  Context *context () const { return daddy_context_; }
+
+  Translator (Translator const &);
+
+  SCM internal_get_property (SCM symbol) const;
+
+  virtual Output_def *get_output_def () const;
+  virtual Translator_group *get_daddy_translator ()const;
+  virtual Moment now_mom () const;
+
+  virtual bool try_music (Music *req);
+  virtual void initialize ();
+  virtual void finalize ();
+
+  void stop_translation_timestep ();
+  void start_translation_timestep ();
+  void process_music ();
+  void process_acknowledged ();
+
+  Score_context *get_score_context () const;
+  Global_context *get_global_context () const;
+
+  TRANSLATOR_DECLARATIONS (Translator);
+  DECLARE_SMOBS (Translator, dummy);
+
+protected:                     // should be private.
+  Context *daddy_context_;
+  virtual void derived_mark () const;
+
+  friend class Translator_group;
 };
+void add_translator (Translator *trans);
 
+Translator *get_translator (SCM s);
+DECLARE_UNSMOB (Translator, translator);
 #endif // TRANSLATOR_HH