3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * A Elbereth Gilthoniel,
13 * silivren penna míriel
14 * o menel aglar elenath!
15 * Na-chaered palan-díriel
16 * o galadhremmin ennorath,
17 * Fanuilos, le linnathon
18 * nef aear, si nef aearon!
20 * [p.238 of _The Lord of the Rings_, II/i: "Many Meetings"]
23 /* utility functions for handling locale-specific stuff like what
24 * character represents the decimal point.
26 * All C programs have an underlying locale. Perl code generally doesn't pay
27 * any attention to it except within the scope of a 'use locale'. For most
28 * categories, it accomplishes this by just using different operations if it is
29 * in such scope than if not. However, various libc functions called by Perl
30 * are affected by the LC_NUMERIC category, so there are macros in perl.h that
31 * are used to toggle between the current locale and the C locale depending on
32 * the desired behavior of those functions at the moment. And, LC_MESSAGES is
33 * switched to the C locale for outputting the message unless within the scope
36 * This code now has multi-thread-safe locale handling on systems that support
37 * that. This is completely transparent to most XS code. On earlier systems,
38 * it would be possible to emulate thread-safe locales, but this likely would
39 * involve a lot of locale switching, and would require XS code changes.
40 * Macros could be written so that the code wouldn't have to know which type of
41 * system is being used. It's unlikely that we would ever do that, since most
42 * modern systems support thread-safe locales, but there was code written to
43 * this end, and is retained, #ifdef'd out.
47 #define PERL_IN_LOCALE_C
48 #include "perl_langinfo.h"
57 /* If the environment says to, we can output debugging information during
58 * initialization. This is done before option parsing, and before any thread
59 * creation, so can be a file-level static */
60 #if ! defined(DEBUGGING) || defined(PERL_GLOBAL_STRUCT)
61 # define debug_initialization 0
62 # define DEBUG_INITIALIZATION_set(v)
64 static bool debug_initialization = FALSE;
65 # define DEBUG_INITIALIZATION_set(v) (debug_initialization = v)
69 /* Returns the Unix errno portion; ignoring any others. This is a macro here
70 * instead of putting it into perl.h, because unclear to khw what should be
72 #define GET_ERRNO saved_errno
74 /* strlen() of a literal string constant. We might want this more general,
75 * but using it in just this file for now. A problem with more generality is
76 * the compiler warnings about comparing unlike signs */
77 #define STRLENs(s) (sizeof("" s "") - 1)
79 /* Is the C string input 'name' "C" or "POSIX"? If so, and 'name' is the
80 * return of setlocale(), then this is extremely likely to be the C or POSIX
81 * locale. However, the output of setlocale() is documented to be opaque, but
82 * the odds are extremely small that it would return these two strings for some
83 * other locale. Note that VMS in these two locales includes many non-ASCII
84 * characters as controls and punctuation (below are hex bytes):
86 * punct: A1-A3 A5 A7-AB B0-B3 B5-B7 B9-BD BF-CF D1-DD DF-EF F1-FD
87 * Oddly, none there are listed as alphas, though some represent alphabetics
88 * http://www.nntp.perl.org/group/perl.perl5.porters/2013/02/msg198753.html */
89 #define isNAME_C_OR_POSIX(name) \
91 && (( *(name) == 'C' && (*(name + 1)) == '\0') \
92 || strEQ((name), "POSIX")))
96 /* This code keeps a LRU cache of the UTF-8ness of the locales it has so-far
97 * looked up. This is in the form of a C string: */
99 #define UTF8NESS_SEP "\v"
100 #define UTF8NESS_PREFIX "\f"
102 /* So, the string looks like:
104 * \vC\a0\vPOSIX\a0\vam_ET\a0\vaf_ZA.utf8\a1\ven_US.UTF-8\a1\0
106 * where the digit 0 after the \a indicates that the locale starting just
107 * after the preceding \v is not UTF-8, and the digit 1 mean it is. */
109 STATIC_ASSERT_DECL(STRLENs(UTF8NESS_SEP) == 1);
110 STATIC_ASSERT_DECL(STRLENs(UTF8NESS_PREFIX) == 1);
112 #define C_and_POSIX_utf8ness UTF8NESS_SEP "C" UTF8NESS_PREFIX "0" \
113 UTF8NESS_SEP "POSIX" UTF8NESS_PREFIX "0"
115 /* The cache is initialized to C_and_POSIX_utf8ness at start up. These are
116 * kept there always. The remining portion of the cache is LRU, with the
117 * oldest looked-up locale at the tail end */
120 S_stdize_locale(pTHX_ char *locs)
122 /* Standardize the locale name from a string returned by 'setlocale',
123 * possibly modifying that string.
125 * The typical return value of setlocale() is either
126 * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
127 * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
128 * (the space-separated values represent the various sublocales,
129 * in some unspecified order). This is not handled by this function.
131 * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
132 * which is harmful for further use of the string in setlocale(). This
133 * function removes the trailing new line and everything up through the '='
136 const char * const s = strchr(locs, '=');
139 PERL_ARGS_ASSERT_STDIZE_LOCALE;
142 const char * const t = strchr(s, '.');
145 const char * const u = strchr(t, '\n');
146 if (u && (u[1] == 0)) {
147 const STRLEN len = u - s;
148 Move(s + 1, locs, len, char);
156 Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
161 /* Two parallel arrays; first the locale categories Perl uses on this system;
162 * the second array is their names. These arrays are in mostly arbitrary
165 const int categories[] = {
167 # ifdef USE_LOCALE_NUMERIC
170 # ifdef USE_LOCALE_CTYPE
173 # ifdef USE_LOCALE_COLLATE
176 # ifdef USE_LOCALE_TIME
179 # ifdef USE_LOCALE_MESSAGES
182 # ifdef USE_LOCALE_MONETARY
185 # ifdef USE_LOCALE_ADDRESS
188 # ifdef USE_LOCALE_IDENTIFICATION
191 # ifdef USE_LOCALE_MEASUREMENT
194 # ifdef USE_LOCALE_PAPER
197 # ifdef USE_LOCALE_TELEPHONE
203 -1 /* Placeholder because C doesn't allow a
204 trailing comma, and it would get complicated
205 with all the #ifdef's */
208 /* The top-most real element is LC_ALL */
210 const char * category_names[] = {
212 # ifdef USE_LOCALE_NUMERIC
215 # ifdef USE_LOCALE_CTYPE
218 # ifdef USE_LOCALE_COLLATE
221 # ifdef USE_LOCALE_TIME
224 # ifdef USE_LOCALE_MESSAGES
227 # ifdef USE_LOCALE_MONETARY
230 # ifdef USE_LOCALE_ADDRESS
233 # ifdef USE_LOCALE_IDENTIFICATION
236 # ifdef USE_LOCALE_MEASUREMENT
239 # ifdef USE_LOCALE_PAPER
242 # ifdef USE_LOCALE_TELEPHONE
248 NULL /* Placeholder */
253 /* On systems with LC_ALL, it is kept in the highest index position. (-2
254 * to account for the final unused placeholder element.) */
255 # define NOMINAL_LC_ALL_INDEX (C_ARRAY_LENGTH(categories) - 2)
259 /* On systems without LC_ALL, we pretend it is there, one beyond the real
260 * top element, hence in the unused placeholder element. */
261 # define NOMINAL_LC_ALL_INDEX (C_ARRAY_LENGTH(categories) - 1)
265 /* Pretending there is an LC_ALL element just above allows us to avoid most
266 * special cases. Most loops through these arrays in the code below are
267 * written like 'for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++)'. They will work
268 * on either type of system. But the code must be written to not access the
269 * element at 'LC_ALL_INDEX' except on platforms that have it. This can be
270 * checked for at compile time by using the #define LC_ALL_INDEX which is only
271 * defined if we do have LC_ALL. */
274 S_category_name(const int category)
280 if (category == LC_ALL) {
286 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
287 if (category == categories[i]) {
288 return category_names[i];
293 const char suffix[] = " (unknown)";
295 Size_t length = sizeof(suffix) + 1;
304 /* Calculate the number of digits */
310 Newx(unknown, length, char);
311 my_snprintf(unknown, length, "%d%s", category, suffix);
317 /* Now create LC_foo_INDEX #defines for just those categories on this system */
318 # ifdef USE_LOCALE_NUMERIC
319 # define LC_NUMERIC_INDEX 0
320 # define _DUMMY_NUMERIC LC_NUMERIC_INDEX
322 # define _DUMMY_NUMERIC -1
324 # ifdef USE_LOCALE_CTYPE
325 # define LC_CTYPE_INDEX _DUMMY_NUMERIC + 1
326 # define _DUMMY_CTYPE LC_CTYPE_INDEX
328 # define _DUMMY_CTYPE _DUMMY_NUMERIC
330 # ifdef USE_LOCALE_COLLATE
331 # define LC_COLLATE_INDEX _DUMMY_CTYPE + 1
332 # define _DUMMY_COLLATE LC_COLLATE_INDEX
334 # define _DUMMY_COLLATE _DUMMY_COLLATE
336 # ifdef USE_LOCALE_TIME
337 # define LC_TIME_INDEX _DUMMY_COLLATE + 1
338 # define _DUMMY_TIME LC_TIME_INDEX
340 # define _DUMMY_TIME _DUMMY_COLLATE
342 # ifdef USE_LOCALE_MESSAGES
343 # define LC_MESSAGES_INDEX _DUMMY_TIME + 1
344 # define _DUMMY_MESSAGES LC_MESSAGES_INDEX
346 # define _DUMMY_MESSAGES _DUMMY_TIME
348 # ifdef USE_LOCALE_MONETARY
349 # define LC_MONETARY_INDEX _DUMMY_MESSAGES + 1
350 # define _DUMMY_MONETARY LC_MONETARY_INDEX
352 # define _DUMMY_MONETARY _DUMMY_MESSAGES
354 # ifdef USE_LOCALE_ADDRESS
355 # define LC_ADDRESS_INDEX _DUMMY_MONETARY + 1
356 # define _DUMMY_ADDRESS LC_ADDRESS_INDEX
358 # define _DUMMY_ADDRESS _DUMMY_MONETARY
360 # ifdef USE_LOCALE_IDENTIFICATION
361 # define LC_IDENTIFICATION_INDEX _DUMMY_ADDRESS + 1
362 # define _DUMMY_IDENTIFICATION LC_IDENTIFICATION_INDEX
364 # define _DUMMY_IDENTIFICATION _DUMMY_ADDRESS
366 # ifdef USE_LOCALE_MEASUREMENT
367 # define LC_MEASUREMENT_INDEX _DUMMY_IDENTIFICATION + 1
368 # define _DUMMY_MEASUREMENT LC_MEASUREMENT_INDEX
370 # define _DUMMY_MEASUREMENT _DUMMY_IDENTIFICATION
372 # ifdef USE_LOCALE_PAPER
373 # define LC_PAPER_INDEX _DUMMY_MEASUREMENT + 1
374 # define _DUMMY_PAPER LC_PAPER_INDEX
376 # define _DUMMY_PAPER _DUMMY_MEASUREMENT
378 # ifdef USE_LOCALE_TELEPHONE
379 # define LC_TELEPHONE_INDEX _DUMMY_PAPER + 1
380 # define _DUMMY_TELEPHONE LC_TELEPHONE_INDEX
382 # define _DUMMY_TELEPHONE _DUMMY_PAPER
385 # define LC_ALL_INDEX _DUMMY_TELEPHONE + 1
387 #endif /* ifdef USE_LOCALE */
389 /* Windows requres a customized base-level setlocale() */
391 # define my_setlocale(cat, locale) win32_setlocale(cat, locale)
393 # define my_setlocale(cat, locale) setlocale(cat, locale)
396 #ifndef USE_POSIX_2008_LOCALE
398 /* "do_setlocale_c" is intended to be called when the category is a constant
399 * known at compile time; "do_setlocale_r", not known until run time */
400 # define do_setlocale_c(cat, locale) my_setlocale(cat, locale)
401 # define do_setlocale_r(cat, locale) my_setlocale(cat, locale)
403 #else /* Below uses POSIX 2008 */
405 /* We emulate setlocale with our own function. LC_foo is not valid for the
406 * POSIX 2008 functions. Instead LC_foo_MASK is used, which we use an array
407 * lookup to convert to. At compile time we have defined LC_foo_INDEX as the
408 * proper offset into the array 'category_masks[]'. At runtime, we have to
409 * search through the array (as the actual numbers may not be small contiguous
410 * positive integers which would lend themselves to array lookup). */
411 # define do_setlocale_c(cat, locale) \
412 emulate_setlocale(cat, locale, cat ## _INDEX, TRUE)
413 # define do_setlocale_r(cat, locale) emulate_setlocale(cat, locale, 0, FALSE)
415 /* A third array, parallel to the ones above to map from category to its
417 const int category_masks[] = {
418 # ifdef USE_LOCALE_NUMERIC
421 # ifdef USE_LOCALE_CTYPE
424 # ifdef USE_LOCALE_COLLATE
427 # ifdef USE_LOCALE_TIME
430 # ifdef USE_LOCALE_MESSAGES
433 # ifdef USE_LOCALE_MONETARY
436 # ifdef USE_LOCALE_ADDRESS
439 # ifdef USE_LOCALE_IDENTIFICATION
440 LC_IDENTIFICATION_MASK,
442 # ifdef USE_LOCALE_MEASUREMENT
445 # ifdef USE_LOCALE_PAPER
448 # ifdef USE_LOCALE_TELEPHONE
451 /* LC_ALL can't be turned off by a Configure
452 * option, and in Posix 2008, should always be
453 * here, so compile it in unconditionally.
454 * This could catch some glitches at compile
460 S_emulate_setlocale(const int category,
463 const bool is_index_valid
466 /* This function effectively performs a setlocale() on just the current
467 * thread; thus it is thread-safe. It does this by using the POSIX 2008
468 * locale functions to emulate the behavior of setlocale(). Similar to
469 * regular setlocale(), the return from this function points to memory that
470 * can be overwritten by other system calls, so needs to be copied
471 * immediately if you need to retain it. The difference here is that
472 * system calls besides another setlocale() can overwrite it.
474 * By doing this, most locale-sensitive functions become thread-safe. The
475 * exceptions are mostly those that return a pointer to static memory.
477 * This function takes the same parameters, 'category' and 'locale', that
478 * the regular setlocale() function does, but it also takes two additional
479 * ones. This is because the 2008 functions don't use a category; instead
480 * they use a corresponding mask. Because this function operates in both
481 * worlds, it may need one or the other or both. This function can
482 * calculate the mask from the input category, but to avoid this
483 * calculation, if the caller knows at compile time what the mask is, it
484 * can pass it, setting 'is_index_valid' to TRUE; otherwise the mask
485 * parameter is ignored.
487 * POSIX 2008, for some sick reason, chose not to provide a method to find
488 * the category name of a locale. Some vendors have created a
489 * querylocale() function to do just that. This function is a lot simpler
490 * to implement on systems that have this. Otherwise, we have to keep
491 * track of what the locale has been set to, so that we can return its
492 * name to emulate setlocale(). It's also possible for C code in some
493 * library to change the locale without us knowing it, though as of
494 * September 2017, there are no occurrences in CPAN of uselocale(). Some
495 * libraries do use setlocale(), but that changes the global locale, and
496 * threads using per-thread locales will just ignore those changes.
497 * Another problem is that without querylocale(), we have to guess at what
498 * was meant by setting a locale of "". We handle this by not actually
499 * ever setting to "" (unless querylocale exists), but to emulate what we
500 * think should happen for "".
510 if (DEBUG_Lv_TEST || debug_initialization) {
511 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale input=%d (%s), \"%s\", %d, %d\n", __FILE__, __LINE__, category, category_name(category), locale, index, is_index_valid);
516 /* If the input mask might be incorrect, calculate the correct one */
517 if (! is_index_valid) {
522 if (DEBUG_Lv_TEST || debug_initialization) {
523 PerlIO_printf(Perl_debug_log, "%s:%d: finding index of category %d (%s)\n", __FILE__, __LINE__, category, category_name(category));
528 for (i = 0; i <= LC_ALL_INDEX; i++) {
529 if (category == categories[i]) {
535 /* Here, we don't know about this category, so can't handle it.
536 * Fallback to the early POSIX usages */
537 Perl_warner(aTHX_ packWARN(WARN_LOCALE),
538 "Unknown locale category %d; can't set it to %s\n",
546 if (DEBUG_Lv_TEST || debug_initialization) {
547 PerlIO_printf(Perl_debug_log, "%s:%d: index is %d for %s\n", __FILE__, __LINE__, index, category_name(category));
554 mask = category_masks[index];
558 if (DEBUG_Lv_TEST || debug_initialization) {
559 PerlIO_printf(Perl_debug_log, "%s:%d: category name is %s; mask is 0x%x\n", __FILE__, __LINE__, category_names[index], mask);
564 /* If just querying what the existing locale is ... */
565 if (locale == NULL) {
566 locale_t cur_obj = uselocale((locale_t) 0);
570 if (DEBUG_Lv_TEST || debug_initialization) {
571 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale querying %p\n", __FILE__, __LINE__, cur_obj);
576 if (cur_obj == LC_GLOBAL_LOCALE) {
577 return my_setlocale(category, NULL);
580 # ifdef HAS_QUERYLOCALE
582 return (char *) querylocale(mask, cur_obj);
586 /* If this assert fails, adjust the size of curlocales in intrpvar.h */
587 STATIC_ASSERT_STMT(C_ARRAY_LENGTH(PL_curlocales) > LC_ALL_INDEX);
589 # if defined(_NL_LOCALE_NAME) && defined(DEBUGGING)
592 /* Internal glibc for querylocale(), but doesn't handle
593 * empty-string ("") locale properly; who knows what other
594 * glitches. Check it for now, under debug. */
596 char * temp_name = nl_langinfo_l(_NL_LOCALE_NAME(category),
597 uselocale((locale_t) 0));
599 PerlIO_printf(Perl_debug_log, "%s:%d: temp_name=%s\n", __FILE__, __LINE__, temp_name ? temp_name : "NULL");
600 PerlIO_printf(Perl_debug_log, "%s:%d: index=%d\n", __FILE__, __LINE__, index);
601 PerlIO_printf(Perl_debug_log, "%s:%d: PL_curlocales[index]=%s\n", __FILE__, __LINE__, PL_curlocales[index]);
603 if (temp_name && PL_curlocales[index] && strNE(temp_name, "")) {
604 if ( strNE(PL_curlocales[index], temp_name)
605 && ! ( isNAME_C_OR_POSIX(temp_name)
606 && isNAME_C_OR_POSIX(PL_curlocales[index]))) {
608 # ifdef USE_C_BACKTRACE
610 dump_c_backtrace(Perl_debug_log, 20, 1);
614 Perl_croak(aTHX_ "panic: Mismatch between what Perl thinks %s is"
615 " (%s) and what internal glibc thinks"
616 " (%s)\n", category_names[index],
617 PL_curlocales[index], temp_name);
626 /* Without querylocale(), we have to use our record-keeping we've
629 if (category != LC_ALL) {
633 if (DEBUG_Lv_TEST || debug_initialization) {
634 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, PL_curlocales[index]);
639 return PL_curlocales[index];
641 else { /* For LC_ALL */
643 Size_t names_len = 0;
645 bool are_all_categories_the_same_locale = TRUE;
647 /* If we have a valid LC_ALL value, just return it */
648 if (PL_curlocales[LC_ALL_INDEX]) {
652 if (DEBUG_Lv_TEST || debug_initialization) {
653 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, PL_curlocales[LC_ALL_INDEX]);
658 return PL_curlocales[LC_ALL_INDEX];
661 /* Otherwise, we need to construct a string of name=value pairs.
662 * We use the glibc syntax, like
663 * LC_NUMERIC=C;LC_TIME=en_US.UTF-8;...
664 * First calculate the needed size. Along the way, check if all
665 * the locale names are the same */
666 for (i = 0; i < LC_ALL_INDEX; i++) {
670 if (DEBUG_Lv_TEST || debug_initialization) {
671 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale i=%d, name=%s, locale=%s\n", __FILE__, __LINE__, i, category_names[i], PL_curlocales[i]);
676 names_len += strlen(category_names[i])
678 + strlen(PL_curlocales[i])
681 if (i > 0 && strNE(PL_curlocales[i], PL_curlocales[i-1])) {
682 are_all_categories_the_same_locale = FALSE;
686 /* If they are the same, we don't actually have to construct the
687 * string; we just make the entry in LC_ALL_INDEX valid, and be
688 * that single name */
689 if (are_all_categories_the_same_locale) {
690 PL_curlocales[LC_ALL_INDEX] = savepv(PL_curlocales[0]);
691 return PL_curlocales[LC_ALL_INDEX];
694 names_len++; /* Trailing '\0' */
695 SAVEFREEPV(Newx(all_string, names_len, char));
698 /* Then fill in the string */
699 for (i = 0; i < LC_ALL_INDEX; i++) {
703 if (DEBUG_Lv_TEST || debug_initialization) {
704 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale i=%d, name=%s, locale=%s\n", __FILE__, __LINE__, i, category_names[i], PL_curlocales[i]);
709 my_strlcat(all_string, category_names[i], names_len);
710 my_strlcat(all_string, "=", names_len);
711 my_strlcat(all_string, PL_curlocales[i], names_len);
712 my_strlcat(all_string, ";", names_len);
717 if (DEBUG_L_TEST || debug_initialization) {
718 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, all_string);
728 SETERRNO(EINVAL, LIB_INVARG);
738 assert(PL_C_locale_obj);
740 /* Otherwise, we are switching locales. This will generally entail freeing
741 * the current one's space (at the C library's discretion). We need to
742 * stop using that locale before the switch. So switch to a known locale
743 * object that we don't otherwise mess with. This returns the locale
744 * object in effect at the time of the switch. */
745 old_obj = uselocale(PL_C_locale_obj);
749 if (DEBUG_Lv_TEST || debug_initialization) {
750 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale was using %p\n", __FILE__, __LINE__, old_obj);
759 if (DEBUG_L_TEST || debug_initialization) {
761 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale switching to C failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
772 if (DEBUG_Lv_TEST || debug_initialization) {
773 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale now using %p\n", __FILE__, __LINE__, PL_C_locale_obj);
778 /* If we weren't in a thread safe locale, set so that newlocale() below
779 which uses 'old_obj', uses an empty one. Same for our reserved C object.
780 The latter is defensive coding, so that, even if there is some bug, we
781 will never end up trying to modify either of these, as if passed to
782 newlocale(), they can be. */
783 if (old_obj == LC_GLOBAL_LOCALE || old_obj == PL_C_locale_obj) {
784 old_obj = (locale_t) 0;
787 /* Create the new locale (it may actually modify the current one). */
789 # ifndef HAS_QUERYLOCALE
791 if (strEQ(locale, "")) {
793 /* For non-querylocale() systems, we do the setting of "" ourselves to
794 * be sure that we really know what's going on. We follow the Linux
795 * documented behavior (but if that differs from the actual behavior,
796 * this won't work exactly as the OS implements). We go out and
797 * examine the environment based on our understanding of how the system
798 * works, and use that to figure things out */
800 const char * const lc_all = PerlEnv_getenv("LC_ALL");
802 /* Use any "LC_ALL" environment variable, as it overrides everything
804 if (lc_all && strNE(lc_all, "")) {
809 /* Otherwise, we need to dig deeper. Unless overridden, the
810 * default is the LANG environment variable; if it doesn't exist,
813 const char * default_name;
815 /* To minimize other threads messing with the environment, we copy
816 * the variable, making it a temporary. But this doesn't work upon
817 * program initialization before any scopes are created, and at
818 * this time, there's nothing else going on that would interfere.
819 * So skip the copy in that case */
820 if (PL_scopestack_ix == 0) {
821 default_name = PerlEnv_getenv("LANG");
824 default_name = savepv(PerlEnv_getenv("LANG"));
827 if (! default_name || strEQ(default_name, "")) {
830 else if (PL_scopestack_ix != 0) {
831 SAVEFREEPV(default_name);
834 if (category != LC_ALL) {
835 const char * const name = PerlEnv_getenv(category_names[index]);
837 /* Here we are setting a single category. Assume will have the
839 locale = default_name;
841 /* But then look for an overriding environment variable */
842 if (name && strNE(name, "")) {
847 bool did_override = FALSE;
850 /* Here, we are getting LC_ALL. Any categories that don't have
851 * a corresponding environment variable set should be set to
852 * LANG, or to "C" if there is no LANG. If no individual
853 * categories differ from this, we can just set LC_ALL. This
854 * is buggy on systems that have extra categories that we don't
855 * know about. If there is an environment variable that sets
856 * that category, we won't know to look for it, and so our use
857 * of LANG or "C" improperly overrides it. On the other hand,
858 * if we don't do what is done here, and there is no
859 * environment variable, the category's locale should be set to
860 * LANG or "C". So there is no good solution. khw thinks the
861 * best is to look at systems to see what categories they have,
862 * and include them, and then to assume that we know the
865 for (i = 0; i < LC_ALL_INDEX; i++) {
866 const char * const env_override
867 = savepv(PerlEnv_getenv(category_names[i]));
868 const char * this_locale = ( env_override
869 && strNE(env_override, ""))
872 if (! emulate_setlocale(categories[i], this_locale, i, TRUE))
874 Safefree(env_override);
878 if (strNE(this_locale, default_name)) {
882 Safefree(env_override);
885 /* If all the categories are the same, we can set LC_ALL to
887 if (! did_override) {
888 locale = default_name;
892 /* Here, LC_ALL is no longer valid, as some individual
893 * categories don't match it. We call ourselves
894 * recursively, as that will execute the code that
895 * generates the proper locale string for this situation.
896 * We don't do the remainder of this function, as that is
897 * to update our records, and we've just done that for the
898 * individual categories in the loop above, and doing so
899 * would cause LC_ALL to be done as well */
900 return emulate_setlocale(LC_ALL, NULL, LC_ALL_INDEX, TRUE);
905 else if (strchr(locale, ';')) {
907 /* LC_ALL may actually incude a conglomeration of various categories.
908 * Without querylocale, this code uses the glibc (as of this writing)
909 * syntax for representing that, but that is not a stable API, and
910 * other platforms do it differently, so we have to handle all cases
913 const char * s = locale;
914 const char * e = locale + strlen(locale);
916 const char * category_end;
917 const char * name_start;
918 const char * name_end;
923 /* Parse through the category */
924 while (isWORDCHAR(*p)) {
931 "panic: %s: %d: Unexpected character in locale name '%02X",
932 __FILE__, __LINE__, *(p-1));
935 /* Parse through the locale name */
937 while (p < e && *p != ';') {
940 "panic: %s: %d: Unexpected character in locale name '%02X",
941 __FILE__, __LINE__, *(p-1));
947 /* Space past the semi-colon */
952 /* Find the index of the category name in our lists */
953 for (i = 0; i < LC_ALL_INDEX; i++) {
954 char * individ_locale;
956 /* Keep going if this isn't the index. The strnNE() avoids a
957 * Perl_form(), but would fail if ever a category name could be
958 * a substring of another one, like if there were a
960 if strnNE(s, category_names[i], category_end - s) {
964 /* If this index is for the single category we're changing, we
965 * have found the locale to set it to. */
966 if (category == categories[i]) {
967 locale = Perl_form(aTHX_ "%.*s",
968 (int) (name_end - name_start),
973 assert(category == LC_ALL);
974 individ_locale = Perl_form(aTHX_ "%.*s",
975 (int) (name_end - name_start), name_start);
976 if (! emulate_setlocale(categories[i], individ_locale, i, TRUE))
985 /* Here we have set all the individual categories by recursive calls.
986 * These collectively should have fixed up LC_ALL, so can just query
987 * what that now is */
988 assert(category == LC_ALL);
990 return do_setlocale_c(LC_ALL, NULL);
995 # endif /* end of ! querylocale */
997 /* Ready to create a new locale by modification of the exising one */
998 new_obj = newlocale(mask, locale, old_obj);
1005 if (DEBUG_L_TEST || debug_initialization) {
1006 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale creating new object failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1011 if (! uselocale(old_obj)) {
1015 if (DEBUG_L_TEST || debug_initialization) {
1016 PerlIO_printf(Perl_debug_log, "%s:%d: switching back failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1028 if (DEBUG_Lv_TEST || debug_initialization) {
1029 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale created %p\n", __FILE__, __LINE__, new_obj);
1034 /* And switch into it */
1035 if (! uselocale(new_obj)) {
1040 if (DEBUG_L_TEST || debug_initialization) {
1041 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale switching to new object failed\n", __FILE__, __LINE__);
1046 if (! uselocale(old_obj)) {
1050 if (DEBUG_L_TEST || debug_initialization) {
1051 PerlIO_printf(Perl_debug_log, "%s:%d: switching back failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1057 freelocale(new_obj);
1064 if (DEBUG_Lv_TEST || debug_initialization) {
1065 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale now using %p\n", __FILE__, __LINE__, new_obj);
1070 /* We are done, except for updating our records (if the system doesn't keep
1071 * them) and in the case of locale "", we don't actually know what the
1072 * locale that got switched to is, as it came from the environment. So
1073 * have to find it */
1075 # ifdef HAS_QUERYLOCALE
1077 if (strEQ(locale, "")) {
1078 locale = querylocale(mask, new_obj);
1083 /* Here, 'locale' is the return value */
1085 /* Without querylocale(), we have to update our records */
1087 if (category == LC_ALL) {
1090 /* For LC_ALL, we change all individual categories to correspond */
1091 /* PL_curlocales is a parallel array, so has same
1092 * length as 'categories' */
1093 for (i = 0; i <= LC_ALL_INDEX; i++) {
1094 Safefree(PL_curlocales[i]);
1095 PL_curlocales[i] = savepv(locale);
1100 /* For a single category, if it's not the same as the one in LC_ALL, we
1103 if (PL_curlocales[LC_ALL_INDEX] && strNE(PL_curlocales[LC_ALL_INDEX], locale)) {
1104 Safefree(PL_curlocales[LC_ALL_INDEX]);
1105 PL_curlocales[LC_ALL_INDEX] = NULL;
1108 /* Then update the category's record */
1109 Safefree(PL_curlocales[index]);
1110 PL_curlocales[index] = savepv(locale);
1118 #endif /* USE_POSIX_2008_LOCALE */
1120 #if 0 /* Code that was to emulate thread-safe locales on platforms that
1121 didn't natively support them */
1123 /* The way this would work is that we would keep a per-thread list of the
1124 * correct locale for that thread. Any operation that was locale-sensitive
1125 * would have to be changed so that it would look like this:
1128 * setlocale to the correct locale for this operation
1132 * This leaves the global locale in the most recently used operation's, but it
1133 * was locked long enough to get the result. If that result is static, it
1134 * needs to be copied before the unlock.
1136 * Macros could be written like SETUP_LOCALE_DEPENDENT_OP(category) that did
1137 * the setup, but are no-ops when not needed, and similarly,
1138 * END_LOCALE_DEPENDENT_OP for the tear-down
1140 * But every call to a locale-sensitive function would have to be changed, and
1141 * if a module didn't cooperate by using the mutex, things would break.
1143 * This code was abandoned before being completed or tested, and is left as-is
1146 # define do_setlocale_c(cat, locale) locking_setlocale(cat, locale, cat ## _INDEX, TRUE)
1147 # define do_setlocale_r(cat, locale) locking_setlocale(cat, locale, 0, FALSE)
1150 S_locking_setlocale(pTHX_
1152 const char * locale,
1154 const bool is_index_valid
1157 /* This function kind of performs a setlocale() on just the current thread;
1158 * thus it is kind of thread-safe. It does this by keeping a thread-level
1159 * array of the current locales for each category. Every time a locale is
1160 * switched to, it does the switch globally, but updates the thread's
1161 * array. A query as to what the current locale is just returns the
1162 * appropriate element from the array, and doesn't actually call the system
1163 * setlocale(). The saving into the array is done in an uninterruptible
1164 * section of code, so is unaffected by whatever any other threads might be
1167 * All locale-sensitive operations must work by first starting a critical
1168 * section, then switching to the thread's locale as kept by this function,
1169 * and then doing the operation, then ending the critical section. Thus,
1170 * each gets done in the appropriate locale. simulating thread-safety.
1172 * This function takes the same parameters, 'category' and 'locale', that
1173 * the regular setlocale() function does, but it also takes two additional
1174 * ones. This is because as described earlier. If we know on input the
1175 * index corresponding to the category into the array where we store the
1176 * current locales, we don't have to calculate it. If the caller knows at
1177 * compile time what the index is, it it can pass it, setting
1178 * 'is_index_valid' to TRUE; otherwise the index parameter is ignored.
1182 /* If the input index might be incorrect, calculate the correct one */
1183 if (! is_index_valid) {
1186 if (DEBUG_Lv_TEST || debug_initialization) {
1187 PerlIO_printf(Perl_debug_log, "%s:%d: converting category %d to index\n", __FILE__, __LINE__, category);
1190 for (i = 0; i <= LC_ALL_INDEX; i++) {
1191 if (category == categories[i]) {
1197 /* Here, we don't know about this category, so can't handle it.
1198 * XXX best we can do is to unsafely set this
1201 return my_setlocale(category, locale);
1205 if (DEBUG_Lv_TEST || debug_initialization) {
1206 PerlIO_printf(Perl_debug_log, "%s:%d: index is 0x%x\n", __FILE__, __LINE__, index);
1210 /* For a query, just return what's in our records */
1211 if (new_locale == NULL) {
1212 return curlocales[index];
1216 /* Otherwise, we need to do the switch, and save the result, all in a
1217 * critical section */
1219 Safefree(curlocales[[index]]);
1221 /* It might be that this is called from an already-locked section of code.
1222 * We would have to detect and skip the LOCK/UNLOCK if so */
1225 curlocales[index] = savepv(my_setlocale(category, new_locale));
1227 if (strEQ(new_locale, "")) {
1231 /* The locale values come from the environment, and may not all be the
1232 * same, so for LC_ALL, we have to update all the others, while the
1233 * mutex is still locked */
1235 if (category == LC_ALL) {
1237 for (i = 0; i < LC_ALL_INDEX) {
1238 curlocales[i] = my_setlocale(categories[i], NULL);
1247 return curlocales[index];
1253 S_set_numeric_radix(pTHX_ const bool use_locale)
1255 /* If 'use_locale' is FALSE, set to use a dot for the radix character. If
1256 * TRUE, use the radix character derived from the current locale */
1258 #if defined(USE_LOCALE_NUMERIC) && ( defined(HAS_LOCALECONV) \
1259 || defined(HAS_NL_LANGINFO))
1261 const char * radix = (use_locale)
1262 ? my_nl_langinfo(RADIXCHAR, FALSE)
1263 /* FALSE => already in dest locale */
1266 sv_setpv(PL_numeric_radix_sv, radix);
1268 /* If this is valid UTF-8 that isn't totally ASCII, and we are in
1269 * a UTF-8 locale, then mark the radix as being in UTF-8 */
1270 if (is_utf8_non_invariant_string((U8 *) SvPVX(PL_numeric_radix_sv),
1271 SvCUR(PL_numeric_radix_sv))
1272 && _is_cur_LC_category_utf8(LC_NUMERIC))
1274 SvUTF8_on(PL_numeric_radix_sv);
1279 if (DEBUG_L_TEST || debug_initialization) {
1280 PerlIO_printf(Perl_debug_log, "Locale radix is '%s', ?UTF-8=%d\n",
1281 SvPVX(PL_numeric_radix_sv),
1282 cBOOL(SvUTF8(PL_numeric_radix_sv)));
1286 #endif /* USE_LOCALE_NUMERIC and can find the radix char */
1291 S_new_numeric(pTHX_ const char *newnum)
1294 #ifndef USE_LOCALE_NUMERIC
1296 PERL_UNUSED_ARG(newnum);
1300 /* Called after each libc setlocale() call affecting LC_NUMERIC, to tell
1301 * core Perl this and that 'newnum' is the name of the new locale.
1302 * It installs this locale as the current underlying default.
1304 * The default locale and the C locale can be toggled between by use of the
1305 * set_numeric_underlying() and set_numeric_standard() functions, which
1306 * should probably not be called directly, but only via macros like
1307 * SET_NUMERIC_STANDARD() in perl.h.
1309 * The toggling is necessary mainly so that a non-dot radix decimal point
1310 * character can be output, while allowing internal calculations to use a
1313 * This sets several interpreter-level variables:
1314 * PL_numeric_name The underlying locale's name: a copy of 'newnum'
1315 * PL_numeric_underlying A boolean indicating if the toggled state is such
1316 * that the current locale is the program's underlying
1318 * PL_numeric_standard An int indicating if the toggled state is such
1319 * that the current locale is the C locale or
1320 * indistinguishable from the C locale. If non-zero, it
1321 * is in C; if > 1, it means it may not be toggled away
1323 * PL_numeric_underlying_is_standard A bool kept by this function
1324 * indicating that the underlying locale and the standard
1325 * C locale are indistinguishable for the purposes of
1326 * LC_NUMERIC. This happens when both of the above two
1327 * variables are true at the same time. (Toggling is a
1328 * no-op under these circumstances.) This variable is
1329 * used to avoid having to recalculate.
1335 Safefree(PL_numeric_name);
1336 PL_numeric_name = NULL;
1337 PL_numeric_standard = TRUE;
1338 PL_numeric_underlying = TRUE;
1339 PL_numeric_underlying_is_standard = TRUE;
1343 save_newnum = stdize_locale(savepv(newnum));
1344 PL_numeric_underlying = TRUE;
1345 PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
1347 #ifndef TS_W32_BROKEN_LOCALECONV
1349 /* If its name isn't C nor POSIX, it could still be indistinguishable from
1350 * them. But on broken Windows systems calling my_nl_langinfo() for
1351 * THOUSEP can currently (but rarely) cause a race, so avoid doing that,
1352 * and just always change the locale if not C nor POSIX on those systems */
1353 if (! PL_numeric_standard) {
1354 PL_numeric_standard = cBOOL(strEQ(".", my_nl_langinfo(RADIXCHAR,
1355 FALSE /* Don't toggle locale */ ))
1356 && strEQ("", my_nl_langinfo(THOUSEP, FALSE)));
1361 /* Save the new name if it isn't the same as the previous one, if any */
1362 if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
1363 Safefree(PL_numeric_name);
1364 PL_numeric_name = save_newnum;
1367 Safefree(save_newnum);
1370 PL_numeric_underlying_is_standard = PL_numeric_standard;
1372 # ifdef HAS_POSIX_2008_LOCALE
1374 PL_underlying_numeric_obj = newlocale(LC_NUMERIC_MASK,
1376 PL_underlying_numeric_obj);
1380 if (DEBUG_L_TEST || debug_initialization) {
1381 PerlIO_printf(Perl_debug_log, "Called new_numeric with %s, PL_numeric_name=%s\n", newnum, PL_numeric_name);
1384 /* Keep LC_NUMERIC in the C locale. This is for XS modules, so they don't
1385 * have to worry about the radix being a non-dot. (Core operations that
1386 * need the underlying locale change to it temporarily). */
1387 if (PL_numeric_standard) {
1388 set_numeric_radix(0);
1391 set_numeric_standard();
1394 #endif /* USE_LOCALE_NUMERIC */
1399 Perl_set_numeric_standard(pTHX)
1402 #ifdef USE_LOCALE_NUMERIC
1404 /* Toggle the LC_NUMERIC locale to C. Most code should use the macros like
1405 * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly. The
1406 * macro avoids calling this routine if toggling isn't necessary according
1407 * to our records (which could be wrong if some XS code has changed the
1408 * locale behind our back) */
1410 do_setlocale_c(LC_NUMERIC, "C");
1411 PL_numeric_standard = TRUE;
1412 PL_numeric_underlying = PL_numeric_underlying_is_standard;
1413 set_numeric_radix(0);
1417 if (DEBUG_L_TEST || debug_initialization) {
1418 PerlIO_printf(Perl_debug_log,
1419 "LC_NUMERIC locale now is standard C\n");
1423 #endif /* USE_LOCALE_NUMERIC */
1428 Perl_set_numeric_underlying(pTHX)
1431 #ifdef USE_LOCALE_NUMERIC
1433 /* Toggle the LC_NUMERIC locale to the current underlying default. Most
1434 * code should use the macros like SET_NUMERIC_UNDERLYING() in perl.h
1435 * instead of calling this directly. The macro avoids calling this routine
1436 * if toggling isn't necessary according to our records (which could be
1437 * wrong if some XS code has changed the locale behind our back) */
1439 do_setlocale_c(LC_NUMERIC, PL_numeric_name);
1440 PL_numeric_standard = PL_numeric_underlying_is_standard;
1441 PL_numeric_underlying = TRUE;
1442 set_numeric_radix(! PL_numeric_standard);
1446 if (DEBUG_L_TEST || debug_initialization) {
1447 PerlIO_printf(Perl_debug_log,
1448 "LC_NUMERIC locale now is %s\n",
1453 #endif /* USE_LOCALE_NUMERIC */
1458 * Set up for a new ctype locale.
1461 S_new_ctype(pTHX_ const char *newctype)
1464 #ifndef USE_LOCALE_CTYPE
1466 PERL_ARGS_ASSERT_NEW_CTYPE;
1467 PERL_UNUSED_ARG(newctype);
1468 PERL_UNUSED_CONTEXT;
1472 /* Called after each libc setlocale() call affecting LC_CTYPE, to tell
1473 * core Perl this and that 'newctype' is the name of the new locale.
1475 * This function sets up the folding arrays for all 256 bytes, assuming
1476 * that tofold() is tolc() since fold case is not a concept in POSIX,
1478 * Any code changing the locale (outside this file) should use
1479 * Perl_setlocale or POSIX::setlocale, which call this function. Therefore
1480 * this function should be called directly only from this file and from
1481 * POSIX::setlocale() */
1486 /* Don't check for problems if we are suppressing the warnings */
1487 bool check_for_problems = ckWARN_d(WARN_LOCALE) || UNLIKELY(DEBUG_L_TEST);
1489 PERL_ARGS_ASSERT_NEW_CTYPE;
1491 /* We will replace any bad locale warning with 1) nothing if the new one is
1492 * ok; or 2) a new warning for the bad new locale */
1493 if (PL_warn_locale) {
1494 SvREFCNT_dec_NN(PL_warn_locale);
1495 PL_warn_locale = NULL;
1498 PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE);
1500 /* A UTF-8 locale gets standard rules. But note that code still has to
1501 * handle this specially because of the three problematic code points */
1502 if (PL_in_utf8_CTYPE_locale) {
1503 Copy(PL_fold_latin1, PL_fold_locale, 256, U8);
1506 /* We don't populate the other lists if a UTF-8 locale, but do check that
1507 * everything works as expected, unless checking turned off */
1508 if (check_for_problems || ! PL_in_utf8_CTYPE_locale) {
1509 /* Assume enough space for every character being bad. 4 spaces each
1510 * for the 94 printable characters that are output like "'x' "; and 5
1511 * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating
1513 char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ] = { '\0' };
1514 bool multi_byte_locale = FALSE; /* Assume is a single-byte locale
1516 unsigned int bad_count = 0; /* Count of bad characters */
1518 for (i = 0; i < 256; i++) {
1519 if (! PL_in_utf8_CTYPE_locale) {
1521 PL_fold_locale[i] = (U8) tolower(i);
1522 else if (islower(i))
1523 PL_fold_locale[i] = (U8) toupper(i);
1525 PL_fold_locale[i] = (U8) i;
1528 /* If checking for locale problems, see if the native ASCII-range
1529 * printables plus \n and \t are in their expected categories in
1530 * the new locale. If not, this could mean big trouble, upending
1531 * Perl's and most programs' assumptions, like having a
1532 * metacharacter with special meaning become a \w. Fortunately,
1533 * it's very rare to find locales that aren't supersets of ASCII
1534 * nowadays. It isn't a problem for most controls to be changed
1535 * into something else; we check only \n and \t, though perhaps \r
1536 * could be an issue as well. */
1537 if ( check_for_problems
1538 && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n'))
1540 bool is_bad = FALSE;
1541 char name[3] = { '\0' };
1543 /* Convert the name into a string */
1548 else if (i == '\n') {
1549 my_strlcpy(name, "\n", sizeof(name));
1552 my_strlcpy(name, "\t", sizeof(name));
1555 /* Check each possibe class */
1556 if (UNLIKELY(cBOOL(isalnum(i)) != cBOOL(isALPHANUMERIC_A(i)))) {
1558 DEBUG_L(PerlIO_printf(Perl_debug_log,
1559 "isalnum('%s') unexpectedly is %d\n",
1560 name, cBOOL(isalnum(i))));
1562 if (UNLIKELY(cBOOL(isalpha(i)) != cBOOL(isALPHA_A(i)))) {
1564 DEBUG_L(PerlIO_printf(Perl_debug_log,
1565 "isalpha('%s') unexpectedly is %d\n",
1566 name, cBOOL(isalpha(i))));
1568 if (UNLIKELY(cBOOL(isdigit(i)) != cBOOL(isDIGIT_A(i)))) {
1570 DEBUG_L(PerlIO_printf(Perl_debug_log,
1571 "isdigit('%s') unexpectedly is %d\n",
1572 name, cBOOL(isdigit(i))));
1574 if (UNLIKELY(cBOOL(isgraph(i)) != cBOOL(isGRAPH_A(i)))) {
1576 DEBUG_L(PerlIO_printf(Perl_debug_log,
1577 "isgraph('%s') unexpectedly is %d\n",
1578 name, cBOOL(isgraph(i))));
1580 if (UNLIKELY(cBOOL(islower(i)) != cBOOL(isLOWER_A(i)))) {
1582 DEBUG_L(PerlIO_printf(Perl_debug_log,
1583 "islower('%s') unexpectedly is %d\n",
1584 name, cBOOL(islower(i))));
1586 if (UNLIKELY(cBOOL(isprint(i)) != cBOOL(isPRINT_A(i)))) {
1588 DEBUG_L(PerlIO_printf(Perl_debug_log,
1589 "isprint('%s') unexpectedly is %d\n",
1590 name, cBOOL(isprint(i))));
1592 if (UNLIKELY(cBOOL(ispunct(i)) != cBOOL(isPUNCT_A(i)))) {
1594 DEBUG_L(PerlIO_printf(Perl_debug_log,
1595 "ispunct('%s') unexpectedly is %d\n",
1596 name, cBOOL(ispunct(i))));
1598 if (UNLIKELY(cBOOL(isspace(i)) != cBOOL(isSPACE_A(i)))) {
1600 DEBUG_L(PerlIO_printf(Perl_debug_log,
1601 "isspace('%s') unexpectedly is %d\n",
1602 name, cBOOL(isspace(i))));
1604 if (UNLIKELY(cBOOL(isupper(i)) != cBOOL(isUPPER_A(i)))) {
1606 DEBUG_L(PerlIO_printf(Perl_debug_log,
1607 "isupper('%s') unexpectedly is %d\n",
1608 name, cBOOL(isupper(i))));
1610 if (UNLIKELY(cBOOL(isxdigit(i))!= cBOOL(isXDIGIT_A(i)))) {
1612 DEBUG_L(PerlIO_printf(Perl_debug_log,
1613 "isxdigit('%s') unexpectedly is %d\n",
1614 name, cBOOL(isxdigit(i))));
1616 if (UNLIKELY(tolower(i) != (int) toLOWER_A(i))) {
1618 DEBUG_L(PerlIO_printf(Perl_debug_log,
1619 "tolower('%s')=0x%x instead of the expected 0x%x\n",
1620 name, tolower(i), (int) toLOWER_A(i)));
1622 if (UNLIKELY(toupper(i) != (int) toUPPER_A(i))) {
1624 DEBUG_L(PerlIO_printf(Perl_debug_log,
1625 "toupper('%s')=0x%x instead of the expected 0x%x\n",
1626 name, toupper(i), (int) toUPPER_A(i)));
1628 if (UNLIKELY((i == '\n' && ! isCNTRL_LC(i)))) {
1630 DEBUG_L(PerlIO_printf(Perl_debug_log,
1631 "'\\n' (=%02X) is not a control\n", (int) i));
1634 /* Add to the list; Separate multiple entries with a blank */
1637 my_strlcat(bad_chars_list, " ", sizeof(bad_chars_list));
1639 my_strlcat(bad_chars_list, name, sizeof(bad_chars_list));
1647 /* We only handle single-byte locales (outside of UTF-8 ones; so if
1648 * this locale requires more than one byte, there are going to be
1650 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1651 "%s:%d: check_for_problems=%d, MB_CUR_MAX=%d\n",
1652 __FILE__, __LINE__, check_for_problems, (int) MB_CUR_MAX));
1654 if ( check_for_problems && MB_CUR_MAX > 1
1655 && ! PL_in_utf8_CTYPE_locale
1657 /* Some platforms return MB_CUR_MAX > 1 for even the "C"
1658 * locale. Just assume that the implementation for them (plus
1659 * for POSIX) is correct and the > 1 value is spurious. (Since
1660 * these are specially handled to never be considered UTF-8
1661 * locales, as long as this is the only problem, everything
1662 * should work fine */
1663 && strNE(newctype, "C") && strNE(newctype, "POSIX"))
1665 multi_byte_locale = TRUE;
1670 if (UNLIKELY(bad_count) || UNLIKELY(multi_byte_locale)) {
1671 if (UNLIKELY(bad_count) && PL_in_utf8_CTYPE_locale) {
1672 PL_warn_locale = Perl_newSVpvf(aTHX_
1673 "Locale '%s' contains (at least) the following characters"
1674 " which have\nunexpected meanings: %s\nThe Perl program"
1675 " will use the expected meanings",
1676 newctype, bad_chars_list);
1679 PL_warn_locale = Perl_newSVpvf(aTHX_
1680 "Locale '%s' may not work well.%s%s%s\n",
1683 ? " Some characters in it are not recognized by"
1687 ? "\nThe following characters (and maybe others)"
1688 " may not have the same meaning as the Perl"
1689 " program expects:\n"
1697 # ifdef HAS_NL_LANGINFO
1699 Perl_sv_catpvf(aTHX_ PL_warn_locale, "; codeset=%s",
1700 /* parameter FALSE is a don't care here */
1701 my_nl_langinfo(CODESET, FALSE));
1705 Perl_sv_catpvf(aTHX_ PL_warn_locale, "\n");
1707 /* If we are actually in the scope of the locale or are debugging,
1708 * output the message now. If not in that scope, we save the
1709 * message to be output at the first operation using this locale,
1710 * if that actually happens. Most programs don't use locales, so
1711 * they are immune to bad ones. */
1712 if (IN_LC(LC_CTYPE) || UNLIKELY(DEBUG_L_TEST)) {
1714 /* The '0' below suppresses a bogus gcc compiler warning */
1715 Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0);
1717 if (IN_LC(LC_CTYPE)) {
1718 SvREFCNT_dec_NN(PL_warn_locale);
1719 PL_warn_locale = NULL;
1725 #endif /* USE_LOCALE_CTYPE */
1730 Perl__warn_problematic_locale()
1733 #ifdef USE_LOCALE_CTYPE
1737 /* Internal-to-core function that outputs the message in PL_warn_locale,
1738 * and then NULLS it. Should be called only through the macro
1739 * _CHECK_AND_WARN_PROBLEMATIC_LOCALE */
1741 if (PL_warn_locale) {
1742 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
1743 SvPVX(PL_warn_locale),
1744 0 /* dummy to avoid compiler warning */ );
1745 SvREFCNT_dec_NN(PL_warn_locale);
1746 PL_warn_locale = NULL;
1754 S_new_collate(pTHX_ const char *newcoll)
1757 #ifndef USE_LOCALE_COLLATE
1759 PERL_UNUSED_ARG(newcoll);
1760 PERL_UNUSED_CONTEXT;
1764 /* Called after each libc setlocale() call affecting LC_COLLATE, to tell
1765 * core Perl this and that 'newcoll' is the name of the new locale.
1767 * The design of locale collation is that every locale change is given an
1768 * index 'PL_collation_ix'. The first time a string particpates in an
1769 * operation that requires collation while locale collation is active, it
1770 * is given PERL_MAGIC_collxfrm magic (via sv_collxfrm_flags()). That
1771 * magic includes the collation index, and the transformation of the string
1772 * by strxfrm(), q.v. That transformation is used when doing comparisons,
1773 * instead of the string itself. If a string changes, the magic is
1774 * cleared. The next time the locale changes, the index is incremented,
1775 * and so we know during a comparison that the transformation is not
1776 * necessarily still valid, and so is recomputed. Note that if the locale
1777 * changes enough times, the index could wrap (a U32), and it is possible
1778 * that a transformation would improperly be considered valid, leading to
1779 * an unlikely bug */
1782 if (PL_collation_name) {
1784 Safefree(PL_collation_name);
1785 PL_collation_name = NULL;
1787 PL_collation_standard = TRUE;
1788 is_standard_collation:
1789 PL_collxfrm_base = 0;
1790 PL_collxfrm_mult = 2;
1791 PL_in_utf8_COLLATE_locale = FALSE;
1792 PL_strxfrm_NUL_replacement = '\0';
1793 PL_strxfrm_max_cp = 0;
1797 /* If this is not the same locale as currently, set the new one up */
1798 if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
1800 Safefree(PL_collation_name);
1801 PL_collation_name = stdize_locale(savepv(newcoll));
1802 PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
1803 if (PL_collation_standard) {
1804 goto is_standard_collation;
1807 PL_in_utf8_COLLATE_locale = _is_cur_LC_category_utf8(LC_COLLATE);
1808 PL_strxfrm_NUL_replacement = '\0';
1809 PL_strxfrm_max_cp = 0;
1811 /* A locale collation definition includes primary, secondary, tertiary,
1812 * etc. weights for each character. To sort, the primary weights are
1813 * used, and only if they compare equal, then the secondary weights are
1814 * used, and only if they compare equal, then the tertiary, etc.
1816 * strxfrm() works by taking the input string, say ABC, and creating an
1817 * output transformed string consisting of first the primary weights,
1818 * A¹B¹C¹ followed by the secondary ones, A²B²C²; and then the
1819 * tertiary, etc, yielding A¹B¹C¹ A²B²C² A³B³C³ .... Some characters
1820 * may not have weights at every level. In our example, let's say B
1821 * doesn't have a tertiary weight, and A doesn't have a secondary
1822 * weight. The constructed string is then going to be
1823 * A¹B¹C¹ B²C² A³C³ ....
1824 * This has the desired effect that strcmp() will look at the secondary
1825 * or tertiary weights only if the strings compare equal at all higher
1826 * priority weights. The spaces shown here, like in
1828 * are not just for readability. In the general case, these must
1829 * actually be bytes, which we will call here 'separator weights'; and
1830 * they must be smaller than any other weight value, but since these
1831 * are C strings, only the terminating one can be a NUL (some
1832 * implementations may include a non-NUL separator weight just before
1833 * the NUL). Implementations tend to reserve 01 for the separator
1834 * weights. They are needed so that a shorter string's secondary
1835 * weights won't be misconstrued as primary weights of a longer string,
1836 * etc. By making them smaller than any other weight, the shorter
1837 * string will sort first. (Actually, if all secondary weights are
1838 * smaller than all primary ones, there is no need for a separator
1839 * weight between those two levels, etc.)
1841 * The length of the transformed string is roughly a linear function of
1842 * the input string. It's not exactly linear because some characters
1843 * don't have weights at all levels. When we call strxfrm() we have to
1844 * allocate some memory to hold the transformed string. The
1845 * calculations below try to find coefficients 'm' and 'b' for this
1846 * locale so that m*x + b equals how much space we need, given the size
1847 * of the input string in 'x'. If we calculate too small, we increase
1848 * the size as needed, and call strxfrm() again, but it is better to
1849 * get it right the first time to avoid wasted expensive string
1850 * transformations. */
1853 /* We use the string below to find how long the tranformation of it
1854 * is. Almost all locales are supersets of ASCII, or at least the
1855 * ASCII letters. We use all of them, half upper half lower,
1856 * because if we used fewer, we might hit just the ones that are
1857 * outliers in a particular locale. Most of the strings being
1858 * collated will contain a preponderance of letters, and even if
1859 * they are above-ASCII, they are likely to have the same number of
1860 * weight levels as the ASCII ones. It turns out that digits tend
1861 * to have fewer levels, and some punctuation has more, but those
1862 * are relatively sparse in text, and khw believes this gives a
1863 * reasonable result, but it could be changed if experience so
1865 const char longer[] = "ABCDEFGHIJKLMnopqrstuvwxyz";
1866 char * x_longer; /* Transformed 'longer' */
1867 Size_t x_len_longer; /* Length of 'x_longer' */
1869 char * x_shorter; /* We also transform a substring of 'longer' */
1870 Size_t x_len_shorter;
1872 /* _mem_collxfrm() is used get the transformation (though here we
1873 * are interested only in its length). It is used because it has
1874 * the intelligence to handle all cases, but to work, it needs some
1875 * values of 'm' and 'b' to get it started. For the purposes of
1876 * this calculation we use a very conservative estimate of 'm' and
1877 * 'b'. This assumes a weight can be multiple bytes, enough to
1878 * hold any UV on the platform, and there are 5 levels, 4 weight
1879 * bytes, and a trailing NUL. */
1880 PL_collxfrm_base = 5;
1881 PL_collxfrm_mult = 5 * sizeof(UV);
1883 /* Find out how long the transformation really is */
1884 x_longer = _mem_collxfrm(longer,
1888 /* We avoid converting to UTF-8 in the
1889 * called function by telling it the
1890 * string is in UTF-8 if the locale is a
1891 * UTF-8 one. Since the string passed
1892 * here is invariant under UTF-8, we can
1893 * claim it's UTF-8 even though it isn't.
1895 PL_in_utf8_COLLATE_locale);
1898 /* Find out how long the transformation of a substring of 'longer'
1899 * is. Together the lengths of these transformations are
1900 * sufficient to calculate 'm' and 'b'. The substring is all of
1901 * 'longer' except the first character. This minimizes the chances
1902 * of being swayed by outliers */
1903 x_shorter = _mem_collxfrm(longer + 1,
1906 PL_in_utf8_COLLATE_locale);
1907 Safefree(x_shorter);
1909 /* If the results are nonsensical for this simple test, the whole
1910 * locale definition is suspect. Mark it so that locale collation
1911 * is not active at all for it. XXX Should we warn? */
1912 if ( x_len_shorter == 0
1913 || x_len_longer == 0
1914 || x_len_shorter >= x_len_longer)
1916 PL_collxfrm_mult = 0;
1917 PL_collxfrm_base = 0;
1920 SSize_t base; /* Temporary */
1922 /* We have both: m * strlen(longer) + b = x_len_longer
1923 * m * strlen(shorter) + b = x_len_shorter;
1924 * subtracting yields:
1925 * m * (strlen(longer) - strlen(shorter))
1926 * = x_len_longer - x_len_shorter
1927 * But we have set things up so that 'shorter' is 1 byte smaller
1928 * than 'longer'. Hence:
1929 * m = x_len_longer - x_len_shorter
1931 * But if something went wrong, make sure the multiplier is at
1934 if (x_len_longer > x_len_shorter) {
1935 PL_collxfrm_mult = (STRLEN) x_len_longer - x_len_shorter;
1938 PL_collxfrm_mult = 1;
1943 * but in case something has gone wrong, make sure it is
1945 base = x_len_longer - PL_collxfrm_mult * (sizeof(longer) - 1);
1950 /* Add 1 for the trailing NUL */
1951 PL_collxfrm_base = base + 1;
1956 if (DEBUG_L_TEST || debug_initialization) {
1957 PerlIO_printf(Perl_debug_log,
1958 "%s:%d: ?UTF-8 locale=%d; x_len_shorter=%zu, "
1960 " collate multipler=%zu, collate base=%zu\n",
1962 PL_in_utf8_COLLATE_locale,
1963 x_len_shorter, x_len_longer,
1964 PL_collxfrm_mult, PL_collxfrm_base);
1971 #endif /* USE_LOCALE_COLLATE */
1978 S_win32_setlocale(pTHX_ int category, const char* locale)
1980 /* This, for Windows, emulates POSIX setlocale() behavior. There is no
1981 * difference between the two unless the input locale is "", which normally
1982 * means on Windows to get the machine default, which is set via the
1983 * computer's "Regional and Language Options" (or its current equivalent).
1984 * In POSIX, it instead means to find the locale from the user's
1985 * environment. This routine changes the Windows behavior to first look in
1986 * the environment, and, if anything is found, use that instead of going to
1987 * the machine default. If there is no environment override, the machine
1988 * default is used, by calling the real setlocale() with "".
1990 * The POSIX behavior is to use the LC_ALL variable if set; otherwise to
1991 * use the particular category's variable if set; otherwise to use the LANG
1994 bool override_LC_ALL = FALSE;
1998 if (locale && strEQ(locale, "")) {
2002 locale = PerlEnv_getenv("LC_ALL");
2004 if (category == LC_ALL) {
2005 override_LC_ALL = TRUE;
2011 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
2012 if (category == categories[i]) {
2013 locale = PerlEnv_getenv(category_names[i]);
2018 locale = PerlEnv_getenv("LANG");
2034 result = setlocale(category, locale);
2035 DEBUG_L(STMT_START {
2037 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n", __FILE__, __LINE__,
2038 setlocale_debug_string(category, locale, result));
2042 if (! override_LC_ALL) {
2046 /* Here the input category was LC_ALL, and we have set it to what is in the
2047 * LANG variable or the system default if there is no LANG. But these have
2048 * lower priority than the other LC_foo variables, so override it for each
2049 * one that is set. (If they are set to "", it means to use the same thing
2050 * we just set LC_ALL to, so can skip) */
2052 for (i = 0; i < LC_ALL_INDEX; i++) {
2053 result = PerlEnv_getenv(category_names[i]);
2054 if (result && strNE(result, "")) {
2055 setlocale(categories[i], result);
2056 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
2058 setlocale_debug_string(categories[i], result, "not captured")));
2062 result = setlocale(LC_ALL, NULL);
2063 DEBUG_L(STMT_START {
2065 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
2067 setlocale_debug_string(LC_ALL, NULL, result));
2078 =head1 Locale-related functions and macros
2080 =for apidoc Perl_setlocale
2082 This is an (almost) drop-in replacement for the system L<C<setlocale(3)>>,
2083 taking the same parameters, and returning the same information, except that it
2084 returns the correct underlying C<LC_NUMERIC> locale. Regular C<setlocale> will
2085 instead return C<C> if the underlying locale has a non-dot decimal point
2086 character, or a non-empty thousands separator for displaying floating point
2087 numbers. This is because perl keeps that locale category such that it has a
2088 dot and empty separator, changing the locale briefly during the operations
2089 where the underlying one is required. C<Perl_setlocale> knows about this, and
2090 compensates; regular C<setlocale> doesn't.
2092 Another reason it isn't completely a drop-in replacement is that it is
2093 declared to return S<C<const char *>>, whereas the system setlocale omits the
2094 C<const> (presumably because its API was specified long ago, and can't be
2095 updated; it is illegal to change the information C<setlocale> returns; doing
2096 so leads to segfaults.)
2098 Finally, C<Perl_setlocale> works under all circumstances, whereas plain
2099 C<setlocale> can be completely ineffective on some platforms under some
2102 C<Perl_setlocale> should not be used to change the locale except on systems
2103 where the predefined variable C<${^SAFE_LOCALES}> is 1. On some such systems,
2104 the system C<setlocale()> is ineffective, returning the wrong information, and
2105 failing to actually change the locale. C<Perl_setlocale>, however works
2106 properly in all circumstances.
2108 The return points to a per-thread static buffer, which is overwritten the next
2109 time C<Perl_setlocale> is called from the same thread.
2116 Perl_setlocale(const int category, const char * locale)
2118 /* This wraps POSIX::setlocale() */
2120 const char * retval;
2121 const char * newlocale;
2123 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2126 #ifdef USE_LOCALE_NUMERIC
2128 /* A NULL locale means only query what the current one is. We have the
2129 * LC_NUMERIC name saved, because we are normally switched into the C
2130 * (or equivalent) locale for it. For an LC_ALL query, switch back to get
2131 * the correct results. All other categories don't require special
2133 if (locale == NULL) {
2134 if (category == LC_NUMERIC) {
2136 /* We don't have to copy this return value, as it is a per-thread
2137 * variable, and won't change until a future setlocale */
2138 return PL_numeric_name;
2143 else if (category == LC_ALL) {
2144 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2153 retval = save_to_buffer(do_setlocale_r(category, locale),
2154 &PL_setlocale_buf, &PL_setlocale_bufsize, 0);
2157 #if defined(USE_LOCALE_NUMERIC) && defined(LC_ALL)
2159 if (locale == NULL && category == LC_ALL) {
2160 RESTORE_LC_NUMERIC();
2165 DEBUG_L(PerlIO_printf(Perl_debug_log,
2166 "%s:%d: %s\n", __FILE__, __LINE__,
2167 setlocale_debug_string(category, locale, retval)));
2175 /* If locale == NULL, we are just querying the state */
2176 if (locale == NULL) {
2180 /* Now that have switched locales, we have to update our records to
2185 #ifdef USE_LOCALE_CTYPE
2192 #ifdef USE_LOCALE_COLLATE
2195 new_collate(retval);
2199 #ifdef USE_LOCALE_NUMERIC
2202 new_numeric(retval);
2210 /* LC_ALL updates all the things we care about. The values may not
2211 * be the same as 'retval', as the locale "" may have set things
2214 # ifdef USE_LOCALE_CTYPE
2216 newlocale = savepv(do_setlocale_c(LC_CTYPE, NULL));
2217 new_ctype(newlocale);
2218 Safefree(newlocale);
2220 # endif /* USE_LOCALE_CTYPE */
2221 # ifdef USE_LOCALE_COLLATE
2223 newlocale = savepv(do_setlocale_c(LC_COLLATE, NULL));
2224 new_collate(newlocale);
2225 Safefree(newlocale);
2228 # ifdef USE_LOCALE_NUMERIC
2230 newlocale = savepv(do_setlocale_c(LC_NUMERIC, NULL));
2231 new_numeric(newlocale);
2232 Safefree(newlocale);
2234 # endif /* USE_LOCALE_NUMERIC */
2245 PERL_STATIC_INLINE const char *
2246 S_save_to_buffer(const char * string, char **buf, Size_t *buf_size, const Size_t offset)
2248 /* Copy the NUL-terminated 'string' to 'buf' + 'offset'. 'buf' has size 'buf_size',
2249 * growing it if necessary */
2253 PERL_ARGS_ASSERT_SAVE_TO_BUFFER;
2259 string_size = strlen(string) + offset + 1;
2261 if (*buf_size == 0) {
2262 Newx(*buf, string_size, char);
2263 *buf_size = string_size;
2265 else if (string_size > *buf_size) {
2266 Renew(*buf, string_size, char);
2267 *buf_size = string_size;
2270 Copy(string, *buf + offset, string_size - offset, char);
2276 =for apidoc Perl_langinfo
2278 This is an (almost) drop-in replacement for the system C<L<nl_langinfo(3)>>,
2279 taking the same C<item> parameter values, and returning the same information.
2280 But it is more thread-safe than regular C<nl_langinfo()>, and hides the quirks
2281 of Perl's locale handling from your code, and can be used on systems that lack
2282 a native C<nl_langinfo>.
2290 The reason it isn't quite a drop-in replacement is actually an advantage. The
2291 only difference is that it returns S<C<const char *>>, whereas plain
2292 C<nl_langinfo()> returns S<C<char *>>, but you are (only by documentation)
2293 forbidden to write into the buffer. By declaring this C<const>, the compiler
2294 enforces this restriction, so if it is violated, you know at compilation time,
2295 rather than getting segfaults at runtime.
2299 It delivers the correct results for the C<RADIXCHAR> and C<THOUSEP> items,
2300 without you having to write extra code. The reason for the extra code would be
2301 because these are from the C<LC_NUMERIC> locale category, which is normally
2302 kept set by Perl so that the radix is a dot, and the separator is the empty
2303 string, no matter what the underlying locale is supposed to be, and so to get
2304 the expected results, you have to temporarily toggle into the underlying
2305 locale, and later toggle back. (You could use plain C<nl_langinfo> and
2306 C<L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>> for this but then you wouldn't get
2307 the other advantages of C<Perl_langinfo()>; not keeping C<LC_NUMERIC> in the C
2308 (or equivalent) locale would break a lot of CPAN, which is expecting the radix
2309 (decimal point) character to be a dot.)
2313 The system function it replaces can have its static return buffer trashed,
2314 not only by a subesequent call to that function, but by a C<freelocale>,
2315 C<setlocale>, or other locale change. The returned buffer of this function is
2316 not changed until the next call to it, so the buffer is never in a trashed
2321 Its return buffer is per-thread, so it also is never overwritten by a call to
2322 this function from another thread; unlike the function it replaces.
2326 But most importantly, it works on systems that don't have C<nl_langinfo>, such
2327 as Windows, hence makes your code more portable. Of the fifty-some possible
2328 items specified by the POSIX 2008 standard,
2329 L<http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/langinfo.h.html>,
2330 only one is completely unimplemented, though on non-Windows platforms, another
2331 significant one is also not implemented). It uses various techniques to
2332 recover the other items, including calling C<L<localeconv(3)>>, and
2333 C<L<strftime(3)>>, both of which are specified in C89, so should be always be
2334 available. Later C<strftime()> versions have additional capabilities; C<""> is
2335 returned for those not available on your system.
2337 It is important to note that when called with an item that is recovered by
2338 using C<localeconv>, the buffer from any previous explicit call to
2339 C<localeconv> will be overwritten. This means you must save that buffer's
2340 contents if you need to access them after a call to this function. (But note
2341 that you might not want to be using C<localeconv()> directly anyway, because of
2342 issues like the ones listed in the second item of this list (above) for
2343 C<RADIXCHAR> and C<THOUSEP>. You can use the methods given in L<perlcall> to
2344 call L<POSIX/localeconv> and avoid all the issues, but then you have a hash to
2347 The details for those items which may deviate from what this emulation returns
2348 and what a native C<nl_langinfo()> would return are specified in
2353 When using C<Perl_langinfo> on systems that don't have a native
2354 C<nl_langinfo()>, you must
2356 #include "perl_langinfo.h"
2358 before the C<perl.h> C<#include>. You can replace your C<langinfo.h>
2359 C<#include> with this one. (Doing it this way keeps out the symbols that plain
2360 C<langinfo.h> would try to import into the namespace for code that doesn't need
2363 The original impetus for C<Perl_langinfo()> was so that code that needs to
2364 find out the current currency symbol, floating point radix character, or digit
2365 grouping separator can use, on all systems, the simpler and more
2366 thread-friendly C<nl_langinfo> API instead of C<L<localeconv(3)>> which is a
2367 pain to make thread-friendly. For other fields returned by C<localeconv>, it
2368 is better to use the methods given in L<perlcall> to call
2369 L<C<POSIX::localeconv()>|POSIX/localeconv>, which is thread-friendly.
2376 #ifdef HAS_NL_LANGINFO
2377 Perl_langinfo(const nl_item item)
2379 Perl_langinfo(const int item)
2382 return my_nl_langinfo(item, TRUE);
2386 #ifdef HAS_NL_LANGINFO
2387 S_my_nl_langinfo(const nl_item item, bool toggle)
2389 S_my_nl_langinfo(const int item, bool toggle)
2393 const char * retval;
2395 /* We only need to toggle into the underlying LC_NUMERIC locale for these
2396 * two items, and only if not already there */
2397 if (toggle && (( item != RADIXCHAR && item != THOUSEP)
2398 || PL_numeric_underlying))
2403 #if defined(HAS_NL_LANGINFO) /* nl_langinfo() is available. */
2404 # if ! defined(HAS_THREAD_SAFE_NL_LANGINFO_L) \
2405 || ! defined(HAS_POSIX_2008_LOCALE) \
2406 || ! defined(DUPLOCALE)
2408 /* Here, use plain nl_langinfo(), switching to the underlying LC_NUMERIC
2409 * for those items dependent on it. This must be copied to a buffer before
2410 * switching back, as some systems destroy the buffer when setlocale() is
2414 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2417 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2420 LOCALE_LOCK; /* Prevent interference from another thread executing
2421 this code section (the only call to nl_langinfo in
2425 /* Copy to a per-thread buffer, which is also one that won't be
2426 * destroyed by a subsequent setlocale(), such as the
2427 * RESTORE_LC_NUMERIC may do just below. */
2428 retval = save_to_buffer(nl_langinfo(item),
2429 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
2434 RESTORE_LC_NUMERIC();
2438 # else /* Use nl_langinfo_l(), avoiding both a mutex and changing the locale */
2441 bool do_free = FALSE;
2442 locale_t cur = uselocale((locale_t) 0);
2444 if (cur == LC_GLOBAL_LOCALE) {
2445 cur = duplocale(LC_GLOBAL_LOCALE);
2450 if (PL_underlying_numeric_obj) {
2451 cur = PL_underlying_numeric_obj;
2454 cur = newlocale(LC_NUMERIC_MASK, PL_numeric_name, cur);
2459 /* We have to save it to a buffer, because the freelocale() just below
2460 * can invalidate the internal one */
2461 retval = save_to_buffer(nl_langinfo_l(item, cur),
2462 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
2471 if (strEQ(retval, "")) {
2472 if (item == YESSTR) {
2475 if (item == NOSTR) {
2482 #else /* Below, emulate nl_langinfo as best we can */
2486 # ifdef HAS_LOCALECONV
2488 const struct lconv* lc;
2490 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2492 # ifdef TS_W32_BROKEN_LOCALECONV
2494 const char * save_global;
2495 const char * save_thread;
2503 # ifdef HAS_STRFTIME
2506 bool return_format = FALSE; /* Return the %format, not the value */
2507 const char * format;
2511 /* We copy the results to a per-thread buffer, even if not
2512 * multi-threaded. This is in part to simplify this code, and partly
2513 * because we need a buffer anyway for strftime(), and partly because a
2514 * call of localeconv() could otherwise wipe out the buffer, and the
2515 * programmer would not be expecting this, as this is a nl_langinfo()
2516 * substitute after all, so s/he might be thinking their localeconv()
2517 * is safe until another localeconv() call. */
2522 /* This is unimplemented */
2523 case ERA: /* For use with strftime() %E modifier */
2528 /* We use only an English set, since we don't know any more */
2529 case YESEXPR: return "^[+1yY]";
2530 case YESSTR: return "yes";
2531 case NOEXPR: return "^[-0nN]";
2532 case NOSTR: return "no";
2538 /* On non-windows, this is unimplemented, in part because of
2539 * inconsistencies between vendors. The Darwin native
2540 * nl_langinfo() implementation simply looks at everything past
2541 * any dot in the name, but that doesn't work for other
2542 * vendors. Many Linux locales that don't have UTF-8 in their
2543 * names really are UTF-8, for example; z/OS locales that do
2544 * have UTF-8 in their names, aren't really UTF-8 */
2549 { /* But on Windows, the name does seem to be consistent, so
2554 const char * name = my_setlocale(LC_CTYPE, NULL);
2556 if (isNAME_C_OR_POSIX(name)) {
2557 return "ANSI_X3.4-1968";
2560 /* Find the dot in the locale name */
2561 first = (const char *) strchr(name, '.');
2567 /* Look at everything past the dot */
2572 if (! isDIGIT(*p)) {
2579 /* Here everything past the dot is a digit. Treat it as a
2581 (void) save_to_buffer("CP", &PL_langinfo_buf,
2582 &PL_langinfo_bufsize, 0);
2583 offset = STRLENs("CP");
2587 retval = save_to_buffer(first, &PL_langinfo_buf,
2588 &PL_langinfo_bufsize, offset);
2594 # ifdef HAS_LOCALECONV
2598 /* We don't bother with localeconv_l() because any system that
2599 * has it is likely to also have nl_langinfo() */
2601 LOCALE_LOCK_V; /* Prevent interference with other threads
2602 using localeconv() */
2604 # ifdef TS_W32_BROKEN_LOCALECONV
2606 /* This is a workaround for a Windows bug prior to VS 15.
2607 * What we do here is, while locked, switch to the global
2608 * locale so localeconv() works; then switch back just before
2609 * the unlock. This can screw things up if some thread is
2610 * already using the global locale while assuming no other is.
2611 * A different workaround would be to call GetCurrencyFormat on
2612 * a known value, and parse it; patches welcome
2614 * We have to use LC_ALL instead of LC_MONETARY because of
2615 * another bug in Windows */
2617 save_thread = savepv(my_setlocale(LC_ALL, NULL));
2618 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
2619 save_global= savepv(my_setlocale(LC_ALL, NULL));
2620 my_setlocale(LC_ALL, save_thread);
2626 || ! lc->currency_symbol
2627 || strEQ("", lc->currency_symbol))
2633 /* Leave the first spot empty to be filled in below */
2634 retval = save_to_buffer(lc->currency_symbol, &PL_langinfo_buf,
2635 &PL_langinfo_bufsize, 1);
2636 if (lc->mon_decimal_point && strEQ(lc->mon_decimal_point, ""))
2637 { /* khw couldn't figure out how the localedef specifications
2638 would show that the $ should replace the radix; this is
2639 just a guess as to how it might work.*/
2640 PL_langinfo_buf[0] = '.';
2642 else if (lc->p_cs_precedes) {
2643 PL_langinfo_buf[0] = '-';
2646 PL_langinfo_buf[0] = '+';
2649 # ifdef TS_W32_BROKEN_LOCALECONV
2651 my_setlocale(LC_ALL, save_global);
2652 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
2653 my_setlocale(LC_ALL, save_thread);
2654 Safefree(save_global);
2655 Safefree(save_thread);
2662 # ifdef TS_W32_BROKEN_LOCALECONV
2666 /* For this, we output a known simple floating point number to
2667 * a buffer, and parse it, looking for the radix */
2670 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2673 if (PL_langinfo_bufsize < 10) {
2674 PL_langinfo_bufsize = 10;
2675 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2678 needed_size = my_snprintf(PL_langinfo_buf, PL_langinfo_bufsize,
2680 if (needed_size >= (int) PL_langinfo_bufsize) {
2681 PL_langinfo_bufsize = needed_size + 1;
2682 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2683 needed_size = my_snprintf(PL_langinfo_buf, PL_langinfo_bufsize,
2685 assert(needed_size < (int) PL_langinfo_bufsize);
2688 ptr = PL_langinfo_buf;
2689 e = PL_langinfo_buf + PL_langinfo_bufsize;
2692 while (ptr < e && *ptr != '1') {
2699 while (ptr < e && *ptr != '5') {
2703 /* Everything in between is the radix string */
2705 PL_langinfo_buf[0] = '?';
2706 PL_langinfo_buf[1] = '\0';
2710 Move(item_start, PL_langinfo_buf, ptr - PL_langinfo_buf, char);
2714 RESTORE_LC_NUMERIC();
2717 retval = PL_langinfo_buf;
2722 case RADIXCHAR: /* No special handling needed */
2729 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2732 LOCALE_LOCK_V; /* Prevent interference with other threads
2733 using localeconv() */
2735 # ifdef TS_W32_BROKEN_LOCALECONV
2737 /* This should only be for the thousands separator. A
2738 * different work around would be to use GetNumberFormat on a
2739 * known value and parse the result to find the separator */
2740 save_thread = savepv(my_setlocale(LC_ALL, NULL));
2741 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
2742 save_global = savepv(my_setlocale(LC_ALL, NULL));
2743 my_setlocale(LC_ALL, save_thread);
2745 /* This is the start of code that for broken Windows replaces
2746 * the above and below code, and instead calls
2747 * GetNumberFormat() and then would parse that to find the
2748 * thousands separator. It needs to handle UTF-16 vs -8
2751 needed_size = GetNumberFormatEx(PL_numeric_name, 0, "1234.5", NULL, PL_langinfo_buf, PL_langinfo_bufsize);
2752 DEBUG_L(PerlIO_printf(Perl_debug_log,
2753 "%s: %d: return from GetNumber, count=%d, val=%s\n",
2754 __FILE__, __LINE__, needed_size, PL_langinfo_buf));
2764 temp = (item == RADIXCHAR)
2766 : lc->thousands_sep;
2772 retval = save_to_buffer(temp, &PL_langinfo_buf,
2773 &PL_langinfo_bufsize, 0);
2775 # ifdef TS_W32_BROKEN_LOCALECONV
2777 my_setlocale(LC_ALL, save_global);
2778 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
2779 my_setlocale(LC_ALL, save_thread);
2780 Safefree(save_global);
2781 Safefree(save_thread);
2788 RESTORE_LC_NUMERIC();
2794 # ifdef HAS_STRFTIME
2796 /* These are defined by C89, so we assume that strftime supports
2797 * them, and so are returned unconditionally; they may not be what
2798 * the locale actually says, but should give good enough results
2799 * for someone using them as formats (as opposed to trying to parse
2800 * them to figure out what the locale says). The other format
2801 * items are actually tested to verify they work on the platform */
2802 case D_FMT: return "%x";
2803 case T_FMT: return "%X";
2804 case D_T_FMT: return "%c";
2806 /* These formats are only available in later strfmtime's */
2807 case ERA_D_FMT: case ERA_T_FMT: case ERA_D_T_FMT: case T_FMT_AMPM:
2809 /* The rest can be gotten from most versions of strftime(). */
2810 case ABDAY_1: case ABDAY_2: case ABDAY_3:
2811 case ABDAY_4: case ABDAY_5: case ABDAY_6: case ABDAY_7:
2813 case AM_STR: case PM_STR:
2814 case ABMON_1: case ABMON_2: case ABMON_3: case ABMON_4:
2815 case ABMON_5: case ABMON_6: case ABMON_7: case ABMON_8:
2816 case ABMON_9: case ABMON_10: case ABMON_11: case ABMON_12:
2817 case DAY_1: case DAY_2: case DAY_3: case DAY_4:
2818 case DAY_5: case DAY_6: case DAY_7:
2819 case MON_1: case MON_2: case MON_3: case MON_4:
2820 case MON_5: case MON_6: case MON_7: case MON_8:
2821 case MON_9: case MON_10: case MON_11: case MON_12:
2825 init_tm(&tm); /* Precaution against core dumps */
2829 tm.tm_year = 2017 - 1900;
2836 "panic: %s: %d: switch case: %d problem",
2837 __FILE__, __LINE__, item);
2838 NOT_REACHED; /* NOTREACHED */
2840 case PM_STR: tm.tm_hour = 18;
2845 case ABDAY_7: tm.tm_wday++;
2846 case ABDAY_6: tm.tm_wday++;
2847 case ABDAY_5: tm.tm_wday++;
2848 case ABDAY_4: tm.tm_wday++;
2849 case ABDAY_3: tm.tm_wday++;
2850 case ABDAY_2: tm.tm_wday++;
2855 case DAY_7: tm.tm_wday++;
2856 case DAY_6: tm.tm_wday++;
2857 case DAY_5: tm.tm_wday++;
2858 case DAY_4: tm.tm_wday++;
2859 case DAY_3: tm.tm_wday++;
2860 case DAY_2: tm.tm_wday++;
2865 case ABMON_12: tm.tm_mon++;
2866 case ABMON_11: tm.tm_mon++;
2867 case ABMON_10: tm.tm_mon++;
2868 case ABMON_9: tm.tm_mon++;
2869 case ABMON_8: tm.tm_mon++;
2870 case ABMON_7: tm.tm_mon++;
2871 case ABMON_6: tm.tm_mon++;
2872 case ABMON_5: tm.tm_mon++;
2873 case ABMON_4: tm.tm_mon++;
2874 case ABMON_3: tm.tm_mon++;
2875 case ABMON_2: tm.tm_mon++;
2880 case MON_12: tm.tm_mon++;
2881 case MON_11: tm.tm_mon++;
2882 case MON_10: tm.tm_mon++;
2883 case MON_9: tm.tm_mon++;
2884 case MON_8: tm.tm_mon++;
2885 case MON_7: tm.tm_mon++;
2886 case MON_6: tm.tm_mon++;
2887 case MON_5: tm.tm_mon++;
2888 case MON_4: tm.tm_mon++;
2889 case MON_3: tm.tm_mon++;
2890 case MON_2: tm.tm_mon++;
2897 return_format = TRUE;
2902 return_format = TRUE;
2907 return_format = TRUE;
2912 return_format = TRUE;
2917 format = "%Ow"; /* Find the alternate digit for 0 */
2921 /* We can't use my_strftime() because it doesn't look at
2923 while (0 == strftime(PL_langinfo_buf, PL_langinfo_bufsize,
2926 /* A zero return means one of:
2927 * a) there wasn't enough space in PL_langinfo_buf
2928 * b) the format, like a plain %p, returns empty
2929 * c) it was an illegal format, though some
2930 * implementations of strftime will just return the
2931 * illegal format as a plain character sequence.
2933 * To quickly test for case 'b)', try again but precede
2934 * the format with a plain character. If that result is
2935 * still empty, the problem is either 'a)' or 'c)' */
2937 Size_t format_size = strlen(format) + 1;
2938 Size_t mod_size = format_size + 1;
2942 Newx(mod_format, mod_size, char);
2943 Newx(temp_result, PL_langinfo_bufsize, char);
2945 my_strlcpy(mod_format + 1, format, mod_size);
2946 len = strftime(temp_result,
2947 PL_langinfo_bufsize,
2949 Safefree(mod_format);
2950 Safefree(temp_result);
2952 /* If 'len' is non-zero, it means that we had a case like
2953 * %p which means the current locale doesn't use a.m. or
2954 * p.m., and that is valid */
2957 /* Here, still didn't work. If we get well beyond a
2958 * reasonable size, bail out to prevent an infinite
2961 if (PL_langinfo_bufsize > 100 * format_size) {
2962 *PL_langinfo_buf = '\0';
2965 /* Double the buffer size to retry; Add 1 in case
2966 * original was 0, so we aren't stuck at 0. */
2967 PL_langinfo_bufsize *= 2;
2968 PL_langinfo_bufsize++;
2969 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2977 /* Here, we got a result.
2979 * If the item is 'ALT_DIGITS', PL_langinfo_buf contains the
2980 * alternate format for wday 0. If the value is the same as
2981 * the normal 0, there isn't an alternate, so clear the buffer.
2983 if ( item == ALT_DIGITS
2984 && strEQ(PL_langinfo_buf, "0"))
2986 *PL_langinfo_buf = '\0';
2989 /* ALT_DIGITS is problematic. Experiments on it showed that
2990 * strftime() did not always work properly when going from
2991 * alt-9 to alt-10. Only a few locales have this item defined,
2992 * and in all of them on Linux that khw was able to find,
2993 * nl_langinfo() merely returned the alt-0 character, possibly
2994 * doubled. Most Unicode digits are in blocks of 10
2995 * consecutive code points, so that is sufficient information
2996 * for those scripts, as we can infer alt-1, alt-2, .... But
2997 * for a Japanese locale, a CJK ideographic 0 is returned, and
2998 * the CJK digits are not in code point order, so you can't
2999 * really infer anything. The localedef for this locale did
3000 * specify the succeeding digits, so that strftime() works
3001 * properly on them, without needing to infer anything. But
3002 * the nl_langinfo() return did not give sufficient information
3003 * for the caller to understand what's going on. So until
3004 * there is evidence that it should work differently, this
3005 * returns the alt-0 string for ALT_DIGITS.
3007 * wday was chosen because its range is all a single digit.
3008 * Things like tm_sec have two digits as the minimum: '00' */
3012 retval = PL_langinfo_buf;
3014 /* If to return the format, not the value, overwrite the buffer
3015 * with it. But some strftime()s will keep the original format
3016 * if illegal, so change those to "" */
3017 if (return_format) {
3018 if (strEQ(PL_langinfo_buf, format)) {
3019 *PL_langinfo_buf = '\0';
3022 retval = save_to_buffer(format, &PL_langinfo_buf,
3023 &PL_langinfo_bufsize, 0);
3041 * Initialize locale awareness.
3044 Perl_init_i18nl10n(pTHX_ int printwarn)
3048 * 0 if not to output warning when setup locale is bad
3049 * 1 if to output warning based on value of PERL_BADLANG
3050 * >1 if to output regardless of PERL_BADLANG
3053 * 1 = set ok or not applicable,
3054 * 0 = fallback to a locale of lower priority
3055 * -1 = fallback to all locales failed, not even to the C locale
3057 * Under -DDEBUGGING, if the environment variable PERL_DEBUG_LOCALE_INIT is
3058 * set, debugging information is output.
3060 * This looks more complicated than it is, mainly due to the #ifdefs.
3062 * We try to set LC_ALL to the value determined by the environment. If
3063 * there is no LC_ALL on this platform, we try the individual categories we
3064 * know about. If this works, we are done.
3066 * But if it doesn't work, we have to do something else. We search the
3067 * environment variables ourselves instead of relying on the system to do
3068 * it. We look at, in order, LC_ALL, LANG, a system default locale (if we
3069 * think there is one), and the ultimate fallback "C". This is all done in
3070 * the same loop as above to avoid duplicating code, but it makes things
3071 * more complex. The 'trial_locales' array is initialized with just one
3072 * element; it causes the behavior described in the paragraph above this to
3073 * happen. If that fails, we add elements to 'trial_locales', and do extra
3074 * loop iterations to cause the behavior described in this paragraph.
3076 * On Ultrix, the locale MUST come from the environment, so there is
3077 * preliminary code to set it. I (khw) am not sure that it is necessary,
3078 * and that this couldn't be folded into the loop, but barring any real
3079 * platforms to test on, it's staying as-is
3081 * A slight complication is that in embedded Perls, the locale may already
3082 * be set-up, and we don't want to get it from the normal environment
3083 * variables. This is handled by having a special environment variable
3084 * indicate we're in this situation. We simply set setlocale's 2nd
3085 * parameter to be a NULL instead of "". That indicates to setlocale that
3086 * it is not to change anything, but to return the current value,
3087 * effectively initializing perl's db to what the locale already is.
3089 * We play the same trick with NULL if a LC_ALL succeeds. We call
3090 * setlocale() on the individual categores with NULL to get their existing
3091 * values for our db, instead of trying to change them.
3098 PERL_UNUSED_ARG(printwarn);
3100 #else /* USE_LOCALE */
3103 const char * const language = savepv(PerlEnv_getenv("LANGUAGE"));
3107 /* NULL uses the existing already set up locale */
3108 const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
3111 const char* trial_locales[5]; /* 5 = 1 each for "", LC_ALL, LANG, "", C */
3112 unsigned int trial_locales_count;
3113 const char * const lc_all = savepv(PerlEnv_getenv("LC_ALL"));
3114 const char * const lang = savepv(PerlEnv_getenv("LANG"));
3115 bool setlocale_failure = FALSE;
3118 /* A later getenv() could zap this, so only use here */
3119 const char * const bad_lang_use_once = PerlEnv_getenv("PERL_BADLANG");
3121 const bool locwarn = (printwarn > 1
3123 && ( ! bad_lang_use_once
3125 /* disallow with "" or "0" */
3127 && strNE("0", bad_lang_use_once)))));
3129 /* setlocale() return vals; not copied so must be looked at immediately */
3130 const char * sl_result[NOMINAL_LC_ALL_INDEX + 1];
3132 /* current locale for given category; should have been copied so aren't
3134 const char * curlocales[NOMINAL_LC_ALL_INDEX + 1];
3138 /* In some systems you can find out the system default locale
3139 * and use that as the fallback locale. */
3140 # define SYSTEM_DEFAULT_LOCALE
3142 # ifdef SYSTEM_DEFAULT_LOCALE
3144 const char *system_default_locale = NULL;
3149 # define DEBUG_LOCALE_INIT(a,b,c)
3152 DEBUG_INITIALIZATION_set(cBOOL(PerlEnv_getenv("PERL_DEBUG_LOCALE_INIT")));
3154 # define DEBUG_LOCALE_INIT(category, locale, result) \
3156 if (debug_initialization) { \
3157 PerlIO_printf(Perl_debug_log, \
3159 __FILE__, __LINE__, \
3160 setlocale_debug_string(category, \
3166 /* Make sure the parallel arrays are properly set up */
3167 # ifdef USE_LOCALE_NUMERIC
3168 assert(categories[LC_NUMERIC_INDEX] == LC_NUMERIC);
3169 assert(strEQ(category_names[LC_NUMERIC_INDEX], "LC_NUMERIC"));
3170 # ifdef USE_POSIX_2008_LOCALE
3171 assert(category_masks[LC_NUMERIC_INDEX] == LC_NUMERIC_MASK);
3174 # ifdef USE_LOCALE_CTYPE
3175 assert(categories[LC_CTYPE_INDEX] == LC_CTYPE);
3176 assert(strEQ(category_names[LC_CTYPE_INDEX], "LC_CTYPE"));
3177 # ifdef USE_POSIX_2008_LOCALE
3178 assert(category_masks[LC_CTYPE_INDEX] == LC_CTYPE_MASK);
3181 # ifdef USE_LOCALE_COLLATE
3182 assert(categories[LC_COLLATE_INDEX] == LC_COLLATE);
3183 assert(strEQ(category_names[LC_COLLATE_INDEX], "LC_COLLATE"));
3184 # ifdef USE_POSIX_2008_LOCALE
3185 assert(category_masks[LC_COLLATE_INDEX] == LC_COLLATE_MASK);
3188 # ifdef USE_LOCALE_TIME
3189 assert(categories[LC_TIME_INDEX] == LC_TIME);
3190 assert(strEQ(category_names[LC_TIME_INDEX], "LC_TIME"));
3191 # ifdef USE_POSIX_2008_LOCALE
3192 assert(category_masks[LC_TIME_INDEX] == LC_TIME_MASK);
3195 # ifdef USE_LOCALE_MESSAGES
3196 assert(categories[LC_MESSAGES_INDEX] == LC_MESSAGES);
3197 assert(strEQ(category_names[LC_MESSAGES_INDEX], "LC_MESSAGES"));
3198 # ifdef USE_POSIX_2008_LOCALE
3199 assert(category_masks[LC_MESSAGES_INDEX] == LC_MESSAGES_MASK);
3202 # ifdef USE_LOCALE_MONETARY
3203 assert(categories[LC_MONETARY_INDEX] == LC_MONETARY);
3204 assert(strEQ(category_names[LC_MONETARY_INDEX], "LC_MONETARY"));
3205 # ifdef USE_POSIX_2008_LOCALE
3206 assert(category_masks[LC_MONETARY_INDEX] == LC_MONETARY_MASK);
3209 # ifdef USE_LOCALE_ADDRESS
3210 assert(categories[LC_ADDRESS_INDEX] == LC_ADDRESS);
3211 assert(strEQ(category_names[LC_ADDRESS_INDEX], "LC_ADDRESS"));
3212 # ifdef USE_POSIX_2008_LOCALE
3213 assert(category_masks[LC_ADDRESS_INDEX] == LC_ADDRESS_MASK);
3216 # ifdef USE_LOCALE_IDENTIFICATION
3217 assert(categories[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION);
3218 assert(strEQ(category_names[LC_IDENTIFICATION_INDEX], "LC_IDENTIFICATION"));
3219 # ifdef USE_POSIX_2008_LOCALE
3220 assert(category_masks[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION_MASK);
3223 # ifdef USE_LOCALE_MEASUREMENT
3224 assert(categories[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT);
3225 assert(strEQ(category_names[LC_MEASUREMENT_INDEX], "LC_MEASUREMENT"));
3226 # ifdef USE_POSIX_2008_LOCALE
3227 assert(category_masks[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT_MASK);
3230 # ifdef USE_LOCALE_PAPER
3231 assert(categories[LC_PAPER_INDEX] == LC_PAPER);
3232 assert(strEQ(category_names[LC_PAPER_INDEX], "LC_PAPER"));
3233 # ifdef USE_POSIX_2008_LOCALE
3234 assert(category_masks[LC_PAPER_INDEX] == LC_PAPER_MASK);
3237 # ifdef USE_LOCALE_TELEPHONE
3238 assert(categories[LC_TELEPHONE_INDEX] == LC_TELEPHONE);
3239 assert(strEQ(category_names[LC_TELEPHONE_INDEX], "LC_TELEPHONE"));
3240 # ifdef USE_POSIX_2008_LOCALE
3241 assert(category_masks[LC_TELEPHONE_INDEX] == LC_TELEPHONE_MASK);
3245 assert(categories[LC_ALL_INDEX] == LC_ALL);
3246 assert(strEQ(category_names[LC_ALL_INDEX], "LC_ALL"));
3247 assert(NOMINAL_LC_ALL_INDEX == LC_ALL_INDEX);
3248 # ifdef USE_POSIX_2008_LOCALE
3249 assert(category_masks[LC_ALL_INDEX] == LC_ALL_MASK);
3252 # endif /* DEBUGGING */
3254 /* Initialize the cache of the program's UTF-8ness for the always known
3255 * locales C and POSIX */
3256 my_strlcpy(PL_locale_utf8ness, C_and_POSIX_utf8ness,
3257 sizeof(PL_locale_utf8ness));
3259 # ifdef USE_THREAD_SAFE_LOCALE
3262 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
3266 # ifdef USE_POSIX_2008_LOCALE
3268 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", (locale_t) 0);
3269 if (! PL_C_locale_obj) {
3270 Perl_croak_nocontext(
3271 "panic: Cannot create POSIX 2008 C locale object; errno=%d", errno);
3273 if (DEBUG_Lv_TEST || debug_initialization) {
3274 PerlIO_printf(Perl_debug_log, "%s:%d: created C object %p\n", __FILE__, __LINE__, PL_C_locale_obj);
3279 PL_numeric_radix_sv = newSVpvs(".");
3281 # if defined(USE_POSIX_2008_LOCALE) && ! defined(HAS_QUERYLOCALE)
3283 /* Initialize our records. If we have POSIX 2008, we have LC_ALL */
3284 do_setlocale_c(LC_ALL, my_setlocale(LC_ALL, NULL));
3287 # ifdef LOCALE_ENVIRON_REQUIRED
3290 * Ultrix setlocale(..., "") fails if there are no environment
3291 * variables from which to get a locale name.
3295 # error Ultrix without LC_ALL not implemented
3301 sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, setlocale_init);
3302 DEBUG_LOCALE_INIT(LC_ALL, setlocale_init, sl_result[LC_ALL_INDEX]);
3303 if (sl_result[LC_ALL_INDEX])
3306 setlocale_failure = TRUE;
3308 if (! setlocale_failure) {
3309 const char * locale_param;
3310 for (i = 0; i < LC_ALL_INDEX; i++) {
3311 locale_param = (! done && (lang || PerlEnv_getenv(category_names[i])))
3314 sl_result[i] = do_setlocale_r(categories[i], locale_param);
3315 if (! sl_result[i]) {
3316 setlocale_failure = TRUE;
3318 DEBUG_LOCALE_INIT(categories[i], locale_param, sl_result[i]);
3323 # endif /* LC_ALL */
3324 # endif /* LOCALE_ENVIRON_REQUIRED */
3326 /* We try each locale in the list until we get one that works, or exhaust
3327 * the list. Normally the loop is executed just once. But if setting the
3328 * locale fails, inside the loop we add fallback trials to the array and so
3329 * will execute the loop multiple times */
3330 trial_locales[0] = setlocale_init;
3331 trial_locales_count = 1;
3333 for (i= 0; i < trial_locales_count; i++) {
3334 const char * trial_locale = trial_locales[i];
3338 /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED
3339 * when i==0, but I (khw) don't think that behavior makes much
3341 setlocale_failure = FALSE;
3343 # ifdef SYSTEM_DEFAULT_LOCALE
3344 # ifdef WIN32 /* Note that assumes Win32 has LC_ALL */
3346 /* On Windows machines, an entry of "" after the 0th means to use
3347 * the system default locale, which we now proceed to get. */
3348 if (strEQ(trial_locale, "")) {
3351 /* Note that this may change the locale, but we are going to do
3352 * that anyway just below */
3353 system_default_locale = do_setlocale_c(LC_ALL, "");
3354 DEBUG_LOCALE_INIT(LC_ALL, "", system_default_locale);
3356 /* Skip if invalid or if it's already on the list of locales to
3358 if (! system_default_locale) {
3359 goto next_iteration;
3361 for (j = 0; j < trial_locales_count; j++) {
3362 if (strEQ(system_default_locale, trial_locales[j])) {
3363 goto next_iteration;
3367 trial_locale = system_default_locale;
3370 # error SYSTEM_DEFAULT_LOCALE only implemented for Win32
3372 # endif /* SYSTEM_DEFAULT_LOCALE */
3378 sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, trial_locale);
3379 DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result[LC_ALL_INDEX]);
3380 if (! sl_result[LC_ALL_INDEX]) {
3381 setlocale_failure = TRUE;
3384 /* Since LC_ALL succeeded, it should have changed all the other
3385 * categories it can to its value; so we massage things so that the
3386 * setlocales below just return their category's current values.
3387 * This adequately handles the case in NetBSD where LC_COLLATE may
3388 * not be defined for a locale, and setting it individually will
3389 * fail, whereas setting LC_ALL succeeds, leaving LC_COLLATE set to
3390 * the POSIX locale. */
3391 trial_locale = NULL;
3394 # endif /* LC_ALL */
3396 if (! setlocale_failure) {
3398 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3400 = savepv(do_setlocale_r(categories[j], trial_locale));
3401 if (! curlocales[j]) {
3402 setlocale_failure = TRUE;
3404 DEBUG_LOCALE_INIT(categories[j], trial_locale, curlocales[j]);
3407 if (! setlocale_failure) { /* All succeeded */
3408 break; /* Exit trial_locales loop */
3412 /* Here, something failed; will need to try a fallback. */
3418 if (locwarn) { /* Output failure info only on the first one */
3422 PerlIO_printf(Perl_error_log,
3423 "perl: warning: Setting locale failed.\n");
3425 # else /* !LC_ALL */
3427 PerlIO_printf(Perl_error_log,
3428 "perl: warning: Setting locale failed for the categories:\n\t");
3430 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3431 if (! curlocales[j]) {
3432 PerlIO_printf(Perl_error_log, category_names[j]);
3435 Safefree(curlocales[j]);
3439 # endif /* LC_ALL */
3441 PerlIO_printf(Perl_error_log,
3442 "perl: warning: Please check that your locale settings:\n");
3446 PerlIO_printf(Perl_error_log,
3447 "\tLANGUAGE = %c%s%c,\n",
3448 language ? '"' : '(',
3449 language ? language : "unset",
3450 language ? '"' : ')');
3453 PerlIO_printf(Perl_error_log,
3454 "\tLC_ALL = %c%s%c,\n",
3456 lc_all ? lc_all : "unset",
3457 lc_all ? '"' : ')');
3459 # if defined(USE_ENVIRON_ARRAY)
3464 /* Look through the environment for any variables of the
3465 * form qr/ ^ LC_ [A-Z]+ = /x, except LC_ALL which was
3466 * already handled above. These are assumed to be locale
3467 * settings. Output them and their values. */
3468 for (e = environ; *e; e++) {
3469 const STRLEN prefix_len = sizeof("LC_") - 1;
3472 if ( strBEGINs(*e, "LC_")
3473 && ! strBEGINs(*e, "LC_ALL=")
3474 && (uppers_len = strspn(*e + prefix_len,
3475 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"))
3476 && ((*e)[prefix_len + uppers_len] == '='))
3478 PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
3479 (int) (prefix_len + uppers_len), *e,
3480 *e + prefix_len + uppers_len + 1);
3487 PerlIO_printf(Perl_error_log,
3488 "\t(possibly more locale environment variables)\n");
3492 PerlIO_printf(Perl_error_log,
3493 "\tLANG = %c%s%c\n",
3495 lang ? lang : "unset",
3498 PerlIO_printf(Perl_error_log,
3499 " are supported and installed on your system.\n");
3502 /* Calculate what fallback locales to try. We have avoided this
3503 * until we have to, because failure is quite unlikely. This will
3504 * usually change the upper bound of the loop we are in.
3506 * Since the system's default way of setting the locale has not
3507 * found one that works, We use Perl's defined ordering: LC_ALL,
3508 * LANG, and the C locale. We don't try the same locale twice, so
3509 * don't add to the list if already there. (On POSIX systems, the
3510 * LC_ALL element will likely be a repeat of the 0th element "",
3511 * but there's no harm done by doing it explicitly.
3513 * Note that this tries the LC_ALL environment variable even on
3514 * systems which have no LC_ALL locale setting. This may or may
3515 * not have been originally intentional, but there's no real need
3516 * to change the behavior. */
3518 for (j = 0; j < trial_locales_count; j++) {
3519 if (strEQ(lc_all, trial_locales[j])) {
3523 trial_locales[trial_locales_count++] = lc_all;
3528 for (j = 0; j < trial_locales_count; j++) {
3529 if (strEQ(lang, trial_locales[j])) {
3533 trial_locales[trial_locales_count++] = lang;
3537 # if defined(WIN32) && defined(LC_ALL)
3539 /* For Windows, we also try the system default locale before "C".
3540 * (If there exists a Windows without LC_ALL we skip this because
3541 * it gets too complicated. For those, the "C" is the next
3542 * fallback possibility). The "" is the same as the 0th element of
3543 * the array, but the code at the loop above knows to treat it
3544 * differently when not the 0th */
3545 trial_locales[trial_locales_count++] = "";
3549 for (j = 0; j < trial_locales_count; j++) {
3550 if (strEQ("C", trial_locales[j])) {
3554 trial_locales[trial_locales_count++] = "C";
3557 } /* end of first time through the loop */
3565 } /* end of looping through the trial locales */
3567 if (ok < 1) { /* If we tried to fallback */
3569 if (! setlocale_failure) { /* fallback succeeded */
3570 msg = "Falling back to";
3572 else { /* fallback failed */
3575 /* We dropped off the end of the loop, so have to decrement i to
3576 * get back to the value the last time through */
3580 msg = "Failed to fall back to";
3582 /* To continue, we should use whatever values we've got */
3584 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3585 Safefree(curlocales[j]);
3586 curlocales[j] = savepv(do_setlocale_r(categories[j], NULL));
3587 DEBUG_LOCALE_INIT(categories[j], NULL, curlocales[j]);
3592 const char * description;
3593 const char * name = "";
3594 if (strEQ(trial_locales[i], "C")) {
3595 description = "the standard locale";
3599 # ifdef SYSTEM_DEFAULT_LOCALE
3601 else if (strEQ(trial_locales[i], "")) {
3602 description = "the system default locale";
3603 if (system_default_locale) {
3604 name = system_default_locale;
3608 # endif /* SYSTEM_DEFAULT_LOCALE */
3611 description = "a fallback locale";
3612 name = trial_locales[i];
3614 if (name && strNE(name, "")) {
3615 PerlIO_printf(Perl_error_log,
3616 "perl: warning: %s %s (\"%s\").\n", msg, description, name);
3619 PerlIO_printf(Perl_error_log,
3620 "perl: warning: %s %s.\n", msg, description);
3623 } /* End of tried to fallback */
3625 /* Done with finding the locales; update our records */
3627 # ifdef USE_LOCALE_CTYPE
3629 new_ctype(curlocales[LC_CTYPE_INDEX]);
3632 # ifdef USE_LOCALE_COLLATE
3634 new_collate(curlocales[LC_COLLATE_INDEX]);
3637 # ifdef USE_LOCALE_NUMERIC
3639 new_numeric(curlocales[LC_NUMERIC_INDEX]);
3643 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
3645 # if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
3647 /* This caches whether each category's locale is UTF-8 or not. This
3648 * may involve changing the locale. It is ok to do this at
3649 * initialization time before any threads have started, but not later
3650 * unless thread-safe operations are used.
3651 * Caching means that if the program heeds our dictate not to change
3652 * locales in threaded applications, this data will remain valid, and
3653 * it may get queried without having to change locales. If the
3654 * environment is such that all categories have the same locale, this
3655 * isn't needed, as the code will not change the locale; but this
3656 * handles the uncommon case where the environment has disparate
3657 * locales for the categories */
3658 (void) _is_cur_LC_category_utf8(categories[i]);
3662 Safefree(curlocales[i]);
3665 # if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE)
3667 /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE
3668 * locale is UTF-8. The call to new_ctype() just above has already
3669 * calculated the latter value and saved it in PL_in_utf8_CTYPE_locale. If
3670 * both PL_utf8locale and PL_unicode (set by -C or by $ENV{PERL_UNICODE})
3671 * are true, perl.c:S_parse_body() will turn on the PerlIO :utf8 layer on
3672 * STDIN, STDOUT, STDERR, _and_ the default open discipline. */
3673 PL_utf8locale = PL_in_utf8_CTYPE_locale;
3675 /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
3676 This is an alternative to using the -C command line switch
3677 (the -C if present will override this). */
3679 const char *p = PerlEnv_getenv("PERL_UNICODE");
3680 PL_unicode = p ? parse_unicode_opts(&p) : 0;
3681 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3695 #endif /* USE_LOCALE */
3698 /* So won't continue to output stuff */
3699 DEBUG_INITIALIZATION_set(FALSE);
3706 #ifdef USE_LOCALE_COLLATE
3709 Perl__mem_collxfrm(pTHX_ const char *input_string,
3710 STRLEN len, /* Length of 'input_string' */
3711 STRLEN *xlen, /* Set to length of returned string
3712 (not including the collation index
3714 bool utf8 /* Is the input in UTF-8? */
3718 /* _mem_collxfrm() is a bit like strxfrm() but with two important
3719 * differences. First, it handles embedded NULs. Second, it allocates a bit
3720 * more memory than needed for the transformed data itself. The real
3721 * transformed data begins at offset COLLXFRM_HDR_LEN. *xlen is set to
3722 * the length of that, and doesn't include the collation index size.
3723 * Please see sv_collxfrm() to see how this is used. */
3725 #define COLLXFRM_HDR_LEN sizeof(PL_collation_ix)
3727 char * s = (char *) input_string;
3728 STRLEN s_strlen = strlen(input_string);
3730 STRLEN xAlloc; /* xalloc is a reserved word in VC */
3731 STRLEN length_in_chars;
3732 bool first_time = TRUE; /* Cleared after first loop iteration */
3734 PERL_ARGS_ASSERT__MEM_COLLXFRM;
3736 /* Must be NUL-terminated */
3737 assert(*(input_string + len) == '\0');
3739 /* If this locale has defective collation, skip */
3740 if (PL_collxfrm_base == 0 && PL_collxfrm_mult == 0) {
3741 DEBUG_L(PerlIO_printf(Perl_debug_log,
3742 "_mem_collxfrm: locale's collation is defective\n"));
3746 /* Replace any embedded NULs with the control that sorts before any others.
3747 * This will give as good as possible results on strings that don't
3748 * otherwise contain that character, but otherwise there may be
3749 * less-than-perfect results with that character and NUL. This is
3750 * unavoidable unless we replace strxfrm with our own implementation. */
3751 if (UNLIKELY(s_strlen < len)) { /* Only execute if there is an embedded
3755 STRLEN sans_nuls_len;
3756 int try_non_controls;
3757 char this_replacement_char[] = "?\0"; /* Room for a two-byte string,
3758 making sure 2nd byte is NUL.
3760 STRLEN this_replacement_len;
3762 /* If we don't know what non-NUL control character sorts lowest for
3763 * this locale, find it */
3764 if (PL_strxfrm_NUL_replacement == '\0') {
3766 char * cur_min_x = NULL; /* The min_char's xfrm, (except it also
3767 includes the collation index
3770 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "Looking to replace NUL\n"));
3772 /* Unlikely, but it may be that no control will work to replace
3773 * NUL, in which case we instead look for any character. Controls
3774 * are preferred because collation order is, in general, context
3775 * sensitive, with adjoining characters affecting the order, and
3776 * controls are less likely to have such interactions, allowing the
3777 * NUL-replacement to stand on its own. (Another way to look at it
3778 * is to imagine what would happen if the NUL were replaced by a
3779 * combining character; it wouldn't work out all that well.) */
3780 for (try_non_controls = 0;
3781 try_non_controls < 2;
3784 /* Look through all legal code points (NUL isn't) */
3785 for (j = 1; j < 256; j++) {
3786 char * x; /* j's xfrm plus collation index */
3787 STRLEN x_len; /* length of 'x' */
3788 STRLEN trial_len = 1;
3789 char cur_source[] = { '\0', '\0' };
3791 /* Skip non-controls the first time through the loop. The
3792 * controls in a UTF-8 locale are the L1 ones */
3793 if (! try_non_controls && (PL_in_utf8_COLLATE_locale)
3800 /* Create a 1-char string of the current code point */
3801 cur_source[0] = (char) j;
3803 /* Then transform it */
3804 x = _mem_collxfrm(cur_source, trial_len, &x_len,
3805 0 /* The string is not in UTF-8 */);
3807 /* Ignore any character that didn't successfully transform.
3813 /* If this character's transformation is lower than
3814 * the current lowest, this one becomes the lowest */
3815 if ( cur_min_x == NULL
3816 || strLT(x + COLLXFRM_HDR_LEN,
3817 cur_min_x + COLLXFRM_HDR_LEN))
3819 PL_strxfrm_NUL_replacement = j;
3825 } /* end of loop through all 255 characters */
3827 /* Stop looking if found */
3832 /* Unlikely, but possible, if there aren't any controls that
3833 * work in the locale, repeat the loop, looking for any
3834 * character that works */
3835 DEBUG_L(PerlIO_printf(Perl_debug_log,
3836 "_mem_collxfrm: No control worked. Trying non-controls\n"));
3837 } /* End of loop to try first the controls, then any char */
3840 DEBUG_L(PerlIO_printf(Perl_debug_log,
3841 "_mem_collxfrm: Couldn't find any character to replace"
3842 " embedded NULs in locale %s with", PL_collation_name));
3846 DEBUG_L(PerlIO_printf(Perl_debug_log,
3847 "_mem_collxfrm: Replacing embedded NULs in locale %s with "
3848 "0x%02X\n", PL_collation_name, PL_strxfrm_NUL_replacement));
3850 Safefree(cur_min_x);
3851 } /* End of determining the character that is to replace NULs */
3853 /* If the replacement is variant under UTF-8, it must match the
3854 * UTF8-ness of the original */
3855 if ( ! UVCHR_IS_INVARIANT(PL_strxfrm_NUL_replacement) && utf8) {
3856 this_replacement_char[0] =
3857 UTF8_EIGHT_BIT_HI(PL_strxfrm_NUL_replacement);
3858 this_replacement_char[1] =
3859 UTF8_EIGHT_BIT_LO(PL_strxfrm_NUL_replacement);
3860 this_replacement_len = 2;
3863 this_replacement_char[0] = PL_strxfrm_NUL_replacement;
3864 /* this_replacement_char[1] = '\0' was done at initialization */
3865 this_replacement_len = 1;
3868 /* The worst case length for the replaced string would be if every
3869 * character in it is NUL. Multiply that by the length of each
3870 * replacement, and allow for a trailing NUL */
3871 sans_nuls_len = (len * this_replacement_len) + 1;
3872 Newx(sans_nuls, sans_nuls_len, char);
3875 /* Replace each NUL with the lowest collating control. Loop until have
3876 * exhausted all the NULs */
3877 while (s + s_strlen < e) {
3878 my_strlcat(sans_nuls, s, sans_nuls_len);
3880 /* Do the actual replacement */
3881 my_strlcat(sans_nuls, this_replacement_char, sans_nuls_len);
3883 /* Move past the input NUL */
3885 s_strlen = strlen(s);
3888 /* And add anything that trails the final NUL */
3889 my_strlcat(sans_nuls, s, sans_nuls_len);
3891 /* Switch so below we transform this modified string */
3894 } /* End of replacing NULs */
3896 /* Make sure the UTF8ness of the string and locale match */
3897 if (utf8 != PL_in_utf8_COLLATE_locale) {
3898 /* XXX convert above Unicode to 10FFFF? */
3899 const char * const t = s; /* Temporary so we can later find where the
3902 /* Here they don't match. Change the string's to be what the locale is
3905 if (! utf8) { /* locale is UTF-8, but input isn't; upgrade the input */
3906 s = (char *) bytes_to_utf8((const U8 *) s, &len);
3909 else { /* locale is not UTF-8; but input is; downgrade the input */
3911 s = (char *) bytes_from_utf8((const U8 *) s, &len, &utf8);
3913 /* If the downgrade was successful we are done, but if the input
3914 * contains things that require UTF-8 to represent, have to do
3915 * damage control ... */
3916 if (UNLIKELY(utf8)) {
3918 /* What we do is construct a non-UTF-8 string with
3919 * 1) the characters representable by a single byte converted
3920 * to be so (if necessary);
3921 * 2) and the rest converted to collate the same as the
3922 * highest collating representable character. That makes
3923 * them collate at the end. This is similar to how we
3924 * handle embedded NULs, but we use the highest collating
3925 * code point instead of the smallest. Like the NUL case,
3926 * this isn't perfect, but is the best we can reasonably
3927 * do. Every above-255 code point will sort the same as
3928 * the highest-sorting 0-255 code point. If that code
3929 * point can combine in a sequence with some other code
3930 * points for weight calculations, us changing something to
3931 * be it can adversely affect the results. But in most
3932 * cases, it should work reasonably. And note that this is
3933 * really an illegal situation: using code points above 255
3934 * on a locale where only 0-255 are valid. If two strings
3935 * sort entirely equal, then the sort order for the
3936 * above-255 code points will be in code point order. */
3940 /* If we haven't calculated the code point with the maximum
3941 * collating order for this locale, do so now */
3942 if (! PL_strxfrm_max_cp) {
3945 /* The current transformed string that collates the
3946 * highest (except it also includes the prefixed collation
3948 char * cur_max_x = NULL;
3950 /* Look through all legal code points (NUL isn't) */
3951 for (j = 1; j < 256; j++) {
3954 char cur_source[] = { '\0', '\0' };
3956 /* Create a 1-char string of the current code point */
3957 cur_source[0] = (char) j;
3959 /* Then transform it */
3960 x = _mem_collxfrm(cur_source, 1, &x_len, FALSE);
3962 /* If something went wrong (which it shouldn't), just
3963 * ignore this code point */
3968 /* If this character's transformation is higher than
3969 * the current highest, this one becomes the highest */
3970 if ( cur_max_x == NULL
3971 || strGT(x + COLLXFRM_HDR_LEN,
3972 cur_max_x + COLLXFRM_HDR_LEN))
3974 PL_strxfrm_max_cp = j;
3983 DEBUG_L(PerlIO_printf(Perl_debug_log,
3984 "_mem_collxfrm: Couldn't find any character to"
3985 " replace above-Latin1 chars in locale %s with",
3986 PL_collation_name));
3990 DEBUG_L(PerlIO_printf(Perl_debug_log,
3991 "_mem_collxfrm: highest 1-byte collating character"
3992 " in locale %s is 0x%02X\n",
3994 PL_strxfrm_max_cp));
3996 Safefree(cur_max_x);
3999 /* Here we know which legal code point collates the highest.
4000 * We are ready to construct the non-UTF-8 string. The length
4001 * will be at least 1 byte smaller than the input string
4002 * (because we changed at least one 2-byte character into a
4003 * single byte), but that is eaten up by the trailing NUL */
4009 char * e = (char *) t + len;
4011 for (i = 0; i < len; i+= UTF8SKIP(t + i)) {
4013 if (UTF8_IS_INVARIANT(cur_char)) {
4016 else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(t + i, e)) {
4017 s[d++] = EIGHT_BIT_UTF8_TO_NATIVE(cur_char, t[i+1]);
4019 else { /* Replace illegal cp with highest collating
4021 s[d++] = PL_strxfrm_max_cp;
4025 Renew(s, d, char); /* Free up unused space */
4030 /* Here, we have constructed a modified version of the input. It could
4031 * be that we already had a modified copy before we did this version.
4032 * If so, that copy is no longer needed */
4033 if (t != input_string) {
4038 length_in_chars = (utf8)
4039 ? utf8_length((U8 *) s, (U8 *) s + len)
4042 /* The first element in the output is the collation id, used by
4043 * sv_collxfrm(); then comes the space for the transformed string. The
4044 * equation should give us a good estimate as to how much is needed */
4045 xAlloc = COLLXFRM_HDR_LEN
4047 + (PL_collxfrm_mult * length_in_chars);
4048 Newx(xbuf, xAlloc, char);
4049 if (UNLIKELY(! xbuf)) {
4050 DEBUG_L(PerlIO_printf(Perl_debug_log,
4051 "_mem_collxfrm: Couldn't malloc %zu bytes\n", xAlloc));
4055 /* Store the collation id */
4056 *(U32*)xbuf = PL_collation_ix;
4058 /* Then the transformation of the input. We loop until successful, or we
4062 *xlen = strxfrm(xbuf + COLLXFRM_HDR_LEN, s, xAlloc - COLLXFRM_HDR_LEN);
4064 /* If the transformed string occupies less space than we told strxfrm()
4065 * was available, it means it successfully transformed the whole
4067 if (*xlen < xAlloc - COLLXFRM_HDR_LEN) {
4069 /* Some systems include a trailing NUL in the returned length.
4070 * Ignore it, using a loop in case multiple trailing NULs are
4073 && *(xbuf + COLLXFRM_HDR_LEN + (*xlen) - 1) == '\0')
4078 /* If the first try didn't get it, it means our prediction was low.
4079 * Modify the coefficients so that we predict a larger value in any
4080 * future transformations */
4082 STRLEN needed = *xlen + 1; /* +1 For trailing NUL */
4083 STRLEN computed_guess = PL_collxfrm_base
4084 + (PL_collxfrm_mult * length_in_chars);
4086 /* On zero-length input, just keep current slope instead of
4088 const STRLEN new_m = (length_in_chars != 0)
4089 ? needed / length_in_chars
4092 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
4093 "%s: %d: initial size of %zu bytes for a length "
4094 "%zu string was insufficient, %zu needed\n",
4096 computed_guess, length_in_chars, needed));
4098 /* If slope increased, use it, but discard this result for
4099 * length 1 strings, as we can't be sure that it's a real slope
4101 if (length_in_chars > 1 && new_m > PL_collxfrm_mult) {
4105 STRLEN old_m = PL_collxfrm_mult;
4106 STRLEN old_b = PL_collxfrm_base;
4110 PL_collxfrm_mult = new_m;
4111 PL_collxfrm_base = 1; /* +1 For trailing NUL */
4112 computed_guess = PL_collxfrm_base
4113 + (PL_collxfrm_mult * length_in_chars);
4114 if (computed_guess < needed) {
4115 PL_collxfrm_base += needed - computed_guess;
4118 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
4119 "%s: %d: slope is now %zu; was %zu, base "
4120 "is now %zu; was %zu\n",
4122 PL_collxfrm_mult, old_m,
4123 PL_collxfrm_base, old_b));
4125 else { /* Slope didn't change, but 'b' did */
4126 const STRLEN new_b = needed
4129 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
4130 "%s: %d: base is now %zu; was %zu\n",
4132 new_b, PL_collxfrm_base));
4133 PL_collxfrm_base = new_b;
4140 if (UNLIKELY(*xlen >= PERL_INT_MAX)) {
4141 DEBUG_L(PerlIO_printf(Perl_debug_log,
4142 "_mem_collxfrm: Needed %zu bytes, max permissible is %u\n",
4143 *xlen, PERL_INT_MAX));
4147 /* A well-behaved strxfrm() returns exactly how much space it needs
4148 * (usually not including the trailing NUL) when it fails due to not
4149 * enough space being provided. Assume that this is the case unless
4150 * it's been proven otherwise */
4151 if (LIKELY(PL_strxfrm_is_behaved) && first_time) {
4152 xAlloc = *xlen + COLLXFRM_HDR_LEN + 1;
4154 else { /* Here, either:
4155 * 1) The strxfrm() has previously shown bad behavior; or
4156 * 2) It isn't the first time through the loop, which means
4157 * that the strxfrm() is now showing bad behavior, because
4158 * we gave it what it said was needed in the previous
4159 * iteration, and it came back saying it needed still more.
4160 * (Many versions of cygwin fit this. When the buffer size
4161 * isn't sufficient, they return the input size instead of
4162 * how much is needed.)
4163 * Increase the buffer size by a fixed percentage and try again.
4165 xAlloc += (xAlloc / 4) + 1;
4166 PL_strxfrm_is_behaved = FALSE;
4170 if (DEBUG_Lv_TEST || debug_initialization) {
4171 PerlIO_printf(Perl_debug_log,
4172 "_mem_collxfrm required more space than previously calculated"
4173 " for locale %s, trying again with new guess=%d+%zu\n",
4174 PL_collation_name, (int) COLLXFRM_HDR_LEN,
4175 xAlloc - COLLXFRM_HDR_LEN);
4182 Renew(xbuf, xAlloc, char);
4183 if (UNLIKELY(! xbuf)) {
4184 DEBUG_L(PerlIO_printf(Perl_debug_log,
4185 "_mem_collxfrm: Couldn't realloc %zu bytes\n", xAlloc));
4195 if (DEBUG_Lv_TEST || debug_initialization) {
4197 print_collxfrm_input_and_return(s, s + len, xlen, utf8);
4198 PerlIO_printf(Perl_debug_log, "Its xfrm is:");
4199 PerlIO_printf(Perl_debug_log, "%s\n",
4200 _byte_dump_string((U8 *) xbuf + COLLXFRM_HDR_LEN,
4206 /* Free up unneeded space; retain ehough for trailing NUL */
4207 Renew(xbuf, COLLXFRM_HDR_LEN + *xlen + 1, char);
4209 if (s != input_string) {
4217 if (s != input_string) {
4224 if (DEBUG_Lv_TEST || debug_initialization) {
4225 print_collxfrm_input_and_return(s, s + len, NULL, utf8);
4236 S_print_collxfrm_input_and_return(pTHX_
4237 const char * const s,
4238 const char * const e,
4239 const STRLEN * const xlen,
4243 PERL_ARGS_ASSERT_PRINT_COLLXFRM_INPUT_AND_RETURN;
4245 PerlIO_printf(Perl_debug_log, "_mem_collxfrm[%" UVuf "]: returning ",
4246 (UV)PL_collation_ix);
4248 PerlIO_printf(Perl_debug_log, "%zu", *xlen);
4251 PerlIO_printf(Perl_debug_log, "NULL");
4253 PerlIO_printf(Perl_debug_log, " for locale '%s', string='",
4255 print_bytes_for_locale(s, e, is_utf8);
4257 PerlIO_printf(Perl_debug_log, "'\n");
4261 S_print_bytes_for_locale(pTHX_
4262 const char * const s,
4263 const char * const e,
4267 bool prev_was_printable = TRUE;
4268 bool first_time = TRUE;
4270 PERL_ARGS_ASSERT_PRINT_BYTES_FOR_LOCALE;
4274 ? utf8_to_uvchr_buf((U8 *) t, e, NULL)
4277 if (! prev_was_printable) {
4278 PerlIO_printf(Perl_debug_log, " ");
4280 PerlIO_printf(Perl_debug_log, "%c", (U8) cp);
4281 prev_was_printable = TRUE;
4285 PerlIO_printf(Perl_debug_log, " ");
4287 PerlIO_printf(Perl_debug_log, "%02" UVXf, cp);
4288 prev_was_printable = FALSE;
4290 t += (is_utf8) ? UTF8SKIP(t) : 1;
4295 # endif /* #ifdef DEBUGGING */
4296 #endif /* USE_LOCALE_COLLATE */
4301 S_switch_category_locale_to_template(pTHX_ const int switch_category, const int template_category, const char * template_locale)
4303 /* Changes the locale for LC_'switch_category" to that of
4304 * LC_'template_category', if they aren't already the same. If not NULL,
4305 * 'template_locale' is the locale that 'template_category' is in.
4307 * Returns a copy of the name of the original locale for 'switch_category'
4308 * so can be switched back to with the companion function
4309 * restore_switched_locale(), (NULL if no restoral is necessary.) */
4311 char * restore_to_locale = NULL;
4313 if (switch_category == template_category) { /* No changes needed */
4317 /* Find the original locale of the category we may need to change, so that
4318 * it can be restored to later */
4319 restore_to_locale = stdize_locale(savepv(do_setlocale_r(switch_category,
4321 if (! restore_to_locale) {
4323 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4324 __FILE__, __LINE__, category_name(switch_category), errno);
4327 /* If the locale of the template category wasn't passed in, find it now */
4328 if (template_locale == NULL) {
4329 template_locale = do_setlocale_r(template_category, NULL);
4330 if (! template_locale) {
4332 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4333 __FILE__, __LINE__, category_name(template_category), errno);
4337 /* It the locales are the same, there's nothing to do */
4338 if (strEQ(restore_to_locale, template_locale)) {
4339 Safefree(restore_to_locale);
4341 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale unchanged as %s\n",
4342 category_name(switch_category), restore_to_locale));
4347 /* Finally, change the locale to the template one */
4348 if (! do_setlocale_r(switch_category, template_locale)) {
4350 "panic: %s: %d: Could not change %s locale to %s, errno=%d\n",
4351 __FILE__, __LINE__, category_name(switch_category),
4352 template_locale, errno);
4355 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale switched to %s\n",
4356 category_name(switch_category), template_locale));
4358 return restore_to_locale;
4362 S_restore_switched_locale(pTHX_ const int category, const char * const original_locale)
4364 /* Restores the locale for LC_'category' to 'original_locale' (which is a
4365 * copy that will be freed by this function), or do nothing if the latter
4366 * parameter is NULL */
4368 if (original_locale == NULL) {
4372 if (! do_setlocale_r(category, original_locale)) {
4374 "panic: %s: %d: setlocale %s restore to %s failed, errno=%d\n",
4376 category_name(category), original_locale, errno);
4379 Safefree(original_locale);
4383 Perl__is_cur_LC_category_utf8(pTHX_ int category)
4385 /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE
4386 * otherwise. 'category' may not be LC_ALL. If the platform doesn't have
4387 * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence
4388 * could give the wrong result. The result will very likely be correct for
4389 * languages that have commonly used non-ASCII characters, but for notably
4390 * English, it comes down to if the locale's name ends in something like
4391 * "UTF-8". It errs on the side of not being a UTF-8 locale.
4393 * If the platform is early C89, not containing mbtowc(), or we are
4394 * compiled to not pay attention to LC_CTYPE, this employs heuristics.
4395 * These work very well for non-Latin locales or those whose currency
4396 * symbol isn't a '$' nor plain ASCII text. But without LC_CTYPE and at
4397 * least MB_CUR_MAX, English locales with an ASCII currency symbol depend
4398 * on the name containing UTF-8 or not. */
4400 /* Name of current locale corresponding to the input category */
4401 const char *save_input_locale = NULL;
4403 bool is_utf8 = FALSE; /* The return value */
4405 /* The variables below are for the cache of previous lookups using this
4406 * function. The cache is a C string, described at the definition for
4407 * 'C_and_POSIX_utf8ness'.
4409 * The first part of the cache is fixed, for the C and POSIX locales. The
4410 * varying part starts just after them. */
4411 char * utf8ness_cache = PL_locale_utf8ness + STRLENs(C_and_POSIX_utf8ness);
4413 Size_t utf8ness_cache_size; /* Size of the varying portion */
4414 Size_t input_name_len; /* Length in bytes of save_input_locale */
4415 Size_t input_name_len_with_overhead; /* plus extra chars used to store
4416 the name in the cache */
4417 char * delimited; /* The name plus the delimiters used to store
4419 char * name_pos; /* position of 'delimited' in the cache, or 0
4425 assert(category != LC_ALL);
4429 /* Get the desired category's locale */
4430 save_input_locale = stdize_locale(savepv(do_setlocale_r(category, NULL)));
4431 if (! save_input_locale) {
4433 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4434 __FILE__, __LINE__, category_name(category), errno);
4437 DEBUG_L(PerlIO_printf(Perl_debug_log,
4438 "Current locale for %s is %s\n",
4439 category_name(category), save_input_locale));
4441 input_name_len = strlen(save_input_locale);
4443 /* In our cache, each name is accompanied by two delimiters and a single
4445 input_name_len_with_overhead = input_name_len + 3;
4447 /* Allocate and populate space for a copy of the name surrounded by the
4449 Newx(delimited, input_name_len_with_overhead, char);
4450 delimited[0] = UTF8NESS_SEP[0];
4451 Copy(save_input_locale, delimited + 1, input_name_len, char);
4452 delimited[input_name_len+1] = UTF8NESS_PREFIX[0];
4453 delimited[input_name_len+2] = '\0';
4455 /* And see if that is in the cache */
4456 name_pos = instr(PL_locale_utf8ness, delimited);
4458 is_utf8 = *(name_pos + input_name_len_with_overhead - 1) - '0';
4462 if (DEBUG_Lv_TEST || debug_initialization) {
4463 PerlIO_printf(Perl_debug_log, "UTF8ness for locale %s=%d, \n",
4464 save_input_locale, is_utf8);
4469 /* And, if not already in that position, move it to the beginning of
4470 * the non-constant portion of the list, since it is the most recently
4471 * used. (We don't have to worry about overflow, since just moving
4472 * existing names around) */
4473 if (name_pos > utf8ness_cache) {
4474 Move(utf8ness_cache,
4475 utf8ness_cache + input_name_len_with_overhead,
4476 name_pos - utf8ness_cache, char);
4479 input_name_len_with_overhead - 1, char);
4480 utf8ness_cache[input_name_len_with_overhead - 1] = is_utf8 + '0';
4483 Safefree(delimited);
4484 Safefree(save_input_locale);
4488 /* Here we don't have stored the utf8ness for the input locale. We have to
4491 # if defined(USE_LOCALE_CTYPE) \
4492 && ( defined(HAS_NL_LANGINFO) \
4493 || (defined(HAS_MBTOWC) || defined(HAS_MBRTOWC)))
4496 const char *original_ctype_locale
4497 = switch_category_locale_to_template(LC_CTYPE,
4501 /* Here the current LC_CTYPE is set to the locale of the category whose
4502 * information is desired. This means that nl_langinfo() and mbtowc()
4503 * should give the correct results */
4505 # ifdef MB_CUR_MAX /* But we can potentially rule out UTF-8ness, avoiding
4506 calling the functions if we have this */
4508 /* Standard UTF-8 needs at least 4 bytes to represent the maximum
4509 * Unicode code point. */
4511 DEBUG_L(PerlIO_printf(Perl_debug_log, "%s: %d: MB_CUR_MAX=%d\n",
4512 __FILE__, __LINE__, (int) MB_CUR_MAX));
4513 if ((unsigned) MB_CUR_MAX < STRLENs(MAX_UNICODE_UTF8)) {
4515 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4516 goto finish_and_return;
4520 # if defined(HAS_NL_LANGINFO)
4522 { /* The task is easiest if the platform has this POSIX 2001 function.
4523 Except on some platforms it can wrongly return "", so have to have
4524 a fallback. And it can return that it's UTF-8, even if there are
4525 variances from that. For example, Turkish locales may use the
4526 alternate dotted I rules, and sometimes it appears to be a
4527 defective locale definition. XXX We should probably check for
4528 these in the Latin1 range and warn (but on glibc, requires
4529 iswalnum() etc. due to their not handling 80-FF correctly */
4530 const char *codeset = my_nl_langinfo(CODESET, FALSE);
4531 /* FALSE => already in dest locale */
4533 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
4534 "\tnllanginfo returned CODESET '%s'\n", codeset));
4536 if (codeset && strNE(codeset, "")) {
4538 /* If the implementation of foldEQ() somehow were
4539 * to change to not go byte-by-byte, this could
4540 * read past end of string, as only one length is
4541 * checked. But currently, a premature NUL will
4542 * compare false, and it will stop there */
4543 is_utf8 = cBOOL( foldEQ(codeset, STR_WITH_LEN("UTF-8"))
4544 || foldEQ(codeset, STR_WITH_LEN("UTF8")));
4546 DEBUG_L(PerlIO_printf(Perl_debug_log,
4547 "\tnllanginfo returned CODESET '%s'; ?UTF8 locale=%d\n",
4549 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4550 goto finish_and_return;
4555 # if defined(HAS_MBTOWC) || defined(HAS_MBRTOWC)
4556 /* We can see if this is a UTF-8-like locale if have mbtowc(). It was a
4557 * late adder to C89, so very likely to have it. However, testing has
4558 * shown that, like nl_langinfo() above, there are locales that are not
4559 * strictly UTF-8 that this will return that they are */
4566 # if defined(HAS_MBRTOWC) && defined(USE_ITHREADS)
4572 /* mbrtowc() and mbtowc() convert a byte string to a wide
4573 * character. Feed a byte string to one of them and check that the
4574 * result is the expected Unicode code point */
4576 # if defined(HAS_MBRTOWC) && defined(USE_ITHREADS)
4577 /* Prefer this function if available, as it's reentrant */
4579 memset(&ps, 0, sizeof(ps));;
4580 PERL_UNUSED_RESULT(mbrtowc(&wc, NULL, 0, &ps)); /* Reset any shift
4583 len = mbrtowc(&wc, STR_WITH_LEN(REPLACEMENT_CHARACTER_UTF8), &ps);
4589 PERL_UNUSED_RESULT(mbtowc(&wc, NULL, 0));/* Reset any shift state */
4591 len = mbtowc(&wc, STR_WITH_LEN(REPLACEMENT_CHARACTER_UTF8));
4598 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
4599 "\treturn from mbtowc; len=%d; code_point=%x; errno=%d\n",
4600 len, (unsigned int) wc, GET_ERRNO));
4602 is_utf8 = cBOOL( len == STRLENs(REPLACEMENT_CHARACTER_UTF8)
4603 && wc == (wchar_t) UNICODE_REPLACEMENT);
4606 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4607 goto finish_and_return;
4613 /* Here, we must have a C89 compiler that doesn't have mbtowc(). Next
4614 * try looking at the currency symbol to see if it disambiguates
4615 * things. Often that will be in the native script, and if the symbol
4616 * isn't in UTF-8, we know that the locale isn't. If it is non-ASCII
4617 * UTF-8, we infer that the locale is too, as the odds of a non-UTF8
4618 * string being valid UTF-8 are quite small */
4620 # ifdef USE_LOCALE_MONETARY
4622 /* If have LC_MONETARY, we can look at the currency symbol. Often that
4623 * will be in the native script. We do this one first because there is
4624 * just one string to examine, so potentially avoids work */
4627 const char *original_monetary_locale
4628 = switch_category_locale_to_template(LC_MONETARY,
4631 bool only_ascii = FALSE;
4632 const U8 * currency_string
4633 = (const U8 *) my_nl_langinfo(CRNCYSTR, FALSE);
4634 /* 2nd param not relevant for this item */
4635 const U8 * first_variant;
4637 assert( *currency_string == '-'
4638 || *currency_string == '+'
4639 || *currency_string == '.');
4643 if (is_utf8_invariant_string_loc(currency_string, 0, &first_variant))
4645 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));
4649 is_utf8 = is_strict_utf8_string(first_variant, 0);
4652 restore_switched_locale(LC_MONETARY, original_monetary_locale);
4656 /* It isn't a UTF-8 locale if the symbol is not legal UTF-8;
4657 * otherwise assume the locale is UTF-8 if and only if the symbol
4658 * is non-ascii UTF-8. */
4659 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?Currency symbol for %s is UTF-8=%d\n",
4660 save_input_locale, is_utf8));
4661 goto finish_and_return;
4665 # endif /* USE_LOCALE_MONETARY */
4666 # if defined(HAS_STRFTIME) && defined(USE_LOCALE_TIME)
4668 /* Still haven't found a non-ASCII string to disambiguate UTF-8 or not. Try
4669 * the names of the months and weekdays, timezone, and am/pm indicator */
4671 const char *original_time_locale
4672 = switch_category_locale_to_template(LC_TIME,
4676 bool is_dst = FALSE;
4680 char * formatted_time;
4682 /* Here the current LC_TIME is set to the locale of the category
4683 * whose information is desired. Look at all the days of the week and
4684 * month names, and the timezone and am/pm indicator for UTF-8 variant
4685 * characters. The first such a one found will tell us if the locale
4686 * is UTF-8 or not */
4688 for (i = 0; i < 7 + 12; i++) { /* 7 days; 12 months */
4689 formatted_time = my_strftime("%A %B %Z %p",
4690 0, 0, hour, dom, month, 2012 - 1900, 0, 0, is_dst);
4691 if ( ! formatted_time
4692 || is_utf8_invariant_string((U8 *) formatted_time, 0))
4695 /* Here, we didn't find a non-ASCII. Try the next time through
4696 * with the complemented dst and am/pm, and try with the next
4697 * weekday. After we have gotten all weekdays, try the next
4700 hour = (hour + 12) % 24;
4708 /* Here, we have a non-ASCII. Return TRUE is it is valid UTF8;
4709 * false otherwise. But first, restore LC_TIME to its original
4710 * locale if we changed it */
4711 restore_switched_locale(LC_TIME, original_time_locale);
4713 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?time-related strings for %s are UTF-8=%d\n",
4715 is_utf8_string((U8 *) formatted_time, 0)));
4716 is_utf8 = is_utf8_string((U8 *) formatted_time, 0);
4717 goto finish_and_return;
4720 /* Falling off the end of the loop indicates all the names were just
4721 * ASCII. Go on to the next test. If we changed it, restore LC_TIME
4722 * to its original locale */
4723 restore_switched_locale(LC_TIME, original_time_locale);
4724 DEBUG_Lv(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));
4729 # if 0 && defined(USE_LOCALE_MESSAGES) && defined(HAS_SYS_ERRLIST)
4731 /* This code is ifdefd out because it was found to not be necessary in testing
4732 * on our dromedary test machine, which has over 700 locales. There, this
4733 * added no value to looking at the currency symbol and the time strings. I
4734 * left it in so as to avoid rewriting it if real-world experience indicates
4735 * that dromedary is an outlier. Essentially, instead of returning abpve if we
4736 * haven't found illegal utf8, we continue on and examine all the strerror()
4737 * messages on the platform for utf8ness. If all are ASCII, we still don't
4738 * know the answer; but otherwise we have a pretty good indication of the
4739 * utf8ness. The reason this doesn't help much is that the messages may not
4740 * have been translated into the locale. The currency symbol and time strings
4741 * are much more likely to have been translated. */
4744 bool non_ascii = FALSE;
4745 const char *original_messages_locale
4746 = switch_category_locale_to_template(LC_MESSAGES,
4749 const char * errmsg = NULL;
4751 /* Here the current LC_MESSAGES is set to the locale of the category
4752 * whose information is desired. Look through all the messages. We
4753 * can't use Strerror() here because it may expand to code that
4754 * segfaults in miniperl */
4756 for (e = 0; e <= sys_nerr; e++) {
4758 errmsg = sys_errlist[e];
4759 if (errno || !errmsg) {
4762 errmsg = savepv(errmsg);
4763 if (! is_utf8_invariant_string((U8 *) errmsg, 0)) {
4765 is_utf8 = is_utf8_string((U8 *) errmsg, 0);
4771 restore_switched_locale(LC_MESSAGES, original_messages_locale);
4775 /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid,
4776 * any non-ascii means it is one; otherwise we assume it isn't */
4777 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?error messages for %s are UTF-8=%d\n",
4780 goto finish_and_return;
4783 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));
4787 # ifndef EBCDIC /* On os390, even if the name ends with "UTF-8', it isn't a
4790 /* As a last resort, look at the locale name to see if it matches
4791 * qr/UTF -? * 8 /ix, or some other common locale names. This "name", the
4792 * return of setlocale(), is actually defined to be opaque, so we can't
4793 * really rely on the absence of various substrings in the name to indicate
4794 * its UTF-8ness, but if it has UTF8 in the name, it is extremely likely to
4795 * be a UTF-8 locale. Similarly for the other common names */
4798 const Size_t final_pos = strlen(save_input_locale) - 1;
4800 if (final_pos >= 3) {
4801 const char *name = save_input_locale;
4803 /* Find next 'U' or 'u' and look from there */
4804 while ((name += strcspn(name, "Uu") + 1)
4805 <= save_input_locale + final_pos - 2)
4807 if ( isALPHA_FOLD_NE(*name, 't')
4808 || isALPHA_FOLD_NE(*(name + 1), 'f'))
4813 if (*(name) == '-') {
4814 if ((name > save_input_locale + final_pos - 1)) {
4819 if (*(name) == '8') {
4820 DEBUG_L(PerlIO_printf(Perl_debug_log,
4821 "Locale %s ends with UTF-8 in name\n",
4822 save_input_locale));
4824 goto finish_and_return;
4827 DEBUG_L(PerlIO_printf(Perl_debug_log,
4828 "Locale %s doesn't end with UTF-8 in name\n",
4829 save_input_locale));
4834 /* http://msdn.microsoft.com/en-us/library/windows/desktop/dd317756.aspx */
4835 if (memENDs(save_input_locale, final_pos, "65001")) {
4836 DEBUG_L(PerlIO_printf(Perl_debug_log,
4837 "Locale %s ends with 65001 in name, is UTF-8 locale\n",
4838 save_input_locale));
4840 goto finish_and_return;
4847 /* Other common encodings are the ISO 8859 series, which aren't UTF-8. But
4848 * since we are about to return FALSE anyway, there is no point in doing
4849 * this extra work */
4852 if (instr(save_input_locale, "8859")) {
4853 DEBUG_L(PerlIO_printf(Perl_debug_log,
4854 "Locale %s has 8859 in name, not UTF-8 locale\n",
4855 save_input_locale));
4857 goto finish_and_return;
4861 DEBUG_L(PerlIO_printf(Perl_debug_log,
4862 "Assuming locale %s is not a UTF-8 locale\n",
4863 save_input_locale));
4866 # endif /* the code that is compiled when no modern LC_CTYPE */
4870 /* Cache this result so we don't have to go through all this next time. */
4871 utf8ness_cache_size = sizeof(PL_locale_utf8ness)
4872 - (utf8ness_cache - PL_locale_utf8ness);
4874 /* But we can't save it if it is too large for the total space available */
4875 if (LIKELY(input_name_len_with_overhead < utf8ness_cache_size)) {
4876 Size_t utf8ness_cache_len = strlen(utf8ness_cache);
4878 /* Here it can fit, but we may need to clear out the oldest cached
4879 * result(s) to do so. Check */
4880 if (utf8ness_cache_len + input_name_len_with_overhead
4881 >= utf8ness_cache_size)
4883 /* Here we have to clear something out to make room for this.
4884 * Start looking at the rightmost place where it could fit and find
4885 * the beginning of the entry that extends past that. */
4886 char * cutoff = (char *) my_memrchr(utf8ness_cache,
4889 - input_name_len_with_overhead);
4892 assert(cutoff >= utf8ness_cache);
4894 /* This and all subsequent entries must be removed */
4896 utf8ness_cache_len = strlen(utf8ness_cache);
4899 /* Make space for the new entry */
4900 Move(utf8ness_cache,
4901 utf8ness_cache + input_name_len_with_overhead,
4902 utf8ness_cache_len + 1 /* Incl. trailing NUL */, char);
4905 Copy(delimited, utf8ness_cache, input_name_len_with_overhead - 1, char);
4906 utf8ness_cache[input_name_len_with_overhead - 1] = is_utf8 + '0';
4908 if ((PL_locale_utf8ness[strlen(PL_locale_utf8ness)-1]
4909 & (PERL_UINTMAX_T) ~1) != '0')
4912 "panic: %s: %d: Corrupt utf8ness_cache=%s\nlen=%zu,"
4913 " inserted_name=%s, its_len=%zu\n",
4915 PL_locale_utf8ness, strlen(PL_locale_utf8ness),
4916 delimited, input_name_len_with_overhead);
4922 if (DEBUG_Lv_TEST) {
4923 const char * s = PL_locale_utf8ness;
4925 /* Audit the structure */
4926 while (s < PL_locale_utf8ness + strlen(PL_locale_utf8ness)) {
4929 if (*s != UTF8NESS_SEP[0]) {
4931 "panic: %s: %d: Corrupt utf8ness_cache: missing"
4932 " separator %.*s<-- HERE %s\n",
4934 (int) (s - PL_locale_utf8ness), PL_locale_utf8ness,
4938 e = strchr(s, UTF8NESS_PREFIX[0]);
4941 "panic: %s: %d: Corrupt utf8ness_cache: missing"
4942 " separator %.*s<-- HERE %s\n",
4944 (int) (e - PL_locale_utf8ness), PL_locale_utf8ness,
4948 if (*e != '0' && *e != '1') {
4950 "panic: %s: %d: Corrupt utf8ness_cache: utf8ness"
4951 " must be [01] %.*s<-- HERE %s\n",
4953 (int) (e + 1 - PL_locale_utf8ness),
4954 PL_locale_utf8ness, e + 1);
4956 if (ninstr(PL_locale_utf8ness, s, s-1, e)) {
4958 "panic: %s: %d: Corrupt utf8ness_cache: entry"
4959 " has duplicate %.*s<-- HERE %s\n",
4961 (int) (e - PL_locale_utf8ness), PL_locale_utf8ness,
4968 if (DEBUG_Lv_TEST || debug_initialization) {
4970 PerlIO_printf(Perl_debug_log,
4971 "PL_locale_utf8ness is now %s; returning %d\n",
4972 PL_locale_utf8ness, is_utf8);
4977 Safefree(delimited);
4978 Safefree(save_input_locale);
4985 Perl__is_in_locale_category(pTHX_ const bool compiling, const int category)
4988 /* Internal function which returns if we are in the scope of a pragma that
4989 * enables the locale category 'category'. 'compiling' should indicate if
4990 * this is during the compilation phase (TRUE) or not (FALSE). */
4992 const COP * const cop = (compiling) ? &PL_compiling : PL_curcop;
4994 SV *categories = cop_hints_fetch_pvs(cop, "locale", 0);
4995 if (! categories || categories == &PL_sv_placeholder) {
4999 /* The pseudo-category 'not_characters' is -1, so just add 1 to each to get
5000 * a valid unsigned */
5001 assert(category >= -1);
5002 return cBOOL(SvUV(categories) & (1U << (category + 1)));
5006 Perl_my_strerror(pTHX_ const int errnum)
5008 /* Returns a mortalized copy of the text of the error message associated
5009 * with 'errnum'. It uses the current locale's text unless the platform
5010 * doesn't have the LC_MESSAGES category or we are not being called from
5011 * within the scope of 'use locale'. In the former case, it uses whatever
5012 * strerror returns; in the latter case it uses the text from the C locale.
5014 * The function just calls strerror(), but temporarily switches, if needed,
5015 * to the C locale */
5020 #ifndef USE_LOCALE_MESSAGES
5022 /* If platform doesn't have messages category, we don't do any switching to
5023 * the C locale; we just use whatever strerror() returns */
5025 errstr = savepv(Strerror(errnum));
5027 #else /* Has locale messages */
5029 const bool within_locale_scope = IN_LC(LC_MESSAGES);
5031 # ifndef USE_ITHREADS
5033 /* This function is trivial without threads. */
5034 if (within_locale_scope) {
5035 errstr = savepv(strerror(errnum));
5038 const char * save_locale = savepv(do_setlocale_c(LC_MESSAGES, NULL));
5040 do_setlocale_c(LC_MESSAGES, "C");
5041 errstr = savepv(strerror(errnum));
5042 do_setlocale_c(LC_MESSAGES, save_locale);
5043 Safefree(save_locale);
5046 # elif defined(HAS_POSIX_2008_LOCALE) \
5047 && defined(HAS_STRERROR_L) \
5048 && defined(HAS_DUPLOCALE)
5050 /* This function is also trivial if we don't have to worry about thread
5051 * safety and have strerror_l(), as it handles the switch of locales so we
5052 * don't have to deal with that. We don't have to worry about thread
5053 * safety if strerror_r() is also available. Both it and strerror_l() are
5054 * thread-safe. Plain strerror() isn't thread safe. But on threaded
5055 * builds when strerror_r() is available, the apparent call to strerror()
5056 * below is actually a macro that behind-the-scenes calls strerror_r(). */
5058 # ifdef HAS_STRERROR_R
5060 if (within_locale_scope) {
5061 errstr = savepv(strerror(errnum));
5064 errstr = savepv(strerror_l(errnum, PL_C_locale_obj));
5069 /* Here we have strerror_l(), but not strerror_r() and we are on a
5070 * threaded-build. We use strerror_l() for everything, constructing a
5071 * locale to pass to it if necessary */
5073 bool do_free = FALSE;
5074 locale_t locale_to_use;
5076 if (within_locale_scope) {
5077 locale_to_use = uselocale((locale_t) 0);
5078 if (locale_to_use == LC_GLOBAL_LOCALE) {
5079 locale_to_use = duplocale(LC_GLOBAL_LOCALE);
5083 else { /* Use C locale if not within 'use locale' scope */
5084 locale_to_use = PL_C_locale_obj;
5087 errstr = savepv(strerror_l(errnum, locale_to_use));
5090 freelocale(locale_to_use);
5094 # else /* Doesn't have strerror_l() */
5096 const char * save_locale = NULL;
5097 bool locale_is_C = FALSE;
5099 /* We have a critical section to prevent another thread from executing this
5100 * same code at the same time. (On thread-safe perls, the LOCK is a
5101 * no-op.) Since this is the only place in core that changes LC_MESSAGES
5102 * (unless the user has called setlocale(), this works to prevent races. */
5105 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5106 "my_strerror called with errnum %d\n", errnum));
5107 if (! within_locale_scope) {
5108 save_locale = do_setlocale_c(LC_MESSAGES, NULL);
5109 if (! save_locale) {
5111 "panic: %s: %d: Could not find current LC_MESSAGES locale,"
5112 " errno=%d\n", __FILE__, __LINE__, errno);
5115 locale_is_C = isNAME_C_OR_POSIX(save_locale);
5117 /* Switch to the C locale if not already in it */
5118 if (! locale_is_C) {
5120 /* The setlocale() just below likely will zap 'save_locale', so
5122 save_locale = savepv(save_locale);
5123 do_setlocale_c(LC_MESSAGES, "C");
5126 } /* end of ! within_locale_scope */
5128 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s: %d: WITHIN locale scope\n",
5129 __FILE__, __LINE__));
5132 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5133 "Any locale change has been done; about to call Strerror\n"));
5134 errstr = savepv(Strerror(errnum));
5136 if (! within_locale_scope) {
5137 if (save_locale && ! locale_is_C) {
5138 if (! do_setlocale_c(LC_MESSAGES, save_locale)) {
5140 "panic: %s: %d: setlocale restore failed, errno=%d\n",
5141 __FILE__, __LINE__, errno);
5143 Safefree(save_locale);
5149 # endif /* End of doesn't have strerror_l */
5150 #endif /* End of does have locale messages */
5154 if (DEBUG_Lv_TEST) {
5155 PerlIO_printf(Perl_debug_log, "Strerror returned; saving a copy: '");
5156 print_bytes_for_locale(errstr, errstr + strlen(errstr), 0);
5157 PerlIO_printf(Perl_debug_log, "'\n");
5168 =for apidoc switch_to_global_locale
5170 On systems without locale support, or on single-threaded builds, or on
5171 platforms that do not support per-thread locale operations, this function does
5172 nothing. On such systems that do have locale support, only a locale global to
5173 the whole program is available.
5175 On multi-threaded builds on systems that do have per-thread locale operations,
5176 this function converts the thread it is running in to use the global locale.
5177 This is for code that has not yet or cannot be updated to handle multi-threaded
5178 locale operation. As long as only a single thread is so-converted, everything
5179 works fine, as all the other threads continue to ignore the global one, so only
5180 this thread looks at it.
5182 However, on Windows systems this isn't quite true prior to Visual Studio 15,
5183 at which point Microsoft fixed a bug. A race can occur if you use the
5184 following operations on earlier Windows platforms:
5188 =item L<POSIX::localeconv|POSIX/localeconv>
5190 =item L<I18N::Langinfo>, items C<CRNCYSTR> and C<THOUSEP>
5192 =item L<perlapi/Perl_langinfo>, items C<CRNCYSTR> and C<THOUSEP>
5196 The first item is not fixable (except by upgrading to a later Visual Studio
5197 release), but it would be possible to work around the latter two items by using
5198 the Windows API functions C<GetNumberFormat> and C<GetCurrencyFormat>; patches
5201 Without this function call, threads that use the L<C<setlocale(3)>> system
5202 function will not work properly, as all the locale-sensitive functions will
5203 look at the per-thread locale, and C<setlocale> will have no effect on this
5206 Perl code should convert to either call
5207 L<C<Perl_setlocale>|perlapi/Perl_setlocale> (which is a drop-in for the system
5208 C<setlocale>) or use the methods given in L<perlcall> to call
5209 L<C<POSIX::setlocale>|POSIX/setlocale>. Either one will transparently properly
5210 handle all cases of single- vs multi-thread, POSIX 2008-supported or not.
5212 Non-Perl libraries, such as C<gtk>, that call the system C<setlocale> can
5213 continue to work if this function is called before transferring control to the
5216 Upon return from the code that needs to use the global locale,
5217 L<C<sync_locale()>|perlapi/sync_locale> should be called to restore the safe
5218 multi-thread operation.
5224 Perl_switch_to_global_locale()
5227 #ifdef USE_THREAD_SAFE_LOCALE
5230 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
5233 # ifdef HAS_QUERYLOCALE
5235 setlocale(LC_ALL, querylocale(LC_ALL_MASK, uselocale((locale_t) 0)));
5242 for (i = 0; i < LC_ALL_INDEX; i++) {
5243 setlocale(categories[i], do_setlocale_r(categories[i], NULL));
5249 uselocale(LC_GLOBAL_LOCALE);
5258 =for apidoc sync_locale
5260 L<C<Perl_setlocale>|perlapi/Perl_setlocale> can be used at any time to query or
5261 change the locale (though changing the locale is antisocial and dangerous on
5262 multi-threaded systems that don't have multi-thread safe locale operations.
5263 (See L<perllocale/Multi-threaded operation>). Using the system
5264 L<C<setlocale(3)>> should be avoided. Nevertheless, certain non-Perl libraries
5265 called from XS, such as C<Gtk> do so, and this can't be changed. When the
5266 locale is changed by XS code that didn't use
5267 L<C<Perl_setlocale>|perlapi/Perl_setlocale>, Perl needs to be told that the
5268 locale has changed. Use this function to do so, before returning to Perl.
5270 The return value is a boolean: TRUE if the global locale at the time of call
5271 was in effect; and FALSE if a per-thread locale was in effect. This can be
5272 used by the caller that needs to restore things as-they-were to decide whether
5274 L<C<Perl_switch_to_global_locale>|perlapi/switch_to_global_locale>.
5282 const char * newlocale;
5285 #ifdef USE_POSIX_2008_LOCALE
5287 bool was_in_global_locale = FALSE;
5288 locale_t cur_obj = uselocale((locale_t) 0);
5290 /* On Windows, unless the foreign code has turned off the thread-safe
5291 * locale setting, any plain setlocale() will have affected what we see, so
5292 * no need to worry. Otherwise, If the foreign code has done a plain
5293 * setlocale(), it will only affect the global locale on POSIX systems, but
5294 * will affect the */
5295 if (cur_obj == LC_GLOBAL_LOCALE) {
5297 # ifdef HAS_QUERY_LOCALE
5299 do_setlocale_c(LC_ALL, setlocale(LC_ALL, NULL));
5305 /* We can't trust that we can read the LC_ALL format on the
5306 * platform, so do them individually */
5307 for (i = 0; i < LC_ALL_INDEX; i++) {
5308 do_setlocale_r(categories[i], setlocale(categories[i], NULL));
5313 was_in_global_locale = TRUE;
5318 bool was_in_global_locale = TRUE;
5321 #ifdef USE_LOCALE_CTYPE
5323 newlocale = savepv(do_setlocale_c(LC_CTYPE, NULL));
5324 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5325 "%s:%d: %s\n", __FILE__, __LINE__,
5326 setlocale_debug_string(LC_CTYPE, NULL, newlocale)));
5327 new_ctype(newlocale);
5328 Safefree(newlocale);
5330 #endif /* USE_LOCALE_CTYPE */
5331 #ifdef USE_LOCALE_COLLATE
5333 newlocale = savepv(do_setlocale_c(LC_COLLATE, NULL));
5334 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5335 "%s:%d: %s\n", __FILE__, __LINE__,
5336 setlocale_debug_string(LC_COLLATE, NULL, newlocale)));
5337 new_collate(newlocale);
5338 Safefree(newlocale);
5341 #ifdef USE_LOCALE_NUMERIC
5343 newlocale = savepv(do_setlocale_c(LC_NUMERIC, NULL));
5344 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5345 "%s:%d: %s\n", __FILE__, __LINE__,
5346 setlocale_debug_string(LC_NUMERIC, NULL, newlocale)));
5347 new_numeric(newlocale);
5348 Safefree(newlocale);
5350 #endif /* USE_LOCALE_NUMERIC */
5352 return was_in_global_locale;
5355 #if defined(DEBUGGING) && defined(USE_LOCALE)
5358 S_setlocale_debug_string(const int category, /* category number,
5360 const char* const locale, /* locale name */
5362 /* return value from setlocale() when attempting to
5363 * set 'category' to 'locale' */
5364 const char* const retval)
5366 /* Returns a pointer to a NUL-terminated string in static storage with
5367 * added text about the info passed in. This is not thread safe and will
5368 * be overwritten by the next call, so this should be used just to
5369 * formulate a string to immediately print or savepv() on. */
5371 /* initialise to a non-null value to keep it out of BSS and so keep
5372 * -DPERL_GLOBAL_STRUCT_PRIVATE happy */
5373 static char ret[256] = "If you can read this, thank your buggy C"
5374 " library strlcpy(), and change your hints file"
5377 my_strlcpy(ret, "setlocale(", sizeof(ret));
5378 my_strlcat(ret, category_name(category), sizeof(ret));
5379 my_strlcat(ret, ", ", sizeof(ret));
5382 my_strlcat(ret, "\"", sizeof(ret));
5383 my_strlcat(ret, locale, sizeof(ret));
5384 my_strlcat(ret, "\"", sizeof(ret));
5387 my_strlcat(ret, "NULL", sizeof(ret));
5390 my_strlcat(ret, ") returned ", sizeof(ret));
5393 my_strlcat(ret, "\"", sizeof(ret));
5394 my_strlcat(ret, retval, sizeof(ret));
5395 my_strlcat(ret, "\"", sizeof(ret));
5398 my_strlcat(ret, "NULL", sizeof(ret));
5401 assert(strlen(ret) < sizeof(ret));
5409 Perl_thread_locale_init()
5411 /* Called from a thread on startup*/
5413 #ifdef USE_THREAD_SAFE_LOCALE
5417 /* C starts the new thread in the global C locale. If we are thread-safe,
5418 * we want to not be in the global locale */
5420 DEBUG_L(PerlIO_printf(Perl_debug_log,
5421 "%s:%d: new thread, initial locale is %s; calling setlocale\n",
5422 __FILE__, __LINE__, setlocale(LC_ALL, NULL)));
5426 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
5430 Perl_setlocale(LC_ALL, "C");
5438 Perl_thread_locale_term()
5440 /* Called from a thread as it gets ready to terminate */
5442 #ifdef USE_THREAD_SAFE_LOCALE
5444 /* C starts the new thread in the global C locale. If we are thread-safe,
5445 * we want to not be in the global locale */
5450 locale_t cur_obj = uselocale(LC_GLOBAL_LOCALE);
5451 if (cur_obj != LC_GLOBAL_LOCALE) {
5452 freelocale(cur_obj);
5462 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob