pg_locale.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	collate_methods
struct	pg_locale_struct

Macros
#define	LOCALE_NAME_BUFLEN   128

Typedefs
typedef struct pg_locale_struct *	pg_locale_t

Functions
bool	check_locale (int category, const char *locale, char **canonname)
char *	pg_perm_setlocale (int category, const char *locale)
struct lconv *	PGLC_localeconv (void)
void	cache_locale_time (void)
void	init_database_collation (void)
pg_locale_t	pg_newlocale_from_collation (Oid collid)
char *	get_collation_actual_version (char collprovider, const char *collcollate)
size_t	pg_strlower (char *dst, size_t dstsize, const char *src, ssize_t srclen, pg_locale_t locale)
size_t	pg_strtitle (char *dst, size_t dstsize, const char *src, ssize_t srclen, pg_locale_t locale)
size_t	pg_strupper (char *dst, size_t dstsize, const char *src, ssize_t srclen, pg_locale_t locale)
size_t	pg_strfold (char *dst, size_t dstsize, const char *src, ssize_t srclen, pg_locale_t locale)
int	pg_strcoll (const char *arg1, const char *arg2, pg_locale_t locale)
int	pg_strncoll (const char *arg1, ssize_t len1, const char *arg2, ssize_t len2, pg_locale_t locale)
bool	pg_strxfrm_enabled (pg_locale_t locale)
size_t	pg_strxfrm (char *dest, const char *src, size_t destsize, pg_locale_t locale)
size_t	pg_strnxfrm (char *dest, size_t destsize, const char *src, ssize_t srclen, pg_locale_t locale)
bool	pg_strxfrm_prefix_enabled (pg_locale_t locale)
size_t	pg_strxfrm_prefix (char *dest, const char *src, size_t destsize, pg_locale_t locale)
size_t	pg_strnxfrm_prefix (char *dest, size_t destsize, const char *src, ssize_t srclen, pg_locale_t locale)
int	builtin_locale_encoding (const char *locale)
const char *	builtin_validate_locale (int encoding, const char *locale)
void	icu_validate_locale (const char *loc_str)
char *	icu_language_tag (const char *loc_str, int elevel)
void	report_newlocale_failure (const char *localename)
size_t	wchar2char (char *to, const wchar_t *from, size_t tolen, pg_locale_t locale)
size_t	char2wchar (wchar_t *to, size_t tolen, const char *from, size_t fromlen, pg_locale_t locale)

Variables
PGDLLIMPORT char *	locale_messages
PGDLLIMPORT char *	locale_monetary
PGDLLIMPORT char *	locale_numeric
PGDLLIMPORT char *	locale_time
PGDLLIMPORT int	icu_validation_level
PGDLLIMPORT char *	localized_abbrev_days []
PGDLLIMPORT char *	localized_full_days []
PGDLLIMPORT char *	localized_abbrev_months []
PGDLLIMPORT char *	localized_full_months []
PGDLLIMPORT bool	database_ctype_is_c

Macro Definition Documentation

LOCALE_NAME_BUFLEN

#define LOCALE_NAME_BUFLEN   128

Definition at line 20 of file pg_locale.h.

Typedef Documentation

pg_locale_t

typedef struct pg_locale_struct* pg_locale_t

Definition at line 51 of file pg_locale.h.

Function Documentation

builtin_locale_encoding()

int builtin_locale_encoding

(

const char *

locale

)

Definition at line 1471 of file pg_locale.c.

{
    if (strcmp(locale, "C") == 0)
        return -1;
    else if (strcmp(locale, "C.UTF-8") == 0)
        return PG_UTF8;
    else if (strcmp(locale, "PG_UNICODE_FAST") == 0)
        return PG_UTF8;
 
 
    ereport(ERROR,
            (errcode(ERRCODE_WRONG_OBJECT_TYPE),
             errmsg("invalid locale name \"%s\" for builtin provider",
                    locale)));
 
    return 0;                   /* keep compiler quiet */
}

References ereport, errcode(), errmsg(), ERROR, locale, and PG_UTF8.

Referenced by builtin_validate_locale(), and DefineCollation().

builtin_validate_locale()

const char * builtin_validate_locale	(	int	encoding,
		const char *	locale
	)

Definition at line 1495 of file pg_locale.c.

{
    const char *canonical_name = NULL;
    int         required_encoding;
 
    if (strcmp(locale, "C") == 0)
        canonical_name = "C";
    else if (strcmp(locale, "C.UTF-8") == 0 || strcmp(locale, "C.UTF8") == 0)
        canonical_name = "C.UTF-8";
    else if (strcmp(locale, "PG_UNICODE_FAST") == 0)
        canonical_name = "PG_UNICODE_FAST";
 
    if (!canonical_name)
        ereport(ERROR,
                (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                 errmsg("invalid locale name \"%s\" for builtin provider",
                        locale)));
 
    required_encoding = builtin_locale_encoding(canonical_name);
    if (required_encoding >= 0 && encoding != required_encoding)
        ereport(ERROR,
                (errcode(ERRCODE_WRONG_OBJECT_TYPE),
                 errmsg("encoding \"%s\" does not match locale \"%s\"",
                        pg_encoding_to_char(encoding), locale)));
 
    return canonical_name;
}

References builtin_locale_encoding(), encoding, ereport, errcode(), errmsg(), ERROR, locale, and pg_encoding_to_char.

Referenced by create_pg_locale_builtin(), createdb(), and DefineCollation().

cache_locale_time()

