331 lines
13 KiB
C++
331 lines
13 KiB
C++
/*
|
|
********************************************************************************
|
|
* Copyright (C) 2012, International Business Machines
|
|
* Corporation and others. All Rights Reserved.
|
|
********************************************************************************
|
|
*
|
|
* File COMPACTDECIMALFORMAT.H
|
|
********************************************************************************
|
|
*/
|
|
|
|
#ifndef __COMPACT_DECIMAL_FORMAT_H__
|
|
#define __COMPACT_DECIMAL_FORMAT_H__
|
|
|
|
#include "unicode/utypes.h"
|
|
/**
|
|
* \file
|
|
* \brief C++ API: Formats decimal numbers in compact form.
|
|
*/
|
|
|
|
#if !UCONFIG_NO_FORMATTING
|
|
|
|
#include "unicode/decimfmt.h"
|
|
|
|
struct UHashtable;
|
|
|
|
U_NAMESPACE_BEGIN
|
|
|
|
class PluralRules;
|
|
|
|
/**
|
|
* The CompactDecimalFormat produces abbreviated numbers, suitable for display in
|
|
* environments will limited real estate. For example, 'Hits: 1.2B' instead of
|
|
* 'Hits: 1,200,000,000'. The format will be appropriate for the given language,
|
|
* such as "1,2 Mrd." for German.
|
|
* <p>
|
|
* For numbers under 1000 trillion (under 10^15, such as 123,456,789,012,345),
|
|
* the result will be short for supported languages. However, the result may
|
|
* sometimes exceed 7 characters, such as when there are combining marks or thin
|
|
* characters. In such cases, the visual width in fonts should still be short.
|
|
* <p>
|
|
* By default, there are 3 significant digits. After creation, if more than
|
|
* three significant digits are set (with setMaximumSignificantDigits), or if a
|
|
* fixed number of digits are set (with setMaximumIntegerDigits or
|
|
* setMaximumFractionDigits), then result may be wider.
|
|
* <p>
|
|
* At this time, parsing is not supported, and will produce a U_UNSUPPORTED_ERROR.
|
|
* Resetting the pattern prefixes or suffixes is not supported; the method calls
|
|
* are ignored.
|
|
* <p>
|
|
*/
|
|
class U_I18N_API CompactDecimalFormat : public DecimalFormat {
|
|
public:
|
|
|
|
/**
|
|
* Returns a compact decimal instance for specified locale.
|
|
* @param inLocale the given locale.
|
|
* @param style whether to use short or long style.
|
|
* @param status error code returned here.
|
|
* @draft ICU 51
|
|
*/
|
|
static CompactDecimalFormat* U_EXPORT2 createInstance(
|
|
const Locale& inLocale, UNumberCompactStyle style, UErrorCode& status);
|
|
|
|
/**
|
|
* Copy constructor.
|
|
*
|
|
* @param source the DecimalFormat object to be copied from.
|
|
* @draft ICU 51
|
|
*/
|
|
CompactDecimalFormat(const CompactDecimalFormat& source);
|
|
|
|
/**
|
|
* Destructor.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual ~CompactDecimalFormat();
|
|
|
|
/**
|
|
* Assignment operator.
|
|
*
|
|
* @param rhs the DecimalFormat object to be copied.
|
|
* @draft ICU 51
|
|
*/
|
|
CompactDecimalFormat& operator=(const CompactDecimalFormat& rhs);
|
|
|
|
/**
|
|
* Clone this Format object polymorphically. The caller owns the
|
|
* result and should delete it when done.
|
|
*
|
|
* @return a polymorphic copy of this CompactDecimalFormat.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual Format* clone() const;
|
|
|
|
/**
|
|
* Return TRUE if the given Format objects are semantically equal.
|
|
* Objects of different subclasses are considered unequal.
|
|
*
|
|
* @param other the object to be compared with.
|
|
* @return TRUE if the given Format objects are semantically equal.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual UBool operator==(const Format& other) const;
|
|
|
|
|
|
using DecimalFormat::format;
|
|
|
|
/**
|
|
* Format a double or long number using base-10 representation.
|
|
*
|
|
* @param number The value to be formatted.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param pos On input: an alignment field, if desired.
|
|
* On output: the offsets of the alignment field.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual UnicodeString& format(double number,
|
|
UnicodeString& appendTo,
|
|
FieldPosition& pos) const;
|
|
|
|
/**
|
|
* Format a double or long number using base-10 representation.
|
|
* Currently sets status to U_UNSUPPORTED_ERROR.
|
|
*
|
|
* @param number The value to be formatted.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param posIter On return, can be used to iterate over positions
|
|
* of fields generated by this format call.
|
|
* Can be NULL.
|
|
* @param status Output param filled with success/failure status.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @internal
|
|
*/
|
|
virtual UnicodeString& format(double number,
|
|
UnicodeString& appendTo,
|
|
FieldPositionIterator* posIter,
|
|
UErrorCode& status) const;
|
|
|
|
/**
|
|
* Format an int64 number using base-10 representation.
|
|
*
|
|
* @param number The value to be formatted.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param pos On input: an alignment field, if desired.
|
|
* On output: the offsets of the alignment field.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual UnicodeString& format(int64_t number,
|
|
UnicodeString& appendTo,
|
|
FieldPosition& pos) const;
|
|
|
|
/**
|
|
* Format an int64 number using base-10 representation.
|
|
* Currently sets status to U_UNSUPPORTED_ERROR
|
|
*
|
|
* @param number The value to be formatted.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param posIter On return, can be used to iterate over positions
|
|
* of fields generated by this format call.
|
|
* Can be NULL.
|
|
* @param status Output param filled with success/failure status.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @internal
|
|
*/
|
|
virtual UnicodeString& format(int64_t number,
|
|
UnicodeString& appendTo,
|
|
FieldPositionIterator* posIter,
|
|
UErrorCode& status) const;
|
|
|
|
/**
|
|
* Format a decimal number. Currently sets status to U_UNSUPPORTED_ERROR
|
|
* The syntax of the unformatted number is a "numeric string"
|
|
* as defined in the Decimal Arithmetic Specification, available at
|
|
* http://speleotrove.com/decimal
|
|
*
|
|
* @param number The unformatted number, as a string.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param posIter On return, can be used to iterate over positions
|
|
* of fields generated by this format call.
|
|
* Can be NULL.
|
|
* @param status Output param filled with success/failure status.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @internal
|
|
*/
|
|
virtual UnicodeString& format(const StringPiece &number,
|
|
UnicodeString& appendTo,
|
|
FieldPositionIterator* posIter,
|
|
UErrorCode& status) const;
|
|
|
|
/**
|
|
* Format a decimal number. Currently sets status to U_UNSUPPORTED_ERROR
|
|
* The number is a DigitList wrapper onto a floating point decimal number.
|
|
* The default implementation in NumberFormat converts the decimal number
|
|
* to a double and formats that.
|
|
*
|
|
* @param number The number, a DigitList format Decimal Floating Point.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param posIter On return, can be used to iterate over positions
|
|
* of fields generated by this format call.
|
|
* @param status Output param filled with success/failure status.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @internal
|
|
*/
|
|
virtual UnicodeString& format(const DigitList &number,
|
|
UnicodeString& appendTo,
|
|
FieldPositionIterator* posIter,
|
|
UErrorCode& status) const;
|
|
|
|
/**
|
|
* Format a decimal number. Currently sets status to U_UNSUPPORTED_ERROR.
|
|
* The number is a DigitList wrapper onto a floating point decimal number.
|
|
* The default implementation in NumberFormat converts the decimal number
|
|
* to a double and formats that.
|
|
*
|
|
* @param number The number, a DigitList format Decimal Floating Point.
|
|
* @param appendTo Output parameter to receive result.
|
|
* Result is appended to existing contents.
|
|
* @param pos On input: an alignment field, if desired.
|
|
* On output: the offsets of the alignment field.
|
|
* @param status Output param filled with success/failure status.
|
|
* @return Reference to 'appendTo' parameter.
|
|
* @internal
|
|
*/
|
|
virtual UnicodeString& format(const DigitList &number,
|
|
UnicodeString& appendTo,
|
|
FieldPosition& pos,
|
|
UErrorCode& status) const;
|
|
|
|
/**
|
|
* CompactDecimalFormat does not support parsing. This implementation
|
|
* does nothing.
|
|
* @param text Unused.
|
|
* @param result Does not change.
|
|
* @param parsePosition Does not change.
|
|
* @see Formattable
|
|
* @draft ICU 51
|
|
*/
|
|
virtual void parse(const UnicodeString& text,
|
|
Formattable& result,
|
|
ParsePosition& parsePosition) const;
|
|
|
|
/**
|
|
* CompactDecimalFormat does not support parsing. This implementation
|
|
* sets status to U_UNSUPPORTED_ERROR
|
|
*
|
|
* @param text Unused.
|
|
* @param result Does not change.
|
|
* @param status Always set to U_UNSUPPORTED_ERROR.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual void parse(const UnicodeString& text,
|
|
Formattable& result,
|
|
UErrorCode& status) const;
|
|
|
|
/* Cannot use #ifndef U_HIDE_DRAFT_API for the following draft method since it is virtual */
|
|
/**
|
|
* Parses text from the given string as a currency amount. Unlike
|
|
* the parse() method, this method will attempt to parse a generic
|
|
* currency name, searching for a match of this object's locale's
|
|
* currency display names, or for a 3-letter ISO currency code.
|
|
* This method will fail if this format is not a currency format,
|
|
* that is, if it does not contain the currency pattern symbol
|
|
* (U+00A4) in its prefix or suffix. This implementation always returns
|
|
* NULL.
|
|
*
|
|
* @param text the string to parse
|
|
* @param pos input-output position; on input, the position within text
|
|
* to match; must have 0 <= pos.getIndex() < text.length();
|
|
* on output, the position after the last matched character.
|
|
* If the parse fails, the position in unchanged upon output.
|
|
* @return if parse succeeds, a pointer to a newly-created CurrencyAmount
|
|
* object (owned by the caller) containing information about
|
|
* the parsed currency; if parse fails, this is NULL.
|
|
* @internal
|
|
*/
|
|
virtual CurrencyAmount* parseCurrency(const UnicodeString& text,
|
|
ParsePosition& pos) const;
|
|
|
|
/**
|
|
* Return the class ID for this class. This is useful only for
|
|
* comparing to a return value from getDynamicClassID(). For example:
|
|
* <pre>
|
|
* . Base* polymorphic_pointer = createPolymorphicObject();
|
|
* . if (polymorphic_pointer->getDynamicClassID() ==
|
|
* . Derived::getStaticClassID()) ...
|
|
* </pre>
|
|
* @return The class ID for all objects of this class.
|
|
* @draft ICU 51
|
|
*/
|
|
static UClassID U_EXPORT2 getStaticClassID();
|
|
|
|
/**
|
|
* Returns a unique class ID POLYMORPHICALLY. Pure virtual override.
|
|
* This method is to implement a simple version of RTTI, since not all
|
|
* C++ compilers support genuine RTTI. Polymorphic operator==() and
|
|
* clone() methods call this method.
|
|
*
|
|
* @return The class ID for this object. All objects of a
|
|
* given class have the same class ID. Objects of
|
|
* other classes have different class IDs.
|
|
* @draft ICU 51
|
|
*/
|
|
virtual UClassID getDynamicClassID() const;
|
|
|
|
private:
|
|
|
|
const UHashtable* _unitsByVariant;
|
|
const double* _divisors;
|
|
PluralRules* _pluralRules;
|
|
|
|
// Default constructor not implemented.
|
|
CompactDecimalFormat(const DecimalFormat &, const UHashtable* unitsByVariant, const double* divisors, PluralRules* pluralRules);
|
|
|
|
UBool eqHelper(const CompactDecimalFormat& that) const;
|
|
};
|
|
|
|
U_NAMESPACE_END
|
|
|
|
#endif /* #if !UCONFIG_NO_FORMATTING */
|
|
|
|
#endif // __COMPACT_DECIMAL_FORMAT_H__
|
|
//eof
|