1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798 |
- /*
- * plugin.h
- */
- #ifndef _clish_plugin_h
- #define _clish_plugin_h
- #include "lub/types.h"
- /* Symbol */
- /* Symbol types. Functions with different definition. */
- typedef enum {
- CLISH_SYM_TYPE_NONE = 0, /* None */
- CLISH_SYM_TYPE_ACTION, /* Common builtin symbol */
- CLISH_SYM_TYPE_ACCESS,
- CLISH_SYM_TYPE_CONFIG,
- CLISH_SYM_TYPE_LOG,
- CLISH_SYM_TYPE_MAX /* Number of elements */
- } clish_sym_type_e;
- typedef struct clish_sym_s clish_sym_t;
- typedef struct clish_plugin_s clish_plugin_t;
- /* Plugin types */
- /* Name of init function within plugin */
- #define CLISH_PLUGIN_INIT_FNAME clish_plugin_init
- #define CLISH_PLUGIN_INIT_NAME "clish_plugin_init"
- #define CLISH_PLUGIN_INIT_FUNC(name) int name(void *clish_shell, clish_plugin_t *plugin)
- #define CLISH_PLUGIN_INIT CLISH_PLUGIN_INIT_FUNC(CLISH_PLUGIN_INIT_FNAME)
- /* Name of fini function within plugin */
- #define CLISH_PLUGIN_FINI_FNAME clish_plugin_fini
- #define CLISH_PLUGIN_FINI_NAME "clish_plugin_fini"
- #define CLISH_PLUGIN_FINI_FUNC(name) int name(void *clish_shell, clish_plugin_t *plugin)
- #define CLISH_PLUGIN_FINI CLISH_PLUGIN_FINI_FUNC(CLISH_PLUGIN_FINI_FNAME)
- #define CLISH_PLUGIN_SYM(name) int name(void *clish_context, const char *script, char **out)
- #define CLISH_HOOK_ACCESS(name) int name(void *clish_context, const char *access)
- #define CLISH_HOOK_CONFIG(name) int name(void *clish_context)
- #define CLISH_HOOK_LOG(name) int name(void *clish_context, const char *line, int retcode)
- typedef CLISH_PLUGIN_INIT_FUNC(clish_plugin_init_t);
- typedef CLISH_PLUGIN_FINI_FUNC(clish_plugin_fini_t);
- typedef CLISH_PLUGIN_SYM(clish_hook_action_fn_t);
- typedef CLISH_HOOK_ACCESS(clish_hook_access_fn_t);
- typedef CLISH_HOOK_CONFIG(clish_hook_config_fn_t);
- typedef CLISH_HOOK_LOG(clish_hook_log_fn_t);
- /* Helpers */
- #define SYM_FN(TYPE,SYM) (*((clish_hook_##TYPE##_fn_t *)(clish_sym__get_func(SYM))))
- /* Symbol */
- int clish_sym_compare(const void *first, const void *second);
- clish_sym_t *clish_sym_new(const char *name, void *func, int type);
- void clish_sym_free(clish_sym_t *instance);
- void clish_sym__set_func(clish_sym_t *instance, void *func);
- void *clish_sym__get_func(clish_sym_t *instance);
- void clish_sym__set_name(clish_sym_t *instance, const char *name);
- char *clish_sym__get_name(clish_sym_t *instance);
- void clish_sym__set_permanent(clish_sym_t *instance, bool_t permanent);
- bool_t clish_sym__get_permanent(clish_sym_t *instance);
- void clish_sym__set_plugin(clish_sym_t *instance, clish_plugin_t *plugin);
- clish_plugin_t *clish_sym__get_plugin(clish_sym_t *instance);
- void clish_sym__set_type(clish_sym_t *instance, int type);
- int clish_sym__get_type(clish_sym_t *instance);
- int clish_sym_clone(clish_sym_t *dst, clish_sym_t *src);
- /* Plugin */
- clish_plugin_t *clish_plugin_new(const char *file, const char *alias);
- void clish_plugin_free(clish_plugin_t *instance, void *userdata);
- int clish_plugin_load(clish_plugin_t *instance, void *userdata);
- clish_sym_t *clish_plugin_get_sym(clish_plugin_t *instance,
- const char *name, int type);
- clish_sym_t *clish_plugin_add_generic(clish_plugin_t *instance,
- void *func, const char *name, int type, bool_t permanent);
- clish_sym_t *clish_plugin_add_sym(clish_plugin_t *instance,
- clish_hook_action_fn_t *func, const char *name);
- clish_sym_t *clish_plugin_add_psym(clish_plugin_t *instance,
- clish_hook_action_fn_t *func, const char *name);
- clish_sym_t *clish_plugin_add_hook(clish_plugin_t *instance,
- void *func, const char *name, int type);
- clish_sym_t *clish_plugin_add_phook(clish_plugin_t *instance,
- void *func, const char *name, int type);
- void clish_plugin_dump(const clish_plugin_t *instance);
- void clish_plugin__set_name(clish_plugin_t *instance, const char *name);
- char *clish_plugin__get_name(const clish_plugin_t *instance);
- void clish_plugin__set_alias(clish_plugin_t *instance, const char *alias);
- char *clish_plugin__get_alias(const clish_plugin_t *instance);
- char *clish_plugin__get_pubname(const clish_plugin_t *instance);
- char *clish_plugin__get_file(const clish_plugin_t *instance);
- void clish_plugin__set_conf(clish_plugin_t *instance, const char *conf);
- char *clish_plugin__get_conf(const clish_plugin_t *instance);
- #endif /* _clish_plugin_h */
- /** @} clish_plugin */
|