]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.hh
2003 -> 2004
[lilypond.git] / lily / include / translator.hh
index b0257a4448d6c041aa6e93a076a612e21075b9b0..16a77c6beefbb33829fec7c90d0cf478d000bd00 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2004 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 "scalar.hh"
-#include "dictionary.hh"
-#include "parray.hh"
+#include "lily-guile.hh"
 #include "input.hh"
+#include "smobs.hh"
 
-#define TRANSLATOR_CLONE(c)    VIRTUAL_COPY_CONS(c, Translator)
+#define get_property(x) internal_get_property(ly_symbol2scm(x))
 
-/** Make some kind of #Element#s from Requests. Elements are made by
-  hierarchically grouped #Translator#s
-  */
-class Translator : public Input {
-  Dictionary<Scalar> properties_dict_;
-public:
-  Music_output_def * output_def_l_;
-  String  type_str_;
 
-  bool is_alias_b (String) const;
-  
+#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;
 
-  DECLARE_MY_RUNTIME_TYPEINFO;  
-  TRANSLATOR_CLONE(Translator);
-  Translator (Translator const &);
-  Translator ();
-  virtual ~Translator ();
-  
-  Translator_group * daddy_trans_l_ ;
-  void print () const;
+/*
+  Translate music into grobs.
+*/
+class Translator
+{
+  void init ();
+public:
+  Music_output_def * output_def_;
   
-  /**
-    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.
+  bool is_alias (SCM) const;
+  Translator (Translator const &);
 
-    */
-  bool try_request (Request*);
-  void pre_move_processing();
-  void add_processing ();
-  void creation_processing ();
-  void process_requests();
-  void post_move_processing();
-  void removal_processing();
+  
+  Translator_group * daddy_trans_ ;
+  void removal_processing ();
   /**
     ask daddy for a feature
     */
-  Scalar get_property (String type_str);
-  void set_property (String var_name, Scalar value);
-  Music_output_def *output_def_l () const;
+  Music_output_def *get_output_def () const;
+
+  SCM internal_get_property (SCM symbol) const;
   
-  virtual Moment now_moment () const;  
-
-protected:
-   enum { 
-    ORPHAN,
-    VIRGIN,
-    CREATION_INITED,
-    MOVE_INITED,
-    ACCEPTED_REQS,
-    PROCESSED_REQS,
-    ACKED_REQS,
-    MOVE_DONE
-  } status;
-
-  /*    
-       @see{try_request}
-       Default: always return false
-       */
-  virtual void do_add_processing ();
-  virtual bool do_try_request (Request *req_l);
-  virtual void do_print () const;
-  virtual void do_pre_move_processing(){}
-  virtual void do_post_move_processing(){}
-  virtual void do_process_requests () {}
-  virtual void do_creation_processing() {}
-  virtual void do_removal_processing() {}
-};
+  virtual Moment now_mom () const;  
+
+  /*
+    ugh: bubbled up.
+   */
+  SCM definition_;
+  SCM properties_scm_;
+  SCM trans_group_list_;
+  SCM accepts_list_;
+  virtual SCM get_simple_trans_list ();
+public:
+  DECLARE_SMOBS (Translator, dummy);
+private:
+  /*
+    ugh: bubbled up from Translator_group. 
+   */
+
+protected:                     // should be private.
+  SCM simple_trans_list_;
+  friend class Context_def;
+  // ugir.
+  //   friend SCM Translator_group::get_simple_trans_list ();
 
 
-template<class T>
-class Translator_adder
-{
 public:
-  static Translator *ctor ()
-    {
-      Translator *t = new T;
-      t->type_str_ = T::static_name ();
-      return t;
-    }
-  Translator_adder () {        
-    add_constructor (ctor);
-  }                            
+  Global_translator * top_translator () const;
+  TRANSLATOR_DECLARATIONS(Translator);
+  virtual bool try_music (Music *req);
+  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(c)                         \
-  Translator_adder<c> _ ## c ## init;
-
-typedef Translator *(*Translator_ctor) ();
-
-extern Dictionary<Translator*> *global_translator_dict_p;
-void add_translator (Translator*trans_p);
-void add_constructor (Translator_ctor ctor);
-
-Translator*get_translator_l (String s);
-
+#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 ENTER_DESCRIPTION(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