source file of the GNU LilyPond music typesetter
- (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
+ (c) 1997--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
*/
-
#ifndef TRANSLATOR_HH
#define TRANSLATOR_HH
-#include "string.hh"
+#include "global-ctor.hh"
+#include "std-string.hh"
#include "lily-proto.hh"
#include "virtual-methods.hh"
-#include "scalar.hh"
-#include "dictionary.hh"
-#include "parray.hh"
#include "input.hh"
+#include "smobs.hh"
+#include "std-vector.hh"
+
+struct Acknowledge_information
+{
+ SCM symbol_;
+ Engraver_void_function_engraver_grob_info function_;
+};
-#define TRANSLATOR_CLONE(c) VIRTUAL_COPY_CONS(c, Translator)
+#define TRANSLATOR_DECLARATIONS(NAME) \
+ public: \
+ NAME (); \
+ VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \
+ static SCM static_description_; \
+ static Drul_array<vector<Acknowledge_information> > acknowledge_static_array_drul_; \
+ virtual void fetch_precomputable_methods (Translator_void_method_ptr methods[]); \
+ virtual SCM static_translator_description () const; \
+ virtual SCM translator_description () const; \
+ virtual Engraver_void_function_engraver_grob_info get_acknowledger (SCM sym) \
+ { \
+ return static_get_acknowledger (sym); \
+ } \
+ virtual Engraver_void_function_engraver_grob_info get_end_acknowledger (SCM sym) \
+ { \
+ return static_get_end_acknowledger (sym); \
+ } \
+ static Engraver_void_function_engraver_grob_info static_get_acknowledger (SCM sym); \
+ static Engraver_void_function_engraver_grob_info static_get_end_acknowledger(SCM); \
+ /* end #define */
+
+
+#define DECLARE_ACKNOWLEDGER(x) public : void acknowledge_ ## x (Grob_info); protected:
+#define DECLARE_END_ACKNOWLEDGER(x) public : void acknowledge_end_ ## x (Grob_info); protected:
+
+enum Translator_precompute_index
+ {
+ START_TRANSLATION_TIMESTEP,
+ STOP_TRANSLATION_TIMESTEP,
+ PROCESS_MUSIC,
+ PROCESS_ACKNOWLEDGED,
+ TRANSLATOR_METHOD_PRECOMPUTE_COUNT,
+ };
+
+/*
+ Translate music into grobs.
+*/
+class Translator
+{
+ void init ();
+
+protected:
+ bool must_be_last_;
-/** Make some kind of #Element#s from Requests. Elements are made by
- hierarchically grouped #Translator#s
- */
-class Translator : public Input {
- Dictionary<Scalar> properties_dict_;
public:
- Music_output_def * output_def_l_;
- String type_str_;
+ bool must_be_last () const;
- bool is_alias_b (String) const;
-
+ Context *context () const { return daddy_context_; }
- DECLARE_MY_RUNTIME_TYPEINFO;
- TRANSLATOR_CLONE(Translator);
Translator (Translator const &);
- Translator ();
- virtual ~Translator ();
-
- Translator_group * daddy_trans_l_ ;
-
- void print () const;
-
- /**
- try to fit the request in this engraver
-
- @return
- false: not noted, not taken.
-
- true: request swallowed. Don't try to put the request elsewhere.
-
- */
- bool try_request (Request*);
- 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
- */
- Scalar get_property (String type_str);
- void set_property (String var_name, Scalar value);
- Music_output_def *output_def_l () const;
-
- virtual Moment now_moment () const;
- virtual Engraver *engraver_l () { return 0; }
- virtual Performer *performer_l() { return 0; }
- virtual Translator_group * group_l () { return 0; }
-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_request (Request *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() {}
-};
+ SCM internal_get_property (SCM symbol) const;
+
+ virtual Output_def *get_output_def () const;
+ virtual Translator_group *get_daddy_translator ()const;
+ virtual Moment now_mom () const;
+
+ virtual bool try_music (Music *req);
+ virtual void initialize ();
+ virtual void finalize ();
+
+ void stop_translation_timestep ();
+ void start_translation_timestep ();
+ void process_music ();
+ void process_acknowledged ();
-/**
- A macro to automate administration of translators.
- */
-#define ADD_THIS_TRANSLATOR(c) \
-struct c ## init { \
- static Translator *ctor ()\
- {\
- Translator *t = new c;\
- t-> type_str_ = c::static_name ();\
- return t;\
- }\
- c ## init() { \
- add_constructor (ctor);\
- } \
-} _ ## c ## init;
-
-typedef Translator *(*Translator_ctor) ();
-
-extern Dictionary<Translator*> *global_translator_dict_p;
-void add_translator (Translator*trans_p);
-void add_constructor (Translator_ctor ctor);
-
-Translator*get_translator_l (String s);
+ Score_context *get_score_context () const;
+ Global_context *get_global_context () const;
+
+ TRANSLATOR_DECLARATIONS (Translator);
+ DECLARE_SMOBS (Translator, dummy);
+
+protected: // should be private.
+ Context *daddy_context_;
+ virtual void derived_mark () const;
+
+ friend class Translator_group;
+};
+void add_translator (Translator *trans);
+Translator *get_translator (SCM s);
+DECLARE_UNSMOB (Translator, translator);
#endif // TRANSLATOR_HH