ICU 62.1 62.1
choicfmt.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4********************************************************************************
5* Copyright (C) 1997-2013, International Business Machines
6* Corporation and others. All Rights Reserved.
7********************************************************************************
8*
9* File CHOICFMT.H
10*
11* Modification History:
12*
13* Date Name Description
14* 02/19/97 aliu Converted from java.
15* 03/20/97 helena Finished first cut of implementation and got rid
16* of nextDouble/previousDouble and replaced with
17* boolean array.
18* 4/10/97 aliu Clean up. Modified to work on AIX.
19* 8/6/97 nos Removed overloaded constructor, member var 'buffer'.
20* 07/22/98 stephen Removed operator!= (implemented in Format)
21********************************************************************************
22*/
23
24#ifndef CHOICFMT_H
25#define CHOICFMT_H
26
27#include "unicode/utypes.h"
28
34#if !UCONFIG_NO_FORMATTING
35#ifndef U_HIDE_DEPRECATED_API
36
37#include "unicode/fieldpos.h"
38#include "unicode/format.h"
40#include "unicode/numfmt.h"
41#include "unicode/unistr.h"
42
44
45class MessageFormat;
46
174public:
185
186
199 ChoiceFormat(const double* limits,
200 const UnicodeString* formats,
201 int32_t count );
202
217 ChoiceFormat(const double* limits,
218 const UBool* closures,
219 const UnicodeString* formats,
220 int32_t count);
221
229
237
242 virtual ~ChoiceFormat();
243
251 virtual Format* clone(void) const;
252
261 virtual UBool operator==(const Format& other) const;
262
271 virtual void applyPattern(const UnicodeString& pattern,
273
284 virtual void applyPattern(const UnicodeString& pattern,
295 virtual UnicodeString& toPattern(UnicodeString &pattern) const;
296
310 virtual void setChoices(const double* limitsToCopy,
312 int32_t count );
313
324 virtual void setChoices(const double* limits,
325 const UBool* closures,
326 const UnicodeString* formats,
327 int32_t count);
328
337 virtual const double* getLimits(int32_t& count) const;
338
347 virtual const UBool* getClosures(int32_t& count) const;
348
357 virtual const UnicodeString* getFormats(int32_t& count) const;
358
359
360 using NumberFormat::format;
361
373 virtual UnicodeString& format(double number,
374 UnicodeString& appendTo,
375 FieldPosition& pos) const;
387 virtual UnicodeString& format(int32_t number,
388 UnicodeString& appendTo,
389 FieldPosition& pos) const;
390
402 virtual UnicodeString& format(int64_t number,
403 UnicodeString& appendTo,
404 FieldPosition& pos) const;
405
421 int32_t cnt,
422 UnicodeString& appendTo,
423 FieldPosition& pos,
424 UErrorCode& success) const;
425
426 using NumberFormat::parse;
427
442 virtual void parse(const UnicodeString& text,
445
454 virtual UClassID getDynamicClassID(void) const;
455
468
469private:
476 static UnicodeString& dtos(double value, UnicodeString& string);
477
478 ChoiceFormat(); // default constructor not implemented
479
493
494 friend class MessageFormat;
495
496 virtual void setChoices(const double* limits,
497 const UBool* closures,
498 const UnicodeString* formats,
499 int32_t count,
500 UErrorCode &errorCode);
501
509 static int32_t findSubMessage(const MessagePattern &pattern, int32_t partIndex, double number);
510
511 static double parseArgument(
512 const MessagePattern &pattern, int32_t partIndex,
513 const UnicodeString &source, ParsePosition &pos);
514
523 static int32_t matchStringUntilLimitPart(
524 const MessagePattern &pattern, int32_t partIndex, int32_t limitPartIndex,
525 const UnicodeString &source, int32_t sourceOffset);
526
533 UErrorCode constructorErrorCode;
534
542 MessagePattern msgPattern;
543
583 // double* fChoiceLimits;
584 // UBool* fClosures;
585 // UnicodeString* fChoiceFormats;
586 // int32_t fCount;
587};
588
589
591
592#endif // U_HIDE_DEPRECATED_API
593#endif /* #if !UCONFIG_NO_FORMATTING */
594
595#endif // CHOICFMT_H
596//eof
ChoiceFormat converts between ranges of numeric values and strings for those ranges.
Definition choicfmt.h:173
virtual void setChoices(const double *limitsToCopy, const UnicodeString *formatsToCopy, int32_t count)
Sets the choices to be used in formatting.
virtual Format * clone(void) const
Clones this Format object.
virtual UnicodeString & format(double number, UnicodeString &appendTo, FieldPosition &pos) const
Formats a double number using this object's choices.
virtual UnicodeString & format(int32_t number, UnicodeString &appendTo, FieldPosition &pos) const
Formats an int32_t number using this object's choices.
static UClassID getStaticClassID(void)
Returns the class ID for this class.
virtual UClassID getDynamicClassID(void) const
Returns a unique class ID POLYMORPHICALLY.
virtual const double * getLimits(int32_t &count) const
Returns NULL and 0.
ChoiceFormat(const UnicodeString &pattern, UErrorCode &status)
Constructs a new ChoiceFormat from the pattern string.
ChoiceFormat(const double *limits, const UBool *closures, const UnicodeString *formats, int32_t count)
Constructs a new ChoiceFormat with the given limits, closure flags and message strings.
virtual void setChoices(const double *limits, const UBool *closures, const UnicodeString *formats, int32_t count)
Sets the choices to be used in formatting.
ChoiceFormat(const ChoiceFormat &that)
Copy constructor.
virtual void applyPattern(const UnicodeString &pattern, UParseError &parseError, UErrorCode &status)
Sets the pattern.
virtual void parse(const UnicodeString &text, Formattable &result, ParsePosition &parsePosition) const
Looks for the longest match of any message string on the input text and, if there is a match,...
virtual void applyPattern(const UnicodeString &pattern, UErrorCode &status)
Sets the pattern.
const ChoiceFormat & operator=(const ChoiceFormat &that)
Assignment operator.
virtual ~ChoiceFormat()
Destructor.
virtual const UBool * getClosures(int32_t &count) const
Returns NULL and 0.
virtual UBool operator==(const Format &other) const
Returns true if the given Format objects are semantically equal.
virtual UnicodeString & format(const Formattable *objs, int32_t cnt, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &success) const
Formats an array of objects using this object's choices.
virtual UnicodeString & format(int64_t number, UnicodeString &appendTo, FieldPosition &pos) const
Formats an int64_t number using this object's choices.
ChoiceFormat(const double *limits, const UnicodeString *formats, int32_t count)
Constructs a new ChoiceFormat with the given limits and message strings.
virtual UnicodeString & toPattern(UnicodeString &pattern) const
Gets the pattern.
virtual const UnicodeString * getFormats(int32_t &count) const
Returns NULL and 0.
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition fieldpos.h:108
Base class for all formats.
Definition format.h:96
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition fmtable.h:62
"Smart pointer" base class; do not use directly: use LocalPointer etc.
Parses and represents ICU MessageFormat patterns.
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition parsepos.h:49
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:287
C++ API: FieldPosition identifies the fields in a formatted output.
C++ API: Base class for all formats.
C++ API: MessagePattern class: Parses and represents ICU MessageFormat patterns.
C++ API: Compatibility APIs for number formatting.
A UParseError struct is used to returned detailed information about parsing errors.
Definition parseerr.h:58
int8_t UBool
The ICU boolean type.
Definition umachine.h:236
C++ API: Unicode String.
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:93
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:360
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137