plugin.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. /*
  2. * plugin.h
  3. */
  4. #ifndef _clish_plugin_h
  5. #define _clish_plugin_h
  6. #ifdef HAVE_CONFIG_H
  7. #include "config.h"
  8. #endif /* HAVE_CONFIG_H */
  9. #include "lub/types.h"
  10. /* Symbol */
  11. /* Symbol types. Functions with different definition. */
  12. typedef enum {
  13. CLISH_SYM_TYPE_NONE = 0, /* None */
  14. CLISH_SYM_TYPE_ACTION, /* Common builtin symbol */
  15. CLISH_SYM_TYPE_ACCESS,
  16. CLISH_SYM_TYPE_CONFIG,
  17. CLISH_SYM_TYPE_LOG,
  18. CLISH_SYM_TYPE_MAX /* Number of elements */
  19. } clish_sym_type_e;
  20. typedef struct clish_sym_s clish_sym_t;
  21. typedef struct clish_plugin_s clish_plugin_t;
  22. /* Plugin types */
  23. /* Name of init function within plugin */
  24. #define CLISH_PLUGIN_INIT_FNAME(name) clish_plugin_##name##_init
  25. #define CLISH_PLUGIN_INIT_NAME_PREFIX "clish_plugin_"
  26. #define CLISH_PLUGIN_INIT_NAME_SUFFIX "_init"
  27. #define CLISH_PLUGIN_INIT_FUNC(name) int name(void *clish_shell, clish_plugin_t *plugin)
  28. #define CLISH_PLUGIN_INIT(name) CLISH_PLUGIN_INIT_FUNC(CLISH_PLUGIN_INIT_FNAME(name))
  29. #define CLISH_PLUGIN_FINI(name) int name(void *clish_shell, clish_plugin_t *plugin)
  30. #define CLISH_PLUGIN_SYM(name) int name(void *clish_context, const char *script, char **out)
  31. #define CLISH_HOOK_ACCESS(name) int name(void *clish_shell, const char *access)
  32. #define CLISH_HOOK_CONFIG(name) int name(void *clish_context)
  33. #define CLISH_HOOK_LOG(name) int name(void *clish_context, const char *line, int retcode)
  34. typedef CLISH_PLUGIN_INIT_FUNC(clish_plugin_init_t);
  35. typedef CLISH_PLUGIN_FINI(clish_plugin_fini_t);
  36. typedef CLISH_PLUGIN_SYM(clish_hook_action_fn_t);
  37. typedef CLISH_HOOK_ACCESS(clish_hook_access_fn_t);
  38. typedef CLISH_HOOK_CONFIG(clish_hook_config_fn_t);
  39. typedef CLISH_HOOK_LOG(clish_hook_log_fn_t);
  40. /* Helpers */
  41. #define SYM_FN(TYPE,SYM) (*((clish_hook_##TYPE##_fn_t *)(clish_sym__get_func(SYM))))
  42. /* Create an array of builtin plugin's init functions */
  43. struct clish_plugin_builtin_list_s {
  44. const char *name; /* Plugin name */
  45. clish_plugin_init_t *init; /* Plugin init function */
  46. };
  47. typedef struct clish_plugin_builtin_list_s clish_plugin_builtin_list_t;
  48. extern clish_plugin_builtin_list_t clish_plugin_builtin_list[];
  49. /* Symbol */
  50. int clish_sym_compare(const void *first, const void *second);
  51. clish_sym_t *clish_sym_new(const char *name, void *func, int type);
  52. void clish_sym_free(clish_sym_t *instance);
  53. void clish_sym__set_func(clish_sym_t *instance, void *func);
  54. void *clish_sym__get_func(clish_sym_t *instance);
  55. void clish_sym__set_name(clish_sym_t *instance, const char *name);
  56. char *clish_sym__get_name(clish_sym_t *instance);
  57. void clish_sym__set_permanent(clish_sym_t *instance, bool_t permanent);
  58. bool_t clish_sym__get_permanent(clish_sym_t *instance);
  59. void clish_sym__set_plugin(clish_sym_t *instance, clish_plugin_t *plugin);
  60. clish_plugin_t *clish_sym__get_plugin(clish_sym_t *instance);
  61. void clish_sym__set_type(clish_sym_t *instance, int type);
  62. int clish_sym__get_type(clish_sym_t *instance);
  63. int clish_sym_clone(clish_sym_t *dst, clish_sym_t *src);
  64. /* Plugin */
  65. clish_plugin_t *clish_plugin_new(const char *name);
  66. void clish_plugin_free(clish_plugin_t *instance, void *userdata);
  67. int clish_plugin_load(clish_plugin_t *instance, void *userdata);
  68. clish_sym_t *clish_plugin_get_sym(clish_plugin_t *instance,
  69. const char *name, int type);
  70. clish_sym_t *clish_plugin_add_generic(clish_plugin_t *instance,
  71. void *func, const char *name, int type, bool_t permanent);
  72. clish_sym_t *clish_plugin_add_sym(clish_plugin_t *instance,
  73. clish_hook_action_fn_t *func, const char *name);
  74. clish_sym_t *clish_plugin_add_psym(clish_plugin_t *instance,
  75. clish_hook_action_fn_t *func, const char *name);
  76. clish_sym_t *clish_plugin_add_hook(clish_plugin_t *instance,
  77. void *func, const char *name, int type);
  78. clish_sym_t *clish_plugin_add_phook(clish_plugin_t *instance,
  79. void *func, const char *name, int type);
  80. void clish_plugin_add_fini(clish_plugin_t *instance,
  81. clish_plugin_fini_t *fini);
  82. void clish_plugin_dump(const clish_plugin_t *instance);
  83. char *clish_plugin__get_name(const clish_plugin_t *instance);
  84. void clish_plugin__set_alias(clish_plugin_t *instance, const char *alias);
  85. char *clish_plugin__get_alias(const clish_plugin_t *instance);
  86. char *clish_plugin__get_pubname(const clish_plugin_t *instance);
  87. void clish_plugin__set_file(clish_plugin_t *instance, const char *file);
  88. char *clish_plugin__get_file(const clish_plugin_t *instance);
  89. void clish_plugin__set_conf(clish_plugin_t *instance, const char *conf);
  90. char *clish_plugin__get_conf(const clish_plugin_t *instance);
  91. #endif /* _clish_plugin_h */
  92. /** @} clish_plugin */