CFNumberFormatter.h

   1 /*
   2  * Copyright (c) 2009 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*      CFNumberFormatter.h
  25         Copyright (c) 2003-2009, Apple Inc. All rights reserved.
  26 */
  27
  28 #if !defined(__COREFOUNDATION_CFNUMBERFORMATTER__)
  29 #define __COREFOUNDATION_CFNUMBERFORMATTER__ 1
  30
  31 #include <CoreFoundation/CFBase.h>
  32 #include <CoreFoundation/CFNumber.h>
  33 #include <CoreFoundation/CFLocale.h>
  34
  35 #if MAC_OS_X_VERSION_10_3 <= MAC_OS_X_VERSION_MAX_ALLOWED
  36
  37 CF_EXTERN_C_BEGIN
  38
  39 typedef struct __CFNumberFormatter *CFNumberFormatterRef;
  40
  41 // CFNumberFormatters are not thread-safe.  Do not use one from multiple threads!
  42
  43 CF_EXPORT
  44 CFTypeID CFNumberFormatterGetTypeID(void) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  45
  46 enum {  // number format styles
  47         kCFNumberFormatterNoStyle = 0,
  48         kCFNumberFormatterDecimalStyle = 1,
  49         kCFNumberFormatterCurrencyStyle = 2,
  50         kCFNumberFormatterPercentStyle = 3,
  51         kCFNumberFormatterScientificStyle = 4,
  52         kCFNumberFormatterSpellOutStyle = 5
  53 };
  54 typedef CFIndex CFNumberFormatterStyle;
  55
  56
  57 CF_EXPORT
  58 CFNumberFormatterRef CFNumberFormatterCreate(CFAllocatorRef allocator, CFLocaleRef locale, CFNumberFormatterStyle style) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  59         // Returns a CFNumberFormatter, localized to the given locale, which
  60         // will format numbers to the given style.
  61
  62 CF_EXPORT
  63 CFLocaleRef CFNumberFormatterGetLocale(CFNumberFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  64
  65 CF_EXPORT
  66 CFNumberFormatterStyle CFNumberFormatterGetStyle(CFNumberFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  67         // Get the properties with which the number formatter was created.
  68
  69 CF_EXPORT
  70 CFStringRef CFNumberFormatterGetFormat(CFNumberFormatterRef formatter) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  71
  72 CF_EXPORT
  73 void CFNumberFormatterSetFormat(CFNumberFormatterRef formatter, CFStringRef formatString) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  74         // Set the format description string of the number formatter.  This
  75         // overrides the style settings.  The format of the format string
  76         // is as defined by the ICU library, and is similar to that found
  77         // in Microsoft Excel and NSNumberFormatter (and Java I believe).
  78         // The number formatter starts with a default format string defined
  79         // by the style argument with which it was created.
  80
  81
  82 CF_EXPORT
  83 CFStringRef CFNumberFormatterCreateStringWithNumber(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFNumberRef number) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  84
  85 CF_EXPORT
  86 CFStringRef CFNumberFormatterCreateStringWithValue(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFNumberType numberType, const void *valuePtr) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  87         // Create a string representation of the given number or value
  88         // using the current state of the number formatter.
  89
  90
  91 enum {
  92     kCFNumberFormatterParseIntegersOnly = 1     /* only parse integers */
  93 };
  94 typedef CFOptionFlags CFNumberFormatterOptionFlags;
  95
  96 CF_EXPORT
  97 CFNumberRef CFNumberFormatterCreateNumberFromString(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFStringRef string, CFRange *rangep, CFOptionFlags options) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
  98
  99 CF_EXPORT
 100 Boolean CFNumberFormatterGetValueFromString(CFNumberFormatterRef formatter, CFStringRef string, CFRange *rangep, CFNumberType numberType, void *valuePtr) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 101         // Parse a string representation of a number using the current state
 102         // of the number formatter.  The range parameter specifies the range
 103         // of the string in which the parsing should occur in input, and on
 104         // output indicates the extent that was used; this parameter can
 105         // be NULL, in which case the whole string may be used.  The
 106         // return value indicates whether some number was computed and
 107         // (if valuePtr is not NULL) stored at the location specified by
 108         // valuePtr.  The numberType indicates the type of value pointed
 109         // to by valuePtr.
 110
 111
 112 CF_EXPORT
 113 void CFNumberFormatterSetProperty(CFNumberFormatterRef formatter, CFStringRef key, CFTypeRef value) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 114
 115 CF_EXPORT
 116 CFTypeRef CFNumberFormatterCopyProperty(CFNumberFormatterRef formatter, CFStringRef key) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 117         // Set and get various properties of the number formatter, the set of
 118         // which may be expanded in the future.
 119
 120 CF_EXPORT const CFStringRef kCFNumberFormatterCurrencyCode AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;           // CFString
 121 CF_EXPORT const CFStringRef kCFNumberFormatterDecimalSeparator AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;       // CFString
 122 CF_EXPORT const CFStringRef kCFNumberFormatterCurrencyDecimalSeparator AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER; // CFString
 123 CF_EXPORT const CFStringRef kCFNumberFormatterAlwaysShowDecimalSeparator AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER; // CFBoolean
 124 CF_EXPORT const CFStringRef kCFNumberFormatterGroupingSeparator AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;      // CFString
 125 CF_EXPORT const CFStringRef kCFNumberFormatterUseGroupingSeparator AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;   // CFBoolean
 126 CF_EXPORT const CFStringRef kCFNumberFormatterPercentSymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;          // CFString
 127 CF_EXPORT const CFStringRef kCFNumberFormatterZeroSymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;             // CFString
 128 CF_EXPORT const CFStringRef kCFNumberFormatterNaNSymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;              // CFString
 129 CF_EXPORT const CFStringRef kCFNumberFormatterInfinitySymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;         // CFString
 130 CF_EXPORT const CFStringRef kCFNumberFormatterMinusSign AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;              // CFString
 131 CF_EXPORT const CFStringRef kCFNumberFormatterPlusSign AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;               // CFString
 132 CF_EXPORT const CFStringRef kCFNumberFormatterCurrencySymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;         // CFString
 133 CF_EXPORT const CFStringRef kCFNumberFormatterExponentSymbol AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;         // CFString
 134 CF_EXPORT const CFStringRef kCFNumberFormatterMinIntegerDigits AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;       // CFNumber
 135 CF_EXPORT const CFStringRef kCFNumberFormatterMaxIntegerDigits AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;       // CFNumber
 136 CF_EXPORT const CFStringRef kCFNumberFormatterMinFractionDigits AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;      // CFNumber
 137 CF_EXPORT const CFStringRef kCFNumberFormatterMaxFractionDigits AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;      // CFNumber
 138 CF_EXPORT const CFStringRef kCFNumberFormatterGroupingSize AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;           // CFNumber
 139 CF_EXPORT const CFStringRef kCFNumberFormatterSecondaryGroupingSize AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;  // CFNumber
 140 CF_EXPORT const CFStringRef kCFNumberFormatterRoundingMode AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;           // CFNumber
 141 CF_EXPORT const CFStringRef kCFNumberFormatterRoundingIncrement AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;      // CFNumber
 142 CF_EXPORT const CFStringRef kCFNumberFormatterFormatWidth AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;            // CFNumber
 143 CF_EXPORT const CFStringRef kCFNumberFormatterPaddingPosition AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;        // CFNumber
 144 CF_EXPORT const CFStringRef kCFNumberFormatterPaddingCharacter AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;       // CFString
 145 CF_EXPORT const CFStringRef kCFNumberFormatterDefaultFormat AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;          // CFString
 146 CF_EXPORT const CFStringRef kCFNumberFormatterMultiplier AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;             // CFNumber
 147 CF_EXPORT const CFStringRef kCFNumberFormatterPositivePrefix AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 148 CF_EXPORT const CFStringRef kCFNumberFormatterPositiveSuffix AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 149 CF_EXPORT const CFStringRef kCFNumberFormatterNegativePrefix AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 150 CF_EXPORT const CFStringRef kCFNumberFormatterNegativeSuffix AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;         // CFString
 151 CF_EXPORT const CFStringRef kCFNumberFormatterPerMillSymbol AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;          // CFString
 152 CF_EXPORT const CFStringRef kCFNumberFormatterInternationalCurrencySymbol AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER; // CFString
 153 CF_EXPORT const CFStringRef kCFNumberFormatterCurrencyGroupingSeparator AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER; // CFString
 154 CF_EXPORT const CFStringRef kCFNumberFormatterIsLenient AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;              // CFBoolean
 155 CF_EXPORT const CFStringRef kCFNumberFormatterUseSignificantDigits AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;   // CFBoolean
 156 CF_EXPORT const CFStringRef kCFNumberFormatterMinSignificantDigits AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;   // CFNumber
 157 CF_EXPORT const CFStringRef kCFNumberFormatterMaxSignificantDigits AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;   // CFNumber
 158
 159 enum {
 160     kCFNumberFormatterRoundCeiling = 0,
 161     kCFNumberFormatterRoundFloor = 1,
 162     kCFNumberFormatterRoundDown = 2,
 163     kCFNumberFormatterRoundUp = 3,
 164     kCFNumberFormatterRoundHalfEven = 4,
 165     kCFNumberFormatterRoundHalfDown = 5,
 166     kCFNumberFormatterRoundHalfUp = 6
 167 };
 168 typedef CFIndex CFNumberFormatterRoundingMode;
 169
 170 enum {
 171     kCFNumberFormatterPadBeforePrefix = 0,
 172     kCFNumberFormatterPadAfterPrefix = 1,
 173     kCFNumberFormatterPadBeforeSuffix = 2,
 174     kCFNumberFormatterPadAfterSuffix = 3
 175 };
 176 typedef CFIndex CFNumberFormatterPadPosition;
 177
 178
 179 CF_EXPORT
 180 Boolean CFNumberFormatterGetDecimalInfoForCurrencyCode(CFStringRef currencyCode, int32_t *defaultFractionDigits, double *roundingIncrement) AVAILABLE_MAC_OS_X_VERSION_10_3_AND_LATER;
 181         // Returns the number of fraction digits that should be displayed, and
 182         // the rounding increment (or 0.0 if no rounding is done by the currency)
 183         // for the given currency.  Returns false if the currency code is unknown
 184         // or the information is not available.
 185         // Not localized because these are properties of the currency.
 186
 187 CF_EXTERN_C_END
 188
 189 #endif
 190
 191 #endif /* ! __COREFOUNDATION_CFNUMBERFORMATTER__ */
 192