localebuilder.h

Go to the documentation of this file.

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
#ifndef __LOCALEBUILDER_H__
#define __LOCALEBUILDER_H__
 
#include "unicode/utypes.h"
 
#if U_SHOW_CPLUSPLUS_API
 
#include "unicode/locid.h"
#include "unicode/localematcher.h"
#include "unicode/stringpiece.h"
#include "unicode/uobject.h"

 
U_NAMESPACE_BEGIN
class FixedString;

class U_COMMON_API LocaleBuilder : public UObject {
public:
    LocaleBuilder();

    virtual ~LocaleBuilder();

    LocaleBuilder& setLocale(const Locale& locale) U_LIFETIME_BOUND;

    LocaleBuilder& setLanguageTag(StringPiece tag) U_LIFETIME_BOUND;

    LocaleBuilder& setLanguage(StringPiece language) U_LIFETIME_BOUND;

    LocaleBuilder& setScript(StringPiece script) U_LIFETIME_BOUND;

    LocaleBuilder& setRegion(StringPiece region) U_LIFETIME_BOUND;

    LocaleBuilder& setVariant(StringPiece variant) U_LIFETIME_BOUND;

    LocaleBuilder& setExtension(char key, StringPiece value) U_LIFETIME_BOUND;

    LocaleBuilder& setUnicodeLocaleKeyword(StringPiece key, StringPiece type) U_LIFETIME_BOUND;

    LocaleBuilder& addUnicodeLocaleAttribute(StringPiece attribute) U_LIFETIME_BOUND;

    LocaleBuilder& removeUnicodeLocaleAttribute(StringPiece attribute) U_LIFETIME_BOUND;

    LocaleBuilder& clear() U_LIFETIME_BOUND;

    LocaleBuilder& clearExtensions() U_LIFETIME_BOUND;

    Locale build(UErrorCode& status);

    UBool copyErrorTo(UErrorCode &outErrorCode) const;
 
private:
    friend class LocaleMatcher::Result;
 
    void copyExtensionsFrom(const Locale& src, UErrorCode& errorCode);
 
    UErrorCode status_;
    char language_[9];
    char script_[5];
    char region_[4];
    FixedString *variant_;  // Pointer not object so we need not #include internal fixedstring.h.
    icu::Locale *extensions_;  // Pointer not object. Storage for all other fields.
 
};
 
U_NAMESPACE_END
 
#endif /* U_SHOW_CPLUSPLUS_API */
 
#endif  // __LOCALEBUILDER_H__