Index: source/i18n/unicode/ufieldpositer.h |
diff --git a/source/i18n/unicode/ufieldpositer.h b/source/i18n/unicode/ufieldpositer.h |
new file mode 100644 |
index 0000000000000000000000000000000000000000..6cc9ffada496c3018ced77e9f01b36b6211ac607 |
--- /dev/null |
+++ b/source/i18n/unicode/ufieldpositer.h |
@@ -0,0 +1,121 @@ |
+/* |
+***************************************************************************************** |
+* Copyright (C) 2015, International Business Machines |
+* Corporation and others. All Rights Reserved. |
+***************************************************************************************** |
+*/ |
+ |
+#ifndef UFIELDPOSITER_H |
+#define UFIELDPOSITER_H |
+ |
+#include "unicode/utypes.h" |
+ |
+#if !UCONFIG_NO_FORMATTING |
+#ifndef U_HIDE_DRAFT_API |
+ |
+#include "unicode/localpointer.h" |
+ |
+/** |
+ * \file |
+ * \brief C API: UFieldPositionIterator for use with format APIs. |
+ * |
+ * Usage: |
+ * ufieldpositer_open creates an empty (unset) UFieldPositionIterator. |
+ * This can be passed to format functions such as {@link #udat_formatForFields}, |
+ * which will set it to apply to the fields in a particular formatted string. |
+ * ufieldpositer_next can then be used to iterate over those fields, |
+ * providing for each field its type (using values that are specific to the |
+ * particular format type, such as date or number formats), as well as the |
+ * start and end positions of the field in the formatted string. |
+ * A given UFieldPositionIterator can be re-used for different format calls; |
+ * each such call resets it to apply to that format string. |
+ * ufieldpositer_close should be called to dispose of the UFieldPositionIterator |
+ * when it is no longer needed. |
+ * |
+ * @see FieldPositionIterator |
+ */ |
+ |
+/** |
+ * Opaque UFieldPositionIterator object for use in C. |
+ * @draft ICU 55 |
+ */ |
+struct UFieldPositionIterator; |
+typedef struct UFieldPositionIterator UFieldPositionIterator; /**< C typedef for struct UFieldPositionIterator. @draft ICU 55 */ |
+ |
+/** |
+ * Open a new, unset UFieldPositionIterator object. |
+ * @param status |
+ * A pointer to a UErrorCode to receive any errors. |
+ * @return |
+ * A pointer to an empty (unset) UFieldPositionIterator object, |
+ * or NULL if an error occurred. |
+ * @draft ICU 55 |
+ */ |
+U_DRAFT UFieldPositionIterator* U_EXPORT2 |
+ufieldpositer_open(UErrorCode* status); |
+ |
+/** |
+ * Close a UFieldPositionIterator object. Once closed it may no longer be used. |
+ * @param fpositer |
+ * A pointer to the UFieldPositionIterator object to close. |
+ * @draft ICU 55 |
+ */ |
+U_DRAFT void U_EXPORT2 |
+ufieldpositer_close(UFieldPositionIterator *fpositer); |
+ |
+ |
+#if U_SHOW_CPLUSPLUS_API |
+ |
+U_NAMESPACE_BEGIN |
+ |
+/** |
+ * \class LocalUFieldPositionIteratorPointer |
+ * "Smart pointer" class, closes a UFieldPositionIterator via ufieldpositer_close(). |
+ * For most methods see the LocalPointerBase base class. |
+ * |
+ * @see LocalPointerBase |
+ * @see LocalPointer |
+ * @draft ICU 55 |
+ */ |
+U_DEFINE_LOCAL_OPEN_POINTER(LocalUFieldPositionIteratorPointer, UFieldPositionIterator, ufieldpositer_close); |
+ |
+U_NAMESPACE_END |
+ |
+#endif |
+ |
+/** |
+ * Get information for the next field in the formatted string to which this |
+ * UFieldPositionIterator currently applies, or return FALSE if there are |
+ * no more fields. |
+ * @param fpositer |
+ * A pointer to the UFieldPositionIterator object containing iteration |
+ * state for the format fields. |
+ * @param beginIndex |
+ * A pointer to an int32_t to receive information about the start offset |
+ * of the field in the formatted string (undefined if the function |
+ * returns a negative value). May be NULL if this information is not needed. |
+ * @param endIndex |
+ * A pointer to an int32_t to receive information about the end offset |
+ * of the field in the formatted string (undefined if the function |
+ * returns a negative value). May be NULL if this information is not needed. |
+ * @return |
+ * The field type (non-negative value), or a negative value if there are |
+ * no more fields for which to provide information. If negative, then any |
+ * values pointed to by beginIndex and endIndex are undefined. |
+ * |
+ * The values for field type depend on what type of formatter the |
+ * UFieldPositionIterator has been set by; for a date formatter, the |
+ * values from the UDateFormatField enum. For more information, see the |
+ * descriptions of format functions that take a UFieldPositionIterator* |
+ * parameter, such as {@link #udat_formatForFields}. |
+ * |
+ * @draft ICU 55 |
+ */ |
+U_DRAFT int32_t U_EXPORT2 |
+ufieldpositer_next(UFieldPositionIterator *fpositer, |
+ int32_t *beginIndex, int32_t *endIndex); |
+ |
+#endif /* U_HIDE_DRAFT_API */ |
+#endif /* #if !UCONFIG_NO_FORMATTING */ |
+ |
+#endif |