lily/include/translator.hh

   1 /*
   2   translator.hh -- declare Translator
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7 */
   8
   9
  10 #ifndef TRANSLATOR_HH
  11 #define TRANSLATOR_HH
  12
  13 #include "string.hh"
  14 #include "lily-proto.hh"
  15 #include "virtual-methods.hh"
  16 #include "scalar.hh"
  17 #include "dictionary.hh"
  18 #include "parray.hh"
  19 #include "input.hh"
  20
  21 #define TRANSLATOR_CLONE(c)     VIRTUAL_COPY_CONS(c, Translator)
  22
  23 /** Make some kind of #Element#s from Requests. Elements are made by
  24   hierarchically grouped #Translator#s
  25   */
  26 class Translator : public Input {
  27   Dictionary<Scalar> properties_dict_;
  28 public:
  29   Music_output_def * output_def_l_;
  30   String  type_str_;
  31
  32   bool is_alias_b (String) const;
  33
  34
  35   DECLARE_MY_RUNTIME_TYPEINFO;
  36   TRANSLATOR_CLONE(Translator);
  37   Translator (Translator const &);
  38   Translator ();
  39   virtual ~Translator ();
  40
  41   Translator_group * daddy_trans_l_ ;
  42
  43   virtual void add_processing ();
  44   void print () const;
  45
  46   /**
  47     try to fit the request in this engraver
  48
  49     @return
  50     false: not noted,  not taken.
  51
  52     true: request swallowed. Don't try to put the request elsewhere.
  53
  54     */
  55   bool try_request (Request*);
  56   void pre_move_processing();
  57   void creation_processing ();
  58   void process_requests();
  59   void post_move_processing();
  60   void removal_processing();
  61   /**
  62     ask daddy for a feature
  63     */
  64   Scalar get_property (String type_str);
  65   void set_property (String var_name, Scalar value);
  66   Music_output_def *output_def_l () const;
  67
  68   virtual Moment now_moment () const;
  69   virtual Engraver *engraver_l () { return 0; }
  70   virtual Performer *performer_l() { return 0; }
  71   virtual Translator_group * group_l () { return 0; }
  72
  73 protected:
  74    enum {
  75     ORPHAN,
  76     VIRGIN,
  77     CREATION_INITED,
  78     MOVE_INITED,
  79     ACCEPTED_REQS,
  80     PROCESSED_REQS,
  81     ACKED_REQS,
  82     MOVE_DONE
  83   } status;
  84
  85   /*
  86         @see{try_request}
  87         Default: always return false
  88         */
  89   virtual bool do_try_request (Request *req_l);
  90   virtual void do_print () const;
  91   virtual void do_pre_move_processing(){}
  92   virtual void do_post_move_processing(){}
  93   virtual void do_process_requests () {}
  94   virtual void do_creation_processing() {}
  95   virtual void do_removal_processing() {}
  96 };
  97
  98 /**
  99   A macro to automate administration of translators.
 100  */
 101 #define ADD_THIS_TRANSLATOR(c)                          \
 102 struct c ## init {                                      \
 103     c ## init() {                                       \
 104          Translator *t = new c;\
 105         t-> type_str_ = c::static_name ();\
 106         add_translator (t);\
 107     }                                                   \
 108 } _ ## c ## init;
 109
 110 extern Dictionary<Translator*> *global_translator_dict_p;
 111 void add_translator (Translator*trans_p);
 112
 113 Translator*get_translator_l (String s);
 114
 115 #endif // TRANSLATOR_HH