ICU 50.1.2  50.1.2
icuplug.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * Copyright (C) 2009-2012, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 ******************************************************************************
8 *
9 * FILE NAME : icuplug.h
10 *
11 * Date Name Description
12 * 10/29/2009 sl New.
13 ******************************************************************************
14 */
15 
105 #ifndef ICUPLUG_H
106 #define ICUPLUG_H
107 
108 #include "unicode/utypes.h"
109 
110 
111 /* === Basic types === */
112 
113 #ifndef U_HIDE_INTERNAL_API
114 
121 struct UPlugData;
122 typedef struct UPlugData UPlugData;
123 
131 #define UPLUG_TOKEN 0x54762486
132 
137 #define UPLUG_NAME_MAX 100
138 
139 
146 typedef uint32_t UPlugTokenReturn;
147 
152 typedef enum {
157 } UPlugReason;
158 
159 
167 typedef enum {
173 } UPlugLevel;
174 
182 typedef UPlugTokenReturn (U_EXPORT2 UPlugEntrypoint) (
183  UPlugData *plug,
184  UPlugReason reason,
185  UErrorCode *status);
186 
187 /* === Needed for Implementing === */
188 
197 U_INTERNAL void U_EXPORT2
198 uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
199 
206 U_INTERNAL void U_EXPORT2
207 uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
208 
215 U_INTERNAL UPlugLevel U_EXPORT2
216 uplug_getPlugLevel(UPlugData *plug);
217 
225 U_INTERNAL UPlugLevel U_EXPORT2
227 
228 
234 U_INTERNAL UErrorCode U_EXPORT2
235 uplug_getPlugLoadStatus(UPlugData *plug);
236 
243 U_INTERNAL void U_EXPORT2
244 uplug_setPlugName(UPlugData *plug, const char *name);
245 
252 U_INTERNAL const char * U_EXPORT2
253 uplug_getPlugName(UPlugData *plug);
254 
261 U_INTERNAL const char * U_EXPORT2
262 uplug_getSymbolName(UPlugData *plug);
263 
271 U_INTERNAL const char * U_EXPORT2
272 uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
273 
281 U_INTERNAL void * U_EXPORT2
282 uplug_getLibrary(UPlugData *plug);
283 
290 U_INTERNAL void * U_EXPORT2
291 uplug_getContext(UPlugData *plug);
292 
299 U_INTERNAL void U_EXPORT2
300 uplug_setContext(UPlugData *plug, void *context);
301 
302 
310 U_INTERNAL const char * U_EXPORT2
311 uplug_getConfiguration(UPlugData *plug);
312 
328 U_INTERNAL UPlugData* U_EXPORT2
329 uplug_nextPlug(UPlugData *prior);
330 
343 U_INTERNAL UPlugData* U_EXPORT2
344 uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status);
345 
346 
357 U_INTERNAL UPlugData* U_EXPORT2
358 uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status);
359 
367 U_INTERNAL void U_EXPORT2
368 uplug_removePlug(UPlugData *plug, UErrorCode *status);
369 #endif /* U_HIDE_INTERNAL_API */
370 
371 #endif
The plugin is waiting to be installed.
Definition: icuplug.h:169
void * uplug_getLibrary(UPlugData *plug)
Return the library used for this plugin, if known.
const char * uplug_getSymbolName(UPlugData *plug)
Return the symbol name for this plugin, if known.
The plugin is invalid, hasn't called uplug_setLevel, or can't load.
Definition: icuplug.h:168
UPlugData * uplug_nextPlug(UPlugData *prior)
Return all currently installed plugins, from newest to oldest Usage Example:
UPlugReason
Reason code for the entrypoint's call.
Definition: icuplug.h:152
#define U_INTERNAL
This is used to declare a function as an internal ICU C API.
Definition: umachine.h:117
void uplug_setPlugName(UPlugData *plug, const char *name)
Set the human-readable name of this plugin.
uint32_t UPlugTokenReturn
Return value from a plugin entrypoint.
Definition: icuplug.h:146
UErrorCode uplug_getPlugLoadStatus(UPlugData *plug)
Get plug load status.
The plugin can run at any time.
Definition: icuplug.h:171
The plugin must be called before u_init completes.
Definition: icuplug.h:170
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.
const char * uplug_getConfiguration(UPlugData *plug)
Get the configuration string, if available.
UPlugData * uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status)
Inject a plugin as if it were loaded from a library.
void uplug_setPlugLevel(UPlugData *plug, UPlugLevel level)
Set the level of this plugin.
UPlugLevel
Level of plugin loading INITIAL: UNKNOWN QUERY: INVALID -> { LOW | HIGH } ERR -> INVALID.
Definition: icuplug.h:167
void * uplug_getContext(UPlugData *plug)
Return the plugin-specific context data.
UPlugLevel uplug_getCurrentLevel(void)
Get the lowest level of plug which can currently load.
The plugin is being unloaded.
Definition: icuplug.h:155
UPlugLevel uplug_getPlugLevel(UPlugData *plug)
Get the level of this plugin.
void uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload)
Request that this plugin not be unloaded at cleanup time.
count of known reasons
Definition: icuplug.h:172
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
const char * uplug_getPlugName(UPlugData *plug)
Get the human-readable name of this plugin.
void uplug_removePlug(UPlugData *plug, UErrorCode *status)
Remove a plugin.
The plugin is being loaded.
Definition: icuplug.h:154
void uplug_setContext(UPlugData *plug, void *context)
Set the plugin-specific context data.
UPlugTokenReturn( UPlugEntrypoint)(UPlugData *plug, UPlugReason reason, UErrorCode *status)
Entrypoint for an ICU plugin.
Definition: icuplug.h:182
The plugin is being queried for info.
Definition: icuplug.h:153
Basic definitions for ICU, for both C and C++ APIs.
const char * uplug_getLibraryName(UPlugData *plug, UErrorCode *status)
Return the library name for this plugin, if known.
count of known reasons
Definition: icuplug.h:156
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200