X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Finclude%2Ftranslator.hh;h=118220772ab72b758ea467f67e616bbff6946230;hb=36fba3138858ee42ba3f03e3de0efa1d1f49d147;hp=f39b122d8b83c91f9eb48d04517ec84a0a0b08f1;hpb=b6a8afbd0a9a0b36b07c114503d81a7c420e09e7;p=lilypond.git diff --git a/lily/include/translator.hh b/lily/include/translator.hh index f39b122d8b..118220772a 100644 --- a/lily/include/translator.hh +++ b/lily/include/translator.hh @@ -1,102 +1,108 @@ /* - 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--2006 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 "std-string.hh" #include "lily-proto.hh" #include "virtual-methods.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_; -}; - +#define TRANSLATOR_FAMILY_DECLARATIONS(NAME) \ + public: \ + VIRTUAL_COPY_CONSTRUCTOR (Translator, NAME); \ + static Drul_array > acknowledge_static_array_drul_; \ + virtual void fetch_precomputable_methods (Callback methods[]); \ + static Grob_info_callback static_get_acknowledger (SCM sym); \ + static Grob_info_callback static_get_end_acknowledger(SCM); \ + virtual Grob_info_callback get_acknowledger (SCM sym) \ + { \ + return static_get_acknowledger (sym); \ + } \ + virtual Grob_info_callback get_end_acknowledger (SCM sym) \ + { \ + return static_get_end_acknowledger (sym); \ + } \ + /* end #define */ /* - 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. + 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. */ -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_; \ - } \ + +#define TRANSLATOR_DECLARATIONS(NAME) \ + 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 (); \ -private: \ -static Listener _get_ ## m ## _listener (void *); \ -DECLARE_LISTENER (_listen_scm_ ## m); +#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, - }; +{ + 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: + // We don't make Grob_info_callback specific to Engraver since we + // otherwise get into a circular mess with regard to the definitions + // as the timing of Engraver is exercised from within Translator + typedef void (Translator::*Grob_info_callback) (Grob_info); + typedef void (Translator::*Callback) (void); + int print_smob (SCM, scm_print_state *) const; + SCM mark_smob () const; + static const char type_p_name_[]; + virtual ~Translator (); +private: void init (); -protected: - bool must_be_last_; - public: - bool must_be_last () const; - Context *context () const { return daddy_context_; } Translator (Translator const &); @@ -106,14 +112,13 @@ public: 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; - virtual bool try_music (Music *req); virtual void initialize (); virtual void finalize (); - /*should maybe be virtual*/ - void connect_to_context (Context *c); - void disconnect_from_context (Context *c); + virtual void connect_to_context (Context *c); + virtual void disconnect_from_context (Context *c); void stop_translation_timestep (); void start_translation_timestep (); @@ -124,19 +129,57 @@ public: Global_context *get_global_context () const; TRANSLATOR_DECLARATIONS (Translator); - DECLARE_SMOBS (Translator, dummy); -protected: // should be private. +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; + } + 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); + 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; }; + +struct Acknowledge_information +{ + SCM symbol_; + Translator::Grob_info_callback function_; + + Acknowledge_information () + { + symbol_ = SCM_EOL; + function_ = 0; + } +}; + + 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); -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__) + #endif // TRANSLATOR_HH