ChoiceFormat converts between ranges of numeric values
* and string names for those ranges. A ChoiceFormat splits
* the real number line -Inf to +Inf into two
* or more contiguous ranges. Each range is mapped to a
* string. ChoiceFormat is generally used in a
* MessageFormat for displaying grammatically correct
* plurals such as "There are 2 files."
There are two methods of defining a ChoiceFormat; both
* are equivalent. The first is by using a string pattern. This is the
* preferred method in most cases. The second method is through direct
* specification of the arrays that make up the
* ChoiceFormat.
Patterns
* *In most cases, the preferred way to define a
* ChoiceFormat is with a pattern. Here is an example of a
* ChoiceFormat pattern:
0#are no files|1#is one file|1<are many files* *
The pattern consists of a number or range specifiers
* separated by vertical bars U+007C (|). There is no
* vertical bar after the last range. Each range specifier is of the
* form number separator string.
Number is a floating point number that can be parsed by a
* default NumberFormat for the US locale. It gives the
* lower limit of this range. The lower limit is either inclusive or
* exclusive, depending on the separator. (The upper limit is
* given by the lower limit of the next range.) The Unicode infinity
* sign U+221E is recognized for positive infinity. It may be preceded by
* '-' (U+002D) to indicate negative infinity.
String is the format string for this range, with special
* characters enclosed in single quotes ('The #
* sign'). Single quotes themselves are indicated by two single
* quotes in a row ('o''clock').
Separator is one of the following single characters: * *
#) indicates that the lower limit given by
* number is inclusive. That is, the limit value belongs to
* this range. Another way of saying this is that the corresponding
* closure is FALSE. The Unicode less than or equals
* sign U+2264 may be used in place of #.<) indicates that the lower limit given
* by number is exclusive. This means that the limit
* belongs to the prior range.TRUE.
* See below for more information about closures.
* *Arrays
* *A ChoiceFormat defining n intervals
* (n >= 2) is specified by three arrays of
* n items:
*
*
double limits[] gives the start of each
* interval. This must be a non-decreasing list of values, none of
* which may be NaN.UBool closures[] determines whether each limit
* value is contained in the interval below it or in the interval
* above it. If closures[i] is FALSE, then
* limits[i] is a member of interval
* i. Otherwise it is a member of interval
* i+1. If no closures array is specified, this is
* equivalent to having all closures be FALSE. Closures
* allow one to specify half-open, open, or closed intervals.UnicodeString formats[] gives the string label
* associated with each interval.Formatting and Parsing
* *During formatting, a number is converted to a
* string. ChoiceFormat accomplishes this by mapping the
* number to an interval using the following rule. Given a number
* X and and index value j in the range
* 0..n-1, where n is the number of ranges:
* *Xmatchesjif and only if *limit[j] <= X < limit[j+1]*
(This assumes that all closures are FALSE. If some
* closures are TRUE then the relations must be changed to
* <= or < as appropriate.) If there is
* no match, then either the first or last index is used, depending on
* whether the number is too low or too high. Once a number is mapped to
* an interval j, the string formats[j] is
* output.
During parsing, a string is converted to a
* number. ChoiceFormat finds the element
* formats[j] equal to the string, and returns
* limits[j] as the parsed value.
Notes
* *The first limit value does not define a range boundary. For
* example, in the pattern "1.0#a|2.0#b", the
* intervals are [-Inf, 2.0) and [2.0, +Inf]. It appears that the first
* interval should be [1.0, 2.0). However, since all values that are too
* small are mapped to range zero, the first interval is effectively
* [-Inf, 2.0). However, the first limit value is used during
* formatting. In this example, parse("a") returns
* 1.0.
There are no gaps between intervals and the entire number line is
* covered. A ChoiceFormat maps all possible
* double values to a finite set of intervals.
The non-number NaN is mapped to interval zero during
* formatting.
Examples
* *Here is an example of two arrays that map the number
* 1..7 to the English day of the week abbreviations
* Sun..Sat. No closures array is given; this is the same as
* specifying all closures to be FALSE.
{1,2,3,4,5,6,7},
* {"Sun","Mon","Tue","Wed","Thur","Fri","Sat"}
*
* Here is an example that maps the ranges [-Inf, 1), [1, 1], and (1, * +Inf] to three strings. That is, the number line is split into three * ranges: x < 1.0, x = 1.0, and x > 1.0.
* * {0, 1, 1},
* {FALSE, FALSE, TRUE},
* {"no files", "one file", "many files"}
*
* Here is a simple example that shows formatting and parsing:
* *
* \code
* #include <unicode/choicfmt.h>
* #include <unicode/unistr.h>
* #include <iostream.h>
*
* int main(int argc, char *argv[]) {
* double limits[] = {1,2,3,4,5,6,7};
* UnicodeString monthNames[] = {
* "Sun","Mon","Tue","Wed","Thu","Fri","Sat"};
* ChoiceFormat fmt(limits, monthNames, 7);
* UnicodeString str;
* char buf[256];
* for (double x = 1.0; x <= 8.0; x += 1.0) {
* fmt.format(x, str);
* str.extract(0, str.length(), buf, 256, "");
* str.truncate(0);
* cout << x << " -> "
* << buf << endl;
* }
* cout << endl;
* return 0;
* }
* \endcode
*
*
* Here is a more complex example using a ChoiceFormat
* constructed from a pattern together with a
* MessageFormat.
* \code
* #include <unicode/choicfmt.h>
* #include <unicode/msgfmt.h>
* #include <unicode/unistr.h>
* #include <iostream.h>
*
* int main(int argc, char *argv[]) {
* UErrorCode status = U_ZERO_ERROR;
* double filelimits[] = {0,1,2};
* UnicodeString filepart[] =
* {"are no files","is one file","are {0} files"};
* ChoiceFormat* fileform = new ChoiceFormat(filelimits, filepart, 3 );
* Format* testFormats[] =
* {fileform, NULL, NumberFormat::createInstance(status)};
* MessageFormat pattform("There {0} on {1}", status );
* pattform.adoptFormats(testFormats, 3);
* Formattable testArgs[] = {0L, "Disk A"};
* FieldPosition fp(0);
* UnicodeString str;
* char buf[256];
* for (int32_t i = 0; i < 4; ++i) {
* Formattable fInt(i);
* testArgs[0] = fInt;
* pattform.format(testArgs, 2, str, fp, status );
* str.extract(0, str.length(), buf, "");
* str.truncate(0);
* cout << "Output for i=" << i << " : " << buf << endl;
* }
* cout << endl;
* return 0;
* }
* \endcode
*
*/
class U_I18N_API ChoiceFormat: public NumberFormat {
public:
/**
* Construct a new ChoiceFormat with the limits and the corresponding formats
* based on the pattern.
*
* @param pattern Pattern used to construct object.
* @param status Output param to receive success code. If the
* pattern cannot be parsed, set to failure code.
* @stable
*/
ChoiceFormat(const UnicodeString& newPattern,
UErrorCode& status);
/**
* Construct a new ChoiceFormat with the given limits and formats. Copy
* the limits and formats instead of adopting them.
*
* @param limits Array of limit values.
* @param formats Array of formats.
* @param count Size of 'limits' and 'formats' arrays.
* @stable
*/
ChoiceFormat(const double* limits,
const UnicodeString* formats,
int32_t count );
/**
* Construct a new ChoiceFormat with the given limits and formats.
* Copy the limits and formats (instead of adopting them). By
* default, each limit in the array specifies the inclusive lower
* bound of its range, and the exclusive upper bound of the previous
* range. However, if the isLimitOpen element corresponding to a
* limit is TRUE, then the limit is the exclusive lower bound of its
* range, and the inclusive upper bound of the previous range.
* @param limits Array of limit values
* @param closures Array of booleans specifying whether each
* element of 'limits' is open or closed. If FALSE, then the
* corresponding limit is a member of the range above it. If TRUE,
* then the limit belongs to the range below it.
* @param formats Array of formats
* @param count Size of 'limits', 'closures', and 'formats' arrays
*/
ChoiceFormat(const double* limits,
const UBool* closures,
const UnicodeString* formats,
int32_t count);
/**
* Copy constructor.
*
* @param ChoiceFormat object to be copied from
* @stable
*/
ChoiceFormat(const ChoiceFormat&);
/**
* Assignment operator.
*
* @param ChoiceFormat object to be copied
* @stable
*/
const ChoiceFormat& operator=(const ChoiceFormat&);
/**
* Destructor.
* @stable
*/
virtual ~ChoiceFormat();
/**
* Clone this Format object polymorphically. The caller owns the
* result and should delete it when done.
*
* @return a copy of this object
* @stable
*/
virtual Format* clone(void) const;
/**
* Return true if the given Format objects are semantically equal.
* Objects of different subclasses are considered unequal.
*
* @param other ChoiceFormat object to be compared
* @return true if other is the same as this.
* @stable
*/
virtual UBool operator==(const Format& other) const;
/**
* Sets the pattern.
* @param pattern The pattern to be applied.
* @param status Output param set to success/failure code on
* exit. If the pattern is invalid, this will be
* set to a failure result.
* @stable
*/
virtual void applyPattern(const UnicodeString& pattern,
UErrorCode& status);
/**
* Sets the pattern.
* @param pattern The pattern to be applied.
* @param parseError Struct to recieve information on position
* of error if an error is encountered
* @param status Output param set to success/failure code on
* exit. If the pattern is invalid, this will be
* set to a failure result.
* @draft
*/
virtual void applyPattern(const UnicodeString& pattern,
UParseError& parseError,
UErrorCode& status);
/**
* Gets the pattern.
*
* @param pattern Output param which will recieve the pattern
* @return A reference to 'pattern'
* @stable
*/
virtual UnicodeString& toPattern(UnicodeString &pattern) const;
/**
* Set the choices to be used in formatting. The arrays are adopted and
* should not be deleted by the caller.
*
* @param limitsToAdopt Contains the top value that you want
* parsed with that format,and should be in
* ascending sorted order. When formatting X,
* the choice will be the i, where limit[i]
* <= X < limit[i+1].
* @param formatsToAdopt The format strings you want to use for each limit.
* @param count The size of the above arrays.
* @deprecated Remove after 2003-mar-25. Use setChoices instead.
*/
virtual void adoptChoices(double* limitsToAdopt,
UnicodeString* formatsToAdopt,
int32_t count );
/**
* Set the choices to be used in formatting. The arrays are adopted
* and should not be deleted by the caller. See class description
* for documenatation of the limits, closures, and formats arrays.
* @param limitsToAdopt Array of limits to adopt
* @param closuresToAdopt Array of limit booleans to adopt
* @param formatsToAdopt Array of format string to adopt
* @param count The size of the above arrays
* @deprecated Remove after 2003-mar-25. Use setChoices instead.
*/
virtual void adoptChoices(double* limitsToAdopt,
UBool* closuresToAdopt,
UnicodeString* formatsToAdopt,
int32_t count);
/**
* Set the choices to be used in formatting.
*
* @param limitsToCopy Contains the top value that you want
* parsed with that format,and should be in
* ascending sorted order. When formatting X,
* the choice will be the i, where limit[i]
* <= X < limit[i+1].
* @param formatsToCopy The format strings you want to use for each limit.
* @param count The size of the above arrays.
* @stable
*/
virtual void setChoices(const double* limitsToCopy,
const UnicodeString* formatsToCopy,
int32_t count );
/**
* Set the choices to be used in formatting. See class description
* for documenatation of the limits, closures, and formats arrays.
* @param limits Array of limits
* @param closures Array of limit booleans
* @param formats Array of format string
* @param count The size of the above arrays
*/
virtual void setChoices(const double* limits,
const UBool* closures,
const UnicodeString* formats,
int32_t count);
/**
* Get the limits passed in the constructor.
*
* @param count The size of the limits arrays
* @return the limits.
* @stable
*/
virtual const double* getLimits(int32_t& count) const;
/**
* Get the limit booleans passed in the constructor. The caller
* must not delete the result.
*
* @param count The size of the arrays
* @return the closures
*/
virtual const UBool* getClosures(int32_t& count) const;
/**
* Get the formats passed in the constructor.
*
* @param count The size of the arrays
* @return the formats.
* @stable
*/
virtual const UnicodeString* getFormats(int32_t& count) const;
/**
* Format a double or long number using this object's choices.
*
* @param number The value to be formatted.
* @param toAppendTo The string to append the formatted string to.
* This is an output parameter.
* @param pos On input: an alignment field, if desired.
* On output: the offsets of the alignment field.
* @return A reference to 'toAppendTo'.
* @stable
*/
virtual UnicodeString& format(double number,
UnicodeString& toAppendTo,
FieldPosition& pos) const;
/**
* Format a int_32t number using this object's choices.
*
* @param number The value to be formatted.
* @param toAppendTo The string to append the formatted string to.
* This is an output parameter.
* @param pos On input: an alignment field, if desired.
* On output: the offsets of the alignment field.
* @return A reference to 'toAppendTo'.
* @stable
*/
virtual UnicodeString& format(int32_t number,
UnicodeString& toAppendTo,
FieldPosition& pos) const;
/**
* Format an array of objects using this object's choices.
*
* @param objs The array of objects to be formatted.
* @param cnt The size of objs.
* @param toAppendTo The string to append the formatted string to.
* This is an output parameter.
* @param pos On input: an alignment field, if desired.
* On output: the offsets of the alignment field.
* @param success Output param set to success/failure code on
* exit.
* @return A reference to 'toAppendTo'.
* @stable
*/
virtual UnicodeString& format(const Formattable* objs,
int32_t cnt,
UnicodeString& toAppendTo,
FieldPosition& pos,
UErrorCode& success) const;
/**
* Format an object using this object's choices.
*
*
* @param obj The object to be formatted.
* @param toAppendTo The string to append the formatted string to.
* This is an output parameter.
* @param pos On input: an alignment field, if desired.
* On output: the offsets of the alignment field.
* @param status Output param set to success/failure code on
* exit.
* @return A reference to 'toAppendTo'.
* @stable
*/
virtual UnicodeString& format(const Formattable& obj,
UnicodeString& toAppendTo,
FieldPosition& pos,
UErrorCode& status) const;
/**
* Redeclared NumberFormat method.
*
* @param obj The object to be formatted.
* @param result Output param which will receive the formatted object.
* @param status Output param set to success/failure code on
* exit.
* @return A reference to 'result'.
* @stable
*/
UnicodeString& format(const Formattable& obj,
UnicodeString& result,
UErrorCode& status) const;
/**
* Redeclared NumberFormat method.
* Format a double number. These methods call the NumberFormat
* pure virtual format() methods with the default FieldPosition.
*
* @param number The value to be formatted.
* @param output Output param with the formatted string.
* @return A reference to 'output' param.
* @stable
*/
UnicodeString& format( double number,
UnicodeString& output) const;
/**
* Redeclared NumberFormat method.
* Format a long number. These methods call the NumberFormat
* pure virtual format() methods with the default FieldPosition.
*
* @param number The value to be formatted.
* @param output Output param with the formatted string.
* @return A reference to 'output' param.
* @stable
*/
UnicodeString& format( int32_t number,
UnicodeString& output) const;
/**
* Return a long if possible (e.g. within range LONG_MAX,
* LONG_MAX], and with no decimals), otherwise a double. If
* IntegerOnly is set, will stop at a decimal point (or equivalent;
* e.g. for rational numbers "1 2/3", will stop after the 1).
* * If no object can be parsed, parsePosition is unchanged, and NULL is * returned. * * @param text The text to be parsed. * @param result Formattable to be set to the parse result. * If parse fails, return contents are undefined. * @param parsePosition The position to start parsing at on input. * On output, moved to after the last successfully * parse character. On parse failure, does not change. * @see NumberFormat::isParseIntegerOnly * @stable */ virtual void parse(const UnicodeString& text, Formattable& result, ParsePosition& parsePosition) const; /** * Return a long if possible (e.g. within range LONG_MAX, * LONG_MAX], and with no decimals), otherwise a double. If * IntegerOnly is set, will stop at a decimal point (or equivalent; * e.g. for rational numbers "1 2/3", will stop after the 1). *
* If no object can be parsed, parsePosition is unchanged, and NULL is * returned. * * @param text The text to be parsed. * @param result Formattable to be set to the parse result. * If parse fails, return contents are undefined. * @param status Output param with the formatted string. * @see NumberFormat::isParseIntegerOnly * @stable */ virtual void parse(const UnicodeString& text, Formattable& result, UErrorCode& status) const; public: /** * 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. * @stable */ virtual UClassID getDynamicClassID(void) const; /** * Return the class ID for this class. This is useful only for * comparing to a return value from getDynamicClassID(). For example: *
* . Base* polymorphic_pointer = createPolymorphicObject();
* . if (polymorphic_pointer->getDynamicClassID() ==
* . Derived::getStaticClassID()) ...
*
* @return The class ID for all objects of this class.
* @stable
*/
static UClassID getStaticClassID(void) { return (UClassID)&fgClassID; }
/*
* Finds the least double greater than d (if positive == true),
* or the greatest double less than d (if positive == false).
* If NaN, returns same value.
* * Does not affect floating-point flags, * @deprecated This will be removed after 2002-Jun-30. Use closures API instead. */ static double nextDouble(double d, UBool positive); /** * Finds the least double greater than d. * If NaN, returns same value. * Used to make half-open intervals. * @see ChoiceFormat::previousDouble * @deprecated This will be removed after 2002-Jun-30. Use closures API instead. */ static double nextDouble(double d ); /** * Finds the greatest double less than d. * If NaN, returns same value. * @see ChoiceFormat::nextDouble * @deprecated This will be removed after 2002-Jun-30. Use closures API instead. */ static double previousDouble(double d ); private: // static cache management (thread-safe) // static NumberFormat* getNumberFormat(UErrorCode &status); // call this function to 'check out' a numberformat from the cache. // static void releaseNumberFormat(NumberFormat *adopt); // call this function to 'return' the number format to the cache. /** * Converts a string to a double value using a default NumberFormat object * which is static (shared by all ChoiceFormat instances). * @param string the string to be converted with. * @return the converted double number. */ static double stod(const UnicodeString& string); /** * Converts a double value to a string using a default NumberFormat object * which is static (shared by all ChoiceFormat instances). * @param value the double number to be converted with. * @param string the result string. * @return the converted string. */ static UnicodeString& dtos(double value, UnicodeString& string); //static UMTX fgMutex; //static NumberFormat* fgNumberFormat; static const char fgClassID; static const UChar fgPositiveInfinity[]; static const UChar fgNegativeInfinity[]; /** * Construct a new ChoiceFormat with the limits and the corresponding formats * based on the pattern. * * @param newPattern Pattern used to construct object. * @param parseError Struct to recieve information on position * of error if an error is encountered. * @param status Output param to receive success code. If the * pattern cannot be parsed, set to failure code. * @stable */ ChoiceFormat(const UnicodeString& newPattern, UParseError& parseError, UErrorCode& status); friend class MessageFormat; /** * Each ChoiceFormat divides the range -Inf..+Inf into fCount * intervals. The intervals are: * * 0: fChoiceLimits[0]..fChoiceLimits[1] * 1: fChoiceLimits[1]..fChoiceLimits[2] * ... * fCount-2: fChoiceLimits[fCount-2]..fChoiceLimits[fCount-1] * fCount-1: fChoiceLimits[fCount-1]..+Inf * * Interval 0 is special; during formatting (mapping numbers to * strings), it also contains all numbers less than * fChoiceLimits[0], as well as NaN values. * * Interval i maps to and from string fChoiceFormats[i]. When * parsing (mapping strings to numbers), then intervals map to * their lower limit, that is, interval i maps to fChoiceLimit[i]. * * The intervals may be closed, half open, or open. This affects * formatting but does not affect parsing. Interval i is affected * by fClosures[i] and fClosures[i+1]. If fClosures[i] * is FALSE, then the value fChoiceLimits[i] is in interval i. * That is, intervals i and i are: * * i-1: ... x < fChoiceLimits[i] * i: fChoiceLimits[i] <= x ... * * If fClosures[i] is TRUE, then the value fChoiceLimits[i] is * in interval i-1. That is, intervals i-1 and i are: * * i-1: ... x <= fChoiceLimits[i] * i: fChoiceLimits[i] < x ... * * Because of the nature of interval 0, fClosures[0] has no * effect. */ double* fChoiceLimits; UBool* fClosures; UnicodeString* fChoiceFormats; int32_t fCount; }; inline UClassID ChoiceFormat::getDynamicClassID() const { return ChoiceFormat::getStaticClassID(); } inline double ChoiceFormat::nextDouble( double d ) { return ChoiceFormat::nextDouble( d, TRUE ); } inline double ChoiceFormat::previousDouble( double d ) { return ChoiceFormat::nextDouble( d, FALSE ); } inline UnicodeString& ChoiceFormat::format(const Formattable& obj, UnicodeString& result, UErrorCode& status) const { // Don't use Format:: - use immediate base class only, // in case immediate base modifies behavior later. return NumberFormat::format(obj, result, status); } inline UnicodeString& ChoiceFormat::format(double number, UnicodeString& output) const { return NumberFormat::format(number, output); } inline UnicodeString& ChoiceFormat::format(int32_t number, UnicodeString& output) const { return NumberFormat::format(number, output); } U_NAMESPACE_END #endif // _CHOICFMT //eof