/usr/include/fcitx/module.h is in fcitx-libs-dev 1:4.2.0-1.
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 | /***************************************************************************
* Copyright (C) 2010~2010 by CSSlayer *
* wengxt@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. *
***************************************************************************/
#ifndef _FCITX_MODULE_H
#define _FCITX_MODULE_H
#include <fcitx-config/fcitx-config.h>
#include <fcitx-utils/utarray.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxInstance;
struct _FcitxAddon;
/**
* @brief A misc module in Fcitx, it can register hook, or add it's own event
* to Fcitx main loop.
**/
typedef struct _FcitxModule {
/**
* @brief construction function
*/
void* (*Create)(struct _FcitxInstance* instance);
/**
* @brief set main loop watch fd, no need to implement
*/
void (*SetFD)(void*);
/**
* @brief main loop event handle, no need to implement
*/
void (*ProcessEvent)(void*);
/**
* @brief destruct function
*/
void (*Destroy)(void*);
/**
* @brief reload config, no need to implement
*/
void (*ReloadConfig)(void*);
} FcitxModule;
/**
* @brief the argument to invoke module function
**/
typedef struct _FcitxModuleFunctionArg {
/**
* @brief arguments
**/
void* args[10];
} FcitxModuleFunctionArg;
/**
* @brief init module array
*
* @param modules module array
* @return void
**/
void InitFcitxModules(UT_array* modules);
/**
* @brief load all modules
*
* @param instance fcitx instance
* @return void
**/
void FcitxModuleLoad(struct _FcitxInstance* instance);
/**
* @brief 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*
**/
void* FcitxModuleInvokeFunction(struct _FcitxAddon* addon, int functionId, FcitxModuleFunctionArg args);
/**
* @brief 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*
**/
void* FcitxModuleInvokeFunctionByName(struct _FcitxInstance* instance, const char* name, int functionId, FcitxModuleFunctionArg args);
#define InvokeFunction(INST, MODULE, FUNC, ARG) \
((MODULE##_##FUNC##_RETURNTYPE) FcitxModuleInvokeFunctionByName(INST, MODULE##_NAME, MODULE##_##FUNC, ARG))
#define AddFunction(ADDON, Realname) \
do { \
void *temp = Realname; \
utarray_push_back(&ADDON->functionList, &temp); \
} while(0)
#ifdef __cplusplus
}
#endif
#endif
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|