ICU 74.2: common/unicode/localebuilder.h Source File

ICU 74.2 74.2

localebuilder.h
Go to the documentation of this file.
1// © 2018 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3#ifndef __LOCALEBUILDER_H__
4#define __LOCALEBUILDER_H__
5
6#include "unicode/utypes.h"
7
8#if U_SHOW_CPLUSPLUS_API
9
10#include "unicode/locid.h"
11#include "unicode/localematcher.h"
12#include "unicode/stringpiece.h"
13#include "unicode/uobject.h"
14
20U_NAMESPACE_BEGIN
21class CharString;
22
61 class U_COMMON_API LocaleBuilder : public UObject {
62public:
70 LocaleBuilder();
71
76 virtual ~LocaleBuilder();
77
90 LocaleBuilder& setLocale(const Locale& locale);
91
107 LocaleBuilder& setLanguageTag(StringPiece tag);
108
122 LocaleBuilder& setLanguage(StringPiece language);
123
138 LocaleBuilder& setScript(StringPiece script);
139
157 LocaleBuilder& setRegion(StringPiece region);
158
178 LocaleBuilder& setVariant(StringPiece variant);
179
199 LocaleBuilder& setExtension(char key, StringPiece value);
200
219 LocaleBuilder& setUnicodeLocaleKeyword(
220 StringPiece key, StringPiece type);
221
232 LocaleBuilder& addUnicodeLocaleAttribute(StringPiece attribute);
233
245 LocaleBuilder& removeUnicodeLocaleAttribute(StringPiece attribute);
246
254 LocaleBuilder& clear();
255
263 LocaleBuilder& clearExtensions();
264
278 Locale build(UErrorCode& status);
279
289 UBool copyErrorTo(UErrorCode &outErrorCode) const;
290
291private:
292 friend class LocaleMatcher::Result;
293
294 void copyExtensionsFrom(const Locale& src, UErrorCode& errorCode);
295
296 UErrorCode status_;
297 char language_[9];
298 char script_[5];
299 char region_[4];
300 CharString *variant_; // Pointer not object so we need not #include internal charstr.h.
301 icu::Locale *extensions_; // Pointer not object. Storage for all other fields.
302
303};
304
305U_NAMESPACE_END
306
307#endif /* U_SHOW_CPLUSPLUS_API */
308
309#endif // __LOCALEBUILDER_H__
icu::LocaleBuilder
LocaleBuilder is used to build instances of Locale from values configured by the setters.
Definition localebuilder.h:61
icu::LocaleBuilder::setLanguageTag
LocaleBuilder & setLanguageTag(StringPiece tag)
Resets the LocaleBuilder to match the provided IETF BCP 47 language tag.
icu::LocaleBuilder::setScript
LocaleBuilder & setScript(StringPiece script)
Sets the script.
icu::LocaleBuilder::setUnicodeLocaleKeyword
LocaleBuilder & setUnicodeLocaleKeyword(StringPiece key, StringPiece type)
Sets the Unicode locale keyword type for the given key.
icu::LocaleBuilder::setExtension
LocaleBuilder & setExtension(char key, StringPiece value)
Sets the extension for the given key.
icu::LocaleBuilder::build
Locale build(UErrorCode &status)
Returns an instance of Locale created from the fields set on this builder.
icu::LocaleBuilder::clear
LocaleBuilder & clear()
Resets the builder to its initial, empty state.
icu::LocaleBuilder::setLocale
LocaleBuilder & setLocale(const Locale &locale)
Resets the LocaleBuilder to match the provided locale.
icu::LocaleBuilder::copyErrorTo
UBool copyErrorTo(UErrorCode &outErrorCode) const
Sets the UErrorCode if an error occurred while recording sets.
icu::LocaleBuilder::~LocaleBuilder
virtual ~LocaleBuilder()
Destructor.
icu::LocaleBuilder::addUnicodeLocaleAttribute
LocaleBuilder & addUnicodeLocaleAttribute(StringPiece attribute)
Adds a unicode locale attribute, if not already present, otherwise has no effect.
icu::LocaleBuilder::LocaleBuilder
LocaleBuilder()
Constructs an empty LocaleBuilder.
icu::LocaleBuilder::removeUnicodeLocaleAttribute
LocaleBuilder & removeUnicodeLocaleAttribute(StringPiece attribute)
Removes a unicode locale attribute, if present, otherwise has no effect.
icu::LocaleBuilder::setVariant
LocaleBuilder & setVariant(StringPiece variant)
Sets the variant.
icu::LocaleBuilder::setLanguage
LocaleBuilder & setLanguage(StringPiece language)
Sets the language.
icu::LocaleBuilder::clearExtensions
LocaleBuilder & clearExtensions()
Resets the extensions to their initial, empty state.
icu::LocaleBuilder::setRegion
LocaleBuilder & setRegion(StringPiece region)
Sets the region.
icu::LocaleMatcher::Result
Data for the best-matching pair of a desired and a supported locale.
Definition localematcher.h:192
icu::Locale
A Locale object represents a specific geographical, political, or cultural region.
Definition locid.h:195
icu::StringPiece
A string-like object that points to a sized piece of memory.
Definition stringpiece.h:60
icu::UObject
UObject is the common ICU "boilerplate" class.
Definition uobject.h:223
localematcher.h
C++ API: Locale matcher: User's desired locales vs.
locid.h
C++ API: Locale ID object.
stringpiece.h
C++ API: StringPiece: Read-only byte string wrapper class.
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
uobject.h
C++ API: Common ICU base class UObject.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
U_COMMON_API
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside.
Definition utypes.h:300