ICU 68.2  68.2
icuplug.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ******************************************************************************
5 *
6 * Copyright (C) 2009-2015, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 ******************************************************************************
10 *
11 * FILE NAME : icuplug.h
12 *
13 * Date Name Description
14 * 10/29/2009 sl New.
15 ******************************************************************************
16 */
17 
107 #ifndef ICUPLUG_H
108 #define ICUPLUG_H
109 
110 #include "unicode/utypes.h"
111 
112 
113 #if UCONFIG_ENABLE_PLUGINS || defined(U_IN_DOXYGEN)
114 
115 
116 
117 /* === Basic types === */
118 
119 #ifndef U_HIDE_INTERNAL_API
120 
127 struct UPlugData;
128 typedef struct UPlugData UPlugData;
129 
137 #define UPLUG_TOKEN 0x54762486
138 
143 #define UPLUG_NAME_MAX 100
144 
145 
152 typedef uint32_t UPlugTokenReturn;
153 
158 typedef enum {
168 
169 
177 typedef enum {
188 
196 typedef UPlugTokenReturn (U_EXPORT2 UPlugEntrypoint) (
197  UPlugData *plug,
198  UPlugReason reason,
199  UErrorCode *status);
200 
201 /* === Needed for Implementing === */
202 
211 U_CAPI void U_EXPORT2
212 uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
213 
220 U_CAPI void U_EXPORT2
221 uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
222 
229 U_CAPI UPlugLevel U_EXPORT2
230 uplug_getPlugLevel(UPlugData *plug);
231 
239 U_CAPI UPlugLevel U_EXPORT2
241 
242 
248 U_CAPI UErrorCode U_EXPORT2
249 uplug_getPlugLoadStatus(UPlugData *plug);
250 
257 U_CAPI void U_EXPORT2
258 uplug_setPlugName(UPlugData *plug, const char *name);
259 
266 U_CAPI const char * U_EXPORT2
267 uplug_getPlugName(UPlugData *plug);
268 
275 U_CAPI const char * U_EXPORT2
276 uplug_getSymbolName(UPlugData *plug);
277 
285 U_CAPI const char * U_EXPORT2
286 uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
287 
295 U_CAPI void * U_EXPORT2
296 uplug_getLibrary(UPlugData *plug);
297 
304 U_CAPI void * U_EXPORT2
305 uplug_getContext(UPlugData *plug);
306 
313 U_CAPI void U_EXPORT2
314 uplug_setContext(UPlugData *plug, void *context);
315 
316 
324 U_CAPI const char * U_EXPORT2
325 uplug_getConfiguration(UPlugData *plug);
326 
342 U_CAPI UPlugData* U_EXPORT2
343 uplug_nextPlug(UPlugData *prior);
344 
357 U_CAPI UPlugData* U_EXPORT2
358 uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status);
359 
360 
371 U_CAPI UPlugData* U_EXPORT2
372 uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status);
373 
381 U_CAPI void U_EXPORT2
382 uplug_removePlug(UPlugData *plug, UErrorCode *status);
383 #endif /* U_HIDE_INTERNAL_API */
384 
385 #endif /* UCONFIG_ENABLE_PLUGINS */
386 
387 #endif /* _ICUPLUG */
388 
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
uplug_nextPlug
U_CAPI UPlugData * uplug_nextPlug(UPlugData *prior)
Return all currently installed plugins, from newest to oldest Usage Example:
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
UPLUG_LEVEL_HIGH
@ UPLUG_LEVEL_HIGH
The plugin can run at any time.
Definition: icuplug.h:181
uplug_removePlug
U_CAPI void uplug_removePlug(UPlugData *plug, UErrorCode *status)
Remove a plugin.
UPLUG_LEVEL_INVALID
@ UPLUG_LEVEL_INVALID
The plugin is invalid, hasn't called uplug_setLevel, or can't load.
Definition: icuplug.h:178
uplug_getLibrary
U_CAPI void * uplug_getLibrary(UPlugData *plug)
Return the library used for this plugin, if known.
UPlugTokenReturn
uint32_t UPlugTokenReturn
Return value from a plugin entrypoint.
Definition: icuplug.h:152
UPLUG_LEVEL_LOW
@ UPLUG_LEVEL_LOW
The plugin must be called before u_init completes.
Definition: icuplug.h:180
uplug_getConfiguration
U_CAPI const char * uplug_getConfiguration(UPlugData *plug)
Get the configuration string, if available.
uplug_getCurrentLevel
U_CAPI UPlugLevel uplug_getCurrentLevel(void)
Get the lowest level of plug which can currently load.
uplug_getLibraryName
U_CAPI const char * uplug_getLibraryName(UPlugData *plug, UErrorCode *status)
Return the library name for this plugin, if known.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
UPlugReason
UPlugReason
Reason code for the entrypoint's call.
Definition: icuplug.h:158
uplug_setPlugLevel
U_CAPI void uplug_setPlugLevel(UPlugData *plug, UPlugLevel level)
Set the level of this plugin.
uplug_getContext
U_CAPI void * uplug_getContext(UPlugData *plug)
Return the plugin-specific context data.
UPLUG_LEVEL_COUNT
@ UPLUG_LEVEL_COUNT
Number of known levels.
Definition: icuplug.h:186
uplug_getPlugLevel
U_CAPI UPlugLevel uplug_getPlugLevel(UPlugData *plug)
Get the level of this plugin.
UPLUG_REASON_UNLOAD
@ UPLUG_REASON_UNLOAD
The plugin is being unloaded.
Definition: icuplug.h:161
uplug_getSymbolName
U_CAPI const char * uplug_getSymbolName(UPlugData *plug)
Return the symbol name for this plugin, if known.
UPlugLevel
UPlugLevel
Level of plugin loading INITIAL: UNKNOWN QUERY: INVALID -> { LOW | HIGH } ERR -> INVALID.
Definition: icuplug.h:177
UPLUG_LEVEL_UNKNOWN
@ UPLUG_LEVEL_UNKNOWN
The plugin is waiting to be installed.
Definition: icuplug.h:179
uplug_setPlugNoUnload
U_CAPI void uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload)
Request that this plugin not be unloaded at cleanup time.
UPlugEntrypoint
UPlugTokenReturn() UPlugEntrypoint(UPlugData *plug, UPlugReason reason, UErrorCode *status)
Entrypoint for an ICU plugin.
Definition: icuplug.h:196
uplug_getPlugName
U_CAPI const char * uplug_getPlugName(UPlugData *plug)
Get the human-readable name of this plugin.
uplug_loadPlugFromEntrypoint
U_CAPI UPlugData * uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status)
Inject a plugin as if it were loaded from a library.
UPLUG_REASON_COUNT
@ UPLUG_REASON_COUNT
Number of known reasons.
Definition: icuplug.h:166
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
uplug_setPlugName
U_CAPI void uplug_setPlugName(UPlugData *plug, const char *name)
Set the human-readable name of this plugin.
uplug_setContext
U_CAPI void uplug_setContext(UPlugData *plug, void *context)
Set the plugin-specific context data.
UPLUG_REASON_LOAD
@ UPLUG_REASON_LOAD
The plugin is being loaded.
Definition: icuplug.h:160
uplug_loadPlugFromLibrary
U_CAPI UPlugData * uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status)
Inject a plugin from a library, as if the information came from a config file.
UPLUG_REASON_QUERY
@ UPLUG_REASON_QUERY
The plugin is being queried for info.
Definition: icuplug.h:159
uplug_getPlugLoadStatus
U_CAPI UErrorCode uplug_getPlugLoadStatus(UPlugData *plug)
Get plug load status.