uloc.h

Go to the documentation of this file.

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
*   Copyright (C) 1997-2016, International Business Machines
*   Corporation and others.  All Rights Reserved.
**********************************************************************
*
* File ULOC.H
*
* Modification History:
*
*   Date        Name        Description
*   04/01/97    aliu        Creation.
*   08/22/98    stephen     JDK 1.2 sync.
*   12/08/98    rtg         New C API for Locale
*   03/30/99    damiba      overhaul
*   03/31/99    helena      Javadoc for uloc functions.
*   04/15/99    Madhu       Updated Javadoc
********************************************************************************
*/

#ifndef ULOC_H
#define ULOC_H

#include "unicode/utypes.h"
#include "unicode/uenum.h"

#define ULOC_CHINESE            "zh"

#define ULOC_ENGLISH            "en"

#define ULOC_FRENCH             "fr"

#define ULOC_GERMAN             "de"

#define ULOC_ITALIAN            "it"

#define ULOC_JAPANESE           "ja"

#define ULOC_KOREAN             "ko"

#define ULOC_SIMPLIFIED_CHINESE "zh_CN"

#define ULOC_TRADITIONAL_CHINESE "zh_TW"

#define ULOC_CANADA         "en_CA"

#define ULOC_CANADA_FRENCH  "fr_CA"

#define ULOC_CHINA          "zh_CN"

#define ULOC_PRC            "zh_CN"

#define ULOC_FRANCE         "fr_FR"

#define ULOC_GERMANY        "de_DE"

#define ULOC_ITALY          "it_IT"

#define ULOC_JAPAN          "ja_JP"

#define ULOC_KOREA          "ko_KR"

#define ULOC_TAIWAN         "zh_TW"

#define ULOC_UK             "en_GB"

#define ULOC_US             "en_US"

#define ULOC_LANG_CAPACITY 12

#define ULOC_COUNTRY_CAPACITY 4

#define ULOC_FULLNAME_CAPACITY 157

#define ULOC_SCRIPT_CAPACITY 6

#define ULOC_KEYWORDS_CAPACITY 96

#define ULOC_KEYWORD_AND_VALUES_CAPACITY 100

#define ULOC_KEYWORD_SEPARATOR '@'

#define ULOC_KEYWORD_SEPARATOR_UNICODE 0x40

#define ULOC_KEYWORD_ASSIGN '='

#define ULOC_KEYWORD_ASSIGN_UNICODE 0x3D

#define ULOC_KEYWORD_ITEM_SEPARATOR ';'

#define ULOC_KEYWORD_ITEM_SEPARATOR_UNICODE 0x3B

typedef enum {
  ULOC_ACTUAL_LOCALE    = 0,
  ULOC_VALID_LOCALE    = 1,

#ifndef U_HIDE_DEPRECATED_API

  ULOC_REQUESTED_LOCALE = 2,

    ULOC_DATA_LOCALE_TYPE_LIMIT = 3
#endif  // U_HIDE_DEPRECATED_API
} ULocDataLocaleType;

#ifndef U_HIDE_SYSTEM_API

U_STABLE const char* U_EXPORT2
uloc_getDefault(void);

U_STABLE void U_EXPORT2
uloc_setDefault(const char* localeID,
        UErrorCode*       status);
#endif  /* U_HIDE_SYSTEM_API */

