/usr/include/fcitx/instance.h is in fcitx-libs-dev 1:4.2.9.6-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 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 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 | /***************************************************************************
* 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. *
***************************************************************************/
/**
* @addtogroup Fcitx
* @{
*/
#ifndef __FCITX_INSTANCE_H__
#define __FCITX_INSTANCE_H__
#include <pthread.h>
#include <semaphore.h>
#include <sys/select.h>
#include <fcitx/ui.h>
#include <fcitx-utils/utarray.h>
#include <fcitx/configfile.h>
#include <fcitx/profile.h>
#include <fcitx/addon.h>
#include <fcitx/ime.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxInputContext;
/**
* Fcitx Instance, including all global settings
**/
typedef struct _FcitxInstance FcitxInstance;
typedef void (*FcitxTimeoutCallback)(void* arg);
/**
* create new fcitx instance
*
* @param sem semaphore to notify the instance is end
* @param argc argc
* @param argv argv
* @return FcitxInstance*
**/
FcitxInstance* FcitxInstanceCreate(sem_t *sem, int argc, char* argv[]);
/**
* create new fcitx instance
*
* @param sem semaphore to notify the instance is end
* @param argc argc
* @param argv argv
* @param signal fd
* @return FcitxInstance*
*
* @see FcitxInstanceCreate
*
* @since 4.2.5
**/
FcitxInstance* FcitxInstanceCreateWithFD(sem_t *sem, int argc, char* argv[], int fd);
/**
* create new fcitx instance, but don't run it.
*
* @param sem semaphore to notify the instance is end
* @param argc argc
* @param argv argv
* @param signal fd
* @return FcitxInstance*
*
* @see FcitxInstanceCreate
*
* @since 4.2.5
**/
FcitxInstance* FcitxInstanceCreatePause(sem_t *sem, int argc, char* argv[], int fd);
/**
* start a paused instance
*
* @param instance instance
* @return void
**/
void FcitxInstanceStart(FcitxInstance* instance);
/**
* replace existing fcitx instance
*
* @param instance fcitx instance
* @return boolean
**/
boolean FcitxInstanceIsTryReplace(FcitxInstance* instance);
/**
* replace existing fcitx instance
*
* @param instance fcitx instance
* @return bool
**/
void FcitxInstanceResetTryReplace(FcitxInstance* instance);
/**
* some event maybe sync to the buffer, set this flag to force recheck
*
* @param instance fcitx instance
* @return void
**/
void FcitxInstanceSetRecheckEvent(FcitxInstance* instance);
/**
* lock the instance
*
* @param instance fcitx instance
* @return int
**/
int FcitxInstanceLock(FcitxInstance* instance);
/**
* lock the instance
*
* @param instance fcitx instance
* @return int
**/
int FcitxInstanceUnlock(FcitxInstance* instance);
/**
* notify the instance is end
*
* @param instance fcitx instance
* @return void
**/
void FcitxInstanceEnd(FcitxInstance* instance);
/**
* check whether FcitxInstanceEnd is called or not
*
* @param instance fcitx instance
* @return boolean
*
* @since 4.2.7
**/
boolean FcitxInstanceGetIsDestroying(FcitxInstance* instance);
/**
* Get Current Input Context
*
* @param instance
* @return FcitxInputContext*
**/
FcitxInputContext* FcitxInstanceGetCurrentIC(struct _FcitxInstance* instance);
/**
* Set Current Input Context
*
* @param instance
* @param ic new input context
* @return current ic changed
**/
boolean FcitxInstanceSetCurrentIC(struct _FcitxInstance* instance, FcitxInputContext* ic);
/**
* Get Addons From Instance
*
* @param instance fcitx instance
* @return UT_array*
**/
UT_array* FcitxInstanceGetAddons(FcitxInstance* instance);
UT_array* FcitxInstanceGetUIMenus(FcitxInstance* instance);
UT_array* FcitxInstanceGetUIStats(FcitxInstance* instance);
UT_array* FcitxInstanceGetUIComplexStats(FcitxInstance* instance);
UT_array* FcitxInstanceGetIMEs(FcitxInstance* instance);
UT_array* FcitxInstanceGetAvailIMEs(FcitxInstance* instance);
fd_set* FcitxInstanceGetReadFDSet(FcitxInstance* instance);
fd_set* FcitxInstanceGetWriteFDSet(FcitxInstance* instance);
fd_set* FcitxInstanceGetExceptFDSet(FcitxInstance* instance);
struct _FcitxAddon* FcitxInstanceGetCurrentUI(FcitxInstance* instance);
int FcitxInstanceGetMaxFD(FcitxInstance* instance);
void FcitxInstanceSetMaxFD(FcitxInstance* instance, int maxfd);
FcitxGlobalConfig* FcitxInstanceGetGlobalConfig(FcitxInstance* instance);
FcitxProfile* FcitxInstanceGetProfile(FcitxInstance* instance);
FcitxInputState* FcitxInstanceGetInputState(FcitxInstance* instance);
/**
* add a timeout function
*
* @param instance fcitx instance
* @param milli milli seconds
* @param callback callback function
* @param arg argument
* @return callback id
**/
uint64_t FcitxInstanceAddTimeout(FcitxInstance* instance, long int milli, FcitxTimeoutCallback callback , void* arg);
/**
* check if there is a timeout already exists
*
* @param instance fcitx instance
* @param callback callback function
* @return boolean
**/
boolean FcitxInstanceCheckTimeoutByFunc(FcitxInstance* instance, FcitxTimeoutCallback callback);
/**
* check if an callback id is not called
*
* @param instance ...
* @param id ...
* @return boolean
**/
boolean FcitxInstanceCheckTimeoutById(FcitxInstance *instance, uint64_t id);
/**
* remove one timeout function matched by provided callback
*
* @param instance instance
* @param callback callback function
* @return true if there is a callback removed
**/
boolean FcitxInstanceRemoveTimeoutByFunc(FcitxInstance* instance, FcitxTimeoutCallback callback);
/**
* remove one timeout function by id
*
* @param instance ...
* @param id ...
* @return boolean
**/
boolean FcitxInstanceRemoveTimeoutById(FcitxInstance* instance, uint64_t id);
/**
* wait for instance to end, it simple join with a started fcitx thread
*
* @param instance instance
* @return int
**/
int FcitxInstanceWaitForEnd(FcitxInstance* instance);
/**
* run a fcitx instance in current thread, this function will not return until fcitx finishes.
*
* @param argc argument number
* @param argv argument vector
* @param fd outside file descriptor
* @return true if there some error happened during loading
*
* @since 4.2.8
**/
boolean FcitxInstanceRun(int argc, char* argv[], int fd);
void FcitxInstanceRestart(FcitxInstance *instance);
#ifdef __cplusplus
}
#endif
#endif
/**
* @}
*/
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|