* in such scope than if not. However, various libc functions called by Perl
* are affected by the LC_NUMERIC category, so there are macros in perl.h that
* are used to toggle between the current locale and the C locale depending on
- * the desired behavior of those functions at the moment.
+ * the desired behavior of those functions at the moment. And, LC_MESSAGES is
+ * switched to the C locale for outputting the message unless within the scope
+ * of 'use locale'.
*/
#include "EXTERN.h"
else
PL_numeric_radix_sv = NULL;
- DEBUG_L(PerlIO_printf(Perl_debug_log, "Locale radix is %s\n",
+ DEBUG_L(PerlIO_printf(Perl_debug_log, "Locale radix is '%s', ?UTF-8=%d\n",
(PL_numeric_radix_sv)
- ? lc->decimal_point
- : "NULL"));
+ ? SvPVX(PL_numeric_radix_sv)
+ : "NULL",
+ (PL_numeric_radix_sv)
+ ? cBOOL(SvUTF8(PL_numeric_radix_sv))
+ : 0));
# endif /* HAS_LOCALECONV */
#endif /* USE_LOCALE_NUMERIC */
}
save_newnum = stdize_locale(savepv(newnum));
+
+ PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
+ PL_numeric_local = TRUE;
+
if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
Safefree(PL_numeric_name);
PL_numeric_name = save_newnum;
}
-
- PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
- PL_numeric_local = TRUE;
+ else {
+ Safefree(save_newnum);
+ }
/* Keep LC_NUMERIC in the C locale. This is for XS modules, so they don't
* have to worry about the radix being a non-dot. (Core operations that
#ifdef MB_CUR_MAX
/* We only handle single-byte locales (outside of UTF-8 ones; so if
- * this locale requires than one byte, there are going to be
+ * this locale requires more than one byte, there are going to be
* problems. */
if (check_for_problems && MB_CUR_MAX > 1
* Any code changing the locale (outside this file) should use
* POSIX::setlocale, which calls this function. Therefore this function
* should be called directly only from this file and from
- * POSIX::setlocale() */
+ * POSIX::setlocale().
+ *
+ * The design of locale collation is that every locale change is given an
+ * index 'PL_collation_ix'. The first time a string particpates in an
+ * operation that requires collation while locale collation is active, it
+ * is given PERL_MAGIC_collxfrm magic (via sv_collxfrm_flags()). That
+ * magic includes the collation index, and the transformation of the string
+ * by strxfrm(), q.v. That transformation is used when doing comparisons,
+ * instead of the string itself. If a string changes, the magic is
+ * cleared. The next time the locale changes, the index is incremented,
+ * and so we know during a comparison that the transformation is not
+ * necessarily still valid, and so is recomputed. Note that if the locale
+ * changes enough times, the index could wrap (a U32), and it is possible
+ * that a transformation would improperly be considered valid, leading to
+ * an unlikely bug */
if (! newcoll) {
if (PL_collation_name) {
return;
}
+ /* If this is not the same locale as currently, set the new one up */
if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
++PL_collation_ix;
Safefree(PL_collation_name);
PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
{
+ /* A locale collation definition includes primary, secondary,
+ * tertiary, etc. weights for each character. To sort, the primary
+ * weights are used, and only if they compare equal, then the
+ * secondary weights are used, and only if they compare equal, then
+ * the tertiary, etc. strxfrm() works by taking the input string,
+ * say ABC, and creating an output string consisting of first the
+ * primary weights, A¹B¹C¹ followed by the secondary ones, A²B²C²;
+ * and then the tertiary, etc, yielding A¹B¹C¹A²B²C²A³B³C³....
+ * Some characters may not have weights at every level. In our
+ * example, let's say B doesn't have a tertiary weight, and A
+ * doesn't have a secondary weight. The constructed string is then
+ * going to be A¹B¹C¹B²C²A³C³.... This has the desired
+ * characteristics that strcmp() will look at the secondary or
+ * tertiary weights only if the strings compare equal at all higher
+ * priority weights. The length of the transformed string is
+ * roughly a linear function of the input string. It's not exactly
+ * linear because some characters don't have weights at all levels,
+ * and there are some complications, so there is often per-string
+ * overhead. When we call strxfrm() we have to allocate some
+ * memory to hold the transformed string. The calculations below
+ * try to find constants for this locale 'm' and 'b' so that m*x +
+ * b equals how much space we need given the size of the input
+ * string in 'x'. If we calculate too small, we increase the size
+ * as needed, and call strxfrm() again, but it is better to get it
+ * right the first time to avoid wasted expensive string
+ * transformations. */
/* 2: at most so many chars ('a', 'b'). */
/* 50: surely no system expands a char more. */
#define XFRMBUFSIZE (2 * 50)
}
result = setlocale(category, locale);
+ DEBUG_L(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n", __FILE__, __LINE__,
+ _setlocale_debug_string(category, locale, result)));
if (! override_LC_ALL) {
return result;
result = PerlEnv_getenv("LC_TIME");
if (result && strNE(result, "")) {
setlocale(LC_TIME, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_TIME, result, "not captured")));
}
# endif
# ifdef USE_LOCALE_CTYPE
result = PerlEnv_getenv("LC_CTYPE");
if (result && strNE(result, "")) {
setlocale(LC_CTYPE, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_CTYPE, result, "not captured")));
}
# endif
# ifdef USE_LOCALE_COLLATE
result = PerlEnv_getenv("LC_COLLATE");
if (result && strNE(result, "")) {
setlocale(LC_COLLATE, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_COLLATE, result, "not captured")));
}
# endif
# ifdef USE_LOCALE_MONETARY
result = PerlEnv_getenv("LC_MONETARY");
if (result && strNE(result, "")) {
setlocale(LC_MONETARY, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_MONETARY, result, "not captured")));
}
# endif
# ifdef USE_LOCALE_NUMERIC
result = PerlEnv_getenv("LC_NUMERIC");
if (result && strNE(result, "")) {
setlocale(LC_NUMERIC, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_NUMERIC, result, "not captured")));
}
# endif
# ifdef USE_LOCALE_MESSAGES
result = PerlEnv_getenv("LC_MESSAGES");
if (result && strNE(result, "")) {
setlocale(LC_MESSAGES, result);
+ DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_MESSAGES, result, "not captured")));
}
# endif
- return setlocale(LC_ALL, NULL);
+ result = setlocale(LC_ALL, NULL);
+ DEBUG_L(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
+ __FILE__, __LINE__,
+ _setlocale_debug_string(LC_ALL, NULL, result)));
+ return result;
}
#endif
* 1 = set ok or not applicable,
* 0 = fallback to a locale of lower priority
* -1 = fallback to all locales failed, not even to the C locale
- */
+ *
+ * Under -DDEBUGGING, if the environment variable PERL_DEBUG_LOCALE_INIT is
+ * set, debugging information is output.
+ *
+ * This looks more complicated than it is, mainly due to the #ifdefs.
+ *
+ * We try to set LC_ALL to the value determined by the environment. If
+ * there is no LC_ALL on this platform, we try the individual categories we
+ * know about. If this works, we are done.
+ *
+ * But if it doesn't work, we have to do something else. We search the
+ * environment variables ourselves instead of relying on the system to do
+ * it. We look at, in order, LC_ALL, LANG, a system default locale (if we
+ * think there is one), and the ultimate fallback "C". This is all done in
+ * the same loop as above to avoid duplicating code, but it makes things
+ * more complex. After the original failure, we add the fallback
+ * possibilities to the list of locales to try, and iterate the loop
+ * through them all until one succeeds.
+ *
+ * On Ultrix, the locale MUST come from the environment, so there is
+ * preliminary code to set it. I (khw) am not sure that it is necessary,
+ * and that this couldn't be folded into the loop, but barring any real
+ * platforms to test on, it's staying as-is
+ *
+ * A slight complication is that in embedded Perls, the locale may already
+ * be set-up, and we don't want to get it from the normal environment
+ * variables. This is handled by having a special environment variable
+ * indicate we're in this situation. We simply set setlocale's 2nd
+ * parameter to be a NULL instead of "". That indicates to setlocale that
+ * it is not to change anything, but to return the current value,
+ * effectively initializing perl's db to what the locale already is.
+ *
+ * We play the same trick with NULL if a LC_ALL succeeds. We call
+ * setlocale() on the individual categores with NULL to get their existing
+ * values for our db, instead of trying to change them.
+ * */
int ok = 1;
const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
? NULL
: "";
+#ifdef DEBUGGING
+ const bool debug = (PerlEnv_getenv("PERL_DEBUG_LOCALE_INIT"))
+ ? TRUE
+ : FALSE;
+# define DEBUG_LOCALE_INIT(category, locale, result) \
+ STMT_START { \
+ if (debug) { \
+ PerlIO_printf(Perl_debug_log, \
+ "%s:%d: %s\n", \
+ __FILE__, __LINE__, \
+ _setlocale_debug_string(category, \
+ locale, \
+ result)); \
+ } \
+ } STMT_END
+#else
+# define DEBUG_LOCALE_INIT(a,b,c)
+#endif
const char* trial_locales[5]; /* 5 = 1 each for "", LC_ALL, LANG, "", C */
unsigned int trial_locales_count;
const char * const lc_all = savepv(PerlEnv_getenv("LC_ALL"));
*bad_lang_use_once
&& strNE("0", bad_lang_use_once)))));
bool done = FALSE;
+ char * sl_result; /* return from setlocale() */
+ char * locale_param;
#ifdef WIN32
/* In some systems you can find out the system default locale
* and use that as the fallback locale. */
#ifndef LOCALE_ENVIRON_REQUIRED
PERL_UNUSED_VAR(done);
+ PERL_UNUSED_VAR(locale_param);
#else
/*
# ifdef LC_ALL
if (lang) {
- if (my_setlocale(LC_ALL, setlocale_init))
+ sl_result = my_setlocale(LC_ALL, setlocale_init);
+ DEBUG_LOCALE_INIT(LC_ALL, setlocale_init, sl_result);
+ if (sl_result)
done = TRUE;
else
setlocale_failure = TRUE;
}
- if (!setlocale_failure) {
+ if (! setlocale_failure) {
# ifdef USE_LOCALE_CTYPE
- if (! (curctype =
- my_setlocale(LC_CTYPE,
- (!done && (lang || PerlEnv_getenv("LC_CTYPE")))
- ? setlocale_init : NULL)))
+ locale_param = (! done && (lang || PerlEnv_getenv("LC_CTYPE")))
+ ? setlocale_init
+ : NULL;
+ curctype = my_setlocale(LC_CTYPE, locale_param);
+ DEBUG_LOCALE_INIT(LC_CTYPE, locale_param, sl_result);
+ if (! curctype)
setlocale_failure = TRUE;
else
curctype = savepv(curctype);
# endif /* USE_LOCALE_CTYPE */
# ifdef USE_LOCALE_COLLATE
- if (! (curcoll =
- my_setlocale(LC_COLLATE,
- (!done && (lang || PerlEnv_getenv("LC_COLLATE")))
- ? setlocale_init : NULL)))
+ locale_param = (! done && (lang || PerlEnv_getenv("LC_COLLATE")))
+ ? setlocale_init
+ : NULL;
+ curcoll = my_setlocale(LC_COLLATE, locale_param);
+ DEBUG_LOCALE_INIT(LC_COLLATE, locale_param, sl_result);
+ if (! curcoll)
setlocale_failure = TRUE;
else
curcoll = savepv(curcoll);
# endif /* USE_LOCALE_COLLATE */
# ifdef USE_LOCALE_NUMERIC
- if (! (curnum =
- my_setlocale(LC_NUMERIC,
- (!done && (lang || PerlEnv_getenv("LC_NUMERIC")))
- ? setlocale_init : NULL)))
+ locale_param = (! done && (lang || PerlEnv_getenv("LC_NUMERIC")))
+ ? setlocale_init
+ : NULL;
+ curnum = my_setlocale(LC_NUMERIC, locale_param);
+ DEBUG_LOCALE_INIT(LC_NUMERIC, locale_param, sl_result);
+ if (! curnum)
setlocale_failure = TRUE;
else
curnum = savepv(curnum);
# endif /* USE_LOCALE_NUMERIC */
# ifdef USE_LOCALE_MESSAGES
- if (! my_setlocale(LC_MESSAGES,
- (!done && (lang || PerlEnv_getenv("LC_MESSAGES")))
- ? setlocale_init : NULL))
- {
+ locale_param = (! done && (lang || PerlEnv_getenv("LC_MESSAGES")))
+ ? setlocale_init
+ : NULL;
+ sl_result = my_setlocale(LC_MESSAGES, locale_param);
+ DEBUG_LOCALE_INIT(LC_MESSAGES, locale_param, sl_result);
+ if (! sl_result)
setlocale_failure = TRUE;
}
# endif /* USE_LOCALE_MESSAGES */
# ifdef USE_LOCALE_MONETARY
- if (! my_setlocale(LC_MONETARY,
- (!done && (lang || PerlEnv_getenv("LC_MONETARY")))
- ? setlocale_init : NULL))
- {
+ locale_param = (! done && (lang || PerlEnv_getenv("LC_MONETARY")))
+ ? setlocale_init
+ : NULL;
+ sl_result = my_setlocale(LC_MONETARY, locale_param);
+ DEBUG_LOCALE_INIT(LC_MONETARY, locale_param, sl_result);
+ if (! sl_result) {
setlocale_failure = TRUE;
}
# endif /* USE_LOCALE_MONETARY */
/* Note that this may change the locale, but we are going to do
* that anyway just below */
system_default_locale = setlocale(LC_ALL, "");
+ DEBUG_LOCALE_INIT(LC_ALL, "", system_default_locale);
/* Skip if invalid or it's already on the list of locales to
* try */
}
#ifdef LC_ALL
- if (! my_setlocale(LC_ALL, trial_locale)) {
+ sl_result = my_setlocale(LC_ALL, trial_locale);
+ DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result);
+ if (! sl_result) {
setlocale_failure = TRUE;
}
else {
if (!setlocale_failure) {
#ifdef USE_LOCALE_CTYPE
Safefree(curctype);
- if (! (curctype = my_setlocale(LC_CTYPE, trial_locale)))
+ curctype = my_setlocale(LC_CTYPE, trial_locale);
+ DEBUG_LOCALE_INIT(LC_CTYPE, trial_locale, curctype);
+ if (! curctype)
setlocale_failure = TRUE;
else
curctype = savepv(curctype);
#endif /* USE_LOCALE_CTYPE */
#ifdef USE_LOCALE_COLLATE
Safefree(curcoll);
- if (! (curcoll = my_setlocale(LC_COLLATE, trial_locale)))
+ curcoll = my_setlocale(LC_COLLATE, trial_locale);
+ DEBUG_LOCALE_INIT(LC_COLLATE, trial_locale, curcoll);
+ if (! curcoll)
setlocale_failure = TRUE;
else
curcoll = savepv(curcoll);
#endif /* USE_LOCALE_COLLATE */
#ifdef USE_LOCALE_NUMERIC
Safefree(curnum);
- if (! (curnum = my_setlocale(LC_NUMERIC, trial_locale)))
+ curnum = my_setlocale(LC_NUMERIC, trial_locale);
+ DEBUG_LOCALE_INIT(LC_NUMERIC, trial_locale, curnum);
+ if (! curnum)
setlocale_failure = TRUE;
else
curnum = savepv(curnum);
#endif /* USE_LOCALE_NUMERIC */
#ifdef USE_LOCALE_MESSAGES
- if (! (my_setlocale(LC_MESSAGES, trial_locale)))
+ sl_result = my_setlocale(LC_MESSAGES, trial_locale);
+ DEBUG_LOCALE_INIT(LC_MESSAGES, trial_locale, sl_result);
+ if (! (sl_result))
setlocale_failure = TRUE;
#endif /* USE_LOCALE_MESSAGES */
#ifdef USE_LOCALE_MONETARY
- if (! (my_setlocale(LC_MONETARY, trial_locale)))
+ sl_result = my_setlocale(LC_MONETARY, trial_locale);
+ DEBUG_LOCALE_INIT(LC_MONETARY, trial_locale, sl_result);
+ if (! (sl_result))
setlocale_failure = TRUE;
#endif /* USE_LOCALE_MONETARY */
* LANG, and the C locale. We don't try the same locale twice, so
* don't add to the list if already there. (On POSIX systems, the
* LC_ALL element will likely be a repeat of the 0th element "",
- * but there's no harm done by doing it explicitly */
+ * but there's no harm done by doing it explicitly.
+ *
+ * Note that this tries the LC_ALL environment variable even on
+ * systems which have no LC_ALL locale setting. This may or may
+ * not have been originally intentional, but there's no real need
+ * to change the behavior. */
if (lc_all) {
for (j = 0; j < trial_locales_count; j++) {
if (strEQ(lc_all, trial_locales[j])) {
#ifdef USE_LOCALE_CTYPE
Safefree(curctype);
curctype = savepv(setlocale(LC_CTYPE, NULL));
+ DEBUG_LOCALE_INIT(LC_CTYPE, NULL, curctype);
#endif /* USE_LOCALE_CTYPE */
#ifdef USE_LOCALE_COLLATE
Safefree(curcoll);
curcoll = savepv(setlocale(LC_COLLATE, NULL));
+ DEBUG_LOCALE_INIT(LC_COLLATE, NULL, curcoll);
#endif /* USE_LOCALE_COLLATE */
#ifdef USE_LOCALE_NUMERIC
Safefree(curnum);
curnum = savepv(setlocale(LC_NUMERIC, NULL));
+ DEBUG_LOCALE_INIT(LC_NUMERIC, NULL, curnum);
#endif /* USE_LOCALE_NUMERIC */
}
* differences. First, it handles embedded NULs. Second, it allocates
* a bit more memory than needed for the transformed data itself.
* The real transformed data begins at offset sizeof(collationix).
+ * *xlen is set to the length of that, and doesn't include the collation index
+ * size.
* Please see sv_collxfrm() to see how this is used.
*/
xAlloc = sizeof(PL_collation_ix) + PL_collxfrm_base + (PL_collxfrm_mult * len) + 1;
Newx(xbuf, xAlloc, char);
- if (! xbuf)
+ if (UNLIKELY(! xbuf))
goto bad;
+ /* Store the collation id */
*(U32*)xbuf = PL_collation_ix;
xout = sizeof(PL_collation_ix);
+
+ /* Then the transformation of the input. We loop until successful, or we
+ * give up */
for (xin = 0; xin < len; ) {
Size_t xused;
for (;;) {
xused = strxfrm(xbuf + xout, s + xin, xAlloc - xout);
- if (xused >= PERL_INT_MAX)
- goto bad;
+
+ /* If the transformed string occupies less space than we told
+ * strxfrm() was available, it means it successfully transformed
+ * the whole string. */
if ((STRLEN)xused < xAlloc - xout)
break;
+
+ if (UNLIKELY(xused >= PERL_INT_MAX))
+ goto bad;
+
+ /* Otherwise it should be that the transformation stopped in the
+ * middle because it ran out of space. Malloc more, and try again.
+ * */
xAlloc = (2 * xAlloc) + 1;
Renew(xbuf, xAlloc, char);
- if (! xbuf)
+ if (UNLIKELY(! xbuf))
goto bad;
}
char *
Perl_my_strerror(pTHX_ const int errnum) {
+ dVAR;
/* Uses C locale for the error text unless within scope of 'use locale' for
* LC_MESSAGES */
#ifdef USE_LOCALE_MESSAGES
if (! IN_LC(LC_MESSAGES)) {
- char * save_locale = setlocale(LC_MESSAGES, NULL);
+ char * save_locale;
+
+ /* We have a critical section to prevent another thread from changing
+ * the locale out from under us (or zapping the buffer returned from
+ * setlocale() ) */
+ LOCALE_LOCK;
+
+ save_locale = setlocale(LC_MESSAGES, NULL);
if (! isNAME_C_OR_POSIX(save_locale)) {
char *errstr;
setlocale(LC_MESSAGES, save_locale);
Safefree(save_locale);
+
+ LOCALE_UNLOCK;
+
return errstr;
}
+
+ LOCALE_UNLOCK;
}
#endif
}
+#if defined(DEBUGGING) && defined(USE_LOCALE)
+
+char *
+Perl__setlocale_debug_string(const int category, /* category number,
+ like LC_ALL */
+ const char* const locale, /* locale name */
+
+ /* return value from setlocale() when attempting to
+ * set 'category' to 'locale' */
+ const char* const retval)
+{
+ /* Returns a pointer to a NUL-terminated string in static storage with
+ * added text about the info passed in. This is not thread safe and will
+ * be overwritten by the next call, so this should be used just to
+ * formulate a string to immediately print or savepv() on. */
+
+ /* initialise to a non-null value to keep it out of BSS and so keep
+ * -DPERL_GLOBAL_STRUCT_PRIVATE happy */
+ static char ret[128] = "x";
+
+ my_strlcpy(ret, "setlocale(", sizeof(ret));
+
+ switch (category) {
+ default:
+ my_snprintf(ret, sizeof(ret), "%s? %d", ret, category);
+ break;
+# ifdef LC_ALL
+ case LC_ALL:
+ my_strlcat(ret, "LC_ALL", sizeof(ret));
+ break;
+# endif
+# ifdef LC_CTYPE
+ case LC_CTYPE:
+ my_strlcat(ret, "LC_CTYPE", sizeof(ret));
+ break;
+# endif
+# ifdef LC_NUMERIC
+ case LC_NUMERIC:
+ my_strlcat(ret, "LC_NUMERIC", sizeof(ret));
+ break;
+# endif
+# ifdef LC_COLLATE
+ case LC_COLLATE:
+ my_strlcat(ret, "LC_COLLATE", sizeof(ret));
+ break;
+# endif
+# ifdef LC_TIME
+ case LC_TIME:
+ my_strlcat(ret, "LC_TIME", sizeof(ret));
+ break;
+# endif
+# ifdef LC_MONETARY
+ case LC_MONETARY:
+ my_strlcat(ret, "LC_MONETARY", sizeof(ret));
+ break;
+# endif
+# ifdef LC_MESSAGES
+ case LC_MESSAGES:
+ my_strlcat(ret, "LC_MESSAGES", sizeof(ret));
+ break;
+# endif
+ }
+
+ my_strlcat(ret, ", ", sizeof(ret));
+
+ if (locale) {
+ my_strlcat(ret, "\"", sizeof(ret));
+ my_strlcat(ret, locale, sizeof(ret));
+ my_strlcat(ret, "\"", sizeof(ret));
+ }
+ else {
+ my_strlcat(ret, "NULL", sizeof(ret));
+ }
+
+ my_strlcat(ret, ") returned ", sizeof(ret));
+
+ if (retval) {
+ my_strlcat(ret, "\"", sizeof(ret));
+ my_strlcat(ret, retval, sizeof(ret));
+ my_strlcat(ret, "\"", sizeof(ret));
+ }
+ else {
+ my_strlcat(ret, "NULL", sizeof(ret));
+ }
+
+ assert(strlen(ret) < sizeof(ret));
+
+ return ret;
+}
+
+#endif
/*
https://perl5.git.perl.org / perl5.git / blobdiff