X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=lily%2Finclude%2Ftranslator.hh;h=6145cae05253a849438fc2e2c4a93e95505f7b5d;hb=a276a19dc6bd57832db3107f2f2cbb04cb4677b6;hp=74a46a1fd2c503ce8986933bfb0c21741e6cd55b;hpb=03311c038c913d96eb7ed0a896e2c7d8f4815e17;p=lilypond.git diff --git a/lily/include/translator.hh b/lily/include/translator.hh index 74a46a1fd2..6145cae052 100644 --- a/lily/include/translator.hh +++ b/lily/include/translator.hh @@ -3,124 +3,153 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2000 Han-Wen Nienhuys + (c) 1997--2007 Han-Wen Nienhuys */ - #ifndef TRANSLATOR_HH #define TRANSLATOR_HH #include "global-ctor.hh" -#include "string.hh" #include "lily-proto.hh" #include "virtual-methods.hh" -#include "lily-guile.hh" -#include "parray.hh" -#include "input.hh" +#include "input.hh" // for error reporting #include "smobs.hh" +#include "std-vector.hh" +#include "protected-scm.hh" + +struct Acknowledge_information +{ + SCM symbol_; + Engraver_void_function_engraver_grob_info function_; +}; + + +/* + Each translator class has a static list of listener records. Each + record makes one explains how to register one of the class's stream event + listeners to a context. +*/ +typedef struct translator_listener_record { + Listener (*get_listener_) (void *); + SCM event_class_; + struct translator_listener_record *next_; +} translator_listener_record; + +#define TRANSLATOR_DECLARATIONS(NAME) \ +private: \ + static translator_listener_record *listener_list_; \ + public: \ + NAME (); \ + VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \ + static SCM static_description_; \ + static Drul_array > 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); \ +public: \ + virtual translator_listener_record *get_listener_list () const \ + { \ + return listener_list_; \ + } \ + /* end #define */ + +#define DECLARE_TRANSLATOR_LISTENER(m) \ +public: \ +inline void listen_ ## m (Stream_event *); \ +/* Should be private */ \ +static void _internal_declare_ ## m (); \ +private: \ +static Listener _get_ ## m ## _listener (void *); \ +DECLARE_LISTENER (_listen_scm_ ## m); + +#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, + }; -/** Make some kind of #Element#s from Requests. Elements are made by - hierarchically grouped #Translator#s - */ -class Translator : public Input { +/* + Translate music into grobs. +*/ +class Translator +{ void init (); + +protected: + bool must_be_last_; + public: - Music_output_def * output_def_l_; - String type_str_; - - virtual const char *name() const; - bool is_alias_b (String) const; - - VIRTUAL_COPY_CONS(Translator); + bool must_be_last () const; + + Context *context () const { return daddy_context_; } + Translator (Translator const &); - 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_music (Music*); - void pre_move_processing(); - void add_processing (); - void creation_processing (); - void process_music(); - void post_move_processing(); - void removal_processing(); - /** - ask daddy for a feature - */ - Music_output_def *output_def_l () const; - - SCM get_property (const char *) const; - SCM get_property (SCM symbol) const; - - virtual Moment now_mom () const; - - /* - ugh: bubbled up from Translator_group. - */ - SCM simple_trans_list_; - SCM trans_group_list_; - SCM definition_; - - SCM properties_scm_; - DECLARE_SMOBS(Translator, dummy); -public: - /* - UGH. Clean this up. - */ - enum { - ORPHAN, - VIRGIN, - CREATION_INITED, - MOVE_INITED, - ACCEPTED_REQS, - PROCESSED_REQS, - ACKED_REQS, - MOVE_DONE - } status_; // junkme -protected: - /* - @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_music () ; - 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 void initialize (); + virtual void finalize (); + + /*should maybe be virtual*/ + void connect_to_context (Context *c); + void disconnect_from_context (Context *c); + + void stop_translation_timestep (); + void start_translation_timestep (); + void process_music (); + void process_acknowledged (); + Context *get_score_context () const; + Global_context *get_global_context () const; -/** - 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); + TRANSLATOR_DECLARATIONS (Translator); + DECLARE_SMOBS (Translator); +protected: // should be private. + Context *daddy_context_; + void protect_event (SCM ev); + virtual void derived_mark () const; + static void add_translator_listener (translator_listener_record **listener_list, translator_listener_record *r, Listener (*get_listener) (void *), const char *ev_class); + SCM static_translator_description (const char *grobs, + const char *desc, + translator_listener_record *listener_list, + const char *read, + const char *write) const; + friend class Translator_group; +}; +void add_translator (Translator *trans); + +Translator *get_translator (SCM s); +Moment get_event_length (Stream_event *s); +DECLARE_UNSMOB (Translator, translator); + + +/* + This helper is only meaningful inside listen_* methods. +*/ +extern bool internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function); +#define ASSIGN_EVENT_ONCE(o,n) internal_event_assignment (&o, n, __FUNCTION__) -extern Dictionary *global_translator_dict_p; -void add_translator (Translator*trans_p); -Translator*get_translator_l (String s); -Translator *unsmob_translator (SCM); #endif // TRANSLATOR_HH