plurfmt.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
*******************************************************************************
* Copyright (C) 2007-2014, International Business Machines Corporation and
* others. All Rights Reserved.
*******************************************************************************
*

* File PLURFMT.H
********************************************************************************
*/

#ifndef PLURFMT
#define PLURFMT

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/messagepattern.h"
#include "unicode/numfmt.h"
#include "unicode/plurrule.h"

U_NAMESPACE_BEGIN

class Hashtable;
class NFRule;

class U_I18N_API PluralFormat : public Format {
public:

    PluralFormat(UErrorCode& status);

    PluralFormat(const Locale& locale, UErrorCode& status);

    PluralFormat(const PluralRules& rules, UErrorCode& status);

    PluralFormat(const Locale& locale, const PluralRules& rules, UErrorCode& status);

    PluralFormat(const Locale& locale, UPluralType type, UErrorCode& status);

    PluralFormat(const UnicodeString& pattern, UErrorCode& status);

    PluralFormat(const Locale& locale, const UnicodeString& pattern, UErrorCode& status);

    PluralFormat(const PluralRules& rules,
                 const UnicodeString& pattern,
                 UErrorCode& status);

    PluralFormat(const Locale& locale,
                 const PluralRules& rules,
                 const UnicodeString& pattern,
                 UErrorCode& status);

    PluralFormat(const Locale& locale,
                 UPluralType type,
                 const UnicodeString& pattern,
                 UErrorCode& status);

    PluralFormat(const PluralFormat& other);

    virtual ~PluralFormat();

    void applyPattern(const UnicodeString& pattern, UErrorCode& status);


    using Format::format;

    UnicodeString format(int32_t number, UErrorCode& status) const;

    UnicodeString format(double number, UErrorCode& status) const;

    UnicodeString& format(int32_t number,
                          UnicodeString& appendTo,
                          FieldPosition& pos,
                          UErrorCode& status) const;

    UnicodeString& format(double number,
                          UnicodeString& appendTo,
                          FieldPosition& pos,
                          UErrorCode& status) const;

#ifndef U_HIDE_DEPRECATED_API 

    void setLocale(const Locale& locale, UErrorCode& status);
#endif  /* U_HIDE_DEPRECATED_API */

    void setNumberFormat(const NumberFormat* format, UErrorCode& status);

    PluralFormat& operator=(const PluralFormat& other);

    virtual UBool operator==(const Format& other) const;

    virtual UBool operator!=(const Format& other) const;

    virtual PluralFormat* clone() const;

   UnicodeString& format(const Formattable& obj,
                         UnicodeString& appendTo,
                         FieldPosition& pos,
                         UErrorCode& status) const;

   UnicodeString& toPattern(UnicodeString& appendTo);

   virtual void parseObject(const UnicodeString& source,
                            Formattable& result,
                            ParsePosition& parse_pos) const;

    static UClassID U_EXPORT2 getStaticClassID(void);

     virtual UClassID getDynamicClassID() const;

private:
    class U_I18N_API PluralSelector : public UMemory {
      public:
        virtual ~PluralSelector();
        virtual UnicodeString select(void *context, double number, UErrorCode& ec) const = 0;
    };

    class U_I18N_API PluralSelectorAdapter : public PluralSelector {
      public:
        PluralSelectorAdapter() : pluralRules(NULL) {
        }

        virtual ~PluralSelectorAdapter();

        virtual UnicodeString select(void *context, double number, UErrorCode& /*ec*/) const; 
        void reset();

        PluralRules* pluralRules;
    };

    Locale  locale;
    MessagePattern msgPattern;
    NumberFormat*  numberFormat;
    double offset;
    PluralSelectorAdapter pluralRulesWrapper;

    PluralFormat();   // default constructor not implemented
    void init(const PluralRules* rules, UPluralType type, UErrorCode& status);
    void copyObjects(const PluralFormat& other);

    UnicodeString& format(const Formattable& numberObject, double number,
                          UnicodeString& appendTo,
                          FieldPosition& pos,
                          UErrorCode& status) const; 
    static int32_t findSubMessage(
         const MessagePattern& pattern, int32_t partIndex,
         const PluralSelector& selector, void *context, double number, UErrorCode& ec); 
    void parseType(const UnicodeString& source, const NFRule *rbnfLenientScanner,
        Formattable& result, FieldPosition& pos) const;

    friend class MessageFormat;
    friend class NFRule;
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // _PLURFMT
//eof