X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/e7e76d1b1738854cb212d055225d8eda87682445..646d1759be794fc27ea2be7a051b20a1d6cab7ca:/locale.c diff --git a/locale.c b/locale.c index a477c3b..53ae151 100644 --- a/locale.c +++ b/locale.c @@ -93,7 +93,6 @@ void Perl_set_numeric_radix(pTHX) { #ifdef USE_LOCALE_NUMERIC - dVAR; # ifdef HAS_LOCALECONV const struct lconv* const lc = localeconv(); @@ -107,9 +106,9 @@ Perl_set_numeric_radix(pTHX) sv_setpv(PL_numeric_radix_sv, lc->decimal_point); else PL_numeric_radix_sv = newSVpv(lc->decimal_point, 0); - if (! is_ascii_string((U8 *) lc->decimal_point, 0) + if (! is_invariant_string((U8 *) lc->decimal_point, 0) && is_utf8_string((U8 *) lc->decimal_point, 0) - && is_cur_LC_category_utf8(LC_NUMERIC)) + && _is_cur_LC_category_utf8(LC_NUMERIC)) { SvUTF8_on(PL_numeric_radix_sv); } @@ -117,10 +116,30 @@ Perl_set_numeric_radix(pTHX) } else PL_numeric_radix_sv = NULL; + + DEBUG_L(PerlIO_printf(Perl_debug_log, "Locale radix is %s\n", + (PL_numeric_radix_sv) + ? lc->decimal_point + : "NULL")); + # endif /* HAS_LOCALECONV */ #endif /* USE_LOCALE_NUMERIC */ } +/* Is the C string input 'name' "C" or "POSIX"? If so, and 'name' is the + * return of setlocale(), then this is extremely likely to be the C or POSIX + * locale. However, the output of setlocale() is documented to be opaque, but + * the odds are extremely small that it would return these two strings for some + * other locale. Note that VMS in these two locales includes many non-ASCII + * characters as controls and punctuation (below are hex bytes): + * cntrl: 00-1F 7F 84-97 9B-9F + * punct: 21-2F 3A-40 5B-60 7B-7E A1-A3 A5 A7-AB B0-B3 B5-B7 B9-BD BF-CF D1-DD DF-EF F1-FD + * Oddly, none there are listed as alphas, though some represent alphabetics + * http://www.nntp.perl.org/group/perl.perl5.porters/2013/02/msg198753.html */ +#define isNAME_C_OR_POSIX(name) ((name) != NULL \ + && ((*(name) == 'C' && (*(name + 1)) == '\0') \ + || strEQ((name), "POSIX"))) + void Perl_new_numeric(pTHX_ const char *newnum) { @@ -140,11 +159,14 @@ Perl_new_numeric(pTHX_ const char *newnum) * dot. * * This sets several interpreter-level variables: - * PL_numeric_name The default locale's name: a copy of 'newnum' + * PL_numeric_name The underlying locale's name: a copy of 'newnum' * PL_numeric_local A boolean indicating if the toggled state is such - * that the current locale is the default locale - * PL_numeric_standard A boolean indicating if the toggled state is such - * that the current locale is the C locale + * that the current locale is the program's underlying + * locale + * PL_numeric_standard An int indicating if the toggled state is such + * that the current locale is the C locale. If non-zero, + * it is in C; if > 1, it means it may not be toggled away + * from C. * Note that both of the last two variables can be true at the same time, * if the underlying locale is C. (Toggling is a no-op under these * circumstances.) @@ -155,7 +177,6 @@ Perl_new_numeric(pTHX_ const char *newnum) * POSIX::setlocale() */ char *save_newnum; - dVAR; if (! newnum) { Safefree(PL_numeric_name); @@ -171,11 +192,18 @@ Perl_new_numeric(pTHX_ const char *newnum) PL_numeric_name = save_newnum; } - PL_numeric_standard = ((*save_newnum == 'C' && save_newnum[1] == '\0') - || strEQ(save_newnum, "POSIX")); + PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum); PL_numeric_local = TRUE; + + /* 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 + * need the underlying locale change to it temporarily). */ + set_numeric_standard(); + set_numeric_radix(); +#else + PERL_UNUSED_ARG(newnum); #endif /* USE_LOCALE_NUMERIC */ } @@ -183,18 +211,18 @@ void Perl_set_numeric_standard(pTHX) { #ifdef USE_LOCALE_NUMERIC - dVAR; - - /* Toggle the LC_NUMERIC locale to C, if not already there. Probably - * should use the macros like SET_NUMERIC_STANDARD() in perl.h instead of - * calling this directly. */ - - if (! PL_numeric_standard) { - setlocale(LC_NUMERIC, "C"); - PL_numeric_standard = TRUE; - PL_numeric_local = FALSE; - set_numeric_radix(); - } + /* Toggle the LC_NUMERIC locale to C. Most code should use the macros like + * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly. The + * macro avoids calling this routine if toggling isn't necessary according + * to our records (which could be wrong if some XS code has changed the + * locale behind our back) */ + + setlocale(LC_NUMERIC, "C"); + PL_numeric_standard = TRUE; + PL_numeric_local = isNAME_C_OR_POSIX(PL_numeric_name); + set_numeric_radix(); + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Underlying LC_NUMERIC locale now is C\n")); #endif /* USE_LOCALE_NUMERIC */ } @@ -203,18 +231,19 @@ void Perl_set_numeric_local(pTHX) { #ifdef USE_LOCALE_NUMERIC - dVAR; - - /* Toggle the LC_NUMERIC locale to the current underlying default, if not - * already there. Probably should use the macros like SET_NUMERIC_LOCAL() - * in perl.h instead of calling this directly. */ - - if (! PL_numeric_local) { - setlocale(LC_NUMERIC, PL_numeric_name); - PL_numeric_standard = FALSE; - PL_numeric_local = TRUE; - set_numeric_radix(); - } + /* Toggle the LC_NUMERIC locale to the current underlying default. Most + * code should use the macros like SET_NUMERIC_LOCAL() in perl.h instead of + * calling this directly. The macro avoids calling this routine if + * toggling isn't necessary according to our records (which could be wrong + * if some XS code has changed the locale behind our back) */ + + setlocale(LC_NUMERIC, PL_numeric_name); + PL_numeric_standard = isNAME_C_OR_POSIX(PL_numeric_name); + PL_numeric_local = TRUE; + set_numeric_radix(); + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Underlying LC_NUMERIC locale now is %s\n", + PL_numeric_name)); #endif /* USE_LOCALE_NUMERIC */ } @@ -243,13 +272,139 @@ Perl_new_ctype(pTHX_ const char *newctype) PERL_ARGS_ASSERT_NEW_CTYPE; - for (i = 0; i < 256; i++) { - if (isUPPER_LC((U8) i)) - PL_fold_locale[i] = toLOWER_LC((U8) i); - else if (isLOWER_LC((U8) i)) - PL_fold_locale[i] = toUPPER_LC((U8) i); - else - PL_fold_locale[i] = (U8) i; + /* We will replace any bad locale warning with 1) nothing if the new one is + * ok; or 2) a new warning for the bad new locale */ + if (PL_warn_locale) { + SvREFCNT_dec_NN(PL_warn_locale); + PL_warn_locale = NULL; + } + + PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE); + + /* A UTF-8 locale gets standard rules. But note that code still has to + * handle this specially because of the three problematic code points */ + if (PL_in_utf8_CTYPE_locale) { + Copy(PL_fold_latin1, PL_fold_locale, 256, U8); + } + else { + /* Assume enough space for every character being bad. 4 spaces each + * for the 94 printable characters that are output like "'x' "; and 5 + * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating + * NUL */ + char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ]; + + bool check_for_problems = ckWARN_d(WARN_LOCALE); /* No warnings means + no check */ + bool multi_byte_locale = FALSE; /* Assume is a single-byte locale + to start */ + unsigned int bad_count = 0; /* Count of bad characters */ + + for (i = 0; i < 256; i++) { + if (isUPPER_LC((U8) i)) + PL_fold_locale[i] = (U8) toLOWER_LC((U8) i); + else if (isLOWER_LC((U8) i)) + PL_fold_locale[i] = (U8) toUPPER_LC((U8) i); + else + PL_fold_locale[i] = (U8) i; + + /* If checking for locale problems, see if the native ASCII-range + * printables plus \n and \t are in their expected categories in + * the new locale. If not, this could mean big trouble, upending + * Perl's and most programs' assumptions, like having a + * metacharacter with special meaning become a \w. Fortunately, + * it's very rare to find locales that aren't supersets of ASCII + * nowadays. It isn't a problem for most controls to be changed + * into something else; we check only \n and \t, though perhaps \r + * could be an issue as well. */ + if (check_for_problems + && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n')) + { + if ((isALPHANUMERIC_A(i) && ! isALPHANUMERIC_LC(i)) + || (isPUNCT_A(i) && ! isPUNCT_LC(i)) + || (isBLANK_A(i) && ! isBLANK_LC(i)) + || (i == '\n' && ! isCNTRL_LC(i))) + { + if (bad_count) { /* Separate multiple entries with a + blank */ + bad_chars_list[bad_count++] = ' '; + } + bad_chars_list[bad_count++] = '\''; + if (isPRINT_A(i)) { + bad_chars_list[bad_count++] = (char) i; + } + else { + bad_chars_list[bad_count++] = '\\'; + if (i == '\n') { + bad_chars_list[bad_count++] = 'n'; + } + else { + assert(i == '\t'); + bad_chars_list[bad_count++] = 't'; + } + } + bad_chars_list[bad_count++] = '\''; + bad_chars_list[bad_count] = '\0'; + } + } + } + +#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 + * problems. */ + if (check_for_problems && MB_CUR_MAX > 1 + + /* Some platforms return MB_CUR_MAX > 1 for even the "C" + * locale. Just assume that the implementation for them (plus + * for POSIX) is correct and the > 1 value is spurious. (Since + * these are specially handled to never be considered UTF-8 + * locales, as long as this is the only problem, everything + * should work fine */ + && strNE(newctype, "C") && strNE(newctype, "POSIX")) + { + multi_byte_locale = TRUE; + } +#endif + + if (bad_count || multi_byte_locale) { + PL_warn_locale = Perl_newSVpvf(aTHX_ + "Locale '%s' may not work well.%s%s%s\n", + newctype, + (multi_byte_locale) + ? " Some characters in it are not recognized by" + " Perl." + : "", + (bad_count) + ? "\nThe following characters (and maybe others)" + " may not have the same meaning as the Perl" + " program expects:\n" + : "", + (bad_count) + ? bad_chars_list + : "" + ); + /* If we are actually in the scope of the locale, output the + * message now. Otherwise we save it to be output at the first + * operation using this locale, if that actually happens. Most + * programs don't use locales, so they are immune to bad ones */ + if (IN_LC(LC_CTYPE)) { + + /* We have to save 'newctype' because the setlocale() just + * below may destroy it. The next setlocale() further down + * should restore it properly so that the intermediate change + * here is transparent to this function's caller */ + const char * const badlocale = savepv(newctype); + + setlocale(LC_CTYPE, "C"); + + /* The '0' below suppresses a bogus gcc compiler warning */ + Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0); + setlocale(LC_CTYPE, badlocale); + Safefree(badlocale); + SvREFCNT_dec_NN(PL_warn_locale); + PL_warn_locale = NULL; + } + } } #endif /* USE_LOCALE_CTYPE */ @@ -259,6 +414,32 @@ Perl_new_ctype(pTHX_ const char *newctype) } void +Perl__warn_problematic_locale() +{ + +#ifdef USE_LOCALE_CTYPE + + dTHX; + + /* Internal-to-core function that outputs the message in PL_warn_locale, + * and then NULLS it. Should be called only through the macro + * _CHECK_AND_WARN_PROBLEMATIC_LOCALE */ + + if (PL_warn_locale) { + /*GCC_DIAG_IGNORE(-Wformat-security); Didn't work */ + Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE), + SvPVX(PL_warn_locale), + 0 /* dummy to avoid compiler warning */ ); + /* GCC_DIAG_RESTORE; */ + SvREFCNT_dec_NN(PL_warn_locale); + PL_warn_locale = NULL; + } + +#endif + +} + +void Perl_new_collate(pTHX_ const char *newcoll) { #ifdef USE_LOCALE_COLLATE @@ -271,8 +452,6 @@ Perl_new_collate(pTHX_ const char *newcoll) * should be called directly only from this file and from * POSIX::setlocale() */ - dVAR; - if (! newcoll) { if (PL_collation_name) { ++PL_collation_ix; @@ -289,8 +468,7 @@ Perl_new_collate(pTHX_ const char *newcoll) ++PL_collation_ix; Safefree(PL_collation_name); PL_collation_name = stdize_locale(savepv(newcoll)); - PL_collation_standard = ((*newcoll == 'C' && newcoll[1] == '\0') - || strEQ(newcoll, "POSIX")); + PL_collation_standard = isNAME_C_OR_POSIX(newcoll); { /* 2: at most so many chars ('a', 'b'). */ @@ -308,25 +486,223 @@ Perl_new_collate(pTHX_ const char *newcoll) } } +#else + PERL_UNUSED_ARG(newcoll); #endif /* USE_LOCALE_COLLATE */ } +#ifdef WIN32 + +char * +Perl_my_setlocale(pTHX_ int category, const char* locale) +{ + /* This, for Windows, emulates POSIX setlocale() behavior. There is no + * difference unless the input locale is "", which means on Windows to get + * the machine default, which is set via the computer's "Regional and + * Language Options" (or its current equivalent). In POSIX, it instead + * means to find the locale from the user's environment. This routine + * looks in the environment, and, if anything is found, uses that instead + * of going to the machine default. If there is no environment override, + * the machine default is used, as normal, by calling the real setlocale() + * with "". The POSIX behavior is to use the LC_ALL variable if set; + * otherwise to use the particular category's variable if set; otherwise to + * use the LANG variable. */ + + bool override_LC_ALL = FALSE; + char * result; + + if (locale && strEQ(locale, "")) { +# ifdef LC_ALL + locale = PerlEnv_getenv("LC_ALL"); + if (! locale) { +#endif + switch (category) { +# ifdef LC_ALL + case LC_ALL: + override_LC_ALL = TRUE; + break; /* We already know its variable isn't set */ +# endif +# ifdef USE_LOCALE_TIME + case LC_TIME: + locale = PerlEnv_getenv("LC_TIME"); + break; +# endif +# ifdef USE_LOCALE_CTYPE + case LC_CTYPE: + locale = PerlEnv_getenv("LC_CTYPE"); + break; +# endif +# ifdef USE_LOCALE_COLLATE + case LC_COLLATE: + locale = PerlEnv_getenv("LC_COLLATE"); + break; +# endif +# ifdef USE_LOCALE_MONETARY + case LC_MONETARY: + locale = PerlEnv_getenv("LC_MONETARY"); + break; +# endif +# ifdef USE_LOCALE_NUMERIC + case LC_NUMERIC: + locale = PerlEnv_getenv("LC_NUMERIC"); + break; +# endif +# ifdef USE_LOCALE_MESSAGES + case LC_MESSAGES: + locale = PerlEnv_getenv("LC_MESSAGES"); + break; +# endif + default: + /* This is a category, like PAPER_SIZE that we don't + * know about; and so can't provide a wrapper. */ + break; + } + if (! locale) { + locale = PerlEnv_getenv("LANG"); + if (! locale) { + locale = ""; + } + } +# ifdef LC_ALL + } +# endif + } + + 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; + } + + /* Here the input category was LC_ALL, and we have set it to what is in the + * LANG variable or the system default if there is no LANG. But these have + * lower priority than the other LC_foo variables, so override it for each + * one that is set. (If they are set to "", it means to use the same thing + * we just set LC_ALL to, so can skip) */ +# ifdef USE_LOCALE_TIME + 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 + + 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 + + /* * Initialize locale awareness. */ int Perl_init_i18nl10n(pTHX_ int printwarn) { - int ok = 1; - /* returns + /* printwarn is + * + * 0 if not to output warning when setup locale is bad + * 1 if to output warning based on value of PERL_BADLANG + * >1 if to output regardless of PERL_BADLANG + * + * returns * 1 = set ok or not applicable, - * 0 = fallback to C locale, - * -1 = fallback to C locale failed - */ + * 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. + * */ -#if defined(USE_LOCALE) - dVAR; + int ok = 1; +#if defined(USE_LOCALE) #ifdef USE_LOCALE_CTYPE char *curctype = NULL; #endif /* USE_LOCALE_CTYPE */ @@ -337,224 +713,446 @@ Perl_init_i18nl10n(pTHX_ int printwarn) char *curnum = NULL; #endif /* USE_LOCALE_NUMERIC */ #ifdef __GLIBC__ - char * const language = PerlEnv_getenv("LANGUAGE"); + const char * const language = savepv(PerlEnv_getenv("LANGUAGE")); #endif + /* NULL uses the existing already set up locale */ const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT")) ? NULL : ""; - char * const lc_all = PerlEnv_getenv("LC_ALL"); - char * const lang = PerlEnv_getenv("LANG"); +#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")); + const char * const lang = savepv(PerlEnv_getenv("LANG")); bool setlocale_failure = FALSE; + unsigned int i; + char *p; + + /* A later getenv() could zap this, so only use here */ + const char * const bad_lang_use_once = PerlEnv_getenv("PERL_BADLANG"); + + const bool locwarn = (printwarn > 1 + || (printwarn + && (! bad_lang_use_once + || ( + /* disallow with "" or "0" */ + *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. */ +# define SYSTEM_DEFAULT_LOCALE +#endif +#ifdef SYSTEM_DEFAULT_LOCALE + const char *system_default_locale = NULL; +#endif -#ifdef LOCALE_ENVIRON_REQUIRED +#ifndef LOCALE_ENVIRON_REQUIRED + PERL_UNUSED_VAR(done); + PERL_UNUSED_VAR(locale_param); +#else /* * Ultrix setlocale(..., "") fails if there are no environment * variables from which to get a locale name. */ - bool done = FALSE; - # ifdef LC_ALL if (lang) { - if (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 - Safefree(curctype); - if (! (curctype = - 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 - Safefree(curcoll); - if (! (curcoll = - 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 - Safefree(curnum); - if (! (curnum = - 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 + 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 + 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 */ } # endif /* LC_ALL */ #endif /* !LOCALE_ENVIRON_REQUIRED */ + /* We try each locale in the list until we get one that works, or exhaust + * the list. Normally the loop is executed just once. But if setting the + * locale fails, inside the loop we add fallback trials to the array and so + * will execute the loop multiple times */ + trial_locales[0] = setlocale_init; + trial_locales_count = 1; + for (i= 0; i < trial_locales_count; i++) { + const char * trial_locale = trial_locales[i]; + + if (i > 0) { + + /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED + * when i==0, but I (khw) don't think that behavior makes much + * sense */ + setlocale_failure = FALSE; + +#ifdef SYSTEM_DEFAULT_LOCALE +# ifdef WIN32 + /* On Windows machines, an entry of "" after the 0th means to use + * the system default locale, which we now proceed to get. */ + if (strEQ(trial_locale, "")) { + unsigned int j; + + /* 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 */ + if (! system_default_locale) { + goto next_iteration; + } + for (j = 0; j < trial_locales_count; j++) { + if (strEQ(system_default_locale, trial_locales[j])) { + goto next_iteration; + } + } + + trial_locale = system_default_locale; + } +# endif /* WIN32 */ +#endif /* SYSTEM_DEFAULT_LOCALE */ + } + #ifdef LC_ALL - if (! setlocale(LC_ALL, setlocale_init)) - setlocale_failure = TRUE; + sl_result = my_setlocale(LC_ALL, trial_locale); + DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result); + if (! sl_result) { + setlocale_failure = TRUE; + } + else { + /* Since LC_ALL succeeded, it should have changed all the other + * categories it can to its value; so we massage things so that the + * setlocales below just return their category's current values. + * This adequately handles the case in NetBSD where LC_COLLATE may + * not be defined for a locale, and setting it individually will + * fail, whereas setting LC_ALL suceeds, leaving LC_COLLATE set to + * the POSIX locale. */ + trial_locale = NULL; + } #endif /* LC_ALL */ - if (!setlocale_failure) { + if (!setlocale_failure) { #ifdef USE_LOCALE_CTYPE - Safefree(curctype); - if (! (curctype = setlocale(LC_CTYPE, setlocale_init))) - setlocale_failure = TRUE; - else - curctype = savepv(curctype); + Safefree(curctype); + 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 = setlocale(LC_COLLATE, setlocale_init))) - setlocale_failure = TRUE; - else - curcoll = savepv(curcoll); + Safefree(curcoll); + 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 = setlocale(LC_NUMERIC, setlocale_init))) - setlocale_failure = TRUE; - else - curnum = savepv(curnum); + Safefree(curnum); + 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 + 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 + 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 */ + + if (! setlocale_failure) { /* Success */ + break; + } + } - if (setlocale_failure) { - char *p; - const bool locwarn = (printwarn > 1 || - (printwarn && - (!(p = PerlEnv_getenv("PERL_BADLANG")) || atoi(p)))); + /* Here, something failed; will need to try a fallback. */ + ok = 0; - if (locwarn) { + if (i == 0) { + unsigned int j; + + if (locwarn) { /* Output failure info only on the first one */ #ifdef LC_ALL - PerlIO_printf(Perl_error_log, - "perl: warning: Setting locale failed.\n"); + PerlIO_printf(Perl_error_log, + "perl: warning: Setting locale failed.\n"); #else /* !LC_ALL */ - PerlIO_printf(Perl_error_log, - "perl: warning: Setting locale failed for the categories:\n\t"); -#ifdef USE_LOCALE_CTYPE - if (! curctype) - PerlIO_printf(Perl_error_log, "LC_CTYPE "); -#endif /* USE_LOCALE_CTYPE */ -#ifdef USE_LOCALE_COLLATE - if (! curcoll) - PerlIO_printf(Perl_error_log, "LC_COLLATE "); -#endif /* USE_LOCALE_COLLATE */ -#ifdef USE_LOCALE_NUMERIC - if (! curnum) - PerlIO_printf(Perl_error_log, "LC_NUMERIC "); -#endif /* USE_LOCALE_NUMERIC */ - PerlIO_printf(Perl_error_log, "\n"); + PerlIO_printf(Perl_error_log, + "perl: warning: Setting locale failed for the categories:\n\t"); +# ifdef USE_LOCALE_CTYPE + if (! curctype) + PerlIO_printf(Perl_error_log, "LC_CTYPE "); +# endif /* USE_LOCALE_CTYPE */ +# ifdef USE_LOCALE_COLLATE + if (! curcoll) + PerlIO_printf(Perl_error_log, "LC_COLLATE "); +# endif /* USE_LOCALE_COLLATE */ +# ifdef USE_LOCALE_NUMERIC + if (! curnum) + PerlIO_printf(Perl_error_log, "LC_NUMERIC "); +# endif /* USE_LOCALE_NUMERIC */ + PerlIO_printf(Perl_error_log, "and possibly others\n"); #endif /* LC_ALL */ - PerlIO_printf(Perl_error_log, - "perl: warning: Please check that your locale settings:\n"); + PerlIO_printf(Perl_error_log, + "perl: warning: Please check that your locale settings:\n"); #ifdef __GLIBC__ - PerlIO_printf(Perl_error_log, - "\tLANGUAGE = %c%s%c,\n", - language ? '"' : '(', - language ? language : "unset", - language ? '"' : ')'); + PerlIO_printf(Perl_error_log, + "\tLANGUAGE = %c%s%c,\n", + language ? '"' : '(', + language ? language : "unset", + language ? '"' : ')'); #endif - PerlIO_printf(Perl_error_log, - "\tLC_ALL = %c%s%c,\n", - lc_all ? '"' : '(', - lc_all ? lc_all : "unset", - lc_all ? '"' : ')'); + PerlIO_printf(Perl_error_log, + "\tLC_ALL = %c%s%c,\n", + lc_all ? '"' : '(', + lc_all ? lc_all : "unset", + lc_all ? '"' : ')'); #if defined(USE_ENVIRON_ARRAY) - { - char **e; - for (e = environ; *e; e++) { - if (strnEQ(*e, "LC_", 3) - && strnNE(*e, "LC_ALL=", 7) - && (p = strchr(*e, '='))) - PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n", - (int)(p - *e), *e, p + 1); - } - } + { + char **e; + for (e = environ; *e; e++) { + if (strnEQ(*e, "LC_", 3) + && strnNE(*e, "LC_ALL=", 7) + && (p = strchr(*e, '='))) + PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n", + (int)(p - *e), *e, p + 1); + } + } #else - PerlIO_printf(Perl_error_log, - "\t(possibly more locale environment variables)\n"); + PerlIO_printf(Perl_error_log, + "\t(possibly more locale environment variables)\n"); #endif - PerlIO_printf(Perl_error_log, - "\tLANG = %c%s%c\n", - lang ? '"' : '(', - lang ? lang : "unset", - lang ? '"' : ')'); + PerlIO_printf(Perl_error_log, + "\tLANG = %c%s%c\n", + lang ? '"' : '(', + lang ? lang : "unset", + lang ? '"' : ')'); - PerlIO_printf(Perl_error_log, - " are supported and installed on your system.\n"); - } + PerlIO_printf(Perl_error_log, + " are supported and installed on your system.\n"); + } -#ifdef LC_ALL + /* Calculate what fallback locales to try. We have avoided this + * until we have to, because failure is quite unlikely. This will + * usually change the upper bound of the loop we are in. + * + * Since the system's default way of setting the locale has not + * found one that works, We use Perl's defined ordering: LC_ALL, + * 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. + * + * 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])) { + goto done_lc_all; + } + } + trial_locales[trial_locales_count++] = lc_all; + } + done_lc_all: - if (setlocale(LC_ALL, "C")) { - if (locwarn) - PerlIO_printf(Perl_error_log, - "perl: warning: Falling back to the standard locale (\"C\").\n"); - ok = 0; - } - else { - if (locwarn) - PerlIO_printf(Perl_error_log, - "perl: warning: Failed to fall back to the standard locale (\"C\").\n"); - ok = -1; - } + if (lang) { + for (j = 0; j < trial_locales_count; j++) { + if (strEQ(lang, trial_locales[j])) { + goto done_lang; + } + } + trial_locales[trial_locales_count++] = lang; + } + done_lang: + +#if defined(WIN32) && defined(LC_ALL) + /* For Windows, we also try the system default locale before "C". + * (If there exists a Windows without LC_ALL we skip this because + * it gets too complicated. For those, the "C" is the next + * fallback possibility). The "" is the same as the 0th element of + * the array, but the code at the loop above knows to treat it + * differently when not the 0th */ + trial_locales[trial_locales_count++] = ""; +#endif -#else /* ! LC_ALL */ + for (j = 0; j < trial_locales_count; j++) { + if (strEQ("C", trial_locales[j])) { + goto done_C; + } + } + trial_locales[trial_locales_count++] = "C"; - if (0 -#ifdef USE_LOCALE_CTYPE - || !(curctype || setlocale(LC_CTYPE, "C")) -#endif /* USE_LOCALE_CTYPE */ -#ifdef USE_LOCALE_COLLATE - || !(curcoll || setlocale(LC_COLLATE, "C")) -#endif /* USE_LOCALE_COLLATE */ -#ifdef USE_LOCALE_NUMERIC - || !(curnum || setlocale(LC_NUMERIC, "C")) -#endif /* USE_LOCALE_NUMERIC */ - ) - { - if (locwarn) - PerlIO_printf(Perl_error_log, - "perl: warning: Cannot fall back to the standard locale (\"C\").\n"); - ok = -1; - } + done_C: ; + } /* end of first time through the loop */ + +#ifdef WIN32 + next_iteration: ; +#endif -#endif /* ! LC_ALL */ + } /* end of looping through the trial locales */ + if (ok < 1) { /* If we tried to fallback */ + const char* msg; + if (! setlocale_failure) { /* fallback succeeded */ + msg = "Falling back to"; + } + else { /* fallback failed */ + + /* We dropped off the end of the loop, so have to decrement i to + * get back to the value the last time through */ + i--; + + ok = -1; + msg = "Failed to fall back to"; + + /* To continue, we should use whatever values we've got */ #ifdef USE_LOCALE_CTYPE - Safefree(curctype); - curctype = savepv(setlocale(LC_CTYPE, NULL)); + 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)); + 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)); + Safefree(curnum); + curnum = savepv(setlocale(LC_NUMERIC, NULL)); + DEBUG_LOCALE_INIT(LC_NUMERIC, NULL, curnum); #endif /* USE_LOCALE_NUMERIC */ - } - else { + } + + if (locwarn) { + const char * description; + const char * name = ""; + if (strEQ(trial_locales[i], "C")) { + description = "the standard locale"; + name = "C"; + } +#ifdef SYSTEM_DEFAULT_LOCALE + else if (strEQ(trial_locales[i], "")) { + description = "the system default locale"; + if (system_default_locale) { + name = system_default_locale; + } + } +#endif /* SYSTEM_DEFAULT_LOCALE */ + else { + description = "a fallback locale"; + name = trial_locales[i]; + } + if (name && strNE(name, "")) { + PerlIO_printf(Perl_error_log, + "perl: warning: %s %s (\"%s\").\n", msg, description, name); + } + else { + PerlIO_printf(Perl_error_log, + "perl: warning: %s %s.\n", msg, description); + } + } + } /* End of tried to fallback */ #ifdef USE_LOCALE_CTYPE new_ctype(curctype); @@ -568,18 +1166,14 @@ Perl_init_i18nl10n(pTHX_ int printwarn) new_numeric(curnum); #endif /* USE_LOCALE_NUMERIC */ - } - #if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE) - { - /* Set PL_utf8locale to TRUE if using PerlIO _and_ - the current LC_CTYPE locale is UTF-8. - If PL_utf8locale and PL_unicode (set by -C or by $ENV{PERL_UNICODE}) - are true, perl.c:S_parse_body() will turn on the PerlIO :utf8 layer - on STDIN, STDOUT, STDERR, _and_ the default open discipline. - */ - PL_utf8locale = is_cur_LC_category_utf8(LC_CTYPE); - } + /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE + * locale is UTF-8. If PL_utf8locale and PL_unicode (set by -C or by + * $ENV{PERL_UNICODE}) are true, perl.c:S_parse_body() will turn on the + * PerlIO :utf8 layer on STDIN, STDOUT, STDERR, _and_ the default open + * discipline. */ + PL_utf8locale = _is_cur_LC_category_utf8(LC_CTYPE); + /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO. This is an alternative to using the -C command line switch (the -C if present will override this). */ @@ -601,11 +1195,21 @@ Perl_init_i18nl10n(pTHX_ int printwarn) Safefree(curnum); #endif /* USE_LOCALE_NUMERIC */ +#ifdef __GLIBC__ + Safefree(language); +#endif + + Safefree(lc_all); + Safefree(lang); + +#else /* !USE_LOCALE */ + PERL_UNUSED_ARG(printwarn); #endif /* USE_LOCALE */ return ok; } + #ifdef USE_LOCALE_COLLATE /* @@ -619,7 +1223,6 @@ Perl_init_i18nl10n(pTHX_ int printwarn) char * Perl_mem_collxfrm(pTHX_ const char *s, STRLEN len, STRLEN *xlen) { - dVAR; char *xbuf; STRLEN xAlloc, xin, xout; /* xalloc is a reserved word in VC */ @@ -671,14 +1274,16 @@ Perl_mem_collxfrm(pTHX_ const char *s, STRLEN len, STRLEN *xlen) #ifdef USE_LOCALE -STATIC bool -S_is_cur_LC_category_utf8(pTHX_ int category) +bool +Perl__is_cur_LC_category_utf8(pTHX_ int category) { /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE * otherwise. 'category' may not be LC_ALL. If the platform doesn't have * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence - * could give the wrong result. It errs on the side of not being a UTF-8 - * locale. */ + * could give the wrong result. The result will very likely be correct for + * languages that have commonly used non-ASCII characters, but for notably + * English, it comes down to if the locale's name ends in something like + * "UTF-8". It errs on the side of not being a UTF-8 locale. */ char *save_input_locale = NULL; STRLEN final_pos; @@ -690,19 +1295,24 @@ S_is_cur_LC_category_utf8(pTHX_ int category) /* First dispose of the trivial cases */ save_input_locale = setlocale(category, NULL); if (! save_input_locale) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not find current locale for category %d\n", + category)); return FALSE; /* XXX maybe should croak */ } save_input_locale = stdize_locale(savepv(save_input_locale)); - if ((*save_input_locale == 'C' && save_input_locale[1] == '\0') - || strEQ(save_input_locale, "POSIX")) - { + if (isNAME_C_OR_POSIX(save_input_locale)) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Current locale for category %d is %s\n", + category, save_input_locale)); Safefree(save_input_locale); return FALSE; } -#if defined(USE_LOCALE_CTYPE) && (defined(MB_CUR_MAX) || defined(HAS_NL_LANGINFO) && defined(CODESET)) +#if defined(USE_LOCALE_CTYPE) \ + && (defined(MB_CUR_MAX) || (defined(HAS_NL_LANGINFO) && defined(CODESET))) - { /* Next try MB_CUR_MAX or nl_langinfo if available */ + { /* Next try nl_langinfo or MB_CUR_MAX if available */ char *save_ctype_locale = NULL; bool is_utf8; @@ -710,10 +1320,13 @@ S_is_cur_LC_category_utf8(pTHX_ int category) if (category != LC_CTYPE) { /* These work only on LC_CTYPE */ /* Get the current LC_CTYPE locale */ - save_ctype_locale = stdize_locale(savepv(setlocale(LC_CTYPE, NULL))); + save_ctype_locale = setlocale(LC_CTYPE, NULL); if (! save_ctype_locale) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not find current locale for LC_CTYPE\n")); goto cant_use_nllanginfo; } + save_ctype_locale = stdize_locale(savepv(save_ctype_locale)); /* If LC_CTYPE and the desired category use the same locale, this * means that finding the value for LC_CTYPE is the same as finding @@ -724,29 +1337,61 @@ S_is_cur_LC_category_utf8(pTHX_ int category) save_ctype_locale = NULL; } else if (! setlocale(LC_CTYPE, save_input_locale)) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not change LC_CTYPE locale to %s\n", + save_input_locale)); Safefree(save_ctype_locale); goto cant_use_nllanginfo; } } + DEBUG_L(PerlIO_printf(Perl_debug_log, "Current LC_CTYPE locale=%s\n", + save_input_locale)); + /* Here the current LC_CTYPE is set to the locale of the category whose - * information is desired. This means that MB_CUR_MAX and - * nl_langinfo() should give the correct results */ + * information is desired. This means that nl_langinfo() and MB_CUR_MAX + * should give the correct results */ -# ifdef MB_CUR_MAX +# if defined(HAS_NL_LANGINFO) && defined(CODESET) + { + char *codeset = nl_langinfo(CODESET); + if (codeset && strNE(codeset, "")) { + codeset = savepv(codeset); - /* If we switched LC_CTYPE, switch back */ - if (save_ctype_locale) { - setlocale(LC_CTYPE, save_ctype_locale); - Safefree(save_ctype_locale); + /* If we switched LC_CTYPE, switch back */ + if (save_ctype_locale) { + setlocale(LC_CTYPE, save_ctype_locale); + Safefree(save_ctype_locale); + } + + is_utf8 = foldEQ(codeset, STR_WITH_LEN("UTF-8")) + || foldEQ(codeset, STR_WITH_LEN("UTF8")); + + DEBUG_L(PerlIO_printf(Perl_debug_log, + "\tnllanginfo returned CODESET '%s'; ?UTF8 locale=%d\n", + codeset, is_utf8)); + Safefree(codeset); + Safefree(save_input_locale); + return is_utf8; + } } +# endif +# ifdef MB_CUR_MAX + + /* Here, either we don't have nl_langinfo, or it didn't return a + * codeset. Try MB_CUR_MAX */ + /* Standard UTF-8 needs at least 4 bytes to represent the maximum * Unicode code point. Since UTF-8 is the only non-single byte * encoding we handle, we just say any such encoding is UTF-8, and if * turns out to be wrong, other things will fail */ is_utf8 = MB_CUR_MAX >= 4; + DEBUG_L(PerlIO_printf(Perl_debug_log, + "\tMB_CUR_MAX=%d; ?UTF8 locale=%d\n", + (int) MB_CUR_MAX, is_utf8)); + Safefree(save_input_locale); # ifdef HAS_MBTOWC @@ -757,48 +1402,306 @@ S_is_cur_LC_category_utf8(pTHX_ int category) * result */ if (is_utf8) { wchar_t wc; - if (mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8)) + PERL_UNUSED_RESULT(mbtowc(&wc, NULL, 0));/* Reset any shift state */ + errno = 0; + if ((size_t)mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8)) != strlen(HYPHEN_UTF8) || wc != (wchar_t) 0x2010) { is_utf8 = FALSE; + DEBUG_L(PerlIO_printf(Perl_debug_log, "\thyphen=U+%x\n", (unsigned int)wc)); + DEBUG_L(PerlIO_printf(Perl_debug_log, + "\treturn from mbtowc=%d; errno=%d; ?UTF8 locale=0\n", + mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8)), errno)); } } - # endif + /* If we switched LC_CTYPE, switch back */ + if (save_ctype_locale) { + setlocale(LC_CTYPE, save_ctype_locale); + Safefree(save_ctype_locale); + } + return is_utf8; -#else -# if defined(HAS_NL_LANGINFO) && defined(CODESET) +# endif + } + + cant_use_nllanginfo: + +#else /* nl_langinfo should work if available, so don't bother compiling this + fallback code. The final fallback of looking at the name is + compiled, and will be executed if nl_langinfo fails */ + + /* nl_langinfo not available or failed somehow. Next try looking at the + * currency symbol to see if it disambiguates things. Often that will be + * in the native script, and if the symbol isn't in UTF-8, we know that the + * locale isn't. If it is non-ASCII UTF-8, we infer that the locale is + * too, as the odds of a non-UTF8 string being valid UTF-8 are quite small + * */ + +#ifdef HAS_LOCALECONV +# ifdef USE_LOCALE_MONETARY + { + char *save_monetary_locale = NULL; + bool only_ascii = FALSE; + bool is_utf8 = FALSE; + struct lconv* lc; + + /* Like above for LC_CTYPE, we first set LC_MONETARY to the locale of + * the desired category, if it isn't that locale already */ + + if (category != LC_MONETARY) { + + save_monetary_locale = setlocale(LC_MONETARY, NULL); + if (! save_monetary_locale) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not find current locale for LC_MONETARY\n")); + goto cant_use_monetary; + } + save_monetary_locale = stdize_locale(savepv(save_monetary_locale)); + + if (strEQ(save_monetary_locale, save_input_locale)) { + Safefree(save_monetary_locale); + save_monetary_locale = NULL; + } + else if (! setlocale(LC_MONETARY, save_input_locale)) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not change LC_MONETARY locale to %s\n", + save_input_locale)); + Safefree(save_monetary_locale); + goto cant_use_monetary; + } + } + + /* Here the current LC_MONETARY is set to the locale of the category + * whose information is desired. */ + + lc = localeconv(); + if (! lc + || ! lc->currency_symbol + || is_invariant_string((U8 *) lc->currency_symbol, 0)) { - char *codeset = savepv(nl_langinfo(CODESET)); - if (codeset) { + DEBUG_L(PerlIO_printf(Perl_debug_log, "Couldn't get currency symbol for %s, or contains only ASCII; can't use for determining if UTF-8 locale\n", save_input_locale)); + only_ascii = TRUE; + } + else { + is_utf8 = is_utf8_string((U8 *) lc->currency_symbol, 0); + } - /* If we switched LC_CTYPE, switch back */ - if (save_ctype_locale) { - setlocale(LC_CTYPE, save_ctype_locale); - Safefree(save_ctype_locale); + /* If we changed it, restore LC_MONETARY to its original locale */ + if (save_monetary_locale) { + setlocale(LC_MONETARY, save_monetary_locale); + Safefree(save_monetary_locale); + } + + if (! only_ascii) { + + /* It isn't a UTF-8 locale if the symbol is not legal UTF-8; + * otherwise assume the locale is UTF-8 if and only if the symbol + * is non-ascii UTF-8. */ + DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?Currency symbol for %s is UTF-8=%d\n", + save_input_locale, is_utf8)); + Safefree(save_input_locale); + return is_utf8; + } + } + cant_use_monetary: + +# endif /* USE_LOCALE_MONETARY */ +#endif /* HAS_LOCALECONV */ + +#if defined(HAS_STRFTIME) && defined(USE_LOCALE_TIME) + +/* Still haven't found a non-ASCII string to disambiguate UTF-8 or not. Try + * the names of the months and weekdays, timezone, and am/pm indicator */ + { + char *save_time_locale = NULL; + int hour = 10; + bool is_dst = FALSE; + int dom = 1; + int month = 0; + int i; + char * formatted_time; + + + /* Like above for LC_MONETARY, we set LC_TIME to the locale of the + * desired category, if it isn't that locale already */ + + if (category != LC_TIME) { + + save_time_locale = setlocale(LC_TIME, NULL); + if (! save_time_locale) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not find current locale for LC_TIME\n")); + goto cant_use_time; + } + save_time_locale = stdize_locale(savepv(save_time_locale)); + + if (strEQ(save_time_locale, save_input_locale)) { + Safefree(save_time_locale); + save_time_locale = NULL; + } + else if (! setlocale(LC_TIME, save_input_locale)) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not change LC_TIME locale to %s\n", + save_input_locale)); + Safefree(save_time_locale); + goto cant_use_time; + } + } + + /* Here the current LC_TIME is set to the locale of the category + * whose information is desired. Look at all the days of the week and + * month names, and the timezone and am/pm indicator for UTF-8 variant + * characters. The first such a one found will tell us if the locale + * is UTF-8 or not */ + + for (i = 0; i < 7 + 12; i++) { /* 7 days; 12 months */ + formatted_time = my_strftime("%A %B %Z %p", + 0, 0, hour, dom, month, 112, 0, 0, is_dst); + if (! formatted_time || is_invariant_string((U8 *) formatted_time, 0)) { + + /* Here, we didn't find a non-ASCII. Try the next time through + * with the complemented dst and am/pm, and try with the next + * weekday. After we have gotten all weekdays, try the next + * month */ + is_dst = ! is_dst; + hour = (hour + 12) % 24; + dom++; + if (i > 6) { + month++; } + continue; + } - is_utf8 = foldEQ(codeset, STR_WITH_LEN("UTF-8")) - || foldEQ(codeset, STR_WITH_LEN("UTF8")); + /* Here, we have a non-ASCII. Return TRUE is it is valid UTF8; + * false otherwise. But first, restore LC_TIME to its original + * locale if we changed it */ + if (save_time_locale) { + setlocale(LC_TIME, save_time_locale); + Safefree(save_time_locale); + } - Safefree(codeset); - Safefree(save_input_locale); - return is_utf8; + DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?time-related strings for %s are UTF-8=%d\n", + save_input_locale, + is_utf8_string((U8 *) formatted_time, 0))); + Safefree(save_input_locale); + return is_utf8_string((U8 *) formatted_time, 0); + } + + /* Falling off the end of the loop indicates all the names were just + * ASCII. Go on to the next test. If we changed it, restore LC_TIME + * to its original locale */ + if (save_time_locale) { + setlocale(LC_TIME, save_time_locale); + Safefree(save_time_locale); + } + DEBUG_L(PerlIO_printf(Perl_debug_log, "All time-related words for %s contain only ASCII; can't use for determining if UTF-8 locale\n", save_input_locale)); + } + cant_use_time: + +#endif + +#if 0 && defined(USE_LOCALE_MESSAGES) && defined(HAS_SYS_ERRLIST) + +/* This code is ifdefd out because it was found to not be necessary in testing + * on our dromedary test machine, which has over 700 locales. There, this + * added no value to looking at the currency symbol and the time strings. I + * left it in so as to avoid rewriting it if real-world experience indicates + * that dromedary is an outlier. Essentially, instead of returning abpve if we + * haven't found illegal utf8, we continue on and examine all the strerror() + * messages on the platform for utf8ness. If all are ASCII, we still don't + * know the answer; but otherwise we have a pretty good indication of the + * utf8ness. The reason this doesn't help much is that the messages may not + * have been translated into the locale. The currency symbol and time strings + * are much more likely to have been translated. */ + { + int e; + bool is_utf8 = FALSE; + bool non_ascii = FALSE; + char *save_messages_locale = NULL; + const char * errmsg = NULL; + + /* Like above, we set LC_MESSAGES to the locale of the desired + * category, if it isn't that locale already */ + + if (category != LC_MESSAGES) { + + save_messages_locale = setlocale(LC_MESSAGES, NULL); + if (! save_messages_locale) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not find current locale for LC_MESSAGES\n")); + goto cant_use_messages; + } + save_messages_locale = stdize_locale(savepv(save_messages_locale)); + + if (strEQ(save_messages_locale, save_input_locale)) { + Safefree(save_messages_locale); + save_messages_locale = NULL; + } + else if (! setlocale(LC_MESSAGES, save_input_locale)) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Could not change LC_MESSAGES locale to %s\n", + save_input_locale)); + Safefree(save_messages_locale); + goto cant_use_messages; } } -# endif -# endif + /* Here the current LC_MESSAGES is set to the locale of the category + * whose information is desired. Look through all the messages. We + * can't use Strerror() here because it may expand to code that + * segfaults in miniperl */ + + for (e = 0; e <= sys_nerr; e++) { + errno = 0; + errmsg = sys_errlist[e]; + if (errno || !errmsg) { + break; + } + errmsg = savepv(errmsg); + if (! is_invariant_string((U8 *) errmsg, 0)) { + non_ascii = TRUE; + is_utf8 = is_utf8_string((U8 *) errmsg, 0); + break; + } + } + Safefree(errmsg); + + /* And, if we changed it, restore LC_MESSAGES to its original locale */ + if (save_messages_locale) { + setlocale(LC_MESSAGES, save_messages_locale); + Safefree(save_messages_locale); + } + + if (non_ascii) { + + /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid, + * any non-ascii means it is one; otherwise we assume it isn't */ + DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?error messages for %s are UTF-8=%d\n", + save_input_locale, + is_utf8)); + Safefree(save_input_locale); + return is_utf8; + } + + DEBUG_L(PerlIO_printf(Perl_debug_log, "All error messages for %s contain only ASCII; can't use for determining if UTF-8 locale\n", save_input_locale)); } + cant_use_messages: - cant_use_nllanginfo: +#endif -#endif /* HAS_NL_LANGINFO etc */ +#endif /* the code that is compiled when no nl_langinfo */ - /* nl_langinfo not available or failed somehow. Look at the locale name to - * see if it matches qr/UTF -? 8 /ix */ +#ifndef EBCDIC /* On os390, even if the name ends with "UTF-8', it isn't a + UTF-8 locale */ + /* As a last resort, look at the locale name to see if it matches + * qr/UTF -? * 8 /ix, or some other common locale names. This "name", the + * return of setlocale(), is actually defined to be opaque, so we can't + * really rely on the absence of various substrings in the name to indicate + * its UTF-8ness, but if it has UTF8 in the name, it is extremely likely to + * be a UTF-8 locale. Similarly for the other common names */ final_pos = strlen(save_input_locale) - 1; if (final_pos >= 3) { @@ -808,8 +1711,8 @@ S_is_cur_LC_category_utf8(pTHX_ int category) while ((name += strcspn(name, "Uu") + 1) <= save_input_locale + final_pos - 2) { - if (toFOLD(*(name)) != 't' - || toFOLD(*(name + 1)) != 'f') + if (!isALPHA_FOLD_NE(*name, 't') + || isALPHA_FOLD_NE(*(name + 1), 'f')) { continue; } @@ -821,11 +1724,18 @@ S_is_cur_LC_category_utf8(pTHX_ int category) name++; } if (*(name) == '8') { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Locale %s ends with UTF-8 in name\n", + save_input_locale)); Safefree(save_input_locale); return TRUE; } } + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Locale %s doesn't end with UTF-8 in name\n", + save_input_locale)); } +#endif #ifdef WIN32 /* http://msdn.microsoft.com/en-us/library/windows/desktop/dd317756.aspx */ @@ -836,176 +1746,213 @@ S_is_cur_LC_category_utf8(pTHX_ int category) && *(save_input_locale + final_pos - 3) == '5' && *(save_input_locale + final_pos - 4) == '6') { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Locale %s ends with 10056 in name, is UTF-8 locale\n", + save_input_locale)); Safefree(save_input_locale); return TRUE; } #endif - /* Other common encodings are the ISO 8859 series, which aren't UTF-8 */ + /* Other common encodings are the ISO 8859 series, which aren't UTF-8. But + * since we are about to return FALSE anyway, there is no point in doing + * this extra work */ +#if 0 if (instr(save_input_locale, "8859")) { + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Locale %s has 8859 in name, not UTF-8 locale\n", + save_input_locale)); Safefree(save_input_locale); return FALSE; } +#endif -#ifdef HAS_LOCALECONV + DEBUG_L(PerlIO_printf(Perl_debug_log, + "Assuming locale %s is not a UTF-8 locale\n", + save_input_locale)); + Safefree(save_input_locale); + return FALSE; +} -# ifdef USE_LOCALE_MONETARY +#endif - /* Here, there is nothing in the locale name to indicate whether the locale - * is UTF-8 or not. This "name", the return of setlocale(), is actually - * defined to be opaque, so we can't really rely on the absence of various - * substrings in the name to indicate its UTF-8ness. Look at the locale's - * currency symbol. Often that will be in the native script, and if the - * symbol isn't in UTF-8, we know that the locale isn't. If it is - * non-ASCII UTF-8, we infer that the locale is too. - * To do this, like above for LC_CTYPE, we first set LC_MONETARY to the - * locale of the desired category, if it isn't that locale already */ - { - char *save_monetary_locale = NULL; - bool illegal_utf8 = FALSE; - bool only_ascii = FALSE; - const struct lconv* const lc = localeconv(); +bool +Perl__is_in_locale_category(pTHX_ const bool compiling, const int category) +{ + dVAR; + /* Internal function which returns if we are in the scope of a pragma that + * enables the locale category 'category'. 'compiling' should indicate if + * this is during the compilation phase (TRUE) or not (FALSE). */ - if (category != LC_MONETARY) { + const COP * const cop = (compiling) ? &PL_compiling : PL_curcop; - save_monetary_locale = stdize_locale(savepv(setlocale(LC_MONETARY, - NULL))); - if (! save_monetary_locale) { - goto cant_use_monetary; - } + SV *categories = cop_hints_fetch_pvs(cop, "locale", 0); + if (! categories || categories == &PL_sv_placeholder) { + return FALSE; + } - if (strNE(save_monetary_locale, save_input_locale)) { - if (! setlocale(LC_MONETARY, save_input_locale)) { - Safefree(save_monetary_locale); - goto cant_use_monetary; - } - } - } + /* The pseudo-category 'not_characters' is -1, so just add 1 to each to get + * a valid unsigned */ + assert(category >= -1); + return cBOOL(SvUV(categories) & (1U << (category + 1))); +} - /* Here the current LC_MONETARY is set to the locale of the category - * whose information is desired. */ +char * +Perl_my_strerror(pTHX_ const int errnum) { - if (lc && lc->currency_symbol) { - if (! is_utf8_string((U8 *) lc->currency_symbol, 0)) { - illegal_utf8 = TRUE; - } - else if (is_ascii_string((U8 *) lc->currency_symbol, 0)) { - only_ascii = TRUE; - } - } + /* Uses C locale for the error text unless within scope of 'use locale' for + * LC_MESSAGES */ - /* If we changed it, restore LC_MONETARY to its original locale */ - if (save_monetary_locale) { - setlocale(LC_MONETARY, save_monetary_locale); - Safefree(save_monetary_locale); - } +#ifdef USE_LOCALE_MESSAGES + if (! IN_LC(LC_MESSAGES)) { + char * save_locale = setlocale(LC_MESSAGES, NULL); + if (! isNAME_C_OR_POSIX(save_locale)) { + char *errstr; - Safefree(save_input_locale); + /* The next setlocale likely will zap this, so create a copy */ + save_locale = savepv(save_locale); - /* It isn't a UTF-8 locale if the symbol is not legal UTF-8; otherwise - * assume the locale is UTF-8 if and only if the symbol is non-ascii - * UTF-8. (We can't really tell if the locale is UTF-8 or not if the - * symbol is just a '$', so we err on the side of it not being UTF-8) - * */ - return (illegal_utf8) - ? FALSE - : ! only_ascii; + setlocale(LC_MESSAGES, "C"); + /* This points to the static space in Strerror, with all its + * limitations */ + errstr = Strerror(errnum); + + setlocale(LC_MESSAGES, save_locale); + Safefree(save_locale); + return errstr; + } } - cant_use_monetary: +#endif -# endif /* USE_LOCALE_MONETARY */ -#endif /* HAS_LOCALECONV */ + return Strerror(errnum); +} -#if 0 && defined(HAS_STRERROR) && defined(USE_LOCALE_MESSAGES) +/* -/* This code is ifdefd out because it was found to not be necessary in testing - * on our dromedary test machine, which has over 700 locales. There, looking - * at just the currency symbol gave essentially the same results as doing this - * extra work. Executing this also caused segfaults in miniperl. I left it in - * so as to avoid rewriting it if real-world experience indicates that - * dromedary is an outlier. Essentially, instead of returning abpve if we - * haven't found illegal utf8, we continue on and examine all the strerror() - * messages on the platform for utf8ness. If all are ASCII, we still don't - * know the answer; but otherwise we have a pretty good indication of the - * utf8ness. The reason this doesn't necessarily help much is that the - * messages may not have been translated into the locale. The currency symbol - * is much more likely to have been translated. The code below would need to - * be altered somewhat to just be a continuation of testing the currency - * symbol. */ - int e; - unsigned int failures = 0, non_ascii = 0; - char *save_messages_locale = NULL; +=head1 Locale-related functions and macros - /* Like above for LC_CTYPE, we set LC_MESSAGES to the locale of the - * desired category, if it isn't that locale already */ +=for apidoc sync_locale - if (category != LC_MESSAGES) { +Changing the program's locale should be avoided by XS code. Nevertheless, +certain non-Perl libraries called from XS, such as C do so. When this +happens, Perl needs to be told that the locale has changed. Use this function +to do so, before returning to Perl. - save_messages_locale = stdize_locale(savepv(setlocale(LC_MESSAGES, - NULL))); - if (! save_messages_locale) { - goto cant_use_messages; - } +=cut +*/ - if (strEQ(save_messages_locale, save_input_locale)) { - Safefree(save_input_locale); - } - else if (! setlocale(LC_MESSAGES, save_input_locale)) { - Safefree(save_messages_locale); - goto cant_use_messages; - } - } +void +Perl_sync_locale(pTHX) +{ - /* Here the current LC_MESSAGES is set to the locale of the category - * whose information is desired. Look through all the messages */ +#ifdef USE_LOCALE_CTYPE + new_ctype(setlocale(LC_CTYPE, NULL)); +#endif /* USE_LOCALE_CTYPE */ - for (e = 0; -#ifdef HAS_SYS_ERRLIST - e <= sys_nerr +#ifdef USE_LOCALE_COLLATE + new_collate(setlocale(LC_COLLATE, NULL)); #endif - ; e++) - { - const U8* const errmsg = (U8 *) Strerror(e) ; - if (!errmsg) - break; - if (! is_utf8_string(errmsg, 0)) { - failures++; - break; - } - else if (! is_ascii_string(errmsg, 0)) { - non_ascii++; - } - } - /* And, if we changed it, restore LC_MESSAGES to its original locale */ - if (save_messages_locale) { - setlocale(LC_MESSAGES, save_messages_locale); - Safefree(save_messages_locale); - } +#ifdef USE_LOCALE_NUMERIC + set_numeric_local(); /* Switch from "C" to underlying LC_NUMERIC */ + new_numeric(setlocale(LC_NUMERIC, NULL)); +#endif /* USE_LOCALE_NUMERIC */ + +} - /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid, - * any non-ascii means it is one; otherwise we assume it isn't */ - return (failures) ? FALSE : non_ascii; +#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. */ + + static char ret[128] = ""; + + 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 } - cant_use_messages: -#endif + my_strlcat(ret, ", ", sizeof(ret)); - Safefree(save_input_locale); - return FALSE; + 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 + /* - * Local variables: - * c-indentation-style: bsd - * c-basic-offset: 4 - * indent-tabs-mode: nil - * End: - * * ex: set ts=8 sts=4 sw=4 et: */