ICU 72.1  72.1
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 
20 U_NAMESPACE_BEGIN
21 class CharString;
22 
62 public:
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 
291 private:
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 
305 U_NAMESPACE_END
306 
307 #endif /* U_SHOW_CPLUSPLUS_API */
308 
309 #endif // __LOCALEBUILDER_H__
C++ API: Locale matcher: User's desired locales vs.
LocaleBuilder is used to build instances of Locale from values configured by the setters.
Definition: localebuilder.h:61
C++ API: StringPiece: Read-only byte string wrapper class.
Data for the best-matching pair of a desired and a supported locale.
C++ API: Common ICU base class UObject.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
C++ API: Locale ID object.
Basic definitions for ICU, for both C and C++ APIs.
#define U_COMMON_API
Set to export library symbols from inside the common library, and to import them from outside...
Definition: utypes.h:300
A string-like object that points to a sized piece of memory.
Definition: stringpiece.h:60
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195