/usr/include/fcitx/module.h is in fcitx-libs-dev 1:4.2.8.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | /***************************************************************************
* Copyright (C) 2010~2012 by CSSlayer *
* wengxt@gmail.com *
* Copyright (C) 2012~2013 by Yichao Yu *
* yyc1992@gmail.com *
* *
* This program 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 2 of the License, or *
* (at your option) any later version. *
* *
* This program 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 this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
/**
* @addtogroup Fcitx
* @{
*/
#ifndef _FCITX_MODULE_H
#define _FCITX_MODULE_H
#include <fcitx-config/fcitx-config.h>
#include <fcitx-utils/utarray.h>
#include <fcitx-utils/utils.h>
#include <fcitx/addon.h>
#include <fcitx/fcitx.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxInstance;
/**
* A misc module in Fcitx, it can register hook, or add it's own event
* to Fcitx main loop.
**/
typedef struct _FcitxModule {
/**
* construction function
*/
void* (*Create)(struct _FcitxInstance* instance);
/**
* set main loop watch fd, no need to implement
*/
void (*SetFD)(void*);
/**
* main loop event handle, no need to implement
*/
void (*ProcessEvent)(void*);
/**
* destruct function
*/
void (*Destroy)(void*);
/**
* reload config, no need to implement
*/
void (*ReloadConfig)(void*);
} FcitxModule;
/**
* the argument to invoke module function
**/
typedef struct _FcitxModuleFunctionArg {
/**
* arguments
**/
void* args[10];
} FcitxModuleFunctionArg;
typedef void *(*FcitxModuleFunction)(void *self, FcitxModuleFunctionArg);
/**
* load all modules
*
* @param instance fcitx instance
* @return void
**/
void FcitxModuleLoad(struct _FcitxInstance* instance);
/**
* Find a exported function of a addon.
*
* @param addon addon
* @param functionId function index
* @return FcitxModuleFunction
**/
FcitxModuleFunction FcitxModuleFindFunction(FcitxAddon *addon,
int func_id);
void *FcitxModuleInvokeOnAddon(FcitxAddon *addon, FcitxModuleFunction func,
FcitxModuleFunctionArg *args);
/**
* invode inter module function wiht addon pointer, returns NULL when fails (the function itself can also return NULL)
*
* @param addon addon
* @param functionId function index
* @param args arguments
* @return void*
**/
FCITX_DEPRECATED
void* FcitxModuleInvokeFunction(FcitxAddon* addon, int functionId,
FcitxModuleFunctionArg args);
#define FcitxModuleInvokeVaArgs(addon, functionId, ARGV...) \
(FcitxModuleInvokeFunction(addon, functionId, \
(FcitxModuleFunctionArg){ {ARGV} }))
/**
* invoke inter module function with addon name, returns NULL when fails (the function itself can also return NULL)
*
* @param instance fcitx instance
* @param name addon name
* @param functionId function index
* @param args arguments
* @return void*
**/
FCITX_DEPRECATED
void* FcitxModuleInvokeFunctionByName(struct _FcitxInstance* instance, const char* name, int functionId, FcitxModuleFunctionArg args);
#define FcitxModuleInvokeVaArgsByName(instance, name, functionId, ARGV...) \
(FcitxModuleInvokeFunctionByName(instance, name, functionId, \
(FcitxModuleFunctionArg){ {ARGV} }))
/** call a function provides by other addon */
#define InvokeFunction(INST, MODULE, FUNC, ARG) \
((MODULE##_##FUNC##_RETURNTYPE)FcitxModuleInvokeFunctionByName(INST, MODULE##_NAME, MODULE##_##FUNC, ARG))
#define InvokeVaArgs(INST, MODULE, FUNC, ARGV...) \
((MODULE##_##FUNC##_RETURNTYPE)FcitxModuleInvokeFunctionByName( \
INST, MODULE##_NAME, MODULE##_##FUNC, \
(FcitxModuleFunctionArg){ {ARGV} }))
/** add a function to a addon */
#define AddFunction(ADDON, Realname) \
do { \
FCITX_DEPRECATED void *(AddonFunction) = (void*)Realname; \
utarray_push_back(&ADDON->functionList, &(AddonFunction)); \
} while(0)
/**
* add a function to a addon
*
* @param addon
* @param func
**/
void FcitxModuleAddFunction(FcitxAddon *addon, FcitxModuleFunction func);
#ifdef __cplusplus
#define DECLARE_ADDFUNCTIONS(prefix) \
extern "C" { \
static inline FcitxAddon* \
Fcitx_##prefix##_GetAddon(FcitxInstance *instance); \
static void Fcitx##prefix##AddFunctions(FcitxInstance *instance); \
}
#else
#define DECLARE_ADDFUNCTIONS(prefix) \
static inline FcitxAddon* \
Fcitx_##prefix##_GetAddon(FcitxInstance *instance); \
static void Fcitx##prefix##AddFunctions(FcitxInstance *instance);
#endif
// Well won't work if there are multiple instances, but that will also break
// lots of other things anyway.
#define DEFINE_GET_ADDON(name, prefix) \
static inline FcitxAddon* \
Fcitx##prefix##GetAddon(FcitxInstance *instance) \
{ \
static FcitxAddon *addon = NULL; \
static FcitxInstance *_instance = NULL; \
if (fcitx_unlikely(_instance != instance)) { \
_instance = instance; \
addon = FcitxAddonsGetAddonByName( \
FcitxInstanceGetAddons(instance), name); \
} \
return addon; \
}
#define DEFINE_GET_AND_INVOKE_FUNC(prefix, suffix, id) \
DEFINE_GET_AND_INVOKE_FUNC_WITH_ERROR(prefix, suffix, id, NULL)
#define DEFINE_GET_AND_INVOKE_FUNC_WITH_ERROR(prefix, suffix, id, err_ret) \
DEFINE_GET_AND_INVOKE_FUNC_WITH_TYPE_AND_ERROR(prefix, suffix, id, \
intptr_t, (intptr_t)err_ret)
#define DEFINE_GET_AND_INVOKE_FUNC_WITH_TYPE_AND_ERROR(prefix, suffix, \
id, type, err_ret) \
static inline FcitxModuleFunction \
Fcitx##prefix##Find##suffix(FcitxAddon *addon) \
{ \
static FcitxAddon *_addon = NULL; \
static FcitxModuleFunction func = NULL; \
if (fcitx_unlikely(addon != _addon)) { \
_addon = addon; \
func = FcitxModuleFindFunction(addon, id); \
} \
return func; \
} \
static inline void* \
Fcitx##prefix##Invoke##suffix(FcitxInstance *instance, \
FcitxModuleFunctionArg args) \
{ \
static type _on_err = (err_ret); \
FCITX_DEF_CAST_TO_PTR(on_err, type, _on_err); \
FcitxAddon *addon = Fcitx##prefix##GetAddon(instance); \
if (fcitx_unlikely(!addon)) \
return on_err; \
FcitxModuleFunction func = Fcitx##prefix##Find##suffix(addon); \
if (fcitx_unlikely(!func)) \
return on_err; \
return FcitxModuleInvokeOnAddon(addon, func, &args); \
}
#define FCITX_DEF_MODULE_ARGS(var, ARGV...) \
FcitxModuleFunctionArg var = { {ARGV} }
#define FCITX_DEF_MODULE_ARGS_LONG(var, arg0, arg1, arg2, arg3, arg4, \
arg5, arg6, arg7, ARGV...) \
const void *__fcitx_def_mod_arg_long_##var##_extras[] = {ARGV}; \
const size_t __fcitx_def_mod_arg_long_##var##_n = \
sizeof(__fcitx_def_mod_arg_long_##var##_extras) / sizeof(void*); \
FcitxModuleFunctionArg var = \
{ {arg0, arg1, arg2, arg3, arg4, arg5, arg6, arg7, \
fcitx_utils_size_to_ptr(__fcitx_def_mod_arg_long_##var##_n), \
(void*)(intptr_t)(__fcitx_def_mod_arg_long_##var##_extras)} }
#define FCITX_MODULE_FUNCTION_ARGS void *arg, FcitxModuleFunctionArg args
#define FCITX_MODULE_SELF(NAME, TYPE) TYPE *NAME = (TYPE*)arg
#define FCITX_MODULE_ARG(NAME, TYPE, INDEX) \
FCITX_DEF_CAST_FROM_PTR(TYPE, NAME, args.args[(INDEX)])
#ifdef __cplusplus
}
#endif
#endif
/**
* @}
*/
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|