/usr/include/fcitx/frontend.h is in fcitx-libs-dev 1:4.2.8.5-2.
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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | /***************************************************************************
* 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_FRONTEND_H_
#define _FCITX_FRONTEND_H_
#include <stdint.h>
#include <fcitx-utils/utarray.h>
#include <fcitx-config/fcitx-config.h>
#include <fcitx-config/hotkey.h>
#include <fcitx/ime.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxInstance;
typedef void* (*FcitxICDataAllocCallback)(void* arg);
typedef void (*FcitxICDataFreeCallback)(void* arg, void* data);
typedef void* (*FcitxICDataCopyCallback)(void* arg, void* data, void* src);
/**
* Input Method State
**/
typedef enum _FcitxContextState {
IS_CLOSED = 0,
IS_INACTIVE,
IS_ACTIVE,
IS_ENG = IS_INACTIVE /* backward compatible */
} FcitxContextState;
/** fcitx input context capacity flags */
typedef enum _FcitxCapacityFlags {
CAPACITY_NONE = 0,
CAPACITY_CLIENT_SIDE_UI = (1 << 0),
CAPACITY_PREEDIT = (1 << 1),
CAPACITY_CLIENT_SIDE_CONTROL_STATE = (1 << 2),
CAPACITY_PASSWORD = (1 << 3),
CAPACITY_FORMATTED_PREEDIT = (1 << 4),
CAPACITY_CLIENT_UNFOCUS_COMMIT = (1 << 5),
CAPACITY_SURROUNDING_TEXT = (1 << 6),
CAPACITY_EMAIL = (1 << 7),
CAPACITY_DIGIT = (1 << 8),
CAPACITY_UPPERCASE = (1 << 9),
CAPACITY_LOWERCASE = (1 << 10),
CAPACITY_NOAUTOUPPERCASE = (1 << 11),
CAPACITY_URL = (1 << 12),
CAPACITY_DIALABLE = (1 << 13),
CAPACITY_NUMBER = (1 << 14),
CAPACITY_NO_ON_SCREEN_KEYBOARD = (1 << 15),
CAPACITY_SPELLCHECK = (1 << 16),
CAPACITY_NO_SPELLCHECK = (1 << 17),
CAPACITY_WORD_COMPLETION = (1 << 18),
CAPACITY_UPPERCASE_WORDS = (1 << 19),
CAPACITY_UPPERCASE_SENTENCES = (1 << 20),
CAPACITY_ALPHA = (1 << 21),
CAPACITY_NAME = (1 << 22)
} FcitxCapacityFlags;
/**
* Input Context, normally one for one program
**/
typedef struct _FcitxInputContext {
FcitxContextState state; /**< input method state */
int offset_x; /**< x offset to the window */
int offset_y; /**< y offset to the window */
int frontendid; /**< frontend id */
void *privateic; /**< private input context data */
FcitxCapacityFlags contextCaps; /**< input context capacity */
struct _FcitxInputContext* next; /**< next input context */
} FcitxInputContext;
typedef struct _FcitxInputContext2 {
FcitxInputContext inputContext;
char* imname;
intptr_t switchBySwitchKey;
UT_array* data;
char* prgname; /**< program name */
union {
FcitxTriState mayUsePreedit;
void* _dummy;
};
void* padding[12];
} FcitxInputContext2;
/**
* Program IM Module Frontend
**/
typedef struct _FcitxFrontend {
void* (*Create)(struct _FcitxInstance*, int frontendindex); /**< frontend create callback */
boolean(*Destroy)(void *arg); /**< frontend destroy callback */
void (*CreateIC)(void* arg, FcitxInputContext*, void* priv); /**< frontend create input context callback */
boolean(*CheckIC)(void* arg, FcitxInputContext* arg1, void* arg2); /**< frontend check context with private value callback */
void (*DestroyIC)(void* arg, FcitxInputContext *context); /**< frontend destroy input context callback */
void (*EnableIM)(void* arg, FcitxInputContext* arg1); /**< frontend enable input method to client callback */
void (*CloseIM)(void* arg, FcitxInputContext* arg1); /**< frontend close input method to client callback */
void (*CommitString)(void* arg, FcitxInputContext* arg1, const char* arg2); /**< frontend commit string callback */
void (*ForwardKey)(void* arg, FcitxInputContext* arg1, FcitxKeyEventType event, FcitxKeySym sym, unsigned int state); /**< frontend forward key callback */
void (*SetWindowOffset)(void* arg, FcitxInputContext* ic, int x, int y); /**< frontend set window offset callback */
void (*GetWindowRect)(void* arg, FcitxInputContext* ic, int* x, int* y, int* w, int* h); /**< frontend get window position callback */
void (*UpdatePreedit)(void* arg, FcitxInputContext* ic); /**< frontend update preedit callback */
void (*UpdateClientSideUI)(void* arg, FcitxInputContext* ic); /**< frontend update client side user interface callback */
void (*ReloadConfig)(void* arg); /**< frontend reload config callback */
boolean(*CheckICFromSameApplication)(void* arg, FcitxInputContext* icToCheck, FcitxInputContext* ic); /**< frontend check input context from same application callback */
pid_t (*GetPid)(void* arg, FcitxInputContext* arg1); /**< get pid for ic, zero for unknown */
void (*DeleteSurroundingText)(void* addonInstance, FcitxInputContext* ic, int offset, unsigned int size);
boolean (*GetSurroundingPreedit)(void* addonInstance, FcitxInputContext* ic, char** str, unsigned int* cursor, unsigned int* anchor);
} FcitxFrontend;
/**
* Initial frontends array
*
* @param frontends array
* @return void
**/
void FcitxFrontendsInit(UT_array* frontends);
/**
* Find Input Context By Frontend Specific filter
*
* @param instance
* @param frontendid frontend id
* @param filter frontend specfic filter
* @return FcitxInputContext*
**/
FcitxInputContext* FcitxInstanceFindIC(struct _FcitxInstance* instance, int frontendid, void* filter);
/**
* Creat New Input Context
*
* @param instance
* @param frontendid frontend id
* @param priv frontend specfic data
* @return FcitxInputContext*
**/
FcitxInputContext* FcitxInstanceCreateIC(struct _FcitxInstance* instance, int frontendid, void* priv);
/**
* Destroy Input context
*
* @param instance
* @param frontendid frontend id
* @param filter frontend specfic filter
* @return void
**/
void FcitxInstanceDestroyIC(struct _FcitxInstance* instance, int frontendid, void* filter);
/**
* Load All frontend
*
* @param instance
* @return void
**/
boolean FcitxInstanceLoadFrontend(struct _FcitxInstance* instance);
/**
* Commit String to Client
*
* @param instance fcitx instance
* @param ic input context
* @param str String to commit
* @return void
**/
void FcitxInstanceCommitString(struct _FcitxInstance* instance, FcitxInputContext* ic, const char* str);
/**
* Get surrounding text for an ic
*
* @param instance fcitx instance
* @param ic input context
* @param str surrounding text
* @param cursor cursor of surrounding text
* @param anchor selection anchor of surrounding text
* @return boolean
**/
boolean FcitxInstanceGetSurroundingText(struct _FcitxInstance* instance, FcitxInputContext* ic, char** str, unsigned int* cursor, unsigned int* anchor);
/**
* Delete client surrounding text
*
* @param instance fcitx instance
* @param ic input conext
* @param offset offset
* @param size size
* @return void
**/
void FcitxInstanceDeleteSurroundingText(struct _FcitxInstance* instance, FcitxInputContext* ic, int offset, unsigned int size);
/**
* Set Cursor Position
*
* @param instance fcitx instance
* @param ic input context
* @param x xpos
* @param y ypos
* @return void
**/
void FcitxInstanceSetWindowOffset(struct _FcitxInstance* instance, FcitxInputContext* ic, int x, int y);
/**
* Get Cursor Position
*
* @param instance fcitx instance
* @param ic input context
* @param x xpos
* @param y ypos
* @return void
**/
void FcitxInstanceGetWindowPosition(struct _FcitxInstance* instance, FcitxInputContext *ic, int* x, int* y);
/**
* Get Cursor Rect
*
* @param instance fcitx instance
* @param ic input context
* @param x xpos
* @param y ypos
* @param w width
* @param h height
* @return void
**/
void FcitxInstanceGetWindowRect(struct _FcitxInstance* instance, FcitxInputContext* ic, int* x, int* y, int* w, int* h);
/**
* Update preedit text to client window
*
* @param instance fcitx instance
* @param ic input context
* @return void
**/
void FcitxInstanceUpdatePreedit(struct _FcitxInstance* instance, FcitxInputContext* ic);
/**
* Update all user interface element to client (Aux Text, Preedit, Candidate Word)
*
* @param instance fcitx instance
* @param ic input context
* @return void
**/
void FcitxInstanceUpdateClientSideUI(struct _FcitxInstance* instance, FcitxInputContext* ic);
/**
* Get Current State, if only want to get state, this function is better, because it will handle the case that Input Context is NULL.
*
* @param instance fcitx instance
* @return IME_STATE
**/
FcitxContextState FcitxInstanceGetCurrentState(struct _FcitxInstance* instance);
/**
* Get Current State, consider the option firstAsInactive
*
* @param instance fcitx instance
* @return IME_STATE
*
* @see FcitxInstanceGetCurrentState
**/
FcitxContextState FcitxInstanceGetCurrentStatev2(struct _FcitxInstance* instance);
/**
* get current ic capacity flag, if only want to get capacity, this function is better, because it will handle the case that Input Context is NULL.
*
* @param instance fcitx instance
* @return CapacityFlags
**/
FcitxCapacityFlags FcitxInstanceGetCurrentCapacity(struct _FcitxInstance* instance);
/**
* set all ic from same application to the given ic
*
* @param instance fcitx instance
* @param frontendid frontend id
* @param ic object ic
* @return void
**/
void FcitxInstanceSetICStateFromSameApplication(struct _FcitxInstance* instance, int frontendid, FcitxInputContext *ic);
/**
* get a per-ic data
*
* @param instance fcitx instnace
* @param ic input context
* @param data slot id
*
* @return data
*
* @since 4.2.5
**/
void* FcitxInstanceGetICData(struct _FcitxInstance* instance, FcitxInputContext* ic, int icdataid);
/**
* get a per-ic data
*
* @param instance fcitx instnace
* @param ic input context
* @param data slot id
* @param newdata new data
*
* @return void
*
* @since 4.2.5
**/
void FcitxInstanceSetICData(struct _FcitxInstance* instance, FcitxInputContext* ic, int icdataid, void* newdata);
/**
* alloc a per-ic data slot
*
* @param instance fcitx instnace
* @param allocCallback alloc callback (set pointer to null, when callback is null)
* @param copyCallback copy callback (used when need to share state)
* @param freeCallback free callback
* @param arg closure data
* @return data slot id
*
* @since 4.2.5
**/
int FcitxInstanceAllocDataForIC(struct _FcitxInstance* instance, FcitxICDataAllocCallback allocCallback, FcitxICDataCopyCallback copyCallback, FcitxICDataFreeCallback freeCallback, void* arg);
/**
* check current ic support preedit or not
*
* @param instance fcitx instnace
* @param ic input context
* @return result
*
* @since 4.2.5
**/
boolean FcitxInstanceICSupportPreedit(struct _FcitxInstance* instance, FcitxInputContext* ic);
#ifdef __cplusplus
}
#endif
#endif
/**
* @}
*/
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|