void cache_locale_time

(

void

)

Definition at line 720 of file pg_locale.c.

{
    char        buf[(2 * 7 + 2 * 12) * MAX_L10N_DATA];
    char       *bufptr;
    time_t      timenow;
    struct tm  *timeinfo;
    struct tm   timeinfobuf;
    bool        strftimefail = false;
    int         encoding;
    int         i;
    locale_t    locale;
 
    /* did we do this already? */
    if (CurrentLCTimeValid)
        return;
 
    elog(DEBUG3, "cache_locale_time() executed; locale: \"%s\"", locale_time);
 
    errno = ENOENT;
#ifdef WIN32
    locale = _create_locale(LC_ALL, locale_time);
    if (locale == (locale_t) 0)
        _dosmaperr(GetLastError());
#else
    locale = newlocale(LC_ALL_MASK, locale_time, (locale_t) 0);
#endif
    if (!locale)
        report_newlocale_failure(locale_time);
 
    /* We use times close to current time as data for strftime(). */
    timenow = time(NULL);
    timeinfo = gmtime_r(&timenow, &timeinfobuf);
 
    /* Store the strftime results in MAX_L10N_DATA-sized portions of buf[] */
    bufptr = buf;
 
    /*
     * MAX_L10N_DATA is sufficient buffer space for every known locale, and
     * POSIX defines no strftime() errors.  (Buffer space exhaustion is not an
     * error.)  An implementation might report errors (e.g. ENOMEM) by
     * returning 0 (or, less plausibly, a negative value) and setting errno.
     * Report errno just in case the implementation did that, but clear it in
     * advance of the calls so we don't emit a stale, unrelated errno.
     */
    errno = 0;
 
    /* localized days */
    for (i = 0; i < 7; i++)
    {
        timeinfo->tm_wday = i;
        if (strftime_l(bufptr, MAX_L10N_DATA, "%a", timeinfo, locale) <= 0)
            strftimefail = true;
        bufptr += MAX_L10N_DATA;
        if (strftime_l(bufptr, MAX_L10N_DATA, "%A", timeinfo, locale) <= 0)
            strftimefail = true;
        bufptr += MAX_L10N_DATA;
    }
 
    /* localized months */
    for (i = 0; i < 12; i++)
    {
        timeinfo->tm_mon = i;
        timeinfo->tm_mday = 1;  /* make sure we don't have invalid date */
        if (strftime_l(bufptr, MAX_L10N_DATA, "%b", timeinfo, locale) <= 0)
            strftimefail = true;
        bufptr += MAX_L10N_DATA;
        if (strftime_l(bufptr, MAX_L10N_DATA, "%B", timeinfo, locale) <= 0)
            strftimefail = true;
        bufptr += MAX_L10N_DATA;
    }
 
#ifdef WIN32
    _free_locale(locale);
#else
    freelocale(locale);
#endif
 
    /*
     * At this point we've done our best to clean up, and can throw errors, or
     * call functions that might throw errors, with a clean conscience.
     */
    if (strftimefail)
        elog(ERROR, "strftime_l() failed");
 
#ifndef WIN32
 
    /*
     * As in PGLC_localeconv(), we must convert strftime()'s output from the
     * encoding implied by LC_TIME to the database encoding.  If we can't
     * identify the LC_TIME encoding, just perform encoding validation.
     */
    encoding = pg_get_encoding_from_locale(locale_time, true);
    if (encoding < 0)
        encoding = PG_SQL_ASCII;
 
#else
 
    /*
     * On Windows, strftime_win32() always returns UTF8 data, so convert from
     * that if necessary.
     */
    encoding = PG_UTF8;
 
#endif                          /* WIN32 */
 
    bufptr = buf;
 
    /* localized days */
    for (i = 0; i < 7; i++)
    {
        cache_single_string(&localized_abbrev_days[i], bufptr, encoding);
        bufptr += MAX_L10N_DATA;
        cache_single_string(&localized_full_days[i], bufptr, encoding);
        bufptr += MAX_L10N_DATA;
    }
    localized_abbrev_days[7] = NULL;
    localized_full_days[7] = NULL;
 
    /* localized months */
    for (i = 0; i < 12; i++)
    {
        cache_single_string(&localized_abbrev_months[i], bufptr, encoding);
        bufptr += MAX_L10N_DATA;
        cache_single_string(&localized_full_months[i], bufptr, encoding);
        bufptr += MAX_L10N_DATA;
    }
    localized_abbrev_months[12] = NULL;
    localized_full_months[12] = NULL;
 
    CurrentLCTimeValid = true;
}

References _dosmaperr(), buf, cache_single_string(), CurrentLCTimeValid, DEBUG3, elog, encoding, ERROR, i, locale, locale_t, locale_time, localized_abbrev_days, localized_abbrev_months, localized_full_days, localized_full_months, MAX_L10N_DATA, pg_get_encoding_from_locale(), PG_SQL_ASCII, PG_UTF8, report_newlocale_failure(), and tm.

Referenced by DCH_from_char(), and DCH_to_char().

char2wchar()

size_t char2wchar	(	wchar_t *	to,
		size_t	tolen,
		const char *	from,
		size_t	fromlen,
		pg_locale_t	locale
	)

Definition at line 936 of file pg_locale_libc.c.

{
    size_t      result;
 
    if (tolen == 0)
        return 0;
 
#ifdef WIN32
    /* See WIN32 "Unicode" comment above */
    if (GetDatabaseEncoding() == PG_UTF8)
    {
        /* Win32 API does not work for zero-length input */
        if (fromlen == 0)
            result = 0;
        else
        {
            result = MultiByteToWideChar(CP_UTF8, 0, from, fromlen, to, tolen - 1);
            /* A zero return is failure */
            if (result == 0)
                result = -1;
        }
 
        if (result != -1)
        {
            Assert(result < tolen);
            /* Append trailing null wchar (MultiByteToWideChar() does not) */
            to[result] = 0;
        }
    }
    else
#endif                          /* WIN32 */
    {
        /* mbstowcs requires ending '\0' */
        char       *str = pnstrdup(from, fromlen);
 
        if (locale == (pg_locale_t) 0)
        {
            /* Use mbstowcs directly for the default locale */
            result = mbstowcs(to, str, tolen);
        }
        else
        {
            /* Use mbstowcs_l for nondefault locales */
            result = mbstowcs_l(to, str, tolen, locale->info.lt);
        }
 
        pfree(str);
    }
 
    if (result == -1)
    {
        /*
         * Invalid multibyte character encountered.  We try to give a useful
         * error message by letting pg_verifymbstr check the string.  But it's
         * possible that the string is OK to us, and not OK to mbstowcs ---
         * this suggests that the LC_CTYPE locale is different from the
         * database encoding.  Give a generic error message if pg_verifymbstr
         * can't find anything wrong.
         */
        pg_verifymbstr(from, fromlen, false);   /* might not return */
        /* but if it does ... */
        ereport(ERROR,
                (errcode(ERRCODE_CHARACTER_NOT_IN_REPERTOIRE),
                 errmsg("invalid multibyte character for locale"),
                 errhint("The server's LC_CTYPE locale is probably incompatible with the database encoding.")));
    }
 
    return result;
}

References Assert(), ereport, errcode(), errhint(), errmsg(), ERROR, GetDatabaseEncoding(), locale, mbstowcs_l(), pfree(), PG_UTF8, pg_verifymbstr(), pnstrdup(), and str.

Referenced by strlower_libc_mb(), strtitle_libc_mb(), strupper_libc_mb(), t_isalnum(), t_isalpha(), and TParserInit().

check_locale()

bool check_locale	(	int	category,
		const char *	locale,
		char **	canonname
	)

Definition at line 293 of file pg_locale.c.

{
    char       *save;
    char       *res;
 
    /* Don't let Windows' non-ASCII locale names in. */
    if (!pg_is_ascii(locale))
    {
        ereport(WARNING,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("locale name \"%s\" contains non-ASCII characters",
                        locale)));
        return false;
    }
 
    if (canonname)
        *canonname = NULL;      /* in case of failure */
 
    save = setlocale(category, NULL);
    if (!save)
        return false;           /* won't happen, we hope */
 
    /* save may be pointing at a modifiable scratch variable, see above. */
    save = pstrdup(save);
 
    /* set the locale with setlocale, to see if it accepts it. */
    res = setlocale(category, locale);
 
    /* save canonical name if requested. */
    if (res && canonname)
        *canonname = pstrdup(res);
 
    /* restore old value. */
    if (!setlocale(category, save))
        elog(WARNING, "failed to restore old locale \"%s\"", save);
    pfree(save);
 
    /* Don't let Windows' non-ASCII locale names out. */
    if (canonname && *canonname && !pg_is_ascii(*canonname))
    {
        ereport(WARNING,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("locale name \"%s\" contains non-ASCII characters",
                        *canonname)));
        pfree(*canonname);
        *canonname = NULL;
        return false;
    }
 
    return (res != NULL);
}

References elog, ereport, errcode(), errmsg(), locale, pfree(), pg_is_ascii(), pstrdup(), setlocale, and WARNING.

Referenced by check_locale_messages(), check_locale_monetary(), check_locale_numeric(), check_locale_time(), and createdb().

get_collation_actual_version()

char * get_collation_actual_version	(	char	collprovider,
		const char *	collcollate
	)

Definition at line 1239 of file pg_locale.c.

{
    char       *collversion = NULL;
 
    if (collprovider == COLLPROVIDER_BUILTIN)
        collversion = get_collation_actual_version_builtin(collcollate);
#ifdef USE_ICU
    else if (collprovider == COLLPROVIDER_ICU)
        collversion = get_collation_actual_version_icu(collcollate);
#endif
    else if (collprovider == COLLPROVIDER_LIBC)
        collversion = get_collation_actual_version_libc(collcollate);
 
    return collversion;
}

References get_collation_actual_version_builtin(), and get_collation_actual_version_libc().

Referenced by AlterCollation(), AlterDatabaseRefreshColl(), CheckMyDatabase(), create_pg_locale(), createdb(), DefineCollation(), pg_collation_actual_version(), pg_database_collation_actual_version(), and pg_import_system_collations().

icu_language_tag()

char * icu_language_tag	(	const char *	loc_str,
		int	elevel
	)

Definition at line 1535 of file pg_locale.c.

{
#ifdef USE_ICU
    UErrorCode  status;
    char       *langtag;
    size_t      buflen = 32;    /* arbitrary starting buffer size */
    const bool  strict = true;
 
    /*
     * A BCP47 language tag doesn't have a clearly-defined upper limit (cf.
     * RFC5646 section 4.4). Additionally, in older ICU versions,
     * uloc_toLanguageTag() doesn't always return the ultimate length on the
     * first call, necessitating a loop.
     */
    langtag = palloc(buflen);
    while (true)
    {
        status = U_ZERO_ERROR;
        uloc_toLanguageTag(loc_str, langtag, buflen, strict, &status);
 
        /* try again if the buffer is not large enough */
        if ((status == U_BUFFER_OVERFLOW_ERROR ||
             status == U_STRING_NOT_TERMINATED_WARNING) &&
            buflen < MaxAllocSize)
        {
            buflen = Min(buflen * 2, MaxAllocSize);
            langtag = repalloc(langtag, buflen);
            continue;
        }
 
        break;
    }
 
    if (U_FAILURE(status))
    {
        pfree(langtag);
 
        if (elevel > 0)
            ereport(elevel,
                    (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                     errmsg("could not convert locale name \"%s\" to language tag: %s",
                            loc_str, u_errorName(status))));
        return NULL;
    }
 
    return langtag;
#else                           /* not USE_ICU */
    ereport(ERROR,
            (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
             errmsg("ICU is not supported in this build")));
    return NULL;                /* keep compiler quiet */
#endif                          /* not USE_ICU */
}

References ereport, errcode(), errmsg(), ERROR, MaxAllocSize, Min, palloc(), pfree(), and repalloc().

Referenced by createdb(), DefineCollation(), and pg_import_system_collations().

icu_validate_locale()

void icu_validate_locale

(

const char *

loc_str

)

Definition at line 1593 of file pg_locale.c.

{
#ifdef USE_ICU
    UCollator  *collator;
    UErrorCode  status;
    char        lang[ULOC_LANG_CAPACITY];
    bool        found = false;
    int         elevel = icu_validation_level;
 
    /* no validation */
    if (elevel < 0)
        return;
 
    /* downgrade to WARNING during pg_upgrade */
    if (IsBinaryUpgrade && elevel > WARNING)
        elevel = WARNING;
 
    /* validate that we can extract the language */
    status = U_ZERO_ERROR;
    uloc_getLanguage(loc_str, lang, ULOC_LANG_CAPACITY, &status);
    if (U_FAILURE(status) || status == U_STRING_NOT_TERMINATED_WARNING)
    {
        ereport(elevel,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("could not get language from ICU locale \"%s\": %s",
                        loc_str, u_errorName(status)),
                 errhint("To disable ICU locale validation, set the parameter \"%s\" to \"%s\".",
                         "icu_validation_level", "disabled")));
        return;
    }
 
    /* check for special language name */
    if (strcmp(lang, "") == 0 ||
        strcmp(lang, "root") == 0 || strcmp(lang, "und") == 0)
        found = true;
 
    /* search for matching language within ICU */
    for (int32_t i = 0; !found && i < uloc_countAvailable(); i++)
    {
        const char *otherloc = uloc_getAvailable(i);
        char        otherlang[ULOC_LANG_CAPACITY];
 
        status = U_ZERO_ERROR;
        uloc_getLanguage(otherloc, otherlang, ULOC_LANG_CAPACITY, &status);
        if (U_FAILURE(status) || status == U_STRING_NOT_TERMINATED_WARNING)
            continue;
 
        if (strcmp(lang, otherlang) == 0)
            found = true;
    }
 
    if (!found)
        ereport(elevel,
                (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
                 errmsg("ICU locale \"%s\" has unknown language \"%s\"",
                        loc_str, lang),
                 errhint("To disable ICU locale validation, set the parameter \"%s\" to \"%s\".",
                         "icu_validation_level", "disabled")));
 
    /* check that it can be opened */
    collator = pg_ucol_open(loc_str);
    ucol_close(collator);
#else                           /* not USE_ICU */
    /* could get here if a collation was created by a build with ICU */
    ereport(ERROR,
            (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
             errmsg("ICU is not supported in this build")));
#endif                          /* not USE_ICU */
}

References ereport, errcode(), errhint(), errmsg(), ERROR, i, icu_validation_level, IsBinaryUpgrade, and WARNING.

Referenced by createdb(), and DefineCollation().

init_database_collation()

void init_database_collation

(

void

)

Definition at line 1146 of file pg_locale.c.

{
    HeapTuple   tup;
    Form_pg_database dbform;
    pg_locale_t result;
 
    Assert(default_locale == NULL);
 
    /* Fetch our pg_database row normally, via syscache */
    tup = SearchSysCache1(DATABASEOID, ObjectIdGetDatum(MyDatabaseId));
    if (!HeapTupleIsValid(tup))
        elog(ERROR, "cache lookup failed for database %u", MyDatabaseId);
    dbform = (Form_pg_database) GETSTRUCT(tup);
 
    if (dbform->datlocprovider == COLLPROVIDER_BUILTIN)
        result = create_pg_locale_builtin(DEFAULT_COLLATION_OID,
                                          TopMemoryContext);
    else if (dbform->datlocprovider == COLLPROVIDER_ICU)
        result = create_pg_locale_icu(DEFAULT_COLLATION_OID,
                                      TopMemoryContext);
    else if (dbform->datlocprovider == COLLPROVIDER_LIBC)
        result = create_pg_locale_libc(DEFAULT_COLLATION_OID,
                                       TopMemoryContext);
    else
        /* shouldn't happen */
        PGLOCALE_SUPPORT_ERROR(dbform->datlocprovider);
 
    result->is_default = true;
    ReleaseSysCache(tup);
 
    default_locale = result;
}

References Assert(), create_pg_locale_builtin(), create_pg_locale_icu(), create_pg_locale_libc(), default_locale, elog, ERROR, GETSTRUCT(), HeapTupleIsValid, pg_locale_struct::is_default, MyDatabaseId, ObjectIdGetDatum(), PGLOCALE_SUPPORT_ERROR, ReleaseSysCache(), SearchSysCache1(), and TopMemoryContext.

Referenced by CheckMyDatabase().

pg_newlocale_from_collation()

pg_locale_t pg_newlocale_from_collation

(

Oid

collid

)

Definition at line 1188 of file pg_locale.c.

{
    collation_cache_entry *cache_entry;
    bool        found;
 
    if (collid == DEFAULT_COLLATION_OID)
        return default_locale;
 
    if (!OidIsValid(collid))
        elog(ERROR, "cache lookup failed for collation %u", collid);
 
    AssertCouldGetRelation();
 
    if (last_collation_cache_oid == collid)
        return last_collation_cache_locale;
 
    if (CollationCache == NULL)
    {
        CollationCacheContext = AllocSetContextCreate(TopMemoryContext,
                                                      "collation cache",
                                                      ALLOCSET_DEFAULT_SIZES);
        CollationCache = collation_cache_create(CollationCacheContext,
                                                16, NULL);
    }
 
    cache_entry = collation_cache_insert(CollationCache, collid, &found);
    if (!found)
    {
        /*
         * Make sure cache entry is marked invalid, in case we fail before
         * setting things.
         */
        cache_entry->locale = 0;
    }
 
    if (cache_entry->locale == 0)
    {
        cache_entry->locale = create_pg_locale(collid, CollationCacheContext);
    }
 
    last_collation_cache_oid = collid;
    last_collation_cache_locale = cache_entry->locale;
 
    return cache_entry->locale;
}

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, AssertCouldGetRelation(), CollationCache, CollationCacheContext, collid, create_pg_locale(), default_locale, elog, ERROR, last_collation_cache_locale, last_collation_cache_oid, collation_cache_entry::locale, OidIsValid, and TopMemoryContext.

Referenced by bpchareq(), bpcharne(), btvarstrequalimage(), convert_string_datum(), DefineCollation(), Generic_Text_IC_like(), GenericMatchText(), hashbpchar(), hashbpcharextended(), hashtext(), hashtextextended(), like_fixed_prefix(), make_greater_string(), match_pattern_prefix(), pg_set_regex_collation(), spg_text_inner_consistent(), str_casefold(), str_initcap(), str_tolower(), str_toupper(), text_position(), text_position_setup(), text_starts_with(), texteq(), textne(), varstr_cmp(), and varstr_sortsupport().

pg_perm_setlocale()

char * pg_perm_setlocale	(	int	category,
		const char *	locale
	)

Definition at line 190 of file pg_locale.c.

{
    char       *result;
    const char *envvar;
 
#ifndef WIN32
    result = setlocale(category, locale);
#else
 
    /*
     * On Windows, setlocale(LC_MESSAGES) does not work, so just assume that
     * the given value is good and set it in the environment variables. We
     * must ignore attempts to set to "", which means "keep using the old
     * environment value".
     */
#ifdef LC_MESSAGES
    if (category == LC_MESSAGES)
    {
        result = (char *) locale;
        if (locale == NULL || locale[0] == '\0')
            return result;
    }
    else
#endif
        result = setlocale(category, locale);
#endif                          /* WIN32 */
 
    if (result == NULL)
        return result;          /* fall out immediately on failure */
 
    /*
     * Use the right encoding in translated messages.  Under ENABLE_NLS, let
     * pg_bind_textdomain_codeset() figure it out.  Under !ENABLE_NLS, message
     * format strings are ASCII, but database-encoding strings may enter the
     * message via %s.  This makes the overall message encoding equal to the
     * database encoding.
     */
    if (category == LC_CTYPE)
    {
        static char save_lc_ctype[LOCALE_NAME_BUFLEN];
 
        /* copy setlocale() return value before callee invokes it again */
        strlcpy(save_lc_ctype, result, sizeof(save_lc_ctype));
        result = save_lc_ctype;
 
#ifdef ENABLE_NLS
        SetMessageEncoding(pg_bind_textdomain_codeset(textdomain(NULL)));
#else
        SetMessageEncoding(GetDatabaseEncoding());
#endif
    }
 
    switch (category)
    {
        case LC_COLLATE:
            envvar = "LC_COLLATE";
            break;
        case LC_CTYPE:
            envvar = "LC_CTYPE";
            break;
#ifdef LC_MESSAGES
        case LC_MESSAGES:
            envvar = "LC_MESSAGES";
#ifdef WIN32
            result = IsoLocaleName(locale);
            if (result == NULL)
                result = (char *) locale;
            elog(DEBUG3, "IsoLocaleName() executed; locale: \"%s\"", result);
#endif                          /* WIN32 */
            break;
#endif                          /* LC_MESSAGES */
        case LC_MONETARY:
            envvar = "LC_MONETARY";
            break;
        case LC_NUMERIC:
            envvar = "LC_NUMERIC";
            break;
        case LC_TIME:
            envvar = "LC_TIME";
            break;
        default:
            elog(FATAL, "unrecognized LC category: %d", category);
            return NULL;        /* keep compiler quiet */
    }
 
    if (setenv(envvar, result, 1) != 0)
        return NULL;
 
    return result;
}

References DEBUG3, elog, FATAL, GetDatabaseEncoding(), locale, LOCALE_NAME_BUFLEN, setenv, setlocale, SetMessageEncoding(), and strlcpy().

Referenced by assign_locale_messages(), CheckMyDatabase(), and init_locale().

pg_strcoll()

int pg_strcoll	(	const char *	arg1,
		const char *	arg2,
		pg_locale_t	locale
	)

Definition at line 1338 of file pg_locale.c.

{
    return locale->collate->strncoll(arg1, -1, arg2, -1, locale);
}

References locale.

Referenced by varstrfastcmp_locale().

pg_strfold()

size_t pg_strfold	(	char *	dst,
		size_t	dstsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1313 of file pg_locale.c.

{
    if (locale->provider == COLLPROVIDER_BUILTIN)
        return strfold_builtin(dst, dstsize, src, srclen, locale);
#ifdef USE_ICU
    else if (locale->provider == COLLPROVIDER_ICU)
        return strfold_icu(dst, dstsize, src, srclen, locale);
#endif
    /* for libc, just use strlower */
    else if (locale->provider == COLLPROVIDER_LIBC)
        return strlower_libc(dst, dstsize, src, srclen, locale);
    else
        /* shouldn't happen */
        PGLOCALE_SUPPORT_ERROR(locale->provider);
 
    return 0;                   /* keep compiler quiet */
}

References locale, PGLOCALE_SUPPORT_ERROR, strfold_builtin(), strfold_icu(), and strlower_libc().

Referenced by str_casefold().

pg_strlower()

size_t pg_strlower	(	char *	dst,
		size_t	dstsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1256 of file pg_locale.c.

{
    if (locale->provider == COLLPROVIDER_BUILTIN)
        return strlower_builtin(dst, dstsize, src, srclen, locale);
#ifdef USE_ICU
    else if (locale->provider == COLLPROVIDER_ICU)
        return strlower_icu(dst, dstsize, src, srclen, locale);
#endif
    else if (locale->provider == COLLPROVIDER_LIBC)
        return strlower_libc(dst, dstsize, src, srclen, locale);
    else
        /* shouldn't happen */
        PGLOCALE_SUPPORT_ERROR(locale->provider);
 
    return 0;                   /* keep compiler quiet */
}

References locale, PGLOCALE_SUPPORT_ERROR, strlower_builtin(), strlower_icu(), and strlower_libc().

Referenced by str_tolower().

pg_strncoll()

int pg_strncoll	(	const char *	arg1,
		ssize_t	len1,
		const char *	arg2,
		ssize_t	len2,
		pg_locale_t	locale
	)

Definition at line 1358 of file pg_locale.c.

{
    return locale->collate->strncoll(arg1, len1, arg2, len2, locale);
}

References locale.

Referenced by MatchText(), text_position_next_internal(), and varstr_cmp().

pg_strnxfrm()

size_t pg_strnxfrm	(	char *	dest,
		size_t	destsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1413 of file pg_locale.c.

{
    return locale->collate->strnxfrm(dest, destsize, src, srclen, locale);
}

References generate_unaccent_rules::dest, and locale.

Referenced by hashbpchar(), hashbpcharextended(), hashtext(), and hashtextextended().

pg_strnxfrm_prefix()

size_t pg_strnxfrm_prefix	(	char *	dest,
		size_t	destsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1460 of file pg_locale.c.

{
    return locale->collate->strnxfrm_prefix(dest, destsize, src, srclen, locale);
}

References generate_unaccent_rules::dest, and locale.

pg_strtitle()

size_t pg_strtitle	(	char *	dst,
		size_t	dstsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1275 of file pg_locale.c.

{
    if (locale->provider == COLLPROVIDER_BUILTIN)
        return strtitle_builtin(dst, dstsize, src, srclen, locale);
#ifdef USE_ICU
    else if (locale->provider == COLLPROVIDER_ICU)
        return strtitle_icu(dst, dstsize, src, srclen, locale);
#endif
    else if (locale->provider == COLLPROVIDER_LIBC)
        return strtitle_libc(dst, dstsize, src, srclen, locale);
    else
        /* shouldn't happen */
        PGLOCALE_SUPPORT_ERROR(locale->provider);
 
    return 0;                   /* keep compiler quiet */
}

References locale, PGLOCALE_SUPPORT_ERROR, strtitle_builtin(), strtitle_icu(), and strtitle_libc().

Referenced by str_initcap().

pg_strupper()

size_t pg_strupper	(	char *	dst,
		size_t	dstsize,
		const char *	src,
		ssize_t	srclen,
		pg_locale_t	locale
	)

Definition at line 1294 of file pg_locale.c.

{
    if (locale->provider == COLLPROVIDER_BUILTIN)
        return strupper_builtin(dst, dstsize, src, srclen, locale);
#ifdef USE_ICU
    else if (locale->provider == COLLPROVIDER_ICU)
        return strupper_icu(dst, dstsize, src, srclen, locale);
#endif
    else if (locale->provider == COLLPROVIDER_LIBC)
        return strupper_libc(dst, dstsize, src, srclen, locale);
    else
        /* shouldn't happen */
        PGLOCALE_SUPPORT_ERROR(locale->provider);
 
    return 0;                   /* keep compiler quiet */
}

References locale, PGLOCALE_SUPPORT_ERROR, strupper_builtin(), strupper_icu(), and strupper_libc().

Referenced by str_toupper().

pg_strxfrm()

size_t pg_strxfrm	(	char *	dest,
		const char *	src,
		size_t	destsize,
		pg_locale_t	locale
	)

Definition at line 1388 of file pg_locale.c.

{
    return locale->collate->strnxfrm(dest, destsize, src, -1, locale);
}

References generate_unaccent_rules::dest, and locale.

Referenced by convert_string_datum(), and varstr_abbrev_convert().

pg_strxfrm_enabled()

bool pg_strxfrm_enabled

(

pg_locale_t

locale

)

Definition at line 1372 of file pg_locale.c.

{
    /*
     * locale->collate->strnxfrm is still a required method, even if it may
     * have the wrong behavior, because the planner uses it for estimates in
     * some cases.
     */
    return locale->collate->strxfrm_is_safe;
}

References locale.

Referenced by varstr_sortsupport().

pg_strxfrm_prefix()

size_t pg_strxfrm_prefix	(	char *	dest,
		const char *	src,
		size_t	destsize,
		pg_locale_t	locale
	)

Definition at line 1435 of file pg_locale.c.

{
    return locale->collate->strnxfrm_prefix(dest, destsize, src, -1, locale);
}

References generate_unaccent_rules::dest, and locale.

Referenced by varstr_abbrev_convert().

pg_strxfrm_prefix_enabled()

bool pg_strxfrm_prefix_enabled

(

pg_locale_t

locale

)

Definition at line 1424 of file pg_locale.c.

{
    return (locale->collate->strnxfrm_prefix != NULL);
}

References locale.

Referenced by varstr_abbrev_convert().

PGLC_localeconv()

struct lconv * PGLC_localeconv

(

void

)

Definition at line 524 of file pg_locale.c.

{
    static struct lconv CurrentLocaleConv;
    static bool CurrentLocaleConvAllocated = false;
    struct lconv *extlconv;
    struct lconv tmp;
    struct lconv worklconv = {0};
 
    /* Did we do it already? */
    if (CurrentLocaleConvValid)
        return &CurrentLocaleConv;
 
    /* Free any already-allocated storage */
    if (CurrentLocaleConvAllocated)
    {
        free_struct_lconv(&CurrentLocaleConv);
        CurrentLocaleConvAllocated = false;
    }
 
    /*
     * Use thread-safe method of obtaining a copy of lconv from the operating
     * system.
     */
    if (pg_localeconv_r(locale_monetary,
                        locale_numeric,
                        &tmp) != 0)
        elog(ERROR,
             "could not get lconv for LC_MONETARY = \"%s\", LC_NUMERIC = \"%s\": %m",
             locale_monetary, locale_numeric);
 
    /* Must copy data now so we can re-encode it. */
    extlconv = &tmp;
    worklconv.decimal_point = strdup(extlconv->decimal_point);
    worklconv.thousands_sep = strdup(extlconv->thousands_sep);
    worklconv.grouping = strdup(extlconv->grouping);
    worklconv.int_curr_symbol = strdup(extlconv->int_curr_symbol);
    worklconv.currency_symbol = strdup(extlconv->currency_symbol);
    worklconv.mon_decimal_point = strdup(extlconv->mon_decimal_point);
    worklconv.mon_thousands_sep = strdup(extlconv->mon_thousands_sep);
    worklconv.mon_grouping = strdup(extlconv->mon_grouping);
    worklconv.positive_sign = strdup(extlconv->positive_sign);
    worklconv.negative_sign = strdup(extlconv->negative_sign);
    /* Copy scalar fields as well */
    worklconv.int_frac_digits = extlconv->int_frac_digits;
    worklconv.frac_digits = extlconv->frac_digits;
    worklconv.p_cs_precedes = extlconv->p_cs_precedes;
    worklconv.p_sep_by_space = extlconv->p_sep_by_space;
    worklconv.n_cs_precedes = extlconv->n_cs_precedes;
    worklconv.n_sep_by_space = extlconv->n_sep_by_space;
    worklconv.p_sign_posn = extlconv->p_sign_posn;
    worklconv.n_sign_posn = extlconv->n_sign_posn;
 
    /* Free the contents of the object populated by pg_localeconv_r(). */
    pg_localeconv_free(&tmp);
 
    /* If any of the preceding strdup calls failed, complain now. */
    if (!struct_lconv_is_valid(&worklconv))
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory")));
 
    PG_TRY();
    {
        int         encoding;
 
        /*
         * Now we must perform encoding conversion from whatever's associated
         * with the locales into the database encoding.  If we can't identify
         * the encoding implied by LC_NUMERIC or LC_MONETARY (ie we get -1),
         * use PG_SQL_ASCII, which will result in just validating that the
         * strings are OK in the database encoding.
         */
        encoding = pg_get_encoding_from_locale(locale_numeric, true);
        if (encoding < 0)
            encoding = PG_SQL_ASCII;
 
        db_encoding_convert(encoding, &worklconv.decimal_point);
        db_encoding_convert(encoding, &worklconv.thousands_sep);
        /* grouping is not text and does not require conversion */
 
        encoding = pg_get_encoding_from_locale(locale_monetary, true);
        if (encoding < 0)
            encoding = PG_SQL_ASCII;
 
        db_encoding_convert(encoding, &worklconv.int_curr_symbol);
        db_encoding_convert(encoding, &worklconv.currency_symbol);
        db_encoding_convert(encoding, &worklconv.mon_decimal_point);
        db_encoding_convert(encoding, &worklconv.mon_thousands_sep);
        /* mon_grouping is not text and does not require conversion */
        db_encoding_convert(encoding, &worklconv.positive_sign);
        db_encoding_convert(encoding, &worklconv.negative_sign);
    }
    PG_CATCH();
    {
        free_struct_lconv(&worklconv);
        PG_RE_THROW();
    }
    PG_END_TRY();
 
    /*
     * Everything is good, so save the results.
     */
    CurrentLocaleConv = worklconv;
    CurrentLocaleConvAllocated = true;
    CurrentLocaleConvValid = true;
    return &CurrentLocaleConv;
}

References CurrentLocaleConvValid, db_encoding_convert(), elog, encoding, ereport, errcode(), errmsg(), ERROR, free_struct_lconv(), locale_monetary, locale_numeric, PG_CATCH, PG_END_TRY, pg_get_encoding_from_locale(), pg_localeconv_free(), pg_localeconv_r(), PG_RE_THROW, PG_SQL_ASCII, PG_TRY, and struct_lconv_is_valid().

Referenced by cash_in(), cash_numeric(), cash_out(), int4_cash(), int8_cash(), NUM_prepare_locale(), and numeric_cash().

report_newlocale_failure()

void report_newlocale_failure

(

const char *

localename

)

Definition at line 804 of file pg_locale_libc.c.

{
    int         save_errno;
 
    /*
     * Windows doesn't provide any useful error indication from
     * _create_locale(), and BSD-derived platforms don't seem to feel they
     * need to set errno either (even though POSIX is pretty clear that
     * newlocale should do so).  So, if errno hasn't been set, assume ENOENT
     * is what to report.
     */
    if (errno == 0)
        errno = ENOENT;
 
    /*
     * ENOENT means "no such locale", not "no such file", so clarify that
     * errno with an errdetail message.
     */
    save_errno = errno;         /* auxiliary funcs might change errno */
    ereport(ERROR,
            (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
             errmsg("could not create locale \"%s\": %m",
                    localename),
             (save_errno == ENOENT ?
              errdetail("The operating system could not find any locale data for the locale name \"%s\".",
                        localename) : 0)));
}

References ereport, errcode(), errdetail(), errmsg(), and ERROR.

Referenced by cache_locale_time(), and make_libc_collator().

wchar2char()

size_t wchar2char	(	char *	to,
		const wchar_t *	from,
		size_t	tolen,
		pg_locale_t	locale
	)

Definition at line 882 of file pg_locale_libc.c.

{
    size_t      result;
 
    if (tolen == 0)
        return 0;
 
#ifdef WIN32
 
    /*
     * On Windows, the "Unicode" locales assume UTF16 not UTF8 encoding, and
     * for some reason mbstowcs and wcstombs won't do this for us, so we use
     * MultiByteToWideChar().
     */
    if (GetDatabaseEncoding() == PG_UTF8)
    {
        result = WideCharToMultiByte(CP_UTF8, 0, from, -1, to, tolen,
                                     NULL, NULL);
        /* A zero return is failure */
        if (result <= 0)
            result = -1;
        else
        {
            Assert(result <= tolen);
            /* Microsoft counts the zero terminator in the result */
            result--;
        }
    }
    else
#endif                          /* WIN32 */
    if (locale == (pg_locale_t) 0)
    {
        /* Use wcstombs directly for the default locale */
        result = wcstombs(to, from, tolen);
    }
    else
    {
        /* Use wcstombs_l for nondefault locales */
        result = wcstombs_l(to, from, tolen, locale->info.lt);
    }
 
    return result;
}

References Assert(), GetDatabaseEncoding(), locale, PG_UTF8, and wcstombs_l().

Referenced by strlower_libc_mb(), strtitle_libc_mb(), and strupper_libc_mb().

Variable Documentation

database_ctype_is_c

PGDLLIMPORT bool database_ctype_is_c

extern

Definition at line 128 of file pg_locale.c.

Referenced by CheckMyDatabase(), t_isalnum(), t_isalpha(), and TParserInit().

icu_validation_level

PGDLLIMPORT int icu_validation_level

extern

Definition at line 113 of file pg_locale.c.

Referenced by createdb(), DefineCollation(), and icu_validate_locale().

locale_messages

PGDLLIMPORT char* locale_messages

extern

Definition at line 108 of file pg_locale.c.

locale_monetary

PGDLLIMPORT char* locale_monetary

extern

Definition at line 109 of file pg_locale.c.

Referenced by PGLC_localeconv().

locale_numeric

PGDLLIMPORT char* locale_numeric

extern

Definition at line 110 of file pg_locale.c.

Referenced by PGLC_localeconv().

locale_time

PGDLLIMPORT char* locale_time

extern

Definition at line 111 of file pg_locale.c.

Referenced by cache_locale_time().

localized_abbrev_days

PGDLLIMPORT char* localized_abbrev_days[]

extern

Definition at line 122 of file pg_locale.c.

Referenced by cache_locale_time(), DCH_from_char(), and DCH_to_char().

localized_abbrev_months

PGDLLIMPORT char* localized_abbrev_months[]

extern

Definition at line 124 of file pg_locale.c.

Referenced by cache_locale_time(), DCH_from_char(), and DCH_to_char().

localized_full_days

PGDLLIMPORT char* localized_full_days[]

extern

Definition at line 123 of file pg_locale.c.

Referenced by cache_locale_time(), DCH_from_char(), and DCH_to_char().

localized_full_months

PGDLLIMPORT char* localized_full_months[]

extern

Definition at line 125 of file pg_locale.c.

Referenced by cache_locale_time(), DCH_from_char(), and DCH_to_char().