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_CONS (Translator);                               \
  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 public:
  39   Music_output_def * output_def_;
  40
  41   Translator (Translator const &);
  42
  43
  44   Translator_group * daddy_trans_ ;
  45   void removal_processing ();
  46   virtual Music_output_def *get_output_def () const;
  47
  48   SCM internal_get_property (SCM symbol) const;
  49
  50   virtual Moment now_mom () const;
  51
  52   /*
  53     ugh: bubbled up.
  54    */
  55   SCM definition_;
  56   SCM properties_scm_;
  57   SCM trans_group_list_;
  58   SCM accepts_list_;
  59   virtual SCM get_simple_trans_list ();
  60 public:
  61   DECLARE_SMOBS (Translator, dummy);
  62 private:
  63   /*
  64     ugh: bubbled up from Translator_group.
  65    */
  66
  67 protected:                      // should be private.
  68   SCM simple_trans_list_;
  69   friend class Context_def;
  70 public:
  71   Global_translator * top_translator () const;
  72   TRANSLATOR_DECLARATIONS(Translator);
  73   virtual bool try_music (Music *req);
  74   virtual void stop_translation_timestep ();
  75   virtual void start_translation_timestep ();
  76   virtual void do_announces () ;
  77   virtual void initialize () ;
  78   virtual void finalize ();
  79 };
  80
  81
  82 /**
  83   A macro to automate administration of translators.
  84  */
  85 #define ADD_THIS_TRANSLATOR(T)                          \
  86 SCM T::static_description_ = SCM_EOL;\
  87 static void  _ ## T ## _adder () {\
  88       T *t = new T;\
  89       T::static_description_ = t->static_translator_description ();\
  90       scm_permanent_object (T::static_description_);\
  91       add_translator (t);\
  92 }\
  93 SCM T::translator_description() const\
  94 { \
  95   return static_description_;\
  96 }\
  97 ADD_GLOBAL_CTOR (_ ## T ## _adder);
  98
  99
 100
 101
 102 #define ENTER_DESCRIPTION(classname,desc,grobs,accepted,acked,read,write)                                               \
 103 ADD_THIS_TRANSLATOR (classname);\
 104 SCM                                                                                             \
 105 classname::static_translator_description () const \
 106 {                                                                                               \
 107   SCM  static_properties= SCM_EOL;                                                              \
 108   /*  static_properties= acons (name ,gh_str02scm (Translator::name (self_scm ())),             \
 109                               static_properties_);                                              \
 110   */                                                                                            \
 111   static_properties= scm_acons (ly_symbol2scm ("grobs-created"),                                \
 112                               parse_symbol_list (grobs), static_properties);    \
 113                                                                                                 \
 114   static_properties= scm_acons (ly_symbol2scm ("description"),                                  \
 115                               scm_makfrom0str (desc), static_properties);                               \
 116                                                                                                 \
 117   static_properties= scm_acons (ly_symbol2scm ("interfaces-acked"),                             \
 118                               parse_symbol_list (acked), static_properties);                    \
 119   static_properties= scm_acons (ly_symbol2scm ("events-accepted"),                              \
 120                               parse_symbol_list (accepted), static_properties);                 \
 121                                                                                                 \
 122   static_properties= scm_acons (ly_symbol2scm ("properties-read"),                              \
 123                               parse_symbol_list (read), static_properties);                     \
 124                                                                                                 \
 125   static_properties= scm_acons (ly_symbol2scm ("properties-written"),                           \
 126                                 parse_symbol_list (write), static_properties);                  \
 127                                                                                                 \
 128   return static_properties;                                                                     \
 129 }
 130
 131
 132
 133 void add_translator (Translator*trans);
 134
 135 Translator*get_translator (SCM s);
 136 DECLARE_UNSMOB(Translator,translator);
 137 #endif // TRANSLATOR_HH