jpayne@69: // © 2016 and later: Unicode, Inc. and others.
jpayne@69: // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69: /*
jpayne@69: ********************************************************************************
jpayne@69: * Copyright (C) 2013-2014, International Business Machines Corporation and others.
jpayne@69: * All Rights Reserved.
jpayne@69: ********************************************************************************
jpayne@69: *
jpayne@69: * File UFORMATTABLE.H
jpayne@69: *
jpayne@69: * Modification History:
jpayne@69: *
jpayne@69: *   Date        Name        Description
jpayne@69: *   2013 Jun 7  srl         New
jpayne@69: ********************************************************************************
jpayne@69: */
jpayne@69: 
jpayne@69: /**
jpayne@69:  * \file
jpayne@69:  * \brief C API: UFormattable is a thin wrapper for primitive types used for formatting and parsing.
jpayne@69:  *
jpayne@69:  * This is a C interface to the icu::Formattable class. Static functions on this class convert
jpayne@69:  * to and from this interface (via reinterpret_cast).  Note that Formattables (and thus UFormattables)
jpayne@69:  * are mutable, and many operations (even getters) may actually modify the internal state. For this
jpayne@69:  * reason, UFormattables are not thread safe, and should not be shared between threads.
jpayne@69:  *
jpayne@69:  * See {@link unum_parseToUFormattable} for example code.
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef UFORMATTABLE_H
jpayne@69: #define UFORMATTABLE_H
jpayne@69: 
jpayne@69: #include "unicode/utypes.h"
jpayne@69: 
jpayne@69: #if !UCONFIG_NO_FORMATTING
jpayne@69: 
jpayne@69: #include "unicode/localpointer.h"
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Enum designating the type of a UFormattable instance.
jpayne@69:  * Practically, this indicates which of the getters would return without conversion
jpayne@69:  * or error.
jpayne@69:  * @see icu::Formattable::Type
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: typedef enum UFormattableType {
jpayne@69:   UFMT_DATE = 0, /**< ufmt_getDate() will return without conversion. @see ufmt_getDate*/
jpayne@69:   UFMT_DOUBLE,   /**< ufmt_getDouble() will return without conversion.  @see ufmt_getDouble*/
jpayne@69:   UFMT_LONG,     /**< ufmt_getLong() will return without conversion. @see ufmt_getLong */
jpayne@69:   UFMT_STRING,   /**< ufmt_getUChars() will return without conversion.  @see ufmt_getUChars*/
jpayne@69:   UFMT_ARRAY,    /**< ufmt_countArray() and ufmt_getArray() will return the value.  @see ufmt_getArrayItemByIndex */
jpayne@69:   UFMT_INT64,    /**< ufmt_getInt64() will return without conversion. @see ufmt_getInt64 */
jpayne@69:   UFMT_OBJECT,   /**< ufmt_getObject() will return without conversion.  @see ufmt_getObject*/
jpayne@69: #ifndef U_HIDE_DEPRECATED_API
jpayne@69:     /**
jpayne@69:      * One more than the highest normal UFormattableType value.
jpayne@69:      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
jpayne@69:      */
jpayne@69:     UFMT_COUNT
jpayne@69: #endif  /* U_HIDE_DEPRECATED_API */
jpayne@69: } UFormattableType;
jpayne@69: 
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Opaque type representing various types of data which may be used for formatting
jpayne@69:  * and parsing operations.
jpayne@69:  * @see icu::Formattable
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: typedef void *UFormattable;
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Initialize a UFormattable, to type UNUM_LONG, value 0
jpayne@69:  * may return error if memory allocation failed.
jpayne@69:  * parameter status error code.
jpayne@69:  * See {@link unum_parseToUFormattable} for example code.
jpayne@69:  * @stable ICU 52
jpayne@69:  * @return the new UFormattable
jpayne@69:  * @see ufmt_close
jpayne@69:  * @see icu::Formattable::Formattable()
jpayne@69:  */
jpayne@69: U_STABLE UFormattable* U_EXPORT2
jpayne@69: ufmt_open(UErrorCode* status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Cleanup any additional memory allocated by this UFormattable.
jpayne@69:  * @param fmt the formatter
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see ufmt_open
jpayne@69:  */
jpayne@69: U_STABLE void U_EXPORT2
jpayne@69: ufmt_close(UFormattable* fmt);
jpayne@69: 
jpayne@69: #if U_SHOW_CPLUSPLUS_API
jpayne@69: 
jpayne@69: U_NAMESPACE_BEGIN
jpayne@69: 
jpayne@69: /**
jpayne@69:  * \class LocalUFormattablePointer
jpayne@69:  * "Smart pointer" class, closes a UFormattable via ufmt_close().
jpayne@69:  * For most methods see the LocalPointerBase base class.
jpayne@69:  *
jpayne@69:  * @see LocalPointerBase
jpayne@69:  * @see LocalPointer
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattablePointer, UFormattable, ufmt_close);
jpayne@69: 
jpayne@69: U_NAMESPACE_END
jpayne@69: 
jpayne@69: #endif
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Return the type of this object
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status status code - U_ILLEGAL_ARGUMENT_ERROR is returned if the UFormattable contains data not supported by
jpayne@69:  * the API
jpayne@69:  * @return the value as a UFormattableType
jpayne@69:  * @see ufmt_isNumeric
jpayne@69:  * @see icu::Formattable::getType() const
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UFormattableType U_EXPORT2
jpayne@69: ufmt_getType(const UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Return whether the object is numeric.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @return true if the object is a double, long, or int64 value, else false.
jpayne@69:  * @see ufmt_getType
jpayne@69:  * @see icu::Formattable::isNumeric() const
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: ufmt_isNumeric(const UFormattable* fmt);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the UDate value of this object.  If the type is not of type UFMT_DATE,
jpayne@69:  * status is set to U_INVALID_FORMAT_ERROR and the return value is
jpayne@69:  * undefined.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @return the value
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getDate(UErrorCode&) const
jpayne@69:  */
jpayne@69: U_STABLE UDate U_EXPORT2
jpayne@69: ufmt_getDate(const UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the double value of this object. If the type is not a UFMT_DOUBLE, or
jpayne@69:  * if there are additional significant digits than fit in a double type,
jpayne@69:  * a conversion is performed with  possible loss of precision.
jpayne@69:  * If the type is UFMT_OBJECT and the
jpayne@69:  * object is a Measure, then the result of
jpayne@69:  * getNumber().getDouble(status) is returned.  If this object is
jpayne@69:  * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69:  * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @return the value
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getDouble(UErrorCode&) const
jpayne@69:  */
jpayne@69: U_STABLE double U_EXPORT2
jpayne@69: ufmt_getDouble(UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the long (int32_t) value of this object. If the magnitude is too
jpayne@69:  * large to fit in a long, then the maximum or minimum long value,
jpayne@69:  * as appropriate, is returned and the status is set to
jpayne@69:  * U_INVALID_FORMAT_ERROR.  If this object is of type UFMT_INT64 and
jpayne@69:  * it fits within a long, then no precision is lost.  If it is of
jpayne@69:  * type kDouble or kDecimalNumber, then a conversion is peformed, with
jpayne@69:  * truncation of any fractional part.  If the type is UFMT_OBJECT and
jpayne@69:  * the object is a Measure, then the result of
jpayne@69:  * getNumber().getLong(status) is returned.  If this object is
jpayne@69:  * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69:  * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @return the value
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getLong(UErrorCode&) const
jpayne@69:  */
jpayne@69: U_STABLE int32_t U_EXPORT2
jpayne@69: ufmt_getLong(UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the int64_t value of this object. If this object is of a numeric
jpayne@69:  * type and the magnitude is too large to fit in an int64, then
jpayne@69:  * the maximum or minimum int64 value, as appropriate, is returned
jpayne@69:  * and the status is set to U_INVALID_FORMAT_ERROR.  If the
jpayne@69:  * magnitude fits in an int64, then a casting conversion is
jpayne@69:  * peformed, with truncation of any fractional part.  If the type
jpayne@69:  * is UFMT_OBJECT and the object is a Measure, then the result of
jpayne@69:  * getNumber().getDouble(status) is returned.  If this object is
jpayne@69:  * neither a numeric type nor a Measure, then 0 is returned and
jpayne@69:  * the status is set to U_INVALID_FORMAT_ERROR.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @return the value
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getInt64(UErrorCode&) const
jpayne@69:  */
jpayne@69: U_STABLE int64_t U_EXPORT2
jpayne@69: ufmt_getInt64(UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns a pointer to the UObject contained within this
jpayne@69:  * formattable (as a const void*), or NULL if this object
jpayne@69:  * is not of type UFMT_OBJECT.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @return the value as a const void*. It is a polymorphic C++ object.
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getObject() const
jpayne@69:  */
jpayne@69: U_STABLE const void *U_EXPORT2
jpayne@69: ufmt_getObject(const UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Gets the string value of this object as a UChar string. If the type is not a
jpayne@69:  * string, status is set to U_INVALID_FORMAT_ERROR and a NULL pointer is returned.
jpayne@69:  * This function is not thread safe and may modify the UFormattable if need be to terminate the string.
jpayne@69:  * The returned pointer is not valid if any other functions are called on this UFormattable, or if the UFormattable is closed.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors
jpayne@69:  * @param len if non null, contains the string length on return
jpayne@69:  * @return the null terminated string value - must not be referenced after any other functions are called on this UFormattable.
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getString(UnicodeString&)const
jpayne@69:  */
jpayne@69: U_STABLE const UChar* U_EXPORT2
jpayne@69: ufmt_getUChars(UFormattable* fmt, int32_t *len, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Get the number of array objects contained, if an array type UFMT_ARRAY
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param status the error code - any conversion or format errors. U_ILLEGAL_ARGUMENT_ERROR if not an array type.
jpayne@69:  * @return the number of array objects or undefined if not an array type
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see ufmt_getArrayItemByIndex
jpayne@69:  */
jpayne@69: U_STABLE int32_t U_EXPORT2
jpayne@69: ufmt_getArrayLength(const UFormattable* fmt, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Get the specified value from the array of UFormattables. Invalid if the object is not an array type UFMT_ARRAY
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param n the number of the array to return (0 based).
jpayne@69:  * @param status the error code - any conversion or format errors. Returns an error if n is out of bounds.
jpayne@69:  * @return the nth array value, only valid while the containing UFormattable is valid. NULL if not an array.
jpayne@69:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getArray(int32_t&, UErrorCode&) const
jpayne@69:  */
jpayne@69: U_STABLE UFormattable * U_EXPORT2
jpayne@69: ufmt_getArrayItemByIndex(UFormattable* fmt, int32_t n, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns a numeric string representation of the number contained within this
jpayne@69:  * formattable, or NULL if this object does not contain numeric type.
jpayne@69:  * For values obtained by parsing, the returned decimal number retains
jpayne@69:  * the full precision and range of the original input, unconstrained by
jpayne@69:  * the limits of a double floating point or a 64 bit int.
jpayne@69:  *
jpayne@69:  * This function is not thread safe, and therfore is not declared const,
jpayne@69:  * even though it is logically const.
jpayne@69:  * The resulting buffer is owned by the UFormattable and is invalid if any other functions are
jpayne@69:  * called on the UFormattable.
jpayne@69:  *
jpayne@69:  * Possible errors include U_MEMORY_ALLOCATION_ERROR, and
jpayne@69:  * U_INVALID_STATE if the formattable object has not been set to
jpayne@69:  * a numeric type.
jpayne@69:  * @param fmt the UFormattable object
jpayne@69:  * @param len if non-null, on exit contains the string length (not including the terminating null)
jpayne@69:  * @param status the error code
jpayne@69:  * @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:  * @stable ICU 52
jpayne@69:  * @see icu::Formattable::getDecimalNumber(UErrorCode&)
jpayne@69:  */
jpayne@69: U_STABLE const char * U_EXPORT2
jpayne@69: ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status);
jpayne@69: 
jpayne@69: #endif
jpayne@69: 
jpayne@69: #endif