]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.hh
release: 1.5.29
[lilypond.git] / lily / include / translator.hh
index 17088c668fed2625a991bbf5a4772a0b6e0ff9b4..cd4cb58fc317cd23db1522c7ce4ef32131ec3343 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--2002 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 "lily-guile.hh"
+#include "parray.hh"
+#include "input.hh"
+#include "smobs.hh"
 
-class Translator {
+#define get_property(x) internal_get_property(ly_symbol2scm(x))
+
+
+#define TRANSLATOR_DECLARATIONS(NAME)                  \
+public:                                                        \
+  NAME();\
+  VIRTUAL_COPY_CONS (Translator);                              \
+  static SCM static_description_;                      \
+  virtual SCM static_translator_description () const;  \
+  virtual SCM translator_description () const;
+
+/** Make some kind of #Element#s from Requests. Elements are made by
+  hierarchically grouped #Translator#s
+  */
+class Translator : public Input {
+  void init ();
 public:
-    String id_str_;
+  Music_output_def * output_def_l_;
+  String type_str_;
+  
+  bool is_alias_b (String) const;
     
-    int iterator_count_;
-    
-    virtual Global_translator *global_l() { return 0; }
-
-    /// Score_register = 0, Staff_registers = 1, etc)
-    virtual void print()const;
-    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;
+
+  Translator (Translator const &);
+
+  
+  Translator_group * daddy_trans_l_ ;
+  DECLARE_SCHEME_CALLBACK(name, (SCM trans));
+  DECLARE_SCHEME_CALLBACK(description,(SCM trans));
+  void announces ();
+
+  void removal_processing ();
+  /**
+    ask daddy for a feature
+    */
+  Music_output_def *output_def_l () const;
+
+  SCM internal_get_property (SCM symbol) const;
+  
+  virtual Moment now_mom () const;  
+
+  /*
+    ugh: bubbled up from Translator_group. 
+   */
+  SCM simple_trans_list_;
+  SCM trans_group_list_;
+  SCM definition_;
+  
+  SCM properties_scm_;
+  DECLARE_SMOBS (Translator, dummy);
+
+public:
+  TRANSLATOR_DECLARATIONS(Translator);
+    /**
+    try to fit the request in this engraver
+
+    @return
+    false: not noted,  not taken.
+
+    true: request swallowed. Don't try to put the request elsewhere.
+
+    */
+  virtual bool try_music (Music *req_l);
+  virtual void stop_translation_timestep ();
+  virtual void start_translation_timestep ();
+  virtual void do_announces () ;
+  virtual void initialize () ;
+  virtual void finalize ();
 };
 
+
+/**
+  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_);\
+      t->type_str_ = classname (t);\
+      add_translator (t);\
+}\
+SCM T::translator_description() const\
+{ \
+  return static_description_;\
+}\
+ADD_GLOBAL_CTOR (_ ## T ## _adder);
+
+
+
+
+#define ENTER_DESCRIPTION(classname,desc,grobs,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"),                                 \
+                             ly_str02scm (desc), static_properties);                           \
+                                                                                               \
+  static_properties= scm_acons (ly_symbol2scm ("interfaces-acked"),                            \
+                             parse_symbol_list (acked), 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;                                                                    \
+}
+
+
+
+extern Dictionary<Translator*> *global_translator_dict_p;
+void add_translator (Translator*trans_p);
+
+Translator*get_translator_l (String s);
+DECLARE_UNSMOB(Translator,translator);
 #endif // TRANSLATOR_HH