Index: public/common/unicode/locid.h |
diff --git a/public/common/unicode/locid.h b/public/common/unicode/locid.h |
deleted file mode 100644 |
index 14f5285334fa6af605abf23509e96e834f5031be..0000000000000000000000000000000000000000 |
--- a/public/common/unicode/locid.h |
+++ /dev/null |
@@ -1,781 +0,0 @@ |
-/* |
-****************************************************************************** |
-* |
-* Copyright (C) 1996-2010, International Business Machines |
-* Corporation and others. All Rights Reserved. |
-* |
-****************************************************************************** |
-* |
-* File locid.h |
-* |
-* Created by: Helena Shih |
-* |
-* Modification History: |
-* |
-* Date Name Description |
-* 02/11/97 aliu Changed gLocPath to fgLocPath and added methods to |
-* get and set it. |
-* 04/02/97 aliu Made operator!= inline; fixed return value of getName(). |
-* 04/15/97 aliu Cleanup for AIX/Win32. |
-* 04/24/97 aliu Numerous changes per code review. |
-* 08/18/98 stephen Added tokenizeString(),changed getDisplayName() |
-* 09/08/98 stephen Moved definition of kEmptyString for Mac Port |
-* 11/09/99 weiv Added const char * getName() const; |
-* 04/12/00 srl removing unicodestring api's and cached hash code |
-* 08/10/01 grhoten Change the static Locales to accessor functions |
-****************************************************************************** |
-*/ |
- |
-#ifndef LOCID_H |
-#define LOCID_H |
- |
-#include "unicode/utypes.h" |
-#include "unicode/uobject.h" |
-#include "unicode/unistr.h" |
-#include "unicode/putil.h" |
-#include "unicode/uloc.h" |
-#include "unicode/strenum.h" |
- |
-/** |
- * \file |
- * \brief C++ API: Locale ID object. |
- */ |
- |
-/** |
- * A <code>Locale</code> object represents a specific geographical, political, |
- * or cultural region. An operation that requires a <code>Locale</code> to perform |
- * its task is called <em>locale-sensitive</em> and uses the <code>Locale</code> |
- * to tailor information for the user. For example, displaying a number |
- * is a locale-sensitive operation--the number should be formatted |
- * according to the customs/conventions of the user's native country, |
- * region, or culture. |
- * |
- * The Locale class is not suitable for subclassing. |
- * |
- * <P> |
- * You can create a <code>Locale</code> object using the constructor in |
- * this class: |
- * \htmlonly<blockquote>\endhtmlonly |
- * <pre> |
- * Locale( const char* language, |
- * const char* country, |
- * const char* variant); |
- * </pre> |
- * \htmlonly</blockquote>\endhtmlonly |
- * The first argument to the constructors is a valid <STRONG>ISO |
- * Language Code.</STRONG> These codes are the lower-case two-letter |
- * codes as defined by ISO-639. |
- * You can find a full list of these codes at: |
- * <BR><a href ="http://www.loc.gov/standards/iso639-2/"> |
- * http://www.loc.gov/standards/iso639-2/</a> |
- * |
- * <P> |
- * The second argument to the constructors is a valid <STRONG>ISO Country |
- * Code.</STRONG> These codes are the upper-case two-letter codes |
- * as defined by ISO-3166. |
- * You can find a full list of these codes at a number of sites, such as: |
- * <BR><a href="http://www.iso.org/iso/en/prods-services/iso3166ma/index.html"> |
- * http://www.iso.org/iso/en/prods-services/iso3166ma/index.html</a> |
- * |
- * <P> |
- * The third constructor requires a third argument--the <STRONG>Variant.</STRONG> |
- * The Variant codes are vendor and browser-specific. |
- * For example, use REVISED for a langauge's revised script orthography, and POSIX for POSIX. |
- * Where there are two variants, separate them with an underscore, and |
- * put the most important one first. For |
- * example, a Traditional Spanish collation might be referenced, with |
- * "ES", "ES", "Traditional_POSIX". |
- * |
- * <P> |
- * Because a <code>Locale</code> object is just an identifier for a region, |
- * no validity check is performed when you construct a <code>Locale</code>. |
- * If you want to see whether particular resources are available for the |
- * <code>Locale</code> you construct, you must query those resources. For |
- * example, ask the <code>NumberFormat</code> for the locales it supports |
- * using its <code>getAvailableLocales</code> method. |
- * <BR><STRONG>Note:</STRONG> When you ask for a resource for a particular |
- * locale, you get back the best available match, not necessarily |
- * precisely what you asked for. For more information, look at |
- * <code>ResourceBundle</code>. |
- * |
- * <P> |
- * The <code>Locale</code> class provides a number of convenient constants |
- * that you can use to create <code>Locale</code> objects for commonly used |
- * locales. For example, the following refers to a <code>Locale</code> object |
- * for the United States: |
- * \htmlonly<blockquote>\endhtmlonly |
- * <pre> |
- * Locale::getUS() |
- * </pre> |
- * \htmlonly</blockquote>\endhtmlonly |
- * |
- * <P> |
- * Once you've created a <code>Locale</code> you can query it for information about |
- * itself. Use <code>getCountry</code> to get the ISO Country Code and |
- * <code>getLanguage</code> to get the ISO Language Code. You can |
- * use <code>getDisplayCountry</code> to get the |
- * name of the country suitable for displaying to the user. Similarly, |
- * you can use <code>getDisplayLanguage</code> to get the name of |
- * the language suitable for displaying to the user. Interestingly, |
- * the <code>getDisplayXXX</code> methods are themselves locale-sensitive |
- * and have two versions: one that uses the default locale and one |
- * that takes a locale as an argument and displays the name or country in |
- * a language appropriate to that locale. |
- * |
- * <P> |
- * ICU provides a number of classes that perform locale-sensitive |
- * operations. For example, the <code>NumberFormat</code> class formats |
- * numbers, currency, or percentages in a locale-sensitive manner. Classes |
- * such as <code>NumberFormat</code> have a number of convenience methods |
- * for creating a default object of that type. For example, the |
- * <code>NumberFormat</code> class provides these three convenience methods |
- * for creating a default <code>NumberFormat</code> object: |
- * \htmlonly<blockquote>\endhtmlonly |
- * <pre> |
- * UErrorCode success = U_ZERO_ERROR; |
- * Locale myLocale; |
- * NumberFormat *nf; |
- * |
- * nf = NumberFormat::createInstance( success ); delete nf; |
- * nf = NumberFormat::createCurrencyInstance( success ); delete nf; |
- * nf = NumberFormat::createPercentInstance( success ); delete nf; |
- * </pre> |
- * \htmlonly</blockquote>\endhtmlonly |
- * Each of these methods has two variants; one with an explicit locale |
- * and one without; the latter using the default locale. |
- * \htmlonly<blockquote>\endhtmlonly |
- * <pre> |
- * nf = NumberFormat::createInstance( myLocale, success ); delete nf; |
- * nf = NumberFormat::createCurrencyInstance( myLocale, success ); delete nf; |
- * nf = NumberFormat::createPercentInstance( myLocale, success ); delete nf; |
- * </pre> |
- * \htmlonly</blockquote>\endhtmlonly |
- * A <code>Locale</code> is the mechanism for identifying the kind of object |
- * (<code>NumberFormat</code>) that you would like to get. The locale is |
- * <STRONG>just</STRONG> a mechanism for identifying objects, |
- * <STRONG>not</STRONG> a container for the objects themselves. |
- * |
- * <P> |
- * Each class that performs locale-sensitive operations allows you |
- * to get all the available objects of that type. You can sift |
- * through these objects by language, country, or variant, |
- * and use the display names to present a menu to the user. |
- * For example, you can create a menu of all the collation objects |
- * suitable for a given language. Such classes implement these |
- * three class methods: |
- * \htmlonly<blockquote>\endhtmlonly |
- * <pre> |
- * static Locale* getAvailableLocales(int32_t& numLocales) |
- * static UnicodeString& getDisplayName(const Locale& objectLocale, |
- * const Locale& displayLocale, |
- * UnicodeString& displayName) |
- * static UnicodeString& getDisplayName(const Locale& objectLocale, |
- * UnicodeString& displayName) |
- * </pre> |
- * \htmlonly</blockquote>\endhtmlonly |
- * |
- * @stable ICU 2.0 |
- * @see ResourceBundle |
- */ |
-U_NAMESPACE_BEGIN |
-class U_COMMON_API Locale : public UObject { |
-public: |
- /** Useful constant for the Root locale. @stable ICU 4.4 */ |
- static const Locale &U_EXPORT2 getRoot(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getEnglish(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getFrench(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getGerman(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getItalian(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getJapanese(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getKorean(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getChinese(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getSimplifiedChinese(void); |
- /** Useful constant for this language. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getTraditionalChinese(void); |
- |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getFrance(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getGermany(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getItaly(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getJapan(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getKorea(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getChina(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getPRC(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getTaiwan(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getUK(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getUS(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getCanada(void); |
- /** Useful constant for this country/region. @stable ICU 2.0 */ |
- static const Locale &U_EXPORT2 getCanadaFrench(void); |
- |
- |
- /** |
- * Construct a default locale object, a Locale for the default locale ID. |
- * |
- * @see getDefault |
- * @see uloc_getDefault |
- * @stable ICU 2.0 |
- */ |
- Locale(); |
- |
- /** |
- * Construct a locale from language, country, variant. |
- * If an error occurs, then the constructed object will be "bogus" |
- * (isBogus() will return TRUE). |
- * |
- * @param language Lowercase two-letter or three-letter ISO-639 code. |
- * This parameter can instead be an ICU style C locale (e.g. "en_US"), |
- * but the other parameters must not be used. |
- * This parameter can be NULL; if so, |
- * the locale is initialized to match the current default locale. |
- * (This is the same as using the default constructor.) |
- * Please note: The Java Locale class does NOT accept the form |
- * 'new Locale("en_US")' but only 'new Locale("en","US")' |
- * |
- * @param country Uppercase two-letter ISO-3166 code. (optional) |
- * @param variant Uppercase vendor and browser specific code. See class |
- * description. (optional) |
- * @param keywordsAndValues A string consisting of keyword/values pairs, such as |
- * "collation=phonebook;currency=euro" |
- * |
- * @see getDefault |
- * @see uloc_getDefault |
- * @stable ICU 2.0 |
- */ |
- Locale( const char * language, |
- const char * country = 0, |
- const char * variant = 0, |
- const char * keywordsAndValues = 0); |
- |
- /** |
- * Initializes a Locale object from another Locale object. |
- * |
- * @param other The Locale object being copied in. |
- * @stable ICU 2.0 |
- */ |
- Locale(const Locale& other); |
- |
- |
- /** |
- * Destructor |
- * @stable ICU 2.0 |
- */ |
- virtual ~Locale() ; |
- |
- /** |
- * Replaces the entire contents of *this with the specified value. |
- * |
- * @param other The Locale object being copied in. |
- * @return *this |
- * @stable ICU 2.0 |
- */ |
- Locale& operator=(const Locale& other); |
- |
- /** |
- * Checks if two locale keys are the same. |
- * |
- * @param other The locale key object to be compared with this. |
- * @return True if the two locale keys are the same, false otherwise. |
- * @stable ICU 2.0 |
- */ |
- UBool operator==(const Locale& other) const; |
- |
- /** |
- * Checks if two locale keys are not the same. |
- * |
- * @param other The locale key object to be compared with this. |
- * @return True if the two locale keys are not the same, false |
- * otherwise. |
- * @stable ICU 2.0 |
- */ |
- UBool operator!=(const Locale& other) const; |
- |
- /** |
- * Clone this object. |
- * Clones can be used concurrently in multiple threads. |
- * If an error occurs, then NULL is returned. |
- * The caller must delete the clone. |
- * |
- * @return a clone of this object |
- * |
- * @see getDynamicClassID |
- * @stable ICU 2.8 |
- */ |
- Locale *clone() const; |
- |
- /** |
- * Common methods of getting the current default Locale. Used for the |
- * presentation: menus, dialogs, etc. Generally set once when your applet or |
- * application is initialized, then never reset. (If you do reset the |
- * default locale, you probably want to reload your GUI, so that the change |
- * is reflected in your interface.) |
- * |
- * More advanced programs will allow users to use different locales for |
- * different fields, e.g. in a spreadsheet. |
- * |
- * Note that the initial setting will match the host system. |
- * @return a reference to the Locale object for the default locale ID |
- * @system |
- * @stable ICU 2.0 |
- */ |
- static const Locale& U_EXPORT2 getDefault(void); |
- |
- /** |
- * Sets the default. Normally set once at the beginning of a process, |
- * then never reset. |
- * setDefault() only changes ICU's default locale ID, <strong>not</strong> |
- * the default locale ID of the runtime environment. |
- * |
- * @param newLocale Locale to set to. If NULL, set to the value obtained |
- * from the runtime environement. |
- * @param success The error code. |
- * @system |
- * @stable ICU 2.0 |
- */ |
- static void U_EXPORT2 setDefault(const Locale& newLocale, |
- UErrorCode& success); |
- |
- /** |
- * Creates a locale which has had minimal canonicalization |
- * as per uloc_getName(). |
- * @param name The name to create from. If name is null, |
- * the default Locale is used. |
- * @return new locale object |
- * @stable ICU 2.0 |
- * @see uloc_getName |
- */ |
- static Locale U_EXPORT2 createFromName(const char *name); |
- |
- /** |
- * Creates a locale from the given string after canonicalizing |
- * the string by calling uloc_canonicalize(). |
- * @param name the locale ID to create from. Must not be NULL. |
- * @return a new locale object corresponding to the given name |
- * @stable ICU 3.0 |
- * @see uloc_canonicalize |
- */ |
- static Locale U_EXPORT2 createCanonical(const char* name); |
- |
- /** |
- * Returns the locale's ISO-639 language code. |
- * @return An alias to the code |
- * @stable ICU 2.0 |
- */ |
- inline const char * getLanguage( ) const; |
- |
- /** |
- * Returns the locale's ISO-15924 abbreviation script code. |
- * @return An alias to the code |
- * @see uscript_getShortName |
- * @see uscript_getCode |
- * @stable ICU 2.8 |
- */ |
- inline const char * getScript( ) const; |
- |
- /** |
- * Returns the locale's ISO-3166 country code. |
- * @return An alias to the code |
- * @stable ICU 2.0 |
- */ |
- inline const char * getCountry( ) const; |
- |
- /** |
- * Returns the locale's variant code. |
- * @return An alias to the code |
- * @stable ICU 2.0 |
- */ |
- inline const char * getVariant( ) const; |
- |
- /** |
- * Returns the programmatic name of the entire locale, with the language, |
- * country and variant separated by underbars. If a field is missing, up |
- * to two leading underbars will occur. Example: "en", "de_DE", "en_US_WIN", |
- * "de__POSIX", "fr__MAC", "__MAC", "_MT", "_FR_EURO" |
- * @return A pointer to "name". |
- * @stable ICU 2.0 |
- */ |
- inline const char * getName() const; |
- |
- /** |
- * Returns the programmatic name of the entire locale as getName would return, |
- * but without keywords. |
- * @return A pointer to "name". |
- * @see getName |
- * @stable ICU 2.8 |
- */ |
- const char * getBaseName() const; |
- |
- |
- /** |
- * Gets the list of keywords for the specified locale. |
- * |
- * @param status the status code |
- * @return pointer to StringEnumeration class, or NULL if there are no keywords. |
- * Client must dispose of it by calling delete. |
- * @stable ICU 2.8 |
- */ |
- StringEnumeration * createKeywords(UErrorCode &status) const; |
- |
- /** |
- * Get the value for a keyword. |
- * |
- * @param keywordName name of the keyword for which we want the value. Case insensitive. |
- * @param buffer The buffer to receive the keyword value. |
- * @param bufferCapacity The capacity of receiving buffer |
- * @param status Returns any error information while performing this operation. |
- * @return the length of the keyword value |
- * |
- * @stable ICU 2.8 |
- */ |
- int32_t getKeywordValue(const char* keywordName, char *buffer, int32_t bufferCapacity, UErrorCode &status) const; |
- |
- /** |
- * Set the value for a keyword. |
- * |
- * @param keywordName name of the keyword to be set. Case insensitive. |
- * @param keywordValue value of the keyword to be set. If 0-length or |
- * NULL, will result in the keyword being removed. No error is given if |
- * that keyword does not exist. |
- * @param status Returns any error information while performing this operation. |
- * |
- * @internal |
- */ |
- void setKeywordValue(const char* keywordName, const char* keywordValue, UErrorCode &status); |
- |
- /** |
- * returns the locale's three-letter language code, as specified |
- * in ISO draft standard ISO-639-2. |
- * @return An alias to the code, or NULL |
- * @stable ICU 2.0 |
- */ |
- const char * getISO3Language() const; |
- |
- /** |
- * Fills in "name" with the locale's three-letter ISO-3166 country code. |
- * @return An alias to the code, or NULL |
- * @stable ICU 2.0 |
- */ |
- const char * getISO3Country() const; |
- |
- /** |
- * Returns the Windows LCID value corresponding to this locale. |
- * This value is stored in the resource data for the locale as a one-to-four-digit |
- * hexadecimal number. If the resource is missing, in the wrong format, or |
- * there is no Windows LCID value that corresponds to this locale, returns 0. |
- * @stable ICU 2.0 |
- */ |
- uint32_t getLCID(void) const; |
- |
- /** |
- * Fills in "dispLang" with the name of this locale's language in a format suitable for |
- * user display in the default locale. For example, if the locale's language code is |
- * "fr" and the default locale's language code is "en", this function would set |
- * dispLang to "French". |
- * @param dispLang Receives the language's display name. |
- * @return A reference to "dispLang". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayLanguage(UnicodeString& dispLang) const; |
- |
- /** |
- * Fills in "dispLang" with the name of this locale's language in a format suitable for |
- * user display in the locale specified by "displayLocale". For example, if the locale's |
- * language code is "en" and displayLocale's language code is "fr", this function would set |
- * dispLang to "Anglais". |
- * @param displayLocale Specifies the locale to be used to display the name. In other words, |
- * if the locale's language code is "en", passing Locale::getFrench() for |
- * displayLocale would result in "Anglais", while passing Locale::getGerman() |
- * for displayLocale would result in "Englisch". |
- * @param dispLang Receives the language's display name. |
- * @return A reference to "dispLang". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayLanguage( const Locale& displayLocale, |
- UnicodeString& dispLang) const; |
- |
- /** |
- * Fills in "dispScript" with the name of this locale's script in a format suitable |
- * for user display in the default locale. For example, if the locale's script code |
- * is "LATN" and the default locale's language code is "en", this function would set |
- * dispScript to "Latin". |
- * @param dispScript Receives the scripts's display name. |
- * @return A reference to "dispScript". |
- * @stable ICU 2.8 |
- */ |
- UnicodeString& getDisplayScript( UnicodeString& dispScript) const; |
- |
- /** |
- * Fills in "dispScript" with the name of this locale's country in a format suitable |
- * for user display in the locale specified by "displayLocale". For example, if the locale's |
- * script code is "LATN" and displayLocale's language code is "en", this function would set |
- * dispScript to "Latin". |
- * @param displayLocale Specifies the locale to be used to display the name. In other |
- * words, if the locale's script code is "LATN", passing |
- * Locale::getFrench() for displayLocale would result in "", while |
- * passing Locale::getGerman() for displayLocale would result in |
- * "". |
- * @param dispScript Receives the scripts's display name. |
- * @return A reference to "dispScript". |
- * @stable ICU 2.8 |
- */ |
- UnicodeString& getDisplayScript( const Locale& displayLocale, |
- UnicodeString& dispScript) const; |
- |
- /** |
- * Fills in "dispCountry" with the name of this locale's country in a format suitable |
- * for user display in the default locale. For example, if the locale's country code |
- * is "FR" and the default locale's language code is "en", this function would set |
- * dispCountry to "France". |
- * @param dispCountry Receives the country's display name. |
- * @return A reference to "dispCountry". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayCountry( UnicodeString& dispCountry) const; |
- |
- /** |
- * Fills in "dispCountry" with the name of this locale's country in a format suitable |
- * for user display in the locale specified by "displayLocale". For example, if the locale's |
- * country code is "US" and displayLocale's language code is "fr", this function would set |
- * dispCountry to "États-Unis". |
- * @param displayLocale Specifies the locale to be used to display the name. In other |
- * words, if the locale's country code is "US", passing |
- * Locale::getFrench() for displayLocale would result in "États-Unis", while |
- * passing Locale::getGerman() for displayLocale would result in |
- * "Vereinigte Staaten". |
- * @param dispCountry Receives the country's display name. |
- * @return A reference to "dispCountry". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayCountry( const Locale& displayLocale, |
- UnicodeString& dispCountry) const; |
- |
- /** |
- * Fills in "dispVar" with the name of this locale's variant code in a format suitable |
- * for user display in the default locale. |
- * @param dispVar Receives the variant's name. |
- * @return A reference to "dispVar". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayVariant( UnicodeString& dispVar) const; |
- |
- /** |
- * Fills in "dispVar" with the name of this locale's variant code in a format |
- * suitable for user display in the locale specified by "displayLocale". |
- * @param displayLocale Specifies the locale to be used to display the name. |
- * @param dispVar Receives the variant's display name. |
- * @return A reference to "dispVar". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayVariant( const Locale& displayLocale, |
- UnicodeString& dispVar) const; |
- |
- /** |
- * Fills in "name" with the name of this locale in a format suitable for user display |
- * in the default locale. This function uses getDisplayLanguage(), getDisplayCountry(), |
- * and getDisplayVariant() to do its work, and outputs the display name in the format |
- * "language (country[,variant])". For example, if the default locale is en_US, then |
- * fr_FR's display name would be "French (France)", and es_MX_Traditional's display name |
- * would be "Spanish (Mexico,Traditional)". |
- * @param name Receives the locale's display name. |
- * @return A reference to "name". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayName( UnicodeString& name) const; |
- |
- /** |
- * Fills in "name" with the name of this locale in a format suitable for user display |
- * in the locale specfied by "displayLocale". This function uses getDisplayLanguage(), |
- * getDisplayCountry(), and getDisplayVariant() to do its work, and outputs the display |
- * name in the format "language (country[,variant])". For example, if displayLocale is |
- * fr_FR, then en_US's display name would be "Anglais (États-Unis)", and no_NO_NY's |
- * display name would be "norvégien (Norvège,NY)". |
- * @param displayLocale Specifies the locale to be used to display the name. |
- * @param name Receives the locale's display name. |
- * @return A reference to "name". |
- * @stable ICU 2.0 |
- */ |
- UnicodeString& getDisplayName( const Locale& displayLocale, |
- UnicodeString& name) const; |
- |
- /** |
- * Generates a hash code for the locale. |
- * @stable ICU 2.0 |
- */ |
- int32_t hashCode(void) const; |
- |
- /** |
- * Sets the locale to bogus |
- * A bogus locale represents a non-existing locale associated |
- * with services that can be instantiated from non-locale data |
- * in addition to locale (for example, collation can be |
- * instantiated from a locale and from a rule set). |
- * @stable ICU 2.1 |
- */ |
- void setToBogus(); |
- |
- /** |
- * Gets the bogus state. Locale object can be bogus if it doesn't exist |
- * @return FALSE if it is a real locale, TRUE if it is a bogus locale |
- * @stable ICU 2.1 |
- */ |
- UBool isBogus(void) const; |
- |
- /** |
- * Returns a list of all installed locales. |
- * @param count Receives the number of locales in the list. |
- * @return A pointer to an array of Locale objects. This array is the list |
- * of all locales with installed resource files. The called does NOT |
- * get ownership of this list, and must NOT delete it. |
- * @stable ICU 2.0 |
- */ |
- static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count); |
- |
- /** |
- * Gets a list of all available 2-letter country codes defined in ISO 3166. This is a |
- * pointer to an array of pointers to arrays of char. All of these pointers are |
- * owned by ICU-- do not delete them, and do not write through them. The array is |
- * terminated with a null pointer. |
- * @return a list of all available country codes |
- * @stable ICU 2.0 |
- */ |
- static const char* const* U_EXPORT2 getISOCountries(); |
- |
- /** |
- * Gets a list of all available language codes defined in ISO 639. This is a pointer |
- * to an array of pointers to arrays of char. All of these pointers are owned |
- * by ICU-- do not delete them, and do not write through them. The array is |
- * terminated with a null pointer. |
- * @return a list of all available language codes |
- * @stable ICU 2.0 |
- */ |
- static const char* const* U_EXPORT2 getISOLanguages(); |
- |
- /** |
- * ICU "poor man's RTTI", returns a UClassID for this class. |
- * |
- * @stable ICU 2.2 |
- */ |
- static UClassID U_EXPORT2 getStaticClassID(); |
- |
- /** |
- * ICU "poor man's RTTI", returns a UClassID for the actual class. |
- * |
- * @stable ICU 2.2 |
- */ |
- virtual UClassID getDynamicClassID() const; |
- |
-protected: /* only protected for testing purposes. DO NOT USE. */ |
- /** |
- * Set this from a single POSIX style locale string. |
- * @internal |
- */ |
- void setFromPOSIXID(const char *posixID); |
- |
-private: |
- /** |
- * Initialize the locale object with a new name. |
- * Was deprecated - used in implementation - moved internal |
- * |
- * @param cLocaleID The new locale name. |
- */ |
- Locale& init(const char* cLocaleID, UBool canonicalize); |
- |
- /* |
- * Internal constructor to allow construction of a locale object with |
- * NO side effects. (Default constructor tries to get |
- * the default locale.) |
- */ |
- enum ELocaleType { |
- eBOGUS |
- }; |
- Locale(ELocaleType); |
- |
- /** |
- * Initialize the locale cache for commonly used locales |
- */ |
- static Locale *getLocaleCache(void); |
- |
- char language[ULOC_LANG_CAPACITY]; |
- char script[ULOC_SCRIPT_CAPACITY]; |
- char country[ULOC_COUNTRY_CAPACITY]; |
- int32_t variantBegin; |
- char* fullName; |
- char fullNameBuffer[ULOC_FULLNAME_CAPACITY]; |
- // name without keywords |
- char* baseName; |
- char baseNameBuffer[ULOC_FULLNAME_CAPACITY]; |
- |
- UBool fIsBogus; |
- |
- static const Locale &getLocale(int locid); |
- |
- /** |
- * A friend to allow the default locale to be set by either the C or C++ API. |
- * @internal |
- */ |
- friend void locale_set_default_internal(const char *); |
-}; |
- |
-inline UBool |
-Locale::operator!=(const Locale& other) const |
-{ |
- return !operator==(other); |
-} |
- |
-inline const char * |
-Locale::getCountry() const |
-{ |
- return country; |
-} |
- |
-inline const char * |
-Locale::getLanguage() const |
-{ |
- return language; |
-} |
- |
-inline const char * |
-Locale::getScript() const |
-{ |
- return script; |
-} |
- |
-inline const char * |
-Locale::getVariant() const |
-{ |
- getBaseName(); // lazy init |
- return &baseName[variantBegin]; |
-} |
- |
-inline const char * |
-Locale::getName() const |
-{ |
- return fullName; |
-} |
- |
-inline UBool |
-Locale::isBogus(void) const { |
- return fIsBogus; |
-} |
- |
-U_NAMESPACE_END |
- |
-#endif |