forked from rime/librime
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rime_api.h
732 lines (621 loc) · 25.3 KB
/
rime_api.h
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
/*
* Copyright RIME Developers
* Distributed under the BSD License
*
* 2011-08-08 GONG Chen <chen.sst@gmail.com> v0.9
* 2013-05-02 GONG Chen <chen.sst@gmail.com> v1.0
*/
#ifndef RIME_API_H_
#define RIME_API_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <stddef.h>
#include <stdint.h>
#if defined(_WIN32)
#if defined(RIME_EXPORTS)
/* DLL export */
#define RIME_API __declspec(dllexport)
#elif defined(RIME_IMPORTS)
/* DLL import */
#define RIME_API __declspec(dllimport)
#else
/* static library */
#define RIME_API
#endif
#else /* _WIN32 */
#define RIME_API
#endif /* _WIN32 */
typedef uintptr_t RimeSessionId;
typedef int Bool;
#ifndef False
#define False 0
#endif
#ifndef True
#define True 1
#endif
//! Define the max number of candidates
/*!
* \deprecated There is no limit to the number of candidates in RimeMenu
*/
#define RIME_MAX_NUM_CANDIDATES 10
// Version control
#define RIME_STRUCT_INIT(Type, var) \
((var).data_size = sizeof(Type) - sizeof((var).data_size))
#define RIME_STRUCT_HAS_MEMBER(var, member) \
((int)(sizeof((var).data_size) + (var).data_size) > \
(char*)&member - (char*)&var)
#define RIME_STRUCT_CLEAR(var) \
memset((char*)&(var) + sizeof((var).data_size), 0, (var).data_size)
//! Define a variable of Type
#define RIME_STRUCT(Type, var) \
Type var = {0}; \
RIME_STRUCT_INIT(Type, var);
//! For passing pointer to capnproto builder as opaque pointer through C API.
#define RIME_PROTO_BUILDER void
//! Rime traits structure
/*!
* Should be initialized by calling RIME_STRUCT_INIT(Type, var)
*/
typedef struct rime_traits_t {
int data_size;
// v0.9
const char* shared_data_dir;
const char* user_data_dir;
const char* distribution_name;
const char* distribution_code_name;
const char* distribution_version;
// v1.0
/*!
* Pass a C-string constant in the format "rime.x"
* where 'x' is the name of your application.
* Add prefix "rime." to ensure old log files are automatically cleaned.
*/
const char* app_name;
//! A list of modules to load before initializing
const char** modules;
// v1.6
/*! Minimal level of logged messages.
* Value is passed to Glog library using FLAGS_minloglevel variable.
* 0 = INFO (default), 1 = WARNING, 2 = ERROR, 3 = FATAL
*/
int min_log_level;
/*! Directory of log files.
* Value is passed to Glog library using FLAGS_log_dir variable.
*/
const char* log_dir;
//! prebuilt data directory. defaults to ${shared_data_dir}/build
const char* prebuilt_data_dir;
//! staging directory. defaults to ${user_data_dir}/build
const char* staging_dir;
} RimeTraits;
typedef struct {
int length;
int cursor_pos;
int sel_start;
int sel_end;
char* preedit;
} RimeComposition;
typedef struct rime_candidate_t {
char* text;
char* comment;
void* reserved;
} RimeCandidate;
typedef struct {
int page_size;
int page_no;
Bool is_last_page;
int highlighted_candidate_index;
int num_candidates;
RimeCandidate* candidates;
char* select_keys;
} RimeMenu;
/*!
* Should be initialized by calling RIME_STRUCT_INIT(Type, var);
*/
typedef struct rime_commit_t {
int data_size;
// v0.9
char* text;
} RimeCommit;
/*!
* Should be initialized by calling RIME_STRUCT_INIT(Type, var);
*/
typedef struct rime_context_t {
int data_size;
// v0.9
RimeComposition composition;
RimeMenu menu;
// v0.9.2
char* commit_text_preview;
char** select_labels;
} RimeContext;
/*!
* Should be initialized by calling RIME_STRUCT_INIT(Type, var);
*/
typedef struct rime_status_t {
int data_size;
// v0.9
char* schema_id;
char* schema_name;
Bool is_disabled;
Bool is_composing;
Bool is_ascii_mode;
Bool is_full_shape;
Bool is_simplified;
Bool is_traditional;
Bool is_ascii_punct;
} RimeStatus;
typedef struct rime_candidate_list_iterator_t {
void* ptr;
int index;
RimeCandidate candidate;
} RimeCandidateListIterator;
typedef struct rime_config_t {
void* ptr;
} RimeConfig;
typedef struct rime_config_iterator_t {
void* list;
void* map;
int index;
const char* key;
const char* path;
} RimeConfigIterator;
typedef struct rime_schema_list_item_t {
char* schema_id;
char* name;
void* reserved;
} RimeSchemaListItem;
typedef struct rime_schema_list_t {
size_t size;
RimeSchemaListItem* list;
} RimeSchemaList;
typedef void (*RimeNotificationHandler)(void* context_object,
RimeSessionId session_id,
const char* message_type,
const char* message_value);
typedef struct rime_string_slice_t {
const char* str;
size_t length;
} RimeStringSlice;
// Setup
/*!
* Call this function before accessing any other API.
*/
RIME_API void RimeSetup(RimeTraits* traits);
/*!
* Pass a C-string constant in the format "rime.x"
* where 'x' is the name of your application.
* Add prefix "rime." to ensure old log files are automatically cleaned.
* \deprecated Use RimeSetup() instead.
*/
RIME_API void RimeSetupLogging(const char* app_name);
//! Receive notifications
/*!
* - on loading schema:
* + message_type="schema", message_value="luna_pinyin/Luna Pinyin"
* - on changing mode:
* + message_type="option", message_value="ascii_mode"
* + message_type="option", message_value="!ascii_mode"
* - on deployment:
* + session_id = 0, message_type="deploy", message_value="start"
* + session_id = 0, message_type="deploy", message_value="success"
* + session_id = 0, message_type="deploy", message_value="failure"
*
* handler will be called with context_object as the first parameter
* every time an event occurs in librime, until RimeFinalize() is called.
* when handler is NULL, notification is disabled.
*/
RIME_API void RimeSetNotificationHandler(RimeNotificationHandler handler,
void* context_object);
// Entry and exit
RIME_API void RimeInitialize(RimeTraits* traits);
RIME_API void RimeFinalize(void);
RIME_API Bool RimeStartMaintenance(Bool full_check);
//! \deprecated Use RimeStartMaintenance(full_check = False) instead.
RIME_API Bool RimeStartMaintenanceOnWorkspaceChange(void);
RIME_API Bool RimeIsMaintenancing(void);
RIME_API void RimeJoinMaintenanceThread(void);
// Deployment
RIME_API void RimeDeployerInitialize(RimeTraits* traits);
RIME_API Bool RimePrebuildAllSchemas(void);
RIME_API Bool RimeDeployWorkspace(void);
RIME_API Bool RimeDeploySchema(const char* schema_file);
RIME_API Bool RimeDeployConfigFile(const char* file_name,
const char* version_key);
RIME_API Bool RimeSyncUserData(void);
// Session management
RIME_API RimeSessionId RimeCreateSession(void);
RIME_API Bool RimeFindSession(RimeSessionId session_id);
RIME_API Bool RimeDestroySession(RimeSessionId session_id);
RIME_API void RimeCleanupStaleSessions(void);
RIME_API void RimeCleanupAllSessions(void);
// Input
RIME_API Bool RimeProcessKey(RimeSessionId session_id, int keycode, int mask);
/*!
* return True if there is unread commit text
*/
RIME_API Bool RimeCommitComposition(RimeSessionId session_id);
RIME_API void RimeClearComposition(RimeSessionId session_id);
// Output
RIME_API Bool RimeGetCommit(RimeSessionId session_id, RimeCommit* commit);
RIME_API Bool RimeFreeCommit(RimeCommit* commit);
RIME_API Bool RimeGetContext(RimeSessionId session_id, RimeContext* context);
RIME_API Bool RimeFreeContext(RimeContext* context);
RIME_API Bool RimeGetStatus(RimeSessionId session_id, RimeStatus* status);
RIME_API Bool RimeFreeStatus(RimeStatus* status);
// Accessing candidate list
RIME_API Bool RimeCandidateListBegin(RimeSessionId session_id,
RimeCandidateListIterator* iterator);
RIME_API Bool RimeCandidateListNext(RimeCandidateListIterator* iterator);
RIME_API void RimeCandidateListEnd(RimeCandidateListIterator* iterator);
RIME_API Bool RimeCandidateListFromIndex(RimeSessionId session_id,
RimeCandidateListIterator* iterator,
int index);
RIME_API Bool RimeSelectCandidate(RimeSessionId session_id, size_t index);
RIME_API Bool RimeSelectCandidateOnCurrentPage(RimeSessionId session_id,
size_t index);
RIME_API Bool RimeDeleteCandidate(RimeSessionId session_id, size_t index);
RIME_API Bool RimeDeleteCandidateOnCurrentPage(RimeSessionId session_id,
size_t index);
// Runtime options
RIME_API void RimeSetOption(RimeSessionId session_id,
const char* option,
Bool value);
RIME_API Bool RimeGetOption(RimeSessionId session_id, const char* option);
RIME_API void RimeSetProperty(RimeSessionId session_id,
const char* prop,
const char* value);
RIME_API Bool RimeGetProperty(RimeSessionId session_id,
const char* prop,
char* value,
size_t buffer_size);
RIME_API Bool RimeGetSchemaList(RimeSchemaList* schema_list);
RIME_API void RimeFreeSchemaList(RimeSchemaList* schema_list);
RIME_API Bool RimeGetCurrentSchema(RimeSessionId session_id,
char* schema_id,
size_t buffer_size);
RIME_API Bool RimeSelectSchema(RimeSessionId session_id, const char* schema_id);
// Configuration
// <schema_id>.schema.yaml
RIME_API Bool RimeSchemaOpen(const char* schema_id, RimeConfig* config);
// <config_id>.yaml
RIME_API Bool RimeConfigOpen(const char* config_id, RimeConfig* config);
// access config files in user data directory, eg. user.yaml and
// installation.yaml
RIME_API Bool RimeUserConfigOpen(const char* config_id, RimeConfig* config);
RIME_API Bool RimeConfigClose(RimeConfig* config);
RIME_API Bool RimeConfigInit(RimeConfig* config);
RIME_API Bool RimeConfigLoadString(RimeConfig* config, const char* yaml);
// Access config values
RIME_API Bool RimeConfigGetBool(RimeConfig* config,
const char* key,
Bool* value);
RIME_API Bool RimeConfigGetInt(RimeConfig* config, const char* key, int* value);
RIME_API Bool RimeConfigGetDouble(RimeConfig* config,
const char* key,
double* value);
RIME_API Bool RimeConfigGetString(RimeConfig* config,
const char* key,
char* value,
size_t buffer_size);
RIME_API const char* RimeConfigGetCString(RimeConfig* config, const char* key);
RIME_API Bool RimeConfigSetBool(RimeConfig* config,
const char* key,
Bool value);
RIME_API Bool RimeConfigSetInt(RimeConfig* config, const char* key, int value);
RIME_API Bool RimeConfigSetDouble(RimeConfig* config,
const char* key,
double value);
RIME_API Bool RimeConfigSetString(RimeConfig* config,
const char* key,
const char* value);
// Manipulate complex structures
RIME_API Bool RimeConfigGetItem(RimeConfig* config,
const char* key,
RimeConfig* value);
RIME_API Bool RimeConfigSetItem(RimeConfig* config,
const char* key,
RimeConfig* value);
RIME_API Bool RimeConfigClear(RimeConfig* config, const char* key);
RIME_API Bool RimeConfigCreateList(RimeConfig* config, const char* key);
RIME_API Bool RimeConfigCreateMap(RimeConfig* config, const char* key);
RIME_API size_t RimeConfigListSize(RimeConfig* config, const char* key);
RIME_API Bool RimeConfigBeginList(RimeConfigIterator* iterator,
RimeConfig* config,
const char* key);
RIME_API Bool RimeConfigBeginMap(RimeConfigIterator* iterator,
RimeConfig* config,
const char* key);
RIME_API Bool RimeConfigNext(RimeConfigIterator* iterator);
RIME_API void RimeConfigEnd(RimeConfigIterator* iterator);
// Utilities
RIME_API Bool RimeConfigUpdateSignature(RimeConfig* config, const char* signer);
// Testing
RIME_API Bool RimeSimulateKeySequence(RimeSessionId session_id,
const char* key_sequence);
// Module
/*!
* Extend the structure to publish custom data/functions in your specific
* module
*/
typedef struct rime_custom_api_t {
int data_size;
} RimeCustomApi;
typedef struct rime_module_t {
int data_size;
const char* module_name;
void (*initialize)(void);
void (*finalize)(void);
RimeCustomApi* (*get_api)(void);
} RimeModule;
RIME_API Bool RimeRegisterModule(RimeModule* module);
RIME_API RimeModule* RimeFindModule(const char* module_name);
//! Run a registered task
RIME_API Bool RimeRunTask(const char* task_name);
RIME_API const char* RimeGetSharedDataDir(void);
RIME_API const char* RimeGetUserDataDir(void);
RIME_API const char* RimeGetSyncDir(void);
RIME_API const char* RimeGetUserId(void);
/*! The API structure
* RimeApi is for rime v1.0+
*/
typedef struct rime_api_t {
int data_size;
/*! setup
* Call this function before accessing any other API functions.
*/
void (*setup)(RimeTraits* traits);
/*! Set up the notification callbacks
* Receive notifications
* - on loading schema:
* + message_type="schema", message_value="luna_pinyin/Luna Pinyin"
* - on changing mode:
* + message_type="option", message_value="ascii_mode"
* + message_type="option", message_value="!ascii_mode"
* - on deployment:
* + session_id = 0, message_type="deploy", message_value="start"
* + session_id = 0, message_type="deploy", message_value="success"
* + session_id = 0, message_type="deploy", message_value="failure"
*
* handler will be called with context_object as the first parameter
* every time an event occurs in librime, until RimeFinalize() is called.
* when handler is NULL, notification is disabled.
*/
void (*set_notification_handler)(RimeNotificationHandler handler,
void* context_object);
// entry and exit
void (*initialize)(RimeTraits* traits);
void (*finalize)(void);
Bool (*start_maintenance)(Bool full_check);
Bool (*is_maintenance_mode)(void);
void (*join_maintenance_thread)(void);
// deployment
void (*deployer_initialize)(RimeTraits* traits);
Bool (*prebuild)(void);
Bool (*deploy)(void);
Bool (*deploy_schema)(const char* schema_file);
Bool (*deploy_config_file)(const char* file_name, const char* version_key);
Bool (*sync_user_data)(void);
// session management
RimeSessionId (*create_session)(void);
Bool (*find_session)(RimeSessionId session_id);
Bool (*destroy_session)(RimeSessionId session_id);
void (*cleanup_stale_sessions)(void);
void (*cleanup_all_sessions)(void);
// input
Bool (*process_key)(RimeSessionId session_id, int keycode, int mask);
// return True if there is unread commit text
Bool (*commit_composition)(RimeSessionId session_id);
void (*clear_composition)(RimeSessionId session_id);
// output
Bool (*get_commit)(RimeSessionId session_id, RimeCommit* commit);
Bool (*free_commit)(RimeCommit* commit);
Bool (*get_context)(RimeSessionId session_id, RimeContext* context);
Bool (*free_context)(RimeContext* ctx);
Bool (*get_status)(RimeSessionId session_id, RimeStatus* status);
Bool (*free_status)(RimeStatus* status);
// runtime options
void (*set_option)(RimeSessionId session_id, const char* option, Bool value);
Bool (*get_option)(RimeSessionId session_id, const char* option);
void (*set_property)(RimeSessionId session_id,
const char* prop,
const char* value);
Bool (*get_property)(RimeSessionId session_id,
const char* prop,
char* value,
size_t buffer_size);
Bool (*get_schema_list)(RimeSchemaList* schema_list);
void (*free_schema_list)(RimeSchemaList* schema_list);
Bool (*get_current_schema)(RimeSessionId session_id,
char* schema_id,
size_t buffer_size);
Bool (*select_schema)(RimeSessionId session_id, const char* schema_id);
// configuration
Bool (*schema_open)(const char* schema_id, RimeConfig* config);
Bool (*config_open)(const char* config_id, RimeConfig* config);
Bool (*config_close)(RimeConfig* config);
Bool (*config_get_bool)(RimeConfig* config, const char* key, Bool* value);
Bool (*config_get_int)(RimeConfig* config, const char* key, int* value);
Bool (*config_get_double)(RimeConfig* config, const char* key, double* value);
Bool (*config_get_string)(RimeConfig* config,
const char* key,
char* value,
size_t buffer_size);
const char* (*config_get_cstring)(RimeConfig* config, const char* key);
Bool (*config_update_signature)(RimeConfig* config, const char* signer);
Bool (*config_begin_map)(RimeConfigIterator* iterator,
RimeConfig* config,
const char* key);
Bool (*config_next)(RimeConfigIterator* iterator);
void (*config_end)(RimeConfigIterator* iterator);
// testing
Bool (*simulate_key_sequence)(RimeSessionId session_id,
const char* key_sequence);
// module
Bool (*register_module)(RimeModule* module);
RimeModule* (*find_module)(const char* module_name);
Bool (*run_task)(const char* task_name);
const char* (*get_shared_data_dir)(void);
const char* (*get_user_data_dir)(void);
const char* (*get_sync_dir)(void);
const char* (*get_user_id)(void);
void (*get_user_data_sync_dir)(char* dir, size_t buffer_size);
//! initialize an empty config object
/*!
* should call config_close() to free the object
*/
Bool (*config_init)(RimeConfig* config);
//! deserialize config from a yaml string
Bool (*config_load_string)(RimeConfig* config, const char* yaml);
// configuration: setters
Bool (*config_set_bool)(RimeConfig* config, const char* key, Bool value);
Bool (*config_set_int)(RimeConfig* config, const char* key, int value);
Bool (*config_set_double)(RimeConfig* config, const char* key, double value);
Bool (*config_set_string)(RimeConfig* config,
const char* key,
const char* value);
// configuration: manipulating complex structures
Bool (*config_get_item)(RimeConfig* config,
const char* key,
RimeConfig* value);
Bool (*config_set_item)(RimeConfig* config,
const char* key,
RimeConfig* value);
Bool (*config_clear)(RimeConfig* config, const char* key);
Bool (*config_create_list)(RimeConfig* config, const char* key);
Bool (*config_create_map)(RimeConfig* config, const char* key);
size_t (*config_list_size)(RimeConfig* config, const char* key);
Bool (*config_begin_list)(RimeConfigIterator* iterator,
RimeConfig* config,
const char* key);
//! get raw input
/*!
* NULL is returned if session does not exist.
* the returned pointer to input string will become invalid upon editing.
*/
const char* (*get_input)(RimeSessionId session_id);
//! caret position in terms of raw input
size_t (*get_caret_pos)(RimeSessionId session_id);
//! select a candidate at the given index in candidate list.
Bool (*select_candidate)(RimeSessionId session_id, size_t index);
//! get the version of librime
const char* (*get_version)(void);
//! set caret position in terms of raw input
void (*set_caret_pos)(RimeSessionId session_id, size_t caret_pos);
//! select a candidate from current page.
Bool (*select_candidate_on_current_page)(RimeSessionId session_id,
size_t index);
//! access candidate list.
Bool (*candidate_list_begin)(RimeSessionId session_id,
RimeCandidateListIterator* iterator);
Bool (*candidate_list_next)(RimeCandidateListIterator* iterator);
void (*candidate_list_end)(RimeCandidateListIterator* iterator);
//! access config files in user data directory, eg. user.yaml and
//! installation.yaml
Bool (*user_config_open)(const char* config_id, RimeConfig* config);
Bool (*candidate_list_from_index)(RimeSessionId session_id,
RimeCandidateListIterator* iterator,
int index);
//! prebuilt data directory.
const char* (*get_prebuilt_data_dir)(void);
//! staging directory, stores data files deployed to a Rime client.
const char* (*get_staging_dir)(void);
//! Deprecated: for capnproto API, use "proto" module from librime-proto
//! plugin.
void (*commit_proto)(RimeSessionId session_id,
RIME_PROTO_BUILDER* commit_builder);
void (*context_proto)(RimeSessionId session_id,
RIME_PROTO_BUILDER* context_builder);
void (*status_proto)(RimeSessionId session_id,
RIME_PROTO_BUILDER* status_builder);
const char* (*get_state_label)(RimeSessionId session_id,
const char* option_name,
Bool state);
//! delete a candidate at the given index in candidate list.
Bool (*delete_candidate)(RimeSessionId session_id, size_t index);
//! delete a candidate from current page.
Bool (*delete_candidate_on_current_page)(RimeSessionId session_id,
size_t index);
RimeStringSlice (*get_state_label_abbreviated)(RimeSessionId session_id,
const char* option_name,
Bool state,
Bool abbreviated);
} RimeApi;
//! API entry
/*!
* Acquire the version controlled RimeApi structure.
*/
RIME_API RimeApi* rime_get_api(void);
//! Clients should test if an api function is available in the current version
//! before calling it.
#define RIME_API_AVAILABLE(api, func) \
(RIME_STRUCT_HAS_MEMBER(*(api), (api)->func) && (api)->func)
// Initializer for MSVC and GCC.
// 2010 Joe Lowe. Released into the public domain.
#if defined(__GNUC__)
#define RIME_MODULE_INITIALIZER(f) \
static void f(void) __attribute__((constructor)); \
static void f(void)
#elif defined(_MSC_VER)
#pragma section(".CRT$XCU", read)
#define RIME_MODULE_INITIALIZER(f) \
static void __cdecl f(void); \
__declspec(allocate(".CRT$XCU")) void(__cdecl * f##_)(void) = f; \
static void __cdecl f(void)
#endif
/*!
* Automatically register a rime module when the library is loaded.
* Clients should define functions called rime_<module_name>_initialize(),
* and rime_<module_name>_finalize().
* \sa core_module.cc for an example.
*/
#define RIME_REGISTER_MODULE(name) \
void rime_require_module_##name() {} \
RIME_MODULE_INITIALIZER(rime_register_module_##name) { \
static RimeModule module = {0}; \
if (!module.data_size) { \
RIME_STRUCT_INIT(RimeModule, module); \
module.module_name = #name; \
module.initialize = rime_##name##_initialize; \
module.finalize = rime_##name##_finalize; \
} \
RimeRegisterModule(&module); \
}
/*!
* Customize the module by assigning additional functions, eg. module->get_api.
*/
#define RIME_REGISTER_CUSTOM_MODULE(name) \
void rime_require_module_##name() {} \
static void rime_customize_module_##name(RimeModule* module); \
RIME_MODULE_INITIALIZER(rime_register_module_##name) { \
static RimeModule module = {0}; \
if (!module.data_size) { \
RIME_STRUCT_INIT(RimeModule, module); \
module.module_name = #name; \
module.initialize = rime_##name##_initialize; \
module.finalize = rime_##name##_finalize; \
rime_customize_module_##name(&module); \
} \
RimeRegisterModule(&module); \
} \
static void rime_customize_module_##name(RimeModule* module)
/*!
* Defines a constant for a list of module names.
*/
#define RIME_MODULE_LIST(var, ...) const char* var[] = {__VA_ARGS__, NULL}
/*!
* Register a phony module which, when loaded, will load a list of modules.
* \sa setup.cc for an example.
*/
#define RIME_REGISTER_MODULE_GROUP(name, ...) \
static RIME_MODULE_LIST(rime_##name##_module_group, __VA_ARGS__); \
static void rime_##name##_initialize() { \
rime::LoadModules(rime_##name##_module_group); \
} \
static void rime_##name##_finalize() {} \
RIME_REGISTER_MODULE(name)
#ifdef __cplusplus
}
#endif
#endif // RIME_API_H_