release: 1.1.43

[lilypond.git] / lily / include / translator.hh

diff --git a/lily/include/translator.hh b/lily/include/translator.hh
index bfcf734e307007a63cf610844bc29637e9048edb..5c3cfec42b649ccb6a1f052ef006d5811049ced9 100644 (file)
--- a/lily/include/translator.hh
+++ b/lily/include/translator.hh
@@ -3,40 +3,108 @@
 
   source file of the GNU LilyPond music typesetter
 
-  (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+  (c)  1997--1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
 */
 
 
 #ifndef TRANSLATOR_HH
 #define TRANSLATOR_HH
-
+#include "global-ctor.hh"
 #include "string.hh"
 #include "lily-proto.hh"
 #include "virtual-methods.hh"
+#include "scalar.hh"
+#include "dictionary.hh"
+#include "parray.hh"
+#include "input.hh"
+
 
 /** Make some kind of #Element#s from Requests. Elements are made by
   hierarchically grouped #Translator#s
   */
-class Translator {
+class Translator : public Input {
 public:
-  String id_str_;
+  Music_output_def * output_def_l_;
+  String type_str_;
+  
+  virtual const char *name() const;
+  bool is_alias_b (String) const;
     
-  int iterator_count_;
-    
-  virtual Global_translator *global_l() { return 0; }
+  VIRTUAL_COPY_CONS(Translator);
+  Translator (Translator const &);
+  Translator ();
+  virtual ~Translator ();
+  
+  Translator_group * daddy_trans_l_ ;
+ 
+  void print () const;
+  
+  /**
+    try to fit the request in this engraver
 
-  virtual void print() const;
-    
-  /// Score_register = 0, Staff_registers = 1, etc)
-  virtual int depth_i() const=0;
-  virtual bool is_bottom_engraver_b() const { return false; }
-  virtual bool try_request (Request*);
-  virtual Translator *find_get_translator_l (String name, String id)=0;
-  virtual Translator *ancestor_l (int l=1)=0;
-  virtual ~Translator(){}
-  DECLARE_MY_RUNTIME_TYPEINFO;
-  Translator();
-  virtual Translator *get_default_interpreter()=0;
+    @return
+    false: not noted,  not taken.
+
+    true: request swallowed. Don't try to put the request elsewhere.
+
+    */
+  bool try_music (Music*);
+  void pre_move_processing();
+  void add_processing ();
+  void creation_processing ();
+  void process_requests();
+  void post_move_processing();
+  void removal_processing();
+  /**
+    ask daddy for a feature
+    */
+  Music_output_def *output_def_l () const;
+  Scalar get_property (String, Translator_group **) const;
+  virtual Moment now_mom () const;  
+
+protected:
+   enum { 
+    ORPHAN,
+    VIRGIN,
+    CREATION_INITED,
+    MOVE_INITED,
+    ACCEPTED_REQS,
+    PROCESSED_REQS,
+    ACKED_REQS,
+    MOVE_DONE
+  } status;
+
+  /*    
+       @see{try_request}
+       Default: always return false
+       */
+  virtual void do_add_processing ();
+  virtual bool do_try_music (Music *req_l);
+  virtual void do_print () const;
+  virtual void do_pre_move_processing(){}
+  virtual void do_post_move_processing(){}
+  virtual void do_process_requests () {}
+  virtual void do_creation_processing() {}
+  virtual void do_removal_processing() {}
 };
 
+
+/**
+  A macro to automate administration of translators.
+ */
+#define ADD_THIS_TRANSLATOR(T)                         \
+static void  _ ## T ## _adder () {\
+      T *t = new T;\
+      t->type_str_ = classname (t);\
+      add_translator (t);\
+}\
+ADD_GLOBAL_CTOR(_ ## T ## _adder);
+
+
+
+extern Dictionary<Translator*> *global_translator_dict_p;
+void add_translator (Translator*trans_p);
+
+Translator*get_translator_l (String s);
+
 #endif // TRANSLATOR_HH