X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Ftranslator.hh;h=eba2d6def4c6a76c83372aff508a11d91e607d2a;hb=0c538805488f6a6c134fe88ccef58995037535e9;hp=230fcba3d6d9a0ec5507b6c0b984f058d3e40165;hpb=fb2cb5e32d671334270e101a7a286ee80d5ade00;p=lilypond.git diff --git a/lily/include/translator.hh b/lily/include/translator.hh index 230fcba3d6..ad8765fd54 100644 --- a/lily/include/translator.hh +++ b/lily/include/translator.hh @@ -1,144 +1,221 @@ /* - translator.hh -- declare Translator + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2015 Han-Wen Nienhuys - (c) 1997--2002 Han-Wen Nienhuys -*/ + LilyPond is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + LilyPond is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + You should have received a copy of the GNU General Public License + along with LilyPond. If not, see . +*/ #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 "input.hh" +#include "callback.hh" +#include "input.hh" // for error reporting #include "smobs.hh" +#include "std-vector.hh" +#include "protected-scm.hh" + +#define TRANSLATOR_FAMILY_DECLARATIONS(NAME) \ + public: \ + VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \ + static Drul_array > acknowledge_static_array_drul_; \ + virtual void fetch_precomputable_methods (SCM methods[]); \ + DECLARE_TRANSLATOR_CALLBACKS (NAME); \ + TRANSLATOR_INHERIT (Translator) \ + static SCM static_get_acknowledger (SCM sym); \ + static SCM static_get_end_acknowledger(SCM); \ + virtual SCM get_acknowledger (SCM sym) \ + { \ + return static_get_acknowledger (sym); \ + } \ + virtual SCM get_end_acknowledger (SCM sym) \ + { \ + return static_get_end_acknowledger (sym); \ + } \ + /* end #define */ + +#define TRANSLATOR_INHERIT(BASE) \ + using BASE::method_finder; \ + using BASE::ack_finder; + +#define DECLARE_TRANSLATOR_CALLBACKS(NAME) \ + template \ + static SCM method_finder () { return method_find_base (); } \ + template \ + static SCM ack_finder () { return ack_find_base (); } \ + /* end #define */ -#define get_property(x) internal_get_property(ly_symbol2scm(x)) - +/* + Each translator class has a static alist of event class symbols + mapping to callbacks that are called with a translator instance and + a stream event when an event of the appropriate event class is + announced in a context. +*/ -#define TRANSLATOR_DECLARATIONS(NAME) \ -public: \ - NAME();\ - VIRTUAL_COPY_CONS (Translator); \ - static SCM static_description_; \ - virtual SCM static_translator_description () const; \ - virtual SCM translator_description () const; +#define TRANSLATOR_DECLARATIONS(NAME) \ + public: \ + TRANSLATOR_FAMILY_DECLARATIONS (NAME); \ + static SCM static_description_; \ + static Protected_scm listener_list_; \ +public: \ + NAME (); \ + virtual SCM static_translator_description () const; \ + virtual SCM translator_description () const; \ + virtual SCM 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 (); + +#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 +class Translator : public Smob { +public: + int print_smob (SCM, scm_print_state *) const; + SCM mark_smob () const; + static const char type_p_name_[]; + virtual ~Translator (); +private: void init (); + public: - Music_output_def * output_def_l_; - String type_str_; - - bool is_alias_b (String) const; - + Context *context () const { return daddy_context_; } + Translator (); Translator (Translator const &); - - Translator_group * daddy_trans_l_ ; - void removal_processing (); - /** - ask daddy for a feature - */ - Music_output_def *output_def_l () const; - SCM internal_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: - TRANSLATOR_DECLARATIONS(Translator); - /** - try to fit the request in this engraver + virtual Output_def *get_output_def () const; + virtual Translator_group *get_daddy_translator ()const; + virtual Moment now_mom () const; + virtual bool must_be_last () const; - @return - false: not noted, not taken. + virtual void initialize (); + virtual void finalize (); - true: request swallowed. Don't try to put the request elsewhere. + virtual void connect_to_context (Context *c); + virtual 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; + + DECLARE_CLASSNAME (Translator); + virtual Translator *clone () const = 0; + virtual void fetch_precomputable_methods (SCM methods[]) = 0; + virtual SCM get_listener_list () const = 0; + virtual SCM translator_description () const = 0; + virtual SCM get_acknowledger (SCM sym) = 0; + virtual SCM get_end_acknowledger (SCM sym) = 0; + +protected: // should be private. + Context *daddy_context_; + void protect_event (SCM ev); + + template + static SCM trampoline (SCM target, SCM event) + { + T *t = unsmob (target); + LY_ASSERT_SMOB (T, target, 1); + LY_ASSERT_SMOB (Stream_event, event, 2); + + t->protect_event (event); + (t->*callback) (unsmob (event)); + return SCM_UNSPECIFIED; + } + + template + static SCM + method_find_base () { return Callback0_wrapper::make_smob (); } + + // Fallback for non-overriden callbacks for which &T::x degrades to + // &Translator::x + template + static SCM + method_finder () { return SCM_UNDEFINED; } + + // Overriden in Engraver. + template + static SCM + ack_find_base () { return SCM_UNDEFINED; } + + template + static SCM + ack_finder () { return SCM_UNDEFINED; } + + virtual void derived_mark () const; + static SCM event_class_symbol (const char *ev_class); + SCM static_translator_description (const char *grobs, + const char *desc, + SCM listener_list, + const char *read, + const char *write) const; + + friend class Translator_group; +}; - */ - 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 finalize (); +struct Acknowledge_information +{ + SCM symbol_; + SCM function_; + + Acknowledge_information () + { + symbol_ = SCM_EOL; + function_ = SCM_UNDEFINED; + } }; -/** - A macro to automate administration of translators. - */ -#define ADD_THIS_TRANSLATOR(T) \ -SCM T::static_description_ = SCM_EOL;\ -static void _ ## T ## _adder () {\ - T *t = new T;\ - T::static_description_ = t->static_translator_description ();\ - scm_permanent_object (T::static_description_);\ - t->type_str_ = classname (t);\ - add_translator (t);\ -}\ -SCM T::translator_description() const\ -{ \ - return static_description_;\ -}\ -ADD_GLOBAL_CTOR (_ ## T ## _adder); - - - - -#define ENTER_DESCRIPTION(classname,desc,grobs,acked,read,write) \ -ADD_THIS_TRANSLATOR (classname);\ -SCM \ -classname::static_translator_description () const \ -{ \ - SCM static_properties= SCM_EOL; \ - /* static_properties= acons (name ,gh_str02scm (Translator::name (self_scm ())), \ - static_properties_); \ - */ \ - static_properties= scm_acons (ly_symbol2scm ("grobs-created"), \ - parse_symbol_list (grobs), static_properties); \ - \ - static_properties= scm_acons (ly_symbol2scm ("description"), \ - ly_str02scm (desc), static_properties); \ - \ - static_properties= scm_acons (ly_symbol2scm ("interfaces-acked"), \ - parse_symbol_list (acked), static_properties); \ - \ - static_properties= scm_acons (ly_symbol2scm ("properties-read"), \ - parse_symbol_list (read), static_properties); \ - \ - static_properties= scm_acons (ly_symbol2scm ("properties-written"), \ - parse_symbol_list (write), static_properties); \ - \ - return static_properties; \ -} - - - -extern Dictionary *global_translator_dict_p; -void add_translator (Translator*trans_p); - -Translator*get_translator_l (String s); -DECLARE_UNSMOB(Translator,translator); +void add_translator (Translator *trans); + +Translator *get_translator (SCM s); +Moment get_event_length (Stream_event *s, Moment now); +Moment get_event_length (Stream_event *s); + +/* + 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__) + #endif // TRANSLATOR_HH