unumberformatter.h

Go to the documentation of this file.

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
 
#ifndef __UNUMBERFORMATTER_H__
#define __UNUMBERFORMATTER_H__
 
#include "unicode/utypes.h"
 
#if !UCONFIG_NO_FORMATTING
 
#include "unicode/parseerr.h"
#include "unicode/ufieldpositer.h"
#include "unicode/umisc.h"
#include "unicode/uformattedvalue.h"
 
 
typedef enum UNumberRoundingPriority {
    UNUM_ROUNDING_PRIORITY_RELAXED,
 
    UNUM_ROUNDING_PRIORITY_STRICT,
} UNumberRoundingPriority;
 
typedef enum UNumberUnitWidth {
            UNUM_UNIT_WIDTH_NARROW = 0,
 
            UNUM_UNIT_WIDTH_SHORT = 1,
 
            UNUM_UNIT_WIDTH_FULL_NAME = 2,
 
            UNUM_UNIT_WIDTH_ISO_CODE = 3,
 
            UNUM_UNIT_WIDTH_FORMAL = 4,
 
            UNUM_UNIT_WIDTH_VARIANT = 5,
 
            UNUM_UNIT_WIDTH_HIDDEN = 6,
 
    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
    // needed for unconditionalized struct MacroProps
            UNUM_UNIT_WIDTH_COUNT = 7
} UNumberUnitWidth;
 
typedef enum UNumberGroupingStrategy {
            UNUM_GROUPING_OFF,
 
            UNUM_GROUPING_MIN2,
 
            UNUM_GROUPING_AUTO,
 
            UNUM_GROUPING_ON_ALIGNED,
 
            UNUM_GROUPING_THOUSANDS
 
#ifndef U_HIDE_INTERNAL_API
    ,
            UNUM_GROUPING_COUNT
#endif  /* U_HIDE_INTERNAL_API */
 
} UNumberGroupingStrategy;
 
typedef enum UNumberSignDisplay {
    UNUM_SIGN_AUTO,
 
    UNUM_SIGN_ALWAYS,
 
    UNUM_SIGN_NEVER,
 
    UNUM_SIGN_ACCOUNTING,
 
    UNUM_SIGN_ACCOUNTING_ALWAYS,
 
    UNUM_SIGN_EXCEPT_ZERO,
 
    UNUM_SIGN_ACCOUNTING_EXCEPT_ZERO,
 
    UNUM_SIGN_NEGATIVE,
 
    UNUM_SIGN_ACCOUNTING_NEGATIVE,
 
    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
    // needed for unconditionalized struct MacroProps
    UNUM_SIGN_COUNT = 9,
} UNumberSignDisplay;
 
typedef enum UNumberDecimalSeparatorDisplay {
            UNUM_DECIMAL_SEPARATOR_AUTO,
 
            UNUM_DECIMAL_SEPARATOR_ALWAYS,
 
    // Do not conditionalize the following with #ifndef U_HIDE_INTERNAL_API,
    // needed for unconditionalized struct MacroProps
            UNUM_DECIMAL_SEPARATOR_COUNT
} UNumberDecimalSeparatorDisplay;
 
typedef enum UNumberTrailingZeroDisplay {
    UNUM_TRAILING_ZERO_AUTO,
 
    UNUM_TRAILING_ZERO_HIDE_IF_WHOLE,
} UNumberTrailingZeroDisplay;
 
struct UNumberFormatter;
typedef struct UNumberFormatter UNumberFormatter;
 
struct UFormattedNumber;
typedef struct UFormattedNumber UFormattedNumber;
 
 
U_CAPI UNumberFormatter* U_EXPORT2
unumf_openForSkeletonAndLocale(const UChar* skeleton, int32_t skeletonLen, const char* locale,
                               UErrorCode* ec);
 
 
U_CAPI UNumberFormatter* U_EXPORT2
unumf_openForSkeletonAndLocaleWithError(
       const UChar* skeleton, int32_t skeletonLen, const char* locale, UParseError* perror, UErrorCode* ec);
 
 
U_CAPI UFormattedNumber* U_EXPORT2
unumf_openResult(UErrorCode* ec);
 
 
U_CAPI void U_EXPORT2
unumf_formatInt(const UNumberFormatter* uformatter, int64_t value, UFormattedNumber* uresult,
                UErrorCode* ec);
 
 
U_CAPI void U_EXPORT2
unumf_formatDouble(const UNumberFormatter* uformatter, double value, UFormattedNumber* uresult,
                   UErrorCode* ec);
 
 
U_CAPI void U_EXPORT2
unumf_formatDecimal(const UNumberFormatter* uformatter, const char* value, int32_t valueLen,
                    UFormattedNumber* uresult, UErrorCode* ec);
 
U_CAPI const UFormattedValue* U_EXPORT2
unumf_resultAsValue(const UFormattedNumber* uresult, UErrorCode* ec);
 
 
U_CAPI int32_t U_EXPORT2
unumf_resultToString(const UFormattedNumber* uresult, UChar* buffer, int32_t bufferCapacity,
                     UErrorCode* ec);
 
 
U_CAPI UBool U_EXPORT2
unumf_resultNextFieldPosition(const UFormattedNumber* uresult, UFieldPosition* ufpos, UErrorCode* ec);
 
 
U_CAPI void U_EXPORT2
unumf_resultGetAllFieldPositions(const UFormattedNumber* uresult, UFieldPositionIterator* ufpositer,
                                 UErrorCode* ec);
 
 
U_CAPI int32_t U_EXPORT2
unumf_resultToDecimalNumber(
       const UFormattedNumber* uresult,
       char* dest,
       int32_t destCapacity,
       UErrorCode* ec);
 
 
U_CAPI void U_EXPORT2
unumf_close(UNumberFormatter* uformatter);
 
 
U_CAPI void U_EXPORT2
unumf_closeResult(UFormattedNumber* uresult);
 
 
#if U_SHOW_CPLUSPLUS_API
U_NAMESPACE_BEGIN
 
U_DEFINE_LOCAL_OPEN_POINTER(LocalUNumberFormatterPointer, UNumberFormatter, unumf_close);
 
U_DEFINE_LOCAL_OPEN_POINTER(LocalUFormattedNumberPointer, UFormattedNumber, unumf_closeResult);
 
U_NAMESPACE_END
#endif // U_SHOW_CPLUSPLUS_API
 
#endif /* #if !UCONFIG_NO_FORMATTING */
#endif //__UNUMBERFORMATTER_H__