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#License
#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"

#ifndef U_HIDE_DRAFT_API

U_NAMESPACE_BEGIN
class CharString;

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

    virtual ~LocaleBuilder();

    LocaleBuilder& setLocale(const Locale& locale);

    LocaleBuilder& setLanguageTag(StringPiece tag);

    LocaleBuilder& setLanguage(StringPiece language);

    LocaleBuilder& setScript(StringPiece script);

    LocaleBuilder& setRegion(StringPiece region);

    LocaleBuilder& setVariant(StringPiece variant);

    LocaleBuilder& setExtension(char key, StringPiece value);

    LocaleBuilder& setUnicodeLocaleKeyword(
        StringPiece key, StringPiece type);

    LocaleBuilder& addUnicodeLocaleAttribute(StringPiece attribute);

    LocaleBuilder& removeUnicodeLocaleAttribute(StringPiece attribute);

    LocaleBuilder& clear();

    LocaleBuilder& clearExtensions();

    Locale build(UErrorCode& status);

#ifndef U_HIDE_DRAFT_API

    UBool copyErrorTo(UErrorCode &outErrorCode) const;
#endif  /* U_HIDE_DRAFT_API */

private:
    friend class LocaleMatcher::Result;

    void copyExtensionsFrom(const Locale& src, UErrorCode& errorCode);

    UErrorCode status_;
    char language_[9];
    char script_[5];
    char region_[4];
    CharString *variant_;  // Pointer not object so we need not #include internal charstr.h.
    icu::Locale *extensions_;  // Pointer not object. Storage for all other fields.

};

U_NAMESPACE_END

#endif  // U_HIDE_DRAFT_API

#endif /* U_SHOW_CPLUSPLUS_API */

#endif  // __LOCALEBUILDER_H__