ICU 55.1 55.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
locid.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * Copyright (C) 1996-2015, International Business Machines
5 * Corporation and others. All Rights Reserved.
6 *
7 ******************************************************************************
8 *
9 * File locid.h
10 *
11 * Created by: Helena Shih
12 *
13 * Modification History:
14 *
15 * Date Name Description
16 * 02/11/97 aliu Changed gLocPath to fgLocPath and added methods to
17 * get and set it.
18 * 04/02/97 aliu Made operator!= inline; fixed return value of getName().
19 * 04/15/97 aliu Cleanup for AIX/Win32.
20 * 04/24/97 aliu Numerous changes per code review.
21 * 08/18/98 stephen Added tokenizeString(),changed getDisplayName()
22 * 09/08/98 stephen Moved definition of kEmptyString for Mac Port
23 * 11/09/99 weiv Added const char * getName() const;
24 * 04/12/00 srl removing unicodestring api's and cached hash code
25 * 08/10/01 grhoten Change the static Locales to accessor functions
26 ******************************************************************************
27 */
28
29 #ifndef LOCID_H
30 #define LOCID_H
31
32 #include "unicode/utypes.h"
33 #include "unicode/uobject.h"
34 #include "unicode/unistr.h"
35 #include "unicode/putil.h"
36 #include "unicode/uloc.h"
37 #include "unicode/strenum.h"
38
44 U_NAMESPACE_BEGIN
45
46 // Forward Declarations
47 void U_CALLCONV locale_available_init();
185 class U_COMMON_API Locale : public UObject {
186 public:
188 static const Locale &U_EXPORT2 getRoot(void);
190 static const Locale &U_EXPORT2 getEnglish(void);
192 static const Locale &U_EXPORT2 getFrench(void);
194 static const Locale &U_EXPORT2 getGerman(void);
196 static const Locale &U_EXPORT2 getItalian(void);
198 static const Locale &U_EXPORT2 getJapanese(void);
200 static const Locale &U_EXPORT2 getKorean(void);
202 static const Locale &U_EXPORT2 getChinese(void);
204 static const Locale &U_EXPORT2 getSimplifiedChinese(void);
206 static const Locale &U_EXPORT2 getTraditionalChinese(void);
207
209 static const Locale &U_EXPORT2 getFrance(void);
211 static const Locale &U_EXPORT2 getGermany(void);
213 static const Locale &U_EXPORT2 getItaly(void);
215 static const Locale &U_EXPORT2 getJapan(void);
217 static const Locale &U_EXPORT2 getKorea(void);
219 static const Locale &U_EXPORT2 getChina(void);
221 static const Locale &U_EXPORT2 getPRC(void);
223 static const Locale &U_EXPORT2 getTaiwan(void);
225 static const Locale &U_EXPORT2 getUK(void);
227 static const Locale &U_EXPORT2 getUS(void);
229 static const Locale &U_EXPORT2 getCanada(void);
231 static const Locale &U_EXPORT2 getCanadaFrench(void);
232
233
241 Locale();
242
267 Locale( const char * language,
268 const char * country = 0,
269 const char * variant = 0,
270 const char * keywordsAndValues = 0);
271
278 Locale(const Locale& other);
279
280
285 virtual ~Locale() ;
286
294 Locale& operator=(const Locale& other);
295
303 UBool operator==(const Locale& other) const;
304
313 UBool operator!=(const Locale& other) const;
314
326 Locale *clone() const;
327
328 #ifndef U_HIDE_SYSTEM_API
329
344 static const Locale& U_EXPORT2 getDefault(void);
345
358 static void U_EXPORT2 setDefault(const Locale& newLocale,
359 UErrorCode& success);
360 #endif /* U_HIDE_SYSTEM_API */
361
371 static Locale U_EXPORT2 createFromName(const char *name);
372
381 static Locale U_EXPORT2 createCanonical(const char* name);
382
388 inline const char * getLanguage( ) const;
389
397 inline const char * getScript( ) const;
398
404 inline const char * getCountry( ) const;
405
411 inline const char * getVariant( ) const;
412
421 inline const char * getName() const;
422
430 const char * getBaseName() const;
431
432
441 StringEnumeration * createKeywords(UErrorCode &status) const;
442
454 int32_t getKeywordValue(const char* keywordName, char *buffer, int32_t bufferCapacity, UErrorCode &status) const;
455
470 void setKeywordValue(const char* keywordName, const char* keywordValue, UErrorCode &status);
471
478 const char * getISO3Language() const;
479
485 const char * getISO3Country() const;
486
494 uint32_t getLCID(void) const;
495
496 #ifndef U_HIDE_DRAFT_API
497
510 UBool isRightToLeft() const;
511 #endif /* U_HIDE_DRAFT_API */
512
522 UnicodeString& getDisplayLanguage(UnicodeString& dispLang) const;
523
537 UnicodeString& getDisplayLanguage( const Locale& displayLocale,
538 UnicodeString& dispLang) const;
539
549 UnicodeString& getDisplayScript( UnicodeString& dispScript) const;
550
565 UnicodeString& getDisplayScript( const Locale& displayLocale,
566 UnicodeString& dispScript) const;
567
577 UnicodeString& getDisplayCountry( UnicodeString& dispCountry) const;
578
593 UnicodeString& getDisplayCountry( const Locale& displayLocale,
594 UnicodeString& dispCountry) const;
595
603 UnicodeString& getDisplayVariant( UnicodeString& dispVar) const;
604
613 UnicodeString& getDisplayVariant( const Locale& displayLocale,
614 UnicodeString& dispVar) const;
615
627 UnicodeString& getDisplayName( UnicodeString& name) const;
628
641 UnicodeString& getDisplayName( const Locale& displayLocale,
642 UnicodeString& name) const;
643
648 int32_t hashCode(void) const;
649
658 void setToBogus();
659
665 UBool isBogus(void) const;
666
675 static const Locale* U_EXPORT2 getAvailableLocales(int32_t& count);
676
685 static const char* const* U_EXPORT2 getISOCountries();
686
695 static const char* const* U_EXPORT2 getISOLanguages();
696
702 static UClassID U_EXPORT2 getStaticClassID();
703
709 virtual UClassID getDynamicClassID() const;
710
711 protected: /* only protected for testing purposes. DO NOT USE. */
712 #ifndef U_HIDE_INTERNAL_API
713
717 void setFromPOSIXID(const char *posixID);
718 #endif /* U_HIDE_INTERNAL_API */
719
720 private:
728 Locale& init(const char* cLocaleID, UBool canonicalize);
729
730 /*
731 * Internal constructor to allow construction of a locale object with
732 * NO side effects. (Default constructor tries to get
733 * the default locale.)
734 */
735 enum ELocaleType {
736 eBOGUS
737 };
738 Locale(ELocaleType);
739
743 static Locale *getLocaleCache(void);
744
745 char language[ULOC_LANG_CAPACITY];
746 char script[ULOC_SCRIPT_CAPACITY];
747 char country[ULOC_COUNTRY_CAPACITY];
748 int32_t variantBegin;
749 char* fullName;
750 char fullNameBuffer[ULOC_FULLNAME_CAPACITY];
751 // name without keywords
752 char* baseName;
753 void initBaseName(UErrorCode& status);
754
755 UBool fIsBogus;
756
757 static const Locale &getLocale(int locid);
758
763 friend Locale *locale_set_default_internal(const char *, UErrorCode& status);
764
768 friend void U_CALLCONV locale_available_init();
769 };
770
771 inline UBool
772 Locale::operator!=(const Locale& other) const
773 {
774 return !operator==(other);
775 }
776
777 inline const char *
778 Locale::getCountry() const
779 {
780 return country;
781 }
782
783 inline const char *
784 Locale::getLanguage() const
785 {
786 return language;
787 }
788
789 inline const char *
790 Locale::getScript() const
791 {
792 return script;
793 }
794
795 inline const char *
796 Locale::getVariant() const
797 {
798 return &baseName[variantBegin];
799 }
800
801 inline const char *
802 Locale::getName() const
803 {
804 return fullName;
805 }
806
807 inline UBool
808 Locale::isBogus(void) const {
809 return fIsBogus;
810 }
811
812 U_NAMESPACE_END
813
814 #endif