]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/translator.hh
* flower
[lilypond.git] / lily / include / translator.hh
index 7740fc7a9ca050220d150c50ebc5821eb2591997..6173536b463a33def48fcd20fbeb6f0b1eb0f16a 100644 (file)
 
   source file of the GNU LilyPond music typesetter
 
-  (c)  1997--2000 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1997--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
-
 #ifndef TRANSLATOR_HH
 #define TRANSLATOR_HH
 
-#include <typeinfo>
 #include "global-ctor.hh"
 #include "string.hh"
 #include "lily-proto.hh"
 #include "virtual-methods.hh"
-#include "lily-guile.hh"
-#include "dictionary.hh"
-#include "parray.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
 
-/** Make some kind of #Element#s from Requests. Elements are made by
-  hierarchically grouped #Translator#s
-  */
-class Translator : public Input {
-public:
-  Music_output_def * output_def_l_;
-  String type_str_;
-  
-  virtual const char *name() const;
-  bool is_alias_b (String) const;
-    
-  VIRTUAL_COPY_CONS(Translator);
-  Translator (Translator const &);
-  Translator ();
-  virtual ~Translator ();
-  
-  Translator_group * daddy_trans_l_ ;
-  void print () const;
-  
-  /**
-    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 try_music (Music*);
-  void pre_move_processing();
-  void add_processing ();
-  void creation_processing ();
-  void process_requests();
-  void post_move_processing();
-  void removal_processing();
-  /**
-    ask daddy for a feature
-    */
-  Music_output_def *output_def_l () const;
-
-  SCM get_property (String) const;
-  SCM get_property (SCM symbol) const;
-  
-  virtual Moment now_mom () const;  
-
-protected:
-  /*
-    UGH. Clean this up.
-   */
-   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_music (Music *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();
-};
+#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 ();
 
-/**
-  A macro to automate administration of translators.
- */
-#define ADD_THIS_TRANSLATOR(T)                         \
-static void  _ ## T ## _adder () {\
-      T *t = new T;\
-      t->type_str_ = classname (t);\
-      add_translator (t);\
-}\
-ADD_GLOBAL_CTOR(_ ## T ## _adder);
+protected:
+  bool must_be_last_;
 
+public:
+  bool must_be_last () const;
 
+  Context *context () const { return daddy_context_; }
 
-extern Dictionary<Translator*> *global_translator_dict_p;
-void add_translator (Translator*trans_p);
+  Translator (Translator const &);
 
-Translator*get_translator_l (String s);
+  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