X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Ftranslator.hh;h=67b1e51bb1c23cf9744f9958c788ca1304cbabe6;hb=5b4b0d6e9a197e8f9eb085b7c2ad78b8be3e5cfc;hp=d0c14c1424ae14f3a36081cf5a9f2e79cdfcd42e;hpb=fc3e875d6bf06f0680e897faffdcab36ad975a03;p=lilypond.git diff --git a/lily/include/translator.hh b/lily/include/translator.hh index d0c14c1424..67b1e51bb1 100644 --- a/lily/include/translator.hh +++ b/lily/include/translator.hh @@ -3,100 +3,154 @@ source file of the GNU LilyPond music typesetter - (c) 1997--2001 Han-Wen Nienhuys + (c) 1997--2008 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); - Translator (Translator const &); - Translator (); - - Translator_group * daddy_trans_l_ ; - - - void pre_move_processing (); - void announces (); - 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: + bool must_be_last () const; - /** - try to fit the request in this engraver + Context *context () const { return daddy_context_; } + + Translator (Translator const &); - @return - false: not noted, not taken. + SCM internal_get_property (SCM symbol) const; - true: request swallowed. Don't try to put the request elsewhere. + 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_l); - virtual void stop_translation_timestep (); - virtual void start_translation_timestep (); - virtual void do_announces () ; - virtual void initialize () ; + 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; + + 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); -/** - 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 *get_translator (SCM s); +Moment get_event_length (Stream_event *s, Moment now); +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