lily/include/translator.hh

   1 /*
   2   translator.hh -- declare Translator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #ifndef TRANSLATOR_HH
  11 #define TRANSLATOR_HH
  12
  13 #include "global-ctor.hh"
  14 #include "string.hh"
  15 #include "lily-proto.hh"
  16 #include "virtual-methods.hh"
  17 #include "lily-guile.hh"
  18 #include "input.hh"
  19 #include "smobs.hh"
  20
  21 #define get_property(x) internal_get_property(ly_symbol2scm(x))
  22
  23
  24 #define TRANSLATOR_DECLARATIONS(NAME)                   \
  25 public:                                                 \
  26   NAME ();                                              \
  27   VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME);          \
  28   static SCM static_description_;                       \
  29   virtual SCM static_translator_description () const;   \
  30   virtual SCM translator_description () const;
  31
  32 /*
  33   Translate music into grobs.
  34 */
  35 class Translator
  36 {
  37   void init ();
  38
  39 public:
  40   Context * context () const { return daddy_context_; }
  41
  42   Translator (Translator const &);
  43
  44   SCM internal_get_property (SCM symbol) const;
  45
  46   virtual Music_output_def *get_output_def () const;
  47   virtual Translator_group* get_daddy_translator ()const;
  48   virtual Moment now_mom () const;
  49   virtual bool try_music (Music *req);
  50   virtual void stop_translation_timestep ();
  51   virtual void start_translation_timestep ();
  52   virtual void initialize () ;
  53   virtual void process_music ();
  54   virtual void do_announces ();
  55   virtual void finalize ();
  56
  57   Score_context * get_score_context () const;
  58   Global_context * get_global_context () const;
  59
  60   TRANSLATOR_DECLARATIONS(Translator);
  61   DECLARE_SMOBS (Translator, dummy);
  62 protected:                      // should be private.
  63   Context * daddy_context_ ;
  64   SCM simple_trans_list_;
  65   friend class Context_def;
  66   friend class Context;
  67 };
  68
  69 /**
  70   A macro to automate administration of translators.
  71  */
  72 #define ADD_THIS_TRANSLATOR(T)                          \
  73 SCM T::static_description_ = SCM_EOL;\
  74 static void  _ ## T ## _adder () {\
  75       T *t = new T;\
  76       T::static_description_ = t->static_translator_description ();\
  77       scm_permanent_object (T::static_description_);\
  78       add_translator (t);\
  79 }\
  80 SCM T::translator_description() const\
  81 { \
  82   return static_description_;\
  83 }\
  84 ADD_GLOBAL_CTOR (_ ## T ## _adder);
  85
  86
  87
  88
  89 #define ENTER_DESCRIPTION(classname,desc,grobs,accepted,acked,read,write)                                               \
  90 ADD_THIS_TRANSLATOR (classname);\
  91 SCM                                                                                             \
  92 classname::static_translator_description () const \
  93 {                                                                                               \
  94   SCM  static_properties= SCM_EOL;                                                              \
  95   /*  static_properties= acons (name ,gh_str02scm (Translator::name (self_scm ())),             \
  96                               static_properties_);                                              \
  97   */                                                                                            \
  98   static_properties= scm_acons (ly_symbol2scm ("grobs-created"),                                \
  99                               parse_symbol_list (grobs), static_properties);    \
 100                                                                                                 \
 101   static_properties= scm_acons (ly_symbol2scm ("description"),                                  \
 102                               scm_makfrom0str (desc), static_properties);                               \
 103                                                                                                 \
 104   static_properties= scm_acons (ly_symbol2scm ("interfaces-acked"),                             \
 105                               parse_symbol_list (acked), static_properties);                    \
 106   static_properties= scm_acons (ly_symbol2scm ("events-accepted"),                              \
 107                               parse_symbol_list (accepted), static_properties);                 \
 108                                                                                                 \
 109   static_properties= scm_acons (ly_symbol2scm ("properties-read"),                              \
 110                               parse_symbol_list (read), static_properties);                     \
 111                                                                                                 \
 112   static_properties= scm_acons (ly_symbol2scm ("properties-written"),                           \
 113                                 parse_symbol_list (write), static_properties);                  \
 114                                                                                                 \
 115   return static_properties;                                                                     \
 116 }
 117
 118
 119
 120 void add_translator (Translator*trans);
 121
 122 Translator*get_translator (SCM s);
 123 DECLARE_UNSMOB(Translator,translator);
 124 #endif // TRANSLATOR_HH