Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/uformattable.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 // © 2016 and later: Unicode, Inc. and others.
jpayne@69 2 // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69 3 /*
jpayne@69 4 ********************************************************************************
jpayne@69 5 * Copyright (C) 2013-2014, International Business Machines Corporation and others.
jpayne@69 6 * All Rights Reserved.
jpayne@69 7 ********************************************************************************
jpayne@69 8 *
jpayne@69 9 * File UFORMATTABLE.H
jpayne@69 10 *
jpayne@69 11 * Modification History:
jpayne@69 12 *
jpayne@69 13 * Date Name Description
jpayne@69 14 * 2013 Jun 7 srl New
jpayne@69 15 ********************************************************************************
jpayne@69 16 */
jpayne@69 17
jpayne@69 18 /**
jpayne@69 19 * \file
jpayne@69 20 * \brief C API: UFormattable is a thin wrapper for primitive types used for formatting and parsing.
jpayne@69 21 *
jpayne@69 22 * This is a C interface to the icu::Formattable class. Static functions on this class convert
jpayne@69 23 * to and from this interface (via reinterpret_cast). Note that Formattables (and thus UFormattables)
jpayne@69 24 * are mutable, and many operations (even getters) may actually modify the internal state. For this
jpayne@69 25 * reason, UFormattables are not thread safe, and should not be shared between threads.
jpayne@69 26 *
jpayne@69 27 * See {@link unum_parseToUFormattable} for example code.
jpayne@69 28 */
jpayne@69 29
jpayne@69 30 #ifndef UFORMATTABLE_H
jpayne@69 31 #define UFORMATTABLE_H
jpayne@69 32
jpayne@69 33 #include "unicode/utypes.h"
jpayne@69 34
jpayne@69 35 #if !UCONFIG_NO_FORMATTING
jpayne@69 36
jpayne@69 37 #include "unicode/localpointer.h"
jpayne@69 38
jpayne@69 39 /**
jpayne@69 40 * Enum designating the type of a UFormattable instance.
jpayne@69 41 * Practically, this indicates which of the getters would return without conversion
jpayne@69 42 * or error.
jpayne@69 43 * @see icu::Formattable::Type
jpayne@69 44 * @stable ICU 52
jpayne@69 45 */
jpayne@69 46 typedef enum UFormattableType {
jpayne@69 47 UFMT_DATE = 0, /**< ufmt_getDate() will return without conversion. @see ufmt_getDate*/
jpayne@69 48 UFMT_DOUBLE, /**< ufmt_getDouble() will return without conversion. @see ufmt_getDouble*/
jpayne@69 49 UFMT_LONG, /**< ufmt_getLong() will return without conversion. @see ufmt_getLong */
jpayne@69 50 UFMT_STRING, /**< ufmt_getUChars() will return without conversion. @see ufmt_getUChars*/
jpayne@69 51 UFMT_ARRAY, /**< ufmt_countArray() and ufmt_getArray() will return the value. @see ufmt_getArrayItemByIndex */
jpayne@69 52 UFMT_INT64, /**< ufmt_getInt64() will return without conversion. @see ufmt_getInt64 */
jpayne@69 53 UFMT_OBJECT, /**< ufmt_getObject() will return without conversion. @see ufmt_getObject*/
jpayne@69 54 #ifndef U_HIDE_DEPRECATED_API
jpayne@69 55 /**
jpayne@69 56 * One more than the highest normal UFormattableType value.
jpayne@69 57 * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
jpayne@69 58 */
jpayne@69 59 UFMT_COUNT
jpayne@69 60 #endif /* U_HIDE_DEPRECATED_API */
jpayne@69 61 } UFormattableType;
jpayne@69 62
jpayne@69 63
jpayne@69 64 /**
jpayne@69 65 * Opaque type representing various types of data which may be used for formatting
jpayne@69 66 * and parsing operations.
jpayne@69 67 * @see icu::Formattable
jpayne@69 68 * @stable ICU 52
jpayne@69 69 */
jpayne@69 70 typedef void *UFormattable;
jpayne@69 71
jpayne@69 72 /**
jpayne@69 73 * Initialize a UFormattable, to type UNUM_LONG, value 0
jpayne@69 74 * may return error if memory allocation failed.
jpayne@69 75 * parameter status error code.
jpayne@69 76 * See {@link unum_parseToUFormattable} for example code.
jpayne@69 77 * @stable ICU 52
jpayne@69 78 * @return the new UFormattable
jpayne@69 79 * @see ufmt_close
jpayne@69 80 * @see icu::Formattable::Formattable()
jpayne@69 81 */
jpayne@69 82 U_STABLE UFormattable* U_EXPORT2
jpayne@69 83 ufmt_open(UErrorCode* status);
jpayne@69 84
jpayne@69 85 /**
jpayne@69 86 * Cleanup any additional memory allocated by this UFormattable.
jpayne@69 87 * @param fmt the formatter
jpayne@69 88 * @stable ICU 52
jpayne@69 89 * @see ufmt_open
jpayne@69 90 */
jpayne@69 91 U_STABLE void U_EXPORT2
jpayne@69 92 ufmt_close(UFormattable* fmt);
jpayne@69 93
jpayne@69 94 #if U_SHOW_CPLUSPLUS_API
jpayne@69 95
jpayne@69 96 U_NAMESPACE_BEGIN
jpayne@69 97
jpayne@69 98 /**
jpayne@69 99 * \class LocalUFormattablePointer
jpayne@69 100 * "Smart pointer" class, closes a UFormattable via ufmt_close().
jpayne@69 101 * For most methods see the LocalPointerBase base class.
jpayne@69 102 *
jpayne@69 103 * @see LocalPointerBase
jpayne@69 104 * @see LocalPointer
jpayne@69 105 * @stable ICU 52
jpayne@69 106 */
jpayne@69 107 U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattablePointer, UFormattable, ufmt_close);
jpayne@69 108
jpayne@69 109 U_NAMESPACE_END
jpayne@69 110
jpayne@69 111 #endif
jpayne@69 112
jpayne@69 113 /**
jpayne@69 114 * Return the type of this object
jpayne@69 115 * @param fmt the UFormattable object
jpayne@69 116 * @param status status code - U_ILLEGAL_ARGUMENT_ERROR is returned if the UFormattable contains data not supported by
jpayne@69 117 * the API
jpayne@69 118 * @return the value as a UFormattableType
jpayne@69 119 * @see ufmt_isNumeric
jpayne@69 120 * @see icu::Formattable::getType() const
jpayne@69 121 * @stable ICU 52
jpayne@69 122 */
jpayne@69 123 U_STABLE UFormattableType U_EXPORT2
jpayne@69 124 ufmt_getType(const UFormattable* fmt, UErrorCode *status);
jpayne@69 125
jpayne@69 126 /**
jpayne@69 127 * Return whether the object is numeric.
jpayne@69 128 * @param fmt the UFormattable object
jpayne@69 129 * @return true if the object is a double, long, or int64 value, else false.
jpayne@69 130 * @see ufmt_getType
jpayne@69 131 * @see icu::Formattable::isNumeric() const
jpayne@69 132 * @stable ICU 52
jpayne@69 133 */
jpayne@69 134 U_STABLE UBool U_EXPORT2
jpayne@69 135 ufmt_isNumeric(const UFormattable* fmt);
jpayne@69 136
jpayne@69 137 /**
jpayne@69 138 * Gets the UDate value of this object. If the type is not of type UFMT_DATE,
jpayne@69 139 * status is set to U_INVALID_FORMAT_ERROR and the return value is
jpayne@69 140 * undefined.
jpayne@69 141 * @param fmt the UFormattable object
jpayne@69 142 * @param status the error code - any conversion or format errors
jpayne@69 143 * @return the value
jpayne@69 144 * @stable ICU 52
jpayne@69 145 * @see icu::Formattable::getDate(UErrorCode&) const
jpayne@69 146 */
jpayne@69 147 U_STABLE UDate U_EXPORT2
jpayne@69 148 ufmt_getDate(const UFormattable* fmt, UErrorCode *status);
jpayne@69 149
jpayne@69 150 /**
jpayne@69 151 * Gets the double value of this object. If the type is not a UFMT_DOUBLE, or
jpayne@69 152 * if there are additional significant digits than fit in a double type,
jpayne@69 153 * a conversion is performed with possible loss of precision.
jpayne@69 154 * If the type is UFMT_OBJECT and the
jpayne@69 155 * object is a Measure, then the result of
jpayne@69 156 * getNumber().getDouble(status) is returned. If this object is
jpayne@69 157 * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69 158 * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69 159 * @param fmt the UFormattable object
jpayne@69 160 * @param status the error code - any conversion or format errors
jpayne@69 161 * @return the value
jpayne@69 162 * @stable ICU 52
jpayne@69 163 * @see icu::Formattable::getDouble(UErrorCode&) const
jpayne@69 164 */
jpayne@69 165 U_STABLE double U_EXPORT2
jpayne@69 166 ufmt_getDouble(UFormattable* fmt, UErrorCode *status);
jpayne@69 167
jpayne@69 168 /**
jpayne@69 169 * Gets the long (int32_t) value of this object. If the magnitude is too
jpayne@69 170 * large to fit in a long, then the maximum or minimum long value,
jpayne@69 171 * as appropriate, is returned and the status is set to
jpayne@69 172 * U_INVALID_FORMAT_ERROR. If this object is of type UFMT_INT64 and
jpayne@69 173 * it fits within a long, then no precision is lost. If it is of
jpayne@69 174 * type kDouble or kDecimalNumber, then a conversion is peformed, with
jpayne@69 175 * truncation of any fractional part. If the type is UFMT_OBJECT and
jpayne@69 176 * the object is a Measure, then the result of
jpayne@69 177 * getNumber().getLong(status) is returned. If this object is
jpayne@69 178 * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69 179 * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69 180 * @param fmt the UFormattable object
jpayne@69 181 * @param status the error code - any conversion or format errors
jpayne@69 182 * @return the value
jpayne@69 183 * @stable ICU 52
jpayne@69 184 * @see icu::Formattable::getLong(UErrorCode&) const
jpayne@69 185 */
jpayne@69 186 U_STABLE int32_t U_EXPORT2
jpayne@69 187 ufmt_getLong(UFormattable* fmt, UErrorCode *status);
jpayne@69 188
jpayne@69 189
jpayne@69 190 /**
jpayne@69 191 * Gets the int64_t value of this object. If this object is of a numeric
jpayne@69 192 * type and the magnitude is too large to fit in an int64, then
jpayne@69 193 * the maximum or minimum int64 value, as appropriate, is returned
jpayne@69 194 * and the status is set to U_INVALID_FORMAT_ERROR. If the
jpayne@69 195 * magnitude fits in an int64, then a casting conversion is
jpayne@69 196 * peformed, with truncation of any fractional part. If the type
jpayne@69 197 * is UFMT_OBJECT and the object is a Measure, then the result of
jpayne@69 198 * getNumber().getDouble(status) is returned. If this object is
jpayne@69 199 * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69 200 * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69 201 * @param fmt the UFormattable object
jpayne@69 202 * @param status the error code - any conversion or format errors
jpayne@69 203 * @return the value
jpayne@69 204 * @stable ICU 52
jpayne@69 205 * @see icu::Formattable::getInt64(UErrorCode&) const
jpayne@69 206 */
jpayne@69 207 U_STABLE int64_t U_EXPORT2
jpayne@69 208 ufmt_getInt64(UFormattable* fmt, UErrorCode *status);
jpayne@69 209
jpayne@69 210 /**
jpayne@69 211 * Returns a pointer to the UObject contained within this
jpayne@69 212 * formattable (as a const void*), or NULL if this object
jpayne@69 213 * is not of type UFMT_OBJECT.
jpayne@69 214 * @param fmt the UFormattable object
jpayne@69 215 * @param status the error code - any conversion or format errors
jpayne@69 216 * @return the value as a const void*. It is a polymorphic C++ object.
jpayne@69 217 * @stable ICU 52
jpayne@69 218 * @see icu::Formattable::getObject() const
jpayne@69 219 */
jpayne@69 220 U_STABLE const void *U_EXPORT2
jpayne@69 221 ufmt_getObject(const UFormattable* fmt, UErrorCode *status);
jpayne@69 222
jpayne@69 223 /**
jpayne@69 224 * Gets the string value of this object as a UChar string. If the type is not a
jpayne@69 225 * string, status is set to U_INVALID_FORMAT_ERROR and a NULL pointer is returned.
jpayne@69 226 * This function is not thread safe and may modify the UFormattable if need be to terminate the string.
jpayne@69 227 * The returned pointer is not valid if any other functions are called on this UFormattable, or if the UFormattable is closed.
jpayne@69 228 * @param fmt the UFormattable object
jpayne@69 229 * @param status the error code - any conversion or format errors
jpayne@69 230 * @param len if non null, contains the string length on return
jpayne@69 231 * @return the null terminated string value - must not be referenced after any other functions are called on this UFormattable.
jpayne@69 232 * @stable ICU 52
jpayne@69 233 * @see icu::Formattable::getString(UnicodeString&)const
jpayne@69 234 */
jpayne@69 235 U_STABLE const UChar* U_EXPORT2
jpayne@69 236 ufmt_getUChars(UFormattable* fmt, int32_t *len, UErrorCode *status);
jpayne@69 237
jpayne@69 238 /**
jpayne@69 239 * Get the number of array objects contained, if an array type UFMT_ARRAY
jpayne@69 240 * @param fmt the UFormattable object
jpayne@69 241 * @param status the error code - any conversion or format errors. U_ILLEGAL_ARGUMENT_ERROR if not an array type.
jpayne@69 242 * @return the number of array objects or undefined if not an array type
jpayne@69 243 * @stable ICU 52
jpayne@69 244 * @see ufmt_getArrayItemByIndex
jpayne@69 245 */
jpayne@69 246 U_STABLE int32_t U_EXPORT2
jpayne@69 247 ufmt_getArrayLength(const UFormattable* fmt, UErrorCode *status);
jpayne@69 248
jpayne@69 249 /**
jpayne@69 250 * Get the specified value from the array of UFormattables. Invalid if the object is not an array type UFMT_ARRAY
jpayne@69 251 * @param fmt the UFormattable object
jpayne@69 252 * @param n the number of the array to return (0 based).
jpayne@69 253 * @param status the error code - any conversion or format errors. Returns an error if n is out of bounds.
jpayne@69 254 * @return the nth array value, only valid while the containing UFormattable is valid. NULL if not an array.
jpayne@69 255 * @stable ICU 52
jpayne@69 256 * @see icu::Formattable::getArray(int32_t&, UErrorCode&) const
jpayne@69 257 */
jpayne@69 258 U_STABLE UFormattable * U_EXPORT2
jpayne@69 259 ufmt_getArrayItemByIndex(UFormattable* fmt, int32_t n, UErrorCode *status);
jpayne@69 260
jpayne@69 261 /**
jpayne@69 262 * Returns a numeric string representation of the number contained within this
jpayne@69 263 * formattable, or NULL if this object does not contain numeric type.
jpayne@69 264 * For values obtained by parsing, the returned decimal number retains
jpayne@69 265 * the full precision and range of the original input, unconstrained by
jpayne@69 266 * the limits of a double floating point or a 64 bit int.
jpayne@69 267 *
jpayne@69 268 * This function is not thread safe, and therfore is not declared const,
jpayne@69 269 * even though it is logically const.
jpayne@69 270 * The resulting buffer is owned by the UFormattable and is invalid if any other functions are
jpayne@69 271 * called on the UFormattable.
jpayne@69 272 *
jpayne@69 273 * Possible errors include U_MEMORY_ALLOCATION_ERROR, and
jpayne@69 274 * U_INVALID_STATE if the formattable object has not been set to
jpayne@69 275 * a numeric type.
jpayne@69 276 * @param fmt the UFormattable object
jpayne@69 277 * @param len if non-null, on exit contains the string length (not including the terminating null)
jpayne@69 278 * @param status the error code
jpayne@69 279 * @return the character buffer as a NULL terminated string, which is owned by the object and must not be accessed if any other functions are called on this object.
jpayne@69 280 * @stable ICU 52
jpayne@69 281 * @see icu::Formattable::getDecimalNumber(UErrorCode&)
jpayne@69 282 */
jpayne@69 283 U_STABLE const char * U_EXPORT2
jpayne@69 284 ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status);
jpayne@69 285
jpayne@69 286 #endif
jpayne@69 287
jpayne@69 288 #endif