ICU 62.1 62.1
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
114
115
116
117/* === Basic types === */
118
119#ifndef U_HIDE_INTERNAL_API
127struct UPlugData;
128typedef struct UPlugData UPlugData;
129
137#define UPLUG_TOKEN 0x54762486
138
143#define UPLUG_NAME_MAX 100
144
145
152typedef uint32_t UPlugTokenReturn;
153
168
169
188
197 UPlugData *plug,
198 UPlugReason reason,
199 UErrorCode *status);
200
201/* === Needed for Implementing === */
202
211U_INTERNAL void U_EXPORT2
212uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
213
220U_INTERNAL void U_EXPORT2
221uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
222
229U_INTERNAL UPlugLevel U_EXPORT2
230uplug_getPlugLevel(UPlugData *plug);
231
239U_INTERNAL UPlugLevel U_EXPORT2
241
242
248U_INTERNAL UErrorCode U_EXPORT2
249uplug_getPlugLoadStatus(UPlugData *plug);
250
257U_INTERNAL void U_EXPORT2
258uplug_setPlugName(UPlugData *plug, const char *name);
259
266U_INTERNAL const char * U_EXPORT2
267uplug_getPlugName(UPlugData *plug);
268
275U_INTERNAL const char * U_EXPORT2
276uplug_getSymbolName(UPlugData *plug);
277
285U_INTERNAL const char * U_EXPORT2
286uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
287
295U_INTERNAL void * U_EXPORT2
296uplug_getLibrary(UPlugData *plug);
297
304U_INTERNAL void * U_EXPORT2
305uplug_getContext(UPlugData *plug);
306
313U_INTERNAL void U_EXPORT2
314uplug_setContext(UPlugData *plug, void *context);
315
316
324U_INTERNAL const char * U_EXPORT2
325uplug_getConfiguration(UPlugData *plug);
326
342U_INTERNAL UPlugData* U_EXPORT2
343uplug_nextPlug(UPlugData *prior);
344
357U_INTERNAL UPlugData* U_EXPORT2
358uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status);
359
360
371U_INTERNAL UPlugData* U_EXPORT2
372uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status);
373
381U_INTERNAL void U_EXPORT2
382uplug_removePlug(UPlugData *plug, UErrorCode *status);
383#endif /* U_HIDE_INTERNAL_API */
384
385#endif /* UCONFIG_ENABLE_PLUGINS */
386
387#endif /* _ICUPLUG */
388
uint32_t UPlugTokenReturn
Return value from a plugin entrypoint.
Definition icuplug.h:152
UErrorCode uplug_getPlugLoadStatus(UPlugData *plug)
Get plug load status.
void * uplug_getContext(UPlugData *plug)
Return the plugin-specific context data.
UPlugReason
Reason code for the entrypoint's call.
Definition icuplug.h:158
@ UPLUG_REASON_COUNT
Number of known reasons.
Definition icuplug.h:166
@ UPLUG_REASON_LOAD
The plugin is being loaded.
Definition icuplug.h:160
@ UPLUG_REASON_UNLOAD
The plugin is being unloaded.
Definition icuplug.h:161
@ UPLUG_REASON_QUERY
The plugin is being queried for info.
Definition icuplug.h:159
UPlugData * uplug_nextPlug(UPlugData *prior)
Return all currently installed plugins, from newest to oldest Usage Example:
void uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload)
Request that this plugin not be unloaded at cleanup time.
const char * uplug_getSymbolName(UPlugData *plug)
Return the symbol name for this plugin, if known.
const char * uplug_getConfiguration(UPlugData *plug)
Get the configuration string, if available.
UPlugLevel uplug_getPlugLevel(UPlugData *plug)
Get the level of this plugin.
const char * uplug_getPlugName(UPlugData *plug)
Get the human-readable name of this plugin.
void uplug_setContext(UPlugData *plug, void *context)
Set the plugin-specific context data.
void uplug_removePlug(UPlugData *plug, UErrorCode *status)
Remove a plugin.
UPlugData * uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status)
Inject a plugin as if it were loaded from a library.
UPlugTokenReturn UPlugEntrypoint(UPlugData *plug, UPlugReason reason, UErrorCode *status)
Entrypoint for an ICU plugin.
Definition icuplug.h:196
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_getLibraryName(UPlugData *plug, UErrorCode *status)
Return the library name for this plugin, if known.
void uplug_setPlugLevel(UPlugData *plug, UPlugLevel level)
Set the level of this plugin.
void uplug_setPlugName(UPlugData *plug, const char *name)
Set the human-readable name of this plugin.
UPlugLevel
Level of plugin loading INITIAL: UNKNOWN QUERY: INVALID -> { LOW | HIGH } ERR -> INVALID.
Definition icuplug.h:177
@ UPLUG_LEVEL_INVALID
The plugin is invalid, hasn't called uplug_setLevel, or can't load.
Definition icuplug.h:178
@ UPLUG_LEVEL_COUNT
Number of known levels.
Definition icuplug.h:186
@ UPLUG_LEVEL_UNKNOWN
The plugin is waiting to be installed.
Definition icuplug.h:179
@ UPLUG_LEVEL_HIGH
The plugin can run at any time.
Definition icuplug.h:181
@ UPLUG_LEVEL_LOW
The plugin must be called before u_init completes.
Definition icuplug.h:180
void * uplug_getLibrary(UPlugData *plug)
Return the library used for this plugin, if known.
UPlugLevel uplug_getCurrentLevel(void)
Get the lowest level of plug which can currently load.
#define U_INTERNAL
This is used to declare a function as an internal ICU C API
Definition umachine.h:119
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396