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