U_STABLE int32_t U_EXPORT2
uloc_getLanguage(const char*    localeID,
         char* language,
         int32_t languageCapacity,
         UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_getScript(const char*    localeID,
         char* script,
         int32_t scriptCapacity,
         UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_getCountry(const char*    localeID,
        char* country,
        int32_t countryCapacity,
        UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_getVariant(const char*    localeID,
        char* variant,
        int32_t variantCapacity,
        UErrorCode* err);


U_STABLE int32_t U_EXPORT2
uloc_getName(const char*    localeID,
         char* name,
         int32_t nameCapacity,
         UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_canonicalize(const char*    localeID,
         char* name,
         int32_t nameCapacity,
         UErrorCode* err);

U_STABLE const char* U_EXPORT2
uloc_getISO3Language(const char* localeID);


U_STABLE const char* U_EXPORT2
uloc_getISO3Country(const char* localeID);

U_STABLE uint32_t U_EXPORT2
uloc_getLCID(const char* localeID);

U_STABLE int32_t U_EXPORT2
uloc_getDisplayLanguage(const char* locale,
            const char* displayLocale,
            UChar* language,
            int32_t languageCapacity,
            UErrorCode* status);

U_STABLE int32_t U_EXPORT2
uloc_getDisplayScript(const char* locale,
            const char* displayLocale,
            UChar* script,
            int32_t scriptCapacity,
            UErrorCode* status);

U_STABLE int32_t U_EXPORT2
uloc_getDisplayCountry(const char* locale,
                       const char* displayLocale,
                       UChar* country,
                       int32_t countryCapacity,
                       UErrorCode* status);


U_STABLE int32_t U_EXPORT2
uloc_getDisplayVariant(const char* locale,
                       const char* displayLocale,
                       UChar* variant,
                       int32_t variantCapacity,
                       UErrorCode* status);

U_STABLE int32_t U_EXPORT2
uloc_getDisplayKeyword(const char* keyword,
                       const char* displayLocale,
                       UChar* dest,
                       int32_t destCapacity,
                       UErrorCode* status);
U_STABLE int32_t U_EXPORT2
uloc_getDisplayKeywordValue(   const char* locale,
                               const char* keyword,
                               const char* displayLocale,
                               UChar* dest,
                               int32_t destCapacity,
                               UErrorCode* status);
U_STABLE int32_t U_EXPORT2
uloc_getDisplayName(const char* localeID,
            const char* inLocaleID,
            UChar* result,
            int32_t maxResultSize,
            UErrorCode* err);


U_STABLE const char* U_EXPORT2
uloc_getAvailable(int32_t n);

U_STABLE int32_t U_EXPORT2 uloc_countAvailable(void);

#ifndef U_HIDE_DRAFT_API

typedef enum ULocAvailableType {
  ULOC_AVAILABLE_DEFAULT,

  ULOC_AVAILABLE_ONLY_LEGACY_ALIASES,

  ULOC_AVAILABLE_WITH_LEGACY_ALIASES,

#ifndef U_HIDE_INTERNAL_API

  ULOC_AVAILABLE_COUNT
#endif
} ULocAvailableType;

U_DRAFT UEnumeration* U_EXPORT2
uloc_openAvailableByType(ULocAvailableType type, UErrorCode* status);

#endif // U_HIDE_DRAFT_API

U_STABLE const char* const* U_EXPORT2
uloc_getISOLanguages(void);

U_STABLE const char* const* U_EXPORT2
uloc_getISOCountries(void);

U_STABLE int32_t U_EXPORT2
uloc_getParent(const char*    localeID,
                 char* parent,
                 int32_t parentCapacity,
                 UErrorCode* err);




U_STABLE int32_t U_EXPORT2
uloc_getBaseName(const char*    localeID,
         char* name,
         int32_t nameCapacity,
         UErrorCode* err);

U_STABLE UEnumeration* U_EXPORT2
uloc_openKeywords(const char* localeID,
                        UErrorCode* status);

U_STABLE int32_t U_EXPORT2
uloc_getKeywordValue(const char* localeID,
                     const char* keywordName,
                     char* buffer, int32_t bufferCapacity,
                     UErrorCode* status);


U_STABLE int32_t U_EXPORT2
uloc_setKeywordValue(const char* keywordName,
                     const char* keywordValue,
                     char* buffer, int32_t bufferCapacity,
                     UErrorCode* status);

U_STABLE UBool U_EXPORT2
uloc_isRightToLeft(const char *locale);

typedef enum {
  ULOC_LAYOUT_LTR   = 0,  /* left-to-right. */
  ULOC_LAYOUT_RTL    = 1,  /* right-to-left. */
  ULOC_LAYOUT_TTB    = 2,  /* top-to-bottom. */
  ULOC_LAYOUT_BTT    = 3,   /* bottom-to-top. */
  ULOC_LAYOUT_UNKNOWN
} ULayoutType;

U_STABLE ULayoutType U_EXPORT2
uloc_getCharacterOrientation(const char* localeId,
                             UErrorCode *status);

U_STABLE ULayoutType U_EXPORT2
uloc_getLineOrientation(const char* localeId,
                        UErrorCode *status);

typedef enum {
  ULOC_ACCEPT_FAILED   = 0,  /* No exact match was found. */
  ULOC_ACCEPT_VALID    = 1,  /* An exact match was found. */
  ULOC_ACCEPT_FALLBACK = 2   /* A fallback was found, for example, 
                                Accept list contained 'ja_JP'
                                which matched available locale 'ja'. */
} UAcceptResult;


U_STABLE int32_t U_EXPORT2
uloc_acceptLanguageFromHTTP(char *result, int32_t resultAvailable,
                            UAcceptResult *outResult,
                            const char *httpAcceptLanguage,
                            UEnumeration* availableLocales,
                            UErrorCode *status);

U_STABLE int32_t U_EXPORT2
uloc_acceptLanguage(char *result, int32_t resultAvailable, 
                    UAcceptResult *outResult, const char **acceptList,
                    int32_t acceptListCount,
                    UEnumeration* availableLocales,
                    UErrorCode *status);


U_STABLE int32_t U_EXPORT2
uloc_getLocaleForLCID(uint32_t hostID, char *locale, int32_t localeCapacity,
                    UErrorCode *status);


U_STABLE int32_t U_EXPORT2
uloc_addLikelySubtags(const char*    localeID,
         char* maximizedLocaleID,
         int32_t maximizedLocaleIDCapacity,
         UErrorCode* err);


U_STABLE int32_t U_EXPORT2
uloc_minimizeSubtags(const char*    localeID,
         char* minimizedLocaleID,
         int32_t minimizedLocaleIDCapacity,
         UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_forLanguageTag(const char* langtag,
                    char* localeID,
                    int32_t localeIDCapacity,
                    int32_t* parsedLength,
                    UErrorCode* err);

U_STABLE int32_t U_EXPORT2
uloc_toLanguageTag(const char* localeID,
                   char* langtag,
                   int32_t langtagCapacity,
                   UBool strict,
                   UErrorCode* err);

U_STABLE const char* U_EXPORT2
uloc_toUnicodeLocaleKey(const char* keyword);

U_STABLE const char* U_EXPORT2
uloc_toUnicodeLocaleType(const char* keyword, const char* value);

U_STABLE const char* U_EXPORT2
uloc_toLegacyKey(const char* keyword);

U_STABLE const char* U_EXPORT2
uloc_toLegacyType(const char* keyword, const char* value);

#endif /*_ULOC*/