]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.hh
Update.
[lilypond.git] / lily / include / translator.hh
index bfcf734e307007a63cf610844bc29637e9048edb..7d965e4b5a4631517184f7b6a56343356d993131 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-
 #ifndef TRANSLATOR_HH
 #define TRANSLATOR_HH
 
+#include "global-ctor.hh"
 #include "string.hh"
 #include "lily-proto.hh"
 #include "virtual-methods.hh"
+#include "input.hh"
+#include "smobs.hh"
+
+/* copied from lily-guile.hh */
+#ifndef get_property
+#define get_property(x) internal_get_property (ly_symbol2scm (x))
+#endif
+
+#define TRANSLATOR_DECLARATIONS(NAME)                  \
+  public:                                              \
+  NAME ();                                             \
+  VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME);         \
+  static SCM static_description_;                      \
+  virtual SCM static_translator_description () const;  \
+  virtual SCM translator_description () const;
+
+/*
+  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 stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void initialize ();
+  virtual void process_music ();
+  virtual void do_announces ();
+  virtual void finalize ();
+
+  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 Context_def;
+  friend class Context;
 };
 
+/**
+   A macro to automate administration of translators.
+*/
+#define ADD_THIS_TRANSLATOR(T)                                         \
+  SCM T::static_description_ = SCM_EOL;                                        \
+  static void _ ## T ## _adder ()                                      \
+  {                                                                    \
+    T *t = new T;                                                      \
+    T::static_description_ = t->static_translator_description ();      \
+    scm_permanent_object (T::static_description_);                     \
+    add_translator (t);                                                        \
+  }                                                                    \
+  SCM T::translator_description () const                               \
+  {                                                                    \
+    return static_description_;                                                \
+  }                                                                    \
+  ADD_GLOBAL_CTOR (_ ## T ## _adder);
+
+#define ADD_TRANSLATOR(classname, desc, grobs, accepted, acked, read, write) \
+  ADD_THIS_TRANSLATOR (classname);                                     \
+  SCM                                                                  \
+  classname::static_translator_description () const                    \
+  {                                                                    \
+    SCM static_properties = SCM_EOL;                                   \
+    /*  static_properties = acons (name , gh_str02scm (Translator::name (self_scm ())),        \
+       static_properties_);                                            \
+    */                                                                 \
+    static_properties = scm_acons (ly_symbol2scm ("grobs-created"),    \
+                                  parse_symbol_list (grobs), static_properties); \
+                                                                       \
+    static_properties = scm_acons (ly_symbol2scm ("description"),      \
+                                  scm_makfrom0str (desc), static_properties); \
+                                                                       \
+    static_properties = scm_acons (ly_symbol2scm ("interfaces-acked"), \
+                                  parse_symbol_list (acked), static_properties); \
+    static_properties = scm_acons (ly_symbol2scm ("events-accepted"),  \
+                                  parse_symbol_list (accepted), static_properties); \
+                                                                       \
+    static_properties = scm_acons (ly_symbol2scm ("properties-read"),  \
+                                  parse_symbol_list (read), static_properties); \
+                                                                       \
+    static_properties = scm_acons (ly_symbol2scm ("properties-written"), \
+                                  parse_symbol_list (write), static_properties); \
+                                                                       \
+    return static_properties;                                          \
+  }
+
+void add_translator (Translator *trans);
+
+Translator *get_translator (SCM s);
+DECLARE_UNSMOB (Translator, translator);
 #endif // TRANSLATOR_HH