ICU-64232.0.1.tar.gz

[apple/icu.git] / icuSources / common / unicode / icuplug.h

diff --git a/icuSources/common/unicode/icuplug.h b/icuSources/common/unicode/icuplug.h
index afc5db76a584a530d9412b945e2be2d3aec53430..2e57b149e14ede56a865c2c6695901bb30663f14 100644 (file)
--- a/icuSources/common/unicode/icuplug.h
+++ b/icuSources/common/unicode/icuplug.h
@@ -1,7 +1,9 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
 ******************************************************************************
 *
-*   Copyright (C) 2009-2011, International Business Machines
+*   Copyright (C) 2009-2015, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 *
 ******************************************************************************
@@ -108,6 +110,10 @@
 #include "unicode/utypes.h"
 
 
+#if UCONFIG_ENABLE_PLUGINS || defined(U_IN_DOXYGEN)
+
+
+
 /* === Basic types === */
 
 #ifndef U_HIDE_INTERNAL_API
@@ -153,7 +159,11 @@ typedef enum {
     UPLUG_REASON_QUERY = 0,     /**< The plugin is being queried for info. **/
     UPLUG_REASON_LOAD = 1,     /**< The plugin is being loaded. **/
     UPLUG_REASON_UNLOAD = 2,   /**< The plugin is being unloaded. **/
-    UPLUG_REASON_COUNT         /**< count of known reasons **/
+    /**
+     * Number of known reasons.
+     * @internal The numeric value may change over time, see ICU ticket #12420.
+     */
+    UPLUG_REASON_COUNT
 } UPlugReason;
 
 
@@ -169,7 +179,11 @@ typedef enum {
     UPLUG_LEVEL_UNKNOWN = 1,     /**< The plugin is waiting to be installed. **/
     UPLUG_LEVEL_LOW     = 2,     /**< The plugin must be called before u_init completes **/
     UPLUG_LEVEL_HIGH    = 3,     /**< The plugin can run at any time. **/
-    UPLUG_LEVEL_COUNT         /**< count of known reasons **/
+    /**
+     * Number of known levels.
+     * @internal The numeric value may change over time, see ICU ticket #12420.
+     */
+    UPLUG_LEVEL_COUNT
 } UPlugLevel;
 
 /**
@@ -194,7 +208,7 @@ typedef UPlugTokenReturn (U_EXPORT2 UPlugEntrypoint) (
  * @param dontUnload  set true if this plugin can't be unloaded
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void U_EXPORT2 
+U_INTERNAL void U_EXPORT2 
 uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
 
 /**
@@ -203,7 +217,7 @@ uplug_setPlugNoUnload(UPlugData *plug, UBool dontUnload);
  * @param level the level of this plugin
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void U_EXPORT2
+U_INTERNAL void U_EXPORT2
 uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
 
 /**
@@ -212,7 +226,7 @@ uplug_setPlugLevel(UPlugData *plug, UPlugLevel level);
  * @return the level of this plugin
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UPlugLevel U_EXPORT2
+U_INTERNAL UPlugLevel U_EXPORT2
 uplug_getPlugLevel(UPlugData *plug);
 
 /**
@@ -222,7 +236,7 @@ uplug_getPlugLevel(UPlugData *plug);
  * @return the lowest level of plug which can currently load
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UPlugLevel U_EXPORT2
+U_INTERNAL UPlugLevel U_EXPORT2
 uplug_getCurrentLevel(void);
 
 
@@ -231,7 +245,7 @@ uplug_getCurrentLevel(void);
  * @return The error code of this plugin's load attempt.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UErrorCode U_EXPORT2
+U_INTERNAL UErrorCode U_EXPORT2
 uplug_getPlugLoadStatus(UPlugData *plug); 
 
 /**
@@ -240,7 +254,7 @@ uplug_getPlugLoadStatus(UPlugData *plug);
  * @param name the name of this plugin. The first UPLUG_NAME_MAX characters willi be copied into a new buffer.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void U_EXPORT2
+U_INTERNAL void U_EXPORT2
 uplug_setPlugName(UPlugData *plug, const char *name);
 
 /**
@@ -249,7 +263,7 @@ uplug_setPlugName(UPlugData *plug, const char *name);
  * @return the name of this plugin
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI const char * U_EXPORT2
+U_INTERNAL const char * U_EXPORT2
 uplug_getPlugName(UPlugData *plug);
 
 /**
@@ -258,7 +272,7 @@ uplug_getPlugName(UPlugData *plug);
  * @return the symbol name, or NULL
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI const char * U_EXPORT2
+U_INTERNAL const char * U_EXPORT2
 uplug_getSymbolName(UPlugData *plug);
 
 /**
@@ -268,7 +282,7 @@ uplug_getSymbolName(UPlugData *plug);
  * @return the library name, or NULL
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI const char * U_EXPORT2
+U_INTERNAL const char * U_EXPORT2
 uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
 
 /**
@@ -278,7 +292,7 @@ uplug_getLibraryName(UPlugData *plug, UErrorCode *status);
  * @return the library, or NULL
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void * U_EXPORT2
+U_INTERNAL void * U_EXPORT2
 uplug_getLibrary(UPlugData *plug);
 
 /**
@@ -287,7 +301,7 @@ uplug_getLibrary(UPlugData *plug);
  * @return the context, or NULL if not set
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void * U_EXPORT2
+U_INTERNAL void * U_EXPORT2
 uplug_getContext(UPlugData *plug);
 
 /**
@@ -296,7 +310,7 @@ uplug_getContext(UPlugData *plug);
  * @param context new context to set
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void U_EXPORT2
+U_INTERNAL void U_EXPORT2
 uplug_setContext(UPlugData *plug, void *context);
 
 
@@ -307,7 +321,7 @@ uplug_setContext(UPlugData *plug, void *context);
  * @return configuration string, or else null.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI const char * U_EXPORT2
+U_INTERNAL const char * U_EXPORT2
 uplug_getConfiguration(UPlugData *plug);
 
 /**
@@ -325,7 +339,7 @@ uplug_getConfiguration(UPlugData *plug);
  * @return the next oldest plugin, or NULL if no more.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UPlugData* U_EXPORT2
+U_INTERNAL UPlugData* U_EXPORT2
 uplug_nextPlug(UPlugData *prior);
 
 /**
@@ -340,7 +354,7 @@ uplug_nextPlug(UPlugData *prior);
  * @return the new UPlugData associated with this plugin, or NULL if error.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UPlugData* U_EXPORT2
+U_INTERNAL UPlugData* U_EXPORT2
 uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UErrorCode *status);
 
 
@@ -354,7 +368,7 @@ uplug_loadPlugFromEntrypoint(UPlugEntrypoint *entrypoint, const char *config, UE
  * @return the new UPlugData associated with this plugin, or NULL if error.
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI UPlugData* U_EXPORT2
+U_INTERNAL UPlugData* U_EXPORT2
 uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *config, UErrorCode *status);
 
 /**
@@ -364,8 +378,11 @@ uplug_loadPlugFromLibrary(const char *libName, const char *sym, const char *conf
  * @param status error result
  * @internal ICU 4.4 Technology Preview
  */
-U_CAPI void U_EXPORT2
+U_INTERNAL void U_EXPORT2
 uplug_removePlug(UPlugData *plug, UErrorCode *status);
 #endif  /* U_HIDE_INTERNAL_API */
 
-#endif
+#endif /* UCONFIG_ENABLE_PLUGINS */
+
+#endif /* _ICUPLUG */
+