lily/include/translator.hh

   1 /*
   2   translator.hh -- declare Translator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--2001 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 "parray.hh"
  19 #include "input.hh"
  20 #include "smobs.hh"
  21
  22 /** Make some kind of #Element#s from Requests. Elements are made by
  23   hierarchically grouped #Translator#s
  24   */
  25 class Translator : public Input {
  26   void init ();
  27 public:
  28   Music_output_def * output_def_l_;
  29   String type_str_;
  30
  31   virtual const char *name () const;
  32   bool is_alias_b (String) const;
  33
  34   VIRTUAL_COPY_CONS (Translator);
  35   Translator (Translator const &);
  36   Translator ();
  37
  38   Translator_group * daddy_trans_l_ ;
  39
  40
  41   void announces ();
  42
  43   void removal_processing ();
  44   /**
  45     ask daddy for a feature
  46     */
  47   Music_output_def *output_def_l () const;
  48
  49   SCM get_property (const char *) const;
  50   SCM get_property (SCM symbol) const;
  51
  52   virtual Moment now_mom () const;
  53
  54   /*
  55     ugh: bubbled up from Translator_group.
  56    */
  57   SCM simple_trans_list_;
  58   SCM trans_group_list_;
  59   SCM definition_;
  60
  61   SCM properties_scm_;
  62   DECLARE_SMOBS (Translator, dummy);
  63 public:
  64
  65     /**
  66     try to fit the request in this engraver
  67
  68     @return
  69     false: not noted,  not taken.
  70
  71     true: request swallowed. Don't try to put the request elsewhere.
  72
  73     */
  74   virtual bool try_music (Music *req_l);
  75   virtual void stop_translation_timestep ();
  76   virtual void start_translation_timestep ();
  77   virtual void do_announces () ;
  78   virtual void initialize () ;
  79   virtual void finalize ();
  80 };
  81
  82
  83 /**
  84   A macro to automate administration of translators.
  85  */
  86 #define ADD_THIS_TRANSLATOR(T)                          \
  87 static void  _ ## T ## _adder () {\
  88       T *t = new T;\
  89       t->type_str_ = classname (t);\
  90       add_translator (t);\
  91 }\
  92 ADD_GLOBAL_CTOR (_ ## T ## _adder);
  93
  94
  95
  96 extern Dictionary<Translator*> *global_translator_dict_p;
  97 void add_translator (Translator*trans_p);
  98
  99 Translator*get_translator_l (String s);
 100 Translator *unsmob_translator (SCM);
 101 #endif // TRANSLATOR_HH