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__
6 #include "unicode/utypes.h"
8 #if U_SHOW_CPLUSPLUS_API
10 #include "unicode/locid.h"
11 #include "unicode/localematcher.h"
12 #include "unicode/stringpiece.h"
13 #include "unicode/uobject.h"
17 * \brief C++ API: Builder API for Locale
24 * <code>LocaleBuilder</code> is used to build instances of <code>Locale</code>
25 * from values configured by the setters. Unlike the <code>Locale</code>
26 * constructors, the <code>LocaleBuilder</code> checks if a value configured by a
27 * setter satisfies the syntax requirements defined by the <code>Locale</code>
28 * class. A <code>Locale</code> object created by a <code>LocaleBuilder</code> is
29 * well-formed and can be transformed to a well-formed IETF BCP 47 language tag
30 * without losing information.
32 * <p>The following example shows how to create a <code>Locale</code> object
33 * with the <code>LocaleBuilder</code>.
36 * UErrorCode status = U_ZERO_ERROR;
37 * Locale aLocale = LocaleBuilder()
42 * if (U_SUCCESS(status)) {
48 * <p>LocaleBuilders can be reused; <code>clear()</code> resets all
49 * fields to their default values.
51 * <p>LocaleBuilder tracks errors in an internal UErrorCode. For all setters,
52 * except setLanguageTag and setLocale, LocaleBuilder will return immediately
53 * if the internal UErrorCode is in error state.
54 * To reset internal state and error code, call clear method.
55 * The setLanguageTag and setLocale method will first clear the internal
56 * UErrorCode, then track the error of the validation of the input parameter
57 * into the internal UErrorCode.
61 class U_COMMON_API LocaleBuilder : public UObject {
64 * Constructs an empty LocaleBuilder. The default value of all
65 * fields, extensions, and private use information is the
76 virtual ~LocaleBuilder();
79 * Resets the <code>LocaleBuilder</code> to match the provided
80 * <code>locale</code>. Existing state is discarded.
82 * <p>All fields of the locale must be well-formed.
83 * <p>This method clears the internal UErrorCode.
85 * @param locale the locale
86 * @return This builder.
90 LocaleBuilder& setLocale(const Locale& locale);
93 * Resets the LocaleBuilder to match the provided IETF BCP 47 language tag.
94 * Discards the existing state.
95 * The empty string causes the builder to be reset, like {@link #clear}.
96 * Legacy language tags (marked as “Type: grandfathered” in BCP 47)
97 * are converted to their canonical form before being processed.
98 * Otherwise, the <code>language tag</code> must be well-formed,
99 * or else the build() method will later report an U_ILLEGAL_ARGUMENT_ERROR.
101 * <p>This method clears the internal UErrorCode.
103 * @param tag the language tag, defined as IETF BCP 47 language tag.
104 * @return This builder.
107 LocaleBuilder& setLanguageTag(StringPiece tag);
110 * Sets the language. If <code>language</code> is the empty string, the
111 * language in this <code>LocaleBuilder</code> is removed. Otherwise, the
112 * <code>language</code> must be well-formed, or else the build() method will
113 * later report an U_ILLEGAL_ARGUMENT_ERROR.
115 * <p>The syntax of language value is defined as
116 * [unicode_language_subtag](http://www.unicode.org/reports/tr35/tr35.html#unicode_language_subtag).
118 * @param language the language
119 * @return This builder.
122 LocaleBuilder& setLanguage(StringPiece language);
125 * Sets the script. If <code>script</code> is the empty string, the script in
126 * this <code>LocaleBuilder</code> is removed.
127 * Otherwise, the <code>script</code> must be well-formed, or else the build()
128 * method will later report an U_ILLEGAL_ARGUMENT_ERROR.
130 * <p>The script value is a four-letter script code as
131 * [unicode_script_subtag](http://www.unicode.org/reports/tr35/tr35.html#unicode_script_subtag)
132 * defined by ISO 15924
134 * @param script the script
135 * @return This builder.
138 LocaleBuilder& setScript(StringPiece script);
141 * Sets the region. If region is the empty string, the region in this
142 * <code>LocaleBuilder</code> is removed. Otherwise, the <code>region</code>
143 * must be well-formed, or else the build() method will later report an
144 * U_ILLEGAL_ARGUMENT_ERROR.
146 * <p>The region value is defined by
147 * [unicode_region_subtag](http://www.unicode.org/reports/tr35/tr35.html#unicode_region_subtag)
148 * as a two-letter ISO 3166 code or a three-digit UN M.49 area code.
150 * <p>The region value in the <code>Locale</code> created by the
151 * <code>LocaleBuilder</code> is always normalized to upper case.
153 * @param region the region
154 * @return This builder.
157 LocaleBuilder& setRegion(StringPiece region);
160 * Sets the variant. If variant is the empty string, the variant in this
161 * <code>LocaleBuilder</code> is removed. Otherwise, the <code>variant</code>
162 * must be well-formed, or else the build() method will later report an
163 * U_ILLEGAL_ARGUMENT_ERROR.
165 * <p><b>Note:</b> This method checks if <code>variant</code>
167 * [unicode_variant_subtag](http://www.unicode.org/reports/tr35/tr35.html#unicode_variant_subtag)
168 * syntax requirements, and normalizes the value to lowercase letters. However,
169 * the <code>Locale</code> class does not impose any syntactic
170 * restriction on variant. To set an ill-formed variant, use a Locale constructor.
171 * If there are multiple unicode_variant_subtag, the caller must concatenate
172 * them with '-' as separator (ex: "foobar-fibar").
174 * @param variant the variant
175 * @return This builder.
178 LocaleBuilder& setVariant(StringPiece variant);
181 * Sets the extension for the given key. If the value is the empty string,
182 * the extension is removed. Otherwise, the <code>key</code> and
183 * <code>value</code> must be well-formed, or else the build() method will
184 * later report an U_ILLEGAL_ARGUMENT_ERROR.
186 * <p><b>Note:</b> The key ('u') is used for the Unicode locale extension.
187 * Setting a value for this key replaces any existing Unicode locale key/type
188 * pairs with those defined in the extension.
190 * <p><b>Note:</b> The key ('x') is used for the private use code. To be
191 * well-formed, the value for this key needs only to have subtags of one to
192 * eight alphanumeric characters, not two to eight as in the general case.
194 * @param key the extension key
195 * @param value the extension value
196 * @return This builder.
199 LocaleBuilder& setExtension(char key, StringPiece value);
202 * Sets the Unicode locale keyword type for the given key. If the type
203 * StringPiece is constructed with a nullptr, the keyword is removed.
204 * If the type is the empty string, the keyword is set without type subtags.
205 * Otherwise, the key and type must be well-formed, or else the build()
206 * method will later report an U_ILLEGAL_ARGUMENT_ERROR.
208 * <p>Keys and types are converted to lower case.
210 * <p><b>Note</b>:Setting the 'u' extension via {@link #setExtension}
211 * replaces all Unicode locale keywords with those defined in the
214 * @param key the Unicode locale key
215 * @param type the Unicode locale type
216 * @return This builder.
219 LocaleBuilder& setUnicodeLocaleKeyword(
220 StringPiece key, StringPiece type);
223 * Adds a unicode locale attribute, if not already present, otherwise
224 * has no effect. The attribute must not be empty string and must be
225 * well-formed or U_ILLEGAL_ARGUMENT_ERROR will be set to status
226 * during the build() call.
228 * @param attribute the attribute
229 * @return This builder.
232 LocaleBuilder& addUnicodeLocaleAttribute(StringPiece attribute);
235 * Removes a unicode locale attribute, if present, otherwise has no
236 * effect. The attribute must not be empty string and must be well-formed
237 * or U_ILLEGAL_ARGUMENT_ERROR will be set to status during the build() call.
239 * <p>Attribute comparison for removal is case-insensitive.
241 * @param attribute the attribute
242 * @return This builder.
245 LocaleBuilder& removeUnicodeLocaleAttribute(StringPiece attribute);
248 * Resets the builder to its initial, empty state.
249 * <p>This method clears the internal UErrorCode.
251 * @return this builder
254 LocaleBuilder& clear();
257 * Resets the extensions to their initial, empty state.
258 * Language, script, region and variant are unchanged.
260 * @return this builder
263 LocaleBuilder& clearExtensions();
266 * Returns an instance of <code>Locale</code> created from the fields set
268 * If any set methods or during the build() call require memory allocation
269 * but fail U_MEMORY_ALLOCATION_ERROR will be set to status.
270 * If any of the fields set by the setters are not well-formed, the status
271 * will be set to U_ILLEGAL_ARGUMENT_ERROR. The state of the builder will
272 * not change after the build() call and the caller is free to keep using
273 * the same builder to build more locales.
275 * @return a new Locale
278 Locale build(UErrorCode& status);
281 * Sets the UErrorCode if an error occurred while recording sets.
282 * Preserves older error codes in the outErrorCode.
283 * @param outErrorCode Set to an error code that occurred while setting subtags.
284 * Unchanged if there is no such error or if outErrorCode
285 * already contained an error.
286 * @return true if U_FAILURE(outErrorCode)
289 UBool copyErrorTo(UErrorCode &outErrorCode) const;
292 friend class LocaleMatcher::Result;
294 void copyExtensionsFrom(const Locale& src, UErrorCode& errorCode);
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.
307 #endif /* U_SHOW_CPLUSPLUS_API */
309 #endif // __LOCALEBUILDER_H__