X-Git-Url: https://git.saurik.com/apple/icu.git/blobdiff_plain/b75a7d8f3b4adbae880cab104ce2c6a50eee4db2..3d1f044b704633e2e541231cd17ae9ecf9ad5c7a:/icuSources/common/unicode/uenum.h

diff --git a/icuSources/common/unicode/uenum.h b/icuSources/common/unicode/uenum.h
index 80a12790..0f14444a 100644
--- a/icuSources/common/unicode/uenum.h
+++ b/icuSources/common/unicode/uenum.h
@@ -1,12 +1,14 @@
+// © 2016 and later: Unicode, Inc. and others.
+// License & terms of use: http://www.unicode.org/copyright.html
 /*
 *******************************************************************************
 *
-*   Copyright (C) 2002, International Business Machines
+*   Copyright (C) 2002-2013, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 *
 *******************************************************************************
 *   file name:  uenum.h
-*   encoding:   US-ASCII
+*   encoding:   UTF-8
 *   tab size:   8 (not used)
 *   indentation:2
 *
@@ -18,14 +20,26 @@
 #define __UENUM_H
 
 #include "unicode/utypes.h"
+#include "unicode/localpointer.h"
 
+#if U_SHOW_CPLUSPLUS_API
+U_NAMESPACE_BEGIN
+class StringEnumeration;
+U_NAMESPACE_END
+#endif // U_SHOW_CPLUSPLUS_API
+
+/**
+ * \file
+ * \brief C API: String Enumeration 
+ */
+ 
 /**
  * An enumeration object.
  * For usage in C programs.
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
 struct UEnumeration;
-/** structure representing an enumeration object instance @draft ICU 2.2 */
+/** structure representing an enumeration object instance @stable ICU 2.2 */
 typedef struct UEnumeration UEnumeration;
 
 /**
@@ -33,11 +47,30 @@ typedef struct UEnumeration UEnumeration;
  * does nothing.  After this call, any char* or UChar* pointer
  * returned by uenum_unext() or uenum_next() is invalid.
  * @param en UEnumeration structure pointer
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
-U_CAPI void U_EXPORT2
+U_STABLE void U_EXPORT2
 uenum_close(UEnumeration* en);
 
+#if U_SHOW_CPLUSPLUS_API
+
+U_NAMESPACE_BEGIN
+
+/**
+ * \class LocalUEnumerationPointer
+ * "Smart pointer" class, closes a UEnumeration via uenum_close().
+ * For most methods see the LocalPointerBase base class.
+ *
+ * @see LocalPointerBase
+ * @see LocalPointer
+ * @stable ICU 4.4
+ */
+U_DEFINE_LOCAL_OPEN_POINTER(LocalUEnumerationPointer, UEnumeration, uenum_close);
+
+U_NAMESPACE_END
+
+#endif // U_SHOW_CPLUSPLUS_API
+
 /**
  * Returns the number of elements that the iterator traverses.  If
  * the iterator is out-of-sync with its service, status is set to
@@ -50,9 +83,9 @@ uenum_close(UEnumeration* en);
  * @param status error code, can be U_ENUM_OUT_OF_SYNC_ERROR if the
  *               iterator is out of sync.
  * @return number of elements in the iterator
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
-U_CAPI int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
 uenum_count(UEnumeration* en, UErrorCode* status);
 
 /**
@@ -64,7 +97,7 @@ uenum_count(UEnumeration* en, UErrorCode* status);
  * The result is terminated by (UChar)0.
  * @param en the iterator object
  * @param resultLength pointer to receive the length of the result
- *                     (not including the terminating \0).
+ *                     (not including the terminating \\0).
  *                     If the pointer is NULL it is ignored.
  * @param status the error code, set to U_ENUM_OUT_OF_SYNC_ERROR if
  *               the iterator is out of sync with its service.
@@ -74,9 +107,9 @@ uenum_count(UEnumeration* en, UErrorCode* status);
  *         until the next call to any uenum_... method, including
  *         uenum_next() or uenum_unext().  When all strings have been
  *         traversed, returns NULL.
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
-U_CAPI const UChar* U_EXPORT2
+U_STABLE const UChar* U_EXPORT2
 uenum_unext(UEnumeration* en,
             int32_t* resultLength,
             UErrorCode* status);
@@ -93,7 +126,7 @@ uenum_unext(UEnumeration* en,
  * (but non-NULL).
  * @param en the iterator object
  * @param resultLength pointer to receive the length of the result
- *                     (not including the terminating \0).
+ *                     (not including the terminating \\0).
  *                     If the pointer is NULL it is ignored.
  * @param status the error code, set to U_ENUM_OUT_OF_SYNC_ERROR if
  *               the iterator is out of sync with its service.  Set to
@@ -107,9 +140,9 @@ uenum_unext(UEnumeration* en,
  *         until the next call to any uenum_... method, including
  *         uenum_next() or uenum_unext().  When all strings have been
  *         traversed, returns NULL.
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
-U_CAPI const char* U_EXPORT2
+U_STABLE const char* U_EXPORT2
 uenum_next(UEnumeration* en,
            int32_t* resultLength,
            UErrorCode* status);
@@ -121,9 +154,55 @@ uenum_next(UEnumeration* en,
  * @param en the iterator object
  * @param status the error code, set to U_ENUM_OUT_OF_SYNC_ERROR if
  *               the iterator is out of sync with its service.  
- * @draft ICU 2.2
+ * @stable ICU 2.2
  */
-U_CAPI void U_EXPORT2
+U_STABLE void U_EXPORT2
 uenum_reset(UEnumeration* en, UErrorCode* status);
 
+#if U_SHOW_CPLUSPLUS_API
+
+/**
+ * Given a StringEnumeration, wrap it in a UEnumeration.  The
+ * StringEnumeration is adopted; after this call, the caller must not
+ * delete it (regardless of error status).
+ * @param adopted the C++ StringEnumeration to be wrapped in a UEnumeration.
+ * @param ec the error code.
+ * @return a UEnumeration wrapping the adopted StringEnumeration.
+ * @stable ICU 4.2
+ */
+U_STABLE UEnumeration* U_EXPORT2
+uenum_openFromStringEnumeration(icu::StringEnumeration* adopted, UErrorCode* ec);
+
+#endif // U_SHOW_CPLUSPLUS_API
+
+/**
+ * Given an array of const UChar* strings, return a UEnumeration.  String pointers from 0..count-1 must not be null.
+ * Do not free or modify either the string array or the characters it points to until this object has been destroyed with uenum_close.
+ * \snippet test/cintltst/uenumtst.c uenum_openUCharStringsEnumeration
+ * @param strings array of const UChar* strings (each null terminated). All storage is owned by the caller.
+ * @param count length of the array
+ * @param ec error code
+ * @return the new UEnumeration object. Caller is responsible for calling uenum_close to free memory.
+ * @see uenum_close
+ * @stable ICU 50
+ */
+U_STABLE UEnumeration* U_EXPORT2
+uenum_openUCharStringsEnumeration(const UChar* const strings[], int32_t count,
+                                 UErrorCode* ec);
+
+/**
+ * Given an array of const char* strings (invariant chars only), return a UEnumeration.  String pointers from 0..count-1 must not be null.
+ * Do not free or modify either the string array or the characters it points to until this object has been destroyed with uenum_close.
+ * \snippet test/cintltst/uenumtst.c uenum_openCharStringsEnumeration
+ * @param strings array of char* strings (each null terminated).  All storage is owned by the caller.
+ * @param count length of the array
+ * @param ec error code
+ * @return the new UEnumeration object. Caller is responsible for calling uenum_close to free memory
+ * @see uenum_close
+ * @stable ICU 50
+ */
+U_STABLE UEnumeration* U_EXPORT2
+uenum_openCharStringsEnumeration(const char* const strings[], int32_t count,
+                                 UErrorCode* ec);
+
 #endif