@ -2,94 +2,30 @@
# include "kaleidoscope/event_handler_result.h" # include "kaleidoscope/event_handler_result.h"
# include "kaleidoscope_internal/event_dispatch.h" # include "kaleidoscope_internal/event_dispatch.h"
# include "kaleidoscope_internal/deprecations.h"
# include "event_handlers.h" # include "event_handlers.h"
# if ndef KALEIDOSCOPE_ENABLE_V1_PLUGIN_API# if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
# define KALEIDOSCOPE_ENABLE_V1_PLUGIN_API 1 # error The V1 plugin API has been removed, please see UPGRADING.md.
# endif # endif
namespace kaleidoscope { namespace kaleidoscope {
class Kaleidoscope_ ; class Plugin {
// A base class that implements default noop versions of all event
// handler methods.
//
// A note to developers:
//
// The only purpose of class EventHandlerBasePlugin
// is to enable the use of _FOR_EACH_EVENT_HANDLER
// to define default event handlers. This is currently not possible
// inside class Plugin directly as it would collide with
// the separate definition of onSetup(). This additional
// definition is, however, necessary to support the V1 plugin API.
//
// TODO(anyone): As soon as the V1 plugin API is removed from Kaleidoscope,
// class EventHandlerBasePlugin can be removed and its content be moved to
// class Plugin.
//
class EventHandlerBasePlugin {
public :
public :
// Please see "event_handlers.h" for a list of supported event handlers and
// their documentation!
# define DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD( \ # define DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD( \
HOOK_NAME , SHOULD_ABORT_ON_CONSUMED_EVENT , SIGNATURE , ARGS_LIST ) __NL__ \
HOOK_NAME , SHOULD_ABORT_ON_CONSUMED_EVENT , SIGNATURE , ARGS_LIST ) __NL__ \
__NL__ \
__NL__ \
EventHandlerResult HOOK_NAME SIGNATURE { __NL__ \
EventHandlerResult HOOK_NAME SIGNATURE { __NL__ \
return EventHandlerResult : : OK ; __NL__ \
return EventHandlerResult : : OK ; __NL__ \
}
}
_FOR_EACH_EVENT_HANDLER ( DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD )
_FOR_EACH_EVENT_HANDLER ( DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD )
# undef DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD # undef DEFINE_AND_IMPLEMENT_EVENT_HANDLER_METHOD
} ; } ;
class Plugin : public EventHandlerBasePlugin {
friend class Kaleidoscope_ ;
protected :
# if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
/** Legacy plugin setup hook.
* In version one of the plugin API , ` plugin - > begin ( ) ` was called at
* ` Kaleidoscope . use ( ) ` time , to perform boot - time initialization . We needed
* this because plugins are supposed to provide a singleton object , statically
* initialized at compile - time ( with few exceptions ) . Because of this , the
* order in which they are instantiated is unspecified , and cannot be relied
* upon . For this reason , one ' s expected to explicitly initialize , " use " the
* plugins one wishes to , by calling ` Kaleidoscope . use ( ) ` with a list of
* plugin object pointers .
*
* This is the only time this function will be called . It is intentionally
* protected , and accessible by the ` Kaleidoscope ` class only .
*
* Also , this method is deprecated in favour of the V2 API , which you can read
* about below .
*/
virtual void begin ( ) { }
# endif
public :
// Please see "event_handlers.h" for a list of supported event handlers and
// their documentation!
EventHandlerResult onSetup ( ) {
# if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API
// By letting the new `onSetup()` method call the legacy begin() method, we
// make sure that the old hooking interface is supported even if
// KALEIDOSCOPE_INIT_PLUGINS() is used to register a plugin that relies on
// the legacy `begin()` method to initialize itself and register hooks.
//
this - > begin ( ) ;
# endif
return EventHandlerResult : : OK ;
}
} ;
} // namespace kaleidoscope
} // namespace kaleidoscope
typedef kaleidoscope : : Plugin KaleidoscopePlugin DEPRECATED ( KALEIDOSCOPEPLUGIN ) ;
Gergely Nagy
6 years ago