ICU 4.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
plurfmt.h
Go to the documentation of this file.
1 /*
2 *******************************************************************************
3 * Copyright (C) 2007-2009, International Business Machines Corporation and
4 * others. All Rights Reserved.
5 *******************************************************************************
6 *
7 
8 * File PLURFMT.H
9 *
10 * Modification History:*
11 * Date Name Description
12 *
13 ********************************************************************************
14 */
15 
16 #ifndef PLURFMT
17 #define PLURFMT
18 
19 #include "unicode/utypes.h"
20 
26 #if !UCONFIG_NO_FORMATTING
27 
28 #include "unicode/numfmt.h"
29 #include "unicode/plurrule.h"
30 
32 
33 class Hashtable;
34 
175 public:
176 
185  PluralFormat(UErrorCode& status);
186 
196  PluralFormat(const Locale& locale, UErrorCode& status);
197 
207  PluralFormat(const PluralRules& rules, UErrorCode& status);
208 
220  PluralFormat(const Locale& locale, const PluralRules& rules, UErrorCode& status);
221 
232  PluralFormat(const UnicodeString& pattern, UErrorCode& status);
233 
248  PluralFormat(const Locale& locale, const UnicodeString& pattern, UErrorCode& status);
249 
261  PluralFormat(const PluralRules& rules,
262  const UnicodeString& pattern,
263  UErrorCode& status);
264 
279  PluralFormat(const Locale& locale,
280  const PluralRules& rules,
281  const UnicodeString& pattern,
282  UErrorCode& status);
283 
288  PluralFormat(const PluralFormat& other);
289 
294  virtual ~PluralFormat();
295 
308  void applyPattern(const UnicodeString& pattern, UErrorCode& status);
309 
322  UnicodeString format(int32_t number, UErrorCode& status) const;
323 
336  UnicodeString format(double number, UErrorCode& status) const;
337 
354  UnicodeString& format(int32_t number,
355  UnicodeString& appendTo,
356  FieldPosition& pos,
357  UErrorCode& status) const;
358 
375  UnicodeString& format(double number,
376  UnicodeString& appendTo,
377  FieldPosition& pos,
378  UErrorCode& status) const;
379 
392  void setLocale(const Locale& locale, UErrorCode& status);
393 
403  void setNumberFormat(const NumberFormat* format, UErrorCode& status);
404 
411  PluralFormat& operator=(const PluralFormat& other);
412 
420  virtual UBool operator==(const Format& other) const;
421 
429  virtual UBool operator!=(const Format& other) const;
430 
436  virtual Format* clone(void) const;
437 
450  UnicodeString& format(const Formattable& obj,
451  UnicodeString& appendTo,
452  FieldPosition& pos,
453  UErrorCode& status) const;
454 
463  UnicodeString& toPattern(UnicodeString& appendTo);
464 
487  virtual void parseObject(const UnicodeString& source,
488  Formattable& result,
489  ParsePosition& parse_pos) const;
490 
497  static UClassID U_EXPORT2 getStaticClassID(void);
498 
504  virtual UClassID getDynamicClassID() const;
505 
506 private:
507  typedef enum fmtToken {
508  none,
509  tLetter,
510  tNumber,
511  tSpace,
512  tNumberSign,
513  tLeftBrace,
514  tRightBrace
515  }fmtToken;
516 
517  Locale locale;
518  PluralRules* pluralRules;
519  UnicodeString pattern;
520  Hashtable *fParsedValuesHash;
521  NumberFormat* numberFormat;
522  NumberFormat* replacedNumberFormat;
523 
524  PluralFormat(); // default constructor not implemented
525  void init(const PluralRules* rules, const Locale& curlocale, UErrorCode& status);
526  UBool inRange(UChar ch, fmtToken& type);
527  UBool checkSufficientDefinition();
528  void parsingFailure();
529  UnicodeString insertFormattedNumber(double number,
530  UnicodeString& message,
531  UnicodeString& appendTo,
532  FieldPosition& pos) const;
533  void copyHashtable(Hashtable *other, UErrorCode& status);
534 };
535 
537 
538 #endif /* #if !UCONFIG_NO_FORMATTING */
539 
540 #endif // _PLURFMT
541 //eof
virtual UClassID getDynamicClassID() const =0
Returns a unique class ID POLYMORPHICALLY.
UBool operator!=(const Format &other) const
Return true if the given Format objects are not semantically equal.
Definition: format.h:118
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const =0
Parse a string to produce an object.
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const
Formats an object to produce a string.
C++ API: PluralRules object.
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:475
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:183
Abstract base class for all number formats.
Definition: numfmt.h:162
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition: parsepos.h:47
virtual UBool operator==(const Format &other) const =0
Return true if the given Format objects are semantically equal.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:187
#define U_EXPORT2
Definition: platform.h:338
virtual Format * clone() const =0
Clone this object polymorphically.
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition: fieldpos.h:106
uint16_t UChar
Define UChar to be wchar_t if that is 16 bits wide; always assumed to be unsigned.
Definition: umachine.h:299
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API If the compiler doesn't support namespaces...
Definition: uversion.h:184
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:47
void * UClassID
UClassID is used to identify classes without using RTTI, since RTTI is not yet supported by all C++ c...
Definition: utypes.h:339
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:593
Defines rules for mapping positive long values onto a small set of keywords.
Definition: plurrule.h:104
Base class for all formats.
Definition: format.h:93
Basic definitions for ICU, for both C and C++ APIs.
C++ API: Abstract base class for all number formats.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:181
signed int int32_t
Define 64 bit limits.
Definition: pwin32.h:143
int8_t UBool
The ICU boolean type.
Definition: umachine.h:208
Format & operator=(const Format &)