This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Actually make I18N::Langinfo avail on all platforms
[perl5.git] / locale.c
1 /*    locale.c
2  *
3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4  *    2002, 2003, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
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.
8  *
9  */
10
11 /*
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!
19  *
20  *     [p.238 of _The Lord of the Rings_, II/i: "Many Meetings"]
21  */
22
23 /* utility functions for handling locale-specific stuff like what
24  * character represents the decimal point.
25  *
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
34  * of 'use locale'.
35  *
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.
44  */
45
46 #include "EXTERN.h"
47 #define PERL_IN_LOCALE_C
48 #include "perl_langinfo.h"
49 #include "perl.h"
50
51 #include "reentr.h"
52
53 #ifdef I_WCHAR
54 #  include <wchar.h>
55 #endif
56
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)
63 #else
64 static bool debug_initialization = FALSE;
65 #  define DEBUG_INITIALIZATION_set(v) (debug_initialization = v)
66 #endif
67
68
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
71  * done generally. */
72 #define GET_ERRNO   saved_errno
73
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)
78
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):
85  *   cntrl:  84-97 9B-9F
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)                                              \
90                              (   (name) != NULL                              \
91                               && (( *(name) == 'C' && (*(name + 1)) == '\0') \
92                                    || strEQ((name), "POSIX")))
93
94 #ifdef USE_LOCALE
95
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:  */
98
99 #define UTF8NESS_SEP     "\v"
100 #define UTF8NESS_PREFIX  "\f"
101
102 /* So, the string looks like:
103  *
104  *      \vC\a0\vPOSIX\a0\vam_ET\a0\vaf_ZA.utf8\a1\ven_US.UTF-8\a1\0
105  *
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. */
108
109 STATIC_ASSERT_DECL(STRLENs(UTF8NESS_SEP) == 1);
110 STATIC_ASSERT_DECL(STRLENs(UTF8NESS_PREFIX) == 1);
111
112 #define C_and_POSIX_utf8ness    UTF8NESS_SEP "C"     UTF8NESS_PREFIX "0"    \
113                                 UTF8NESS_SEP "POSIX" UTF8NESS_PREFIX "0"
114
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 */
118
119 STATIC char *
120 S_stdize_locale(pTHX_ char *locs)
121 {
122     /* Standardize the locale name from a string returned by 'setlocale',
123      * possibly modifying that string.
124      *
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.
130      *
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 '='
134      * */
135
136     const char * const s = strchr(locs, '=');
137     bool okay = TRUE;
138
139     PERL_ARGS_ASSERT_STDIZE_LOCALE;
140
141     if (s) {
142         const char * const t = strchr(s, '.');
143         okay = FALSE;
144         if (t) {
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);
149                 locs[len] = 0;
150                 okay = TRUE;
151             }
152         }
153     }
154
155     if (!okay)
156         Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
157
158     return locs;
159 }
160
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
163  * order. */
164
165 const int categories[] = {
166
167 #    ifdef USE_LOCALE_NUMERIC
168                              LC_NUMERIC,
169 #    endif
170 #    ifdef USE_LOCALE_CTYPE
171                              LC_CTYPE,
172 #    endif
173 #    ifdef USE_LOCALE_COLLATE
174                              LC_COLLATE,
175 #    endif
176 #    ifdef USE_LOCALE_TIME
177                              LC_TIME,
178 #    endif
179 #    ifdef USE_LOCALE_MESSAGES
180                              LC_MESSAGES,
181 #    endif
182 #    ifdef USE_LOCALE_MONETARY
183                              LC_MONETARY,
184 #    endif
185 #    ifdef USE_LOCALE_ADDRESS
186                              LC_ADDRESS,
187 #    endif
188 #    ifdef USE_LOCALE_IDENTIFICATION
189                              LC_IDENTIFICATION,
190 #    endif
191 #    ifdef USE_LOCALE_MEASUREMENT
192                              LC_MEASUREMENT,
193 #    endif
194 #    ifdef USE_LOCALE_PAPER
195                              LC_PAPER,
196 #    endif
197 #    ifdef USE_LOCALE_TELEPHONE
198                              LC_TELEPHONE,
199 #    endif
200 #    ifdef LC_ALL
201                              LC_ALL,
202 #    endif
203                             -1  /* Placeholder because C doesn't allow a
204                                    trailing comma, and it would get complicated
205                                    with all the #ifdef's */
206 };
207
208 /* The top-most real element is LC_ALL */
209
210 const char * category_names[] = {
211
212 #    ifdef USE_LOCALE_NUMERIC
213                                  "LC_NUMERIC",
214 #    endif
215 #    ifdef USE_LOCALE_CTYPE
216                                  "LC_CTYPE",
217 #    endif
218 #    ifdef USE_LOCALE_COLLATE
219                                  "LC_COLLATE",
220 #    endif
221 #    ifdef USE_LOCALE_TIME
222                                  "LC_TIME",
223 #    endif
224 #    ifdef USE_LOCALE_MESSAGES
225                                  "LC_MESSAGES",
226 #    endif
227 #    ifdef USE_LOCALE_MONETARY
228                                  "LC_MONETARY",
229 #    endif
230 #    ifdef USE_LOCALE_ADDRESS
231                                  "LC_ADDRESS",
232 #    endif
233 #    ifdef USE_LOCALE_IDENTIFICATION
234                                  "LC_IDENTIFICATION",
235 #    endif
236 #    ifdef USE_LOCALE_MEASUREMENT
237                                  "LC_MEASUREMENT",
238 #    endif
239 #    ifdef USE_LOCALE_PAPER
240                                  "LC_PAPER",
241 #    endif
242 #    ifdef USE_LOCALE_TELEPHONE
243                                  "LC_TELEPHONE",
244 #    endif
245 #    ifdef LC_ALL
246                                  "LC_ALL",
247 #    endif
248                                  NULL  /* Placeholder */
249                             };
250
251 #  ifdef LC_ALL
252
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)
256
257 #  else
258
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)
262
263 #  endif
264
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. */
272
273 STATIC const char *
274 S_category_name(const int category)
275 {
276     unsigned int i;
277
278 #ifdef LC_ALL
279
280     if (category == LC_ALL) {
281         return "LC_ALL";
282     }
283
284 #endif
285
286     for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
287         if (category == categories[i]) {
288             return category_names[i];
289         }
290     }
291
292     {
293         const char suffix[] = " (unknown)";
294         int temp = category;
295         Size_t length = sizeof(suffix) + 1;
296         char * unknown;
297         dTHX;
298
299         if (temp < 0) {
300             length++;
301             temp = - temp;
302         }
303
304         /* Calculate the number of digits */
305         while (temp >= 10) {
306             temp /= 10;
307             length++;
308         }
309
310         Newx(unknown, length, char);
311         my_snprintf(unknown, length, "%d%s", category, suffix);
312         SAVEFREEPV(unknown);
313         return unknown;
314     }
315 }
316
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
321 #  else
322 #    define _DUMMY_NUMERIC              -1
323 #  endif
324 #  ifdef USE_LOCALE_CTYPE
325 #    define LC_CTYPE_INDEX              _DUMMY_NUMERIC + 1
326 #    define _DUMMY_CTYPE                LC_CTYPE_INDEX
327 #  else
328 #    define _DUMMY_CTYPE                _DUMMY_NUMERIC
329 #  endif
330 #  ifdef USE_LOCALE_COLLATE
331 #    define LC_COLLATE_INDEX            _DUMMY_CTYPE + 1
332 #    define _DUMMY_COLLATE              LC_COLLATE_INDEX
333 #  else
334 #    define _DUMMY_COLLATE              _DUMMY_COLLATE
335 #  endif
336 #  ifdef USE_LOCALE_TIME
337 #    define LC_TIME_INDEX               _DUMMY_COLLATE + 1
338 #    define _DUMMY_TIME                 LC_TIME_INDEX
339 #  else
340 #    define _DUMMY_TIME                 _DUMMY_COLLATE
341 #  endif
342 #  ifdef USE_LOCALE_MESSAGES
343 #    define LC_MESSAGES_INDEX           _DUMMY_TIME + 1
344 #    define _DUMMY_MESSAGES             LC_MESSAGES_INDEX
345 #  else
346 #    define _DUMMY_MESSAGES             _DUMMY_TIME
347 #  endif
348 #  ifdef USE_LOCALE_MONETARY
349 #    define LC_MONETARY_INDEX           _DUMMY_MESSAGES + 1
350 #    define _DUMMY_MONETARY             LC_MONETARY_INDEX
351 #  else
352 #    define _DUMMY_MONETARY             _DUMMY_MESSAGES
353 #  endif
354 #  ifdef USE_LOCALE_ADDRESS
355 #    define LC_ADDRESS_INDEX            _DUMMY_MONETARY + 1
356 #    define _DUMMY_ADDRESS              LC_ADDRESS_INDEX
357 #  else
358 #    define _DUMMY_ADDRESS              _DUMMY_MONETARY
359 #  endif
360 #  ifdef USE_LOCALE_IDENTIFICATION
361 #    define LC_IDENTIFICATION_INDEX     _DUMMY_ADDRESS + 1
362 #    define _DUMMY_IDENTIFICATION       LC_IDENTIFICATION_INDEX
363 #  else
364 #    define _DUMMY_IDENTIFICATION       _DUMMY_ADDRESS
365 #  endif
366 #  ifdef USE_LOCALE_MEASUREMENT
367 #    define LC_MEASUREMENT_INDEX        _DUMMY_IDENTIFICATION + 1
368 #    define _DUMMY_MEASUREMENT          LC_MEASUREMENT_INDEX
369 #  else
370 #    define _DUMMY_MEASUREMENT          _DUMMY_IDENTIFICATION
371 #  endif
372 #  ifdef USE_LOCALE_PAPER
373 #    define LC_PAPER_INDEX              _DUMMY_MEASUREMENT + 1
374 #    define _DUMMY_PAPER                LC_PAPER_INDEX
375 #  else
376 #    define _DUMMY_PAPER                _DUMMY_MEASUREMENT
377 #  endif
378 #  ifdef USE_LOCALE_TELEPHONE
379 #    define LC_TELEPHONE_INDEX          _DUMMY_PAPER + 1
380 #    define _DUMMY_TELEPHONE            LC_TELEPHONE_INDEX
381 #  else
382 #    define _DUMMY_TELEPHONE            _DUMMY_PAPER
383 #  endif
384 #  ifdef LC_ALL
385 #    define LC_ALL_INDEX                _DUMMY_TELEPHONE + 1
386 #  endif
387 #endif /* ifdef USE_LOCALE */
388
389 /* Windows requres a customized base-level setlocale() */
390 #ifdef WIN32
391 #  define my_setlocale(cat, locale) win32_setlocale(cat, locale)
392 #else
393 #  define my_setlocale(cat, locale) setlocale(cat, locale)
394 #endif
395
396 #ifndef USE_POSIX_2008_LOCALE
397
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)
402
403 #else   /* Below uses POSIX 2008 */
404
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)
414
415 /* A third array, parallel to the ones above to map from category to its
416  * equivalent mask */
417 const int category_masks[] = {
418 #  ifdef USE_LOCALE_NUMERIC
419                                 LC_NUMERIC_MASK,
420 #  endif
421 #  ifdef USE_LOCALE_CTYPE
422                                 LC_CTYPE_MASK,
423 #  endif
424 #  ifdef USE_LOCALE_COLLATE
425                                 LC_COLLATE_MASK,
426 #  endif
427 #  ifdef USE_LOCALE_TIME
428                                 LC_TIME_MASK,
429 #  endif
430 #  ifdef USE_LOCALE_MESSAGES
431                                 LC_MESSAGES_MASK,
432 #  endif
433 #  ifdef USE_LOCALE_MONETARY
434                                 LC_MONETARY_MASK,
435 #  endif
436 #  ifdef USE_LOCALE_ADDRESS
437                                 LC_ADDRESS_MASK,
438 #  endif
439 #  ifdef USE_LOCALE_IDENTIFICATION
440                                 LC_IDENTIFICATION_MASK,
441 #  endif
442 #  ifdef USE_LOCALE_MEASUREMENT
443                                 LC_MEASUREMENT_MASK,
444 #  endif
445 #  ifdef USE_LOCALE_PAPER
446                                 LC_PAPER_MASK,
447 #  endif
448 #  ifdef USE_LOCALE_TELEPHONE
449                                 LC_TELEPHONE_MASK,
450 #  endif
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
455                                  * time */
456                                 LC_ALL_MASK
457                             };
458
459 STATIC const char *
460 S_emulate_setlocale(const int category,
461                     const char * locale,
462                     unsigned int index,
463                     const bool is_index_valid
464                    )
465 {
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.
473      *
474      * By doing this, most locale-sensitive functions become thread-safe.  The
475      * exceptions are mostly those that return a pointer to static memory.
476      *
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.
486      *
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 "".
501      */
502
503     int mask;
504     locale_t old_obj;
505     locale_t new_obj;
506     dTHX;
507
508 #  ifdef DEBUGGING
509
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);
512     }
513
514 #  endif
515
516     /* If the input mask might be incorrect, calculate the correct one */
517     if (! is_index_valid) {
518         unsigned int i;
519
520 #  ifdef DEBUGGING
521
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));
524         }
525
526 #  endif
527
528         for (i = 0; i <= LC_ALL_INDEX; i++) {
529             if (category == categories[i]) {
530                 index = i;
531                 goto found_index;
532             }
533         }
534
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",
539                                                      category, locale);
540         return NULL;
541
542       found_index: ;
543
544 #  ifdef DEBUGGING
545
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));
548         }
549
550 #  endif
551
552     }
553
554     mask = category_masks[index];
555
556 #  ifdef DEBUGGING
557
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);
560     }
561
562 #  endif
563
564     /* If just querying what the existing locale is ... */
565     if (locale == NULL) {
566         locale_t cur_obj = uselocale((locale_t) 0);
567
568 #  ifdef DEBUGGING
569
570         if (DEBUG_Lv_TEST || debug_initialization) {
571             PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale querying %p\n", __FILE__, __LINE__, cur_obj);
572         }
573
574 #  endif
575
576         if (cur_obj == LC_GLOBAL_LOCALE) {
577             return my_setlocale(category, NULL);
578         }
579
580 #  ifdef HAS_QUERYLOCALE
581
582         return (char *) querylocale(mask, cur_obj);
583
584 #  else
585
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);
588
589 #    if defined(_NL_LOCALE_NAME) && defined(DEBUGGING)
590
591         {
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. */
595
596             char * temp_name = nl_langinfo_l(_NL_LOCALE_NAME(category),
597                                              uselocale((locale_t) 0));
598             /*
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]);
602             */
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]))) {
607
608 #      ifdef USE_C_BACKTRACE
609
610                     dump_c_backtrace(Perl_debug_log, 20, 1);
611
612 #      endif
613
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);
618                 }
619
620                 return temp_name;
621             }
622         }
623
624 #    endif
625
626         /* Without querylocale(), we have to use our record-keeping we've
627          *  done. */
628
629         if (category != LC_ALL) {
630
631 #    ifdef DEBUGGING
632
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]);
635             }
636
637 #    endif
638
639             return PL_curlocales[index];
640         }
641         else {  /* For LC_ALL */
642             unsigned int i;
643             Size_t names_len = 0;
644             char * all_string;
645             bool are_all_categories_the_same_locale = TRUE;
646
647             /* If we have a valid LC_ALL value, just return it */
648             if (PL_curlocales[LC_ALL_INDEX]) {
649
650 #    ifdef DEBUGGING
651
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]);
654                 }
655
656 #    endif
657
658                 return PL_curlocales[LC_ALL_INDEX];
659             }
660
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++) {
667
668 #    ifdef DEBUGGING
669
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]);
672                 }
673
674 #    endif
675
676                 names_len += strlen(category_names[i])
677                           + 1                       /* '=' */
678                           + strlen(PL_curlocales[i])
679                           + 1;                      /* ';' */
680
681                 if (i > 0 && strNE(PL_curlocales[i], PL_curlocales[i-1])) {
682                     are_all_categories_the_same_locale = FALSE;
683                 }
684             }
685
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];
692             }
693
694             names_len++;    /* Trailing '\0' */
695             SAVEFREEPV(Newx(all_string, names_len, char));
696             *all_string = '\0';
697
698             /* Then fill in the string */
699             for (i = 0; i < LC_ALL_INDEX; i++) {
700
701 #    ifdef DEBUGGING
702
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]);
705                 }
706
707 #    endif
708
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);
713             }
714
715 #    ifdef DEBUGGING
716
717             if (DEBUG_L_TEST || debug_initialization) {
718                 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, all_string);
719             }
720
721     #endif
722
723             return all_string;
724         }
725
726 #    ifdef EINVAL
727
728         SETERRNO(EINVAL, LIB_INVARG);
729
730 #    endif
731
732         return NULL;
733
734 #  endif
735
736     }
737
738     assert(PL_C_locale_obj);
739
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);
746
747 #  ifdef DEBUGGING
748
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);
751     }
752
753 #  endif
754
755     if (! old_obj) {
756
757 #  ifdef DEBUGGING
758
759         if (DEBUG_L_TEST || debug_initialization) {
760             dSAVE_ERRNO;
761             PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale switching to C failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
762             RESTORE_ERRNO;
763         }
764
765 #  endif
766
767         return NULL;
768     }
769
770 #  ifdef DEBUGGING
771
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);
774     }
775
776 #  endif
777
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;
785     }
786
787     /* Create the new locale (it may actually modify the current one). */
788
789 #  ifndef HAS_QUERYLOCALE
790
791     if (strEQ(locale, "")) {
792
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 */
799
800         const char * const lc_all = PerlEnv_getenv("LC_ALL");
801
802         /* Use any "LC_ALL" environment variable, as it overrides everything
803          * else. */
804         if (lc_all && strNE(lc_all, "")) {
805             locale = lc_all;
806         }
807         else {
808
809             /* Otherwise, we need to dig deeper.  Unless overridden, the
810              * default is the LANG environment variable; if it doesn't exist,
811              * then "C" */
812
813             const char * default_name;
814
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");
822             }
823             else {
824                 default_name = savepv(PerlEnv_getenv("LANG"));
825             }
826
827             if (! default_name || strEQ(default_name, "")) {
828                     default_name = "C";
829             }
830             else if (PL_scopestack_ix != 0) {
831                 SAVEFREEPV(default_name);
832             }
833
834             if (category != LC_ALL) {
835                 const char * const name = PerlEnv_getenv(category_names[index]);
836
837                 /* Here we are setting a single category.  Assume will have the
838                  * default name */
839                 locale = default_name;
840
841                 /* But then look for an overriding environment variable */
842                 if (name && strNE(name, "")) {
843                     locale = name;
844                 }
845             }
846             else {
847                 bool did_override = FALSE;
848                 unsigned int i;
849
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
863                  * complete set */
864
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, ""))
870                                                ? env_override
871                                                : default_name;
872                     if (! emulate_setlocale(categories[i], this_locale, i, TRUE))
873                     {
874                         Safefree(env_override);
875                         return NULL;
876                     }
877
878                     if (strNE(this_locale, default_name)) {
879                         did_override = TRUE;
880                     }
881
882                     Safefree(env_override);
883                 }
884
885                 /* If all the categories are the same, we can set LC_ALL to
886                  * that */
887                 if (! did_override) {
888                     locale = default_name;
889                 }
890                 else {
891
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);
901                 }
902             }
903         }
904     }
905     else if (strchr(locale, ';')) {
906
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
911          * ourselves */
912
913         const char * s = locale;
914         const char * e = locale + strlen(locale);
915         const char * p = s;
916         const char * category_end;
917         const char * name_start;
918         const char * name_end;
919
920         while (s < e) {
921             unsigned int i;
922
923             /* Parse through the category */
924             while (isWORDCHAR(*p)) {
925                 p++;
926             }
927             category_end = p;
928
929             if (*p++ != '=') {
930                 Perl_croak(aTHX_
931                     "panic: %s: %d: Unexpected character in locale name '%02X",
932                     __FILE__, __LINE__, *(p-1));
933             }
934
935             /* Parse through the locale name */
936             name_start = p;
937             while (p < e && *p != ';') {
938                 if (! isGRAPH(*p)) {
939                     Perl_croak(aTHX_
940                         "panic: %s: %d: Unexpected character in locale name '%02X",
941                         __FILE__, __LINE__, *(p-1));
942                 }
943                 p++;
944             }
945             name_end = p;
946
947             /* Space past the semi-colon */
948             if (p < e) {
949                 p++;
950             }
951
952             /* Find the index of the category name in our lists */
953             for (i = 0; i < LC_ALL_INDEX; i++) {
954                 char * individ_locale;
955
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
959                  * "LC_TIME_DATE" */
960                 if strnNE(s, category_names[i], category_end - s) {
961                     continue;
962                 }
963
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),
969                                              name_start);
970                     goto ready_to_set;
971                 }
972
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))
977                 {
978                     return NULL;
979                 }
980             }
981
982             s = p;
983         }
984
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);
989
990         return do_setlocale_c(LC_ALL, NULL);
991     }
992
993   ready_to_set: ;
994
995 #  endif  /* end of ! querylocale */
996
997     /* Ready to create a new locale by modification of the exising one */
998     new_obj = newlocale(mask, locale, old_obj);
999
1000     if (! new_obj) {
1001         dSAVE_ERRNO;
1002
1003 #  ifdef DEBUGGING
1004
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);
1007         }
1008
1009 #  endif
1010
1011         if (! uselocale(old_obj)) {
1012
1013 #  ifdef DEBUGGING
1014
1015             if (DEBUG_L_TEST || debug_initialization) {
1016                 PerlIO_printf(Perl_debug_log, "%s:%d: switching back failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1017             }
1018
1019 #  endif
1020
1021         }
1022         RESTORE_ERRNO;
1023         return NULL;
1024     }
1025
1026 #  ifdef DEBUGGING
1027
1028     if (DEBUG_Lv_TEST || debug_initialization) {
1029         PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale created %p\n", __FILE__, __LINE__, new_obj);
1030     }
1031
1032 #  endif
1033
1034     /* And switch into it */
1035     if (! uselocale(new_obj)) {
1036         dSAVE_ERRNO;
1037
1038 #  ifdef DEBUGGING
1039
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__);
1042         }
1043
1044 #  endif
1045
1046         if (! uselocale(old_obj)) {
1047
1048 #  ifdef DEBUGGING
1049
1050             if (DEBUG_L_TEST || debug_initialization) {
1051                 PerlIO_printf(Perl_debug_log, "%s:%d: switching back failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1052             }
1053
1054 #  endif
1055
1056         }
1057         freelocale(new_obj);
1058         RESTORE_ERRNO;
1059         return NULL;
1060     }
1061
1062 #  ifdef DEBUGGING
1063
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);
1066     }
1067
1068 #  endif
1069
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 */
1074
1075 #  ifdef HAS_QUERYLOCALE
1076
1077     if (strEQ(locale, "")) {
1078         locale = querylocale(mask, new_obj);
1079     }
1080
1081 #  else
1082
1083     /* Here, 'locale' is the return value */
1084
1085     /* Without querylocale(), we have to update our records */
1086
1087     if (category == LC_ALL) {
1088         unsigned int i;
1089
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);
1096         }
1097     }
1098     else {
1099
1100         /* For a single category, if it's not the same as the one in LC_ALL, we
1101          * nullify LC_ALL */
1102
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;
1106         }
1107
1108         /* Then update the category's record */
1109         Safefree(PL_curlocales[index]);
1110         PL_curlocales[index] = savepv(locale);
1111     }
1112
1113 #  endif
1114
1115     return locale;
1116 }
1117
1118 #endif /* USE_POSIX_2008_LOCALE */
1119
1120 #if 0   /* Code that was to emulate thread-safe locales on platforms that
1121            didn't natively support them */
1122
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:
1126  *
1127  *      LOCALE_LOCK;
1128  *      setlocale to the correct locale for this operation
1129  *      do operation
1130  *      LOCALE_UNLOCK
1131  *
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.
1135  *
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
1139  *
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.
1142  *
1143  * This code was abandoned before being completed or tested, and is left as-is
1144 */
1145
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)
1148
1149 STATIC char *
1150 S_locking_setlocale(pTHX_
1151                     const int category,
1152                     const char * locale,
1153                     int index,
1154                     const bool is_index_valid
1155                    )
1156 {
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
1165      * doing.
1166      *
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.
1171      *
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.
1179      *
1180      */
1181
1182     /* If the input index might be incorrect, calculate the correct one */
1183     if (! is_index_valid) {
1184         unsigned int i;
1185
1186         if (DEBUG_Lv_TEST || debug_initialization) {
1187             PerlIO_printf(Perl_debug_log, "%s:%d: converting category %d to index\n", __FILE__, __LINE__, category);
1188         }
1189
1190         for (i = 0; i <= LC_ALL_INDEX; i++) {
1191             if (category == categories[i]) {
1192                 index = i;
1193                 goto found_index;
1194             }
1195         }
1196
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
1199          * XXX warning */
1200
1201         return my_setlocale(category, locale);
1202
1203       found_index: ;
1204
1205         if (DEBUG_Lv_TEST || debug_initialization) {
1206             PerlIO_printf(Perl_debug_log, "%s:%d: index is 0x%x\n", __FILE__, __LINE__, index);
1207         }
1208     }
1209
1210     /* For a query, just return what's in our records */
1211     if (new_locale == NULL) {
1212         return curlocales[index];
1213     }
1214
1215
1216     /* Otherwise, we need to do the switch, and save the result, all in a
1217      * critical section */
1218
1219     Safefree(curlocales[[index]]);
1220
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 */
1223     LOCALE_LOCK;
1224
1225     curlocales[index] = savepv(my_setlocale(category, new_locale));
1226
1227     if (strEQ(new_locale, "")) {
1228
1229 #ifdef LC_ALL
1230
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 */
1234
1235         if (category == LC_ALL) {
1236             unsigned int i;
1237             for (i = 0; i < LC_ALL_INDEX) {
1238                 curlocales[i] = my_setlocale(categories[i], NULL);
1239             }
1240         }
1241     }
1242
1243 #endif
1244
1245     LOCALE_UNLOCK;
1246
1247     return curlocales[index];
1248 }
1249
1250 #endif
1251
1252 STATIC void
1253 S_set_numeric_radix(pTHX_ const bool use_locale)
1254 {
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 */
1257
1258 #if defined(USE_LOCALE_NUMERIC) && (   defined(HAS_LOCALECONV)              \
1259                                     || defined(HAS_NL_LANGINFO))
1260
1261     const char * radix = (use_locale)
1262                          ? my_nl_langinfo(RADIXCHAR, FALSE)
1263                                         /* FALSE => already in dest locale */
1264                          : ".";
1265
1266         sv_setpv(PL_numeric_radix_sv, radix);
1267
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))
1273     {
1274         SvUTF8_on(PL_numeric_radix_sv);
1275     }
1276
1277 #  ifdef DEBUGGING
1278
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)));
1283     }
1284
1285 #  endif
1286 #endif /* USE_LOCALE_NUMERIC and can find the radix char */
1287
1288 }
1289
1290 STATIC void
1291 S_new_numeric(pTHX_ const char *newnum)
1292 {
1293
1294 #ifndef USE_LOCALE_NUMERIC
1295
1296     PERL_UNUSED_ARG(newnum);
1297
1298 #else
1299
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.
1303      *
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.
1308      *
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
1311      * dot.
1312      *
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
1317      *                  locale
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
1322      *                  from C.
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.
1330      */
1331
1332     char *save_newnum;
1333
1334     if (! newnum) {
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;
1340         return;
1341     }
1342
1343     save_newnum = stdize_locale(savepv(newnum));
1344     PL_numeric_underlying = TRUE;
1345     PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
1346
1347     /* If its name isn't C nor POSIX, it could still be indistinguishable from
1348      * them */
1349     if (! PL_numeric_standard) {
1350         PL_numeric_standard = cBOOL(strEQ(".", my_nl_langinfo(RADIXCHAR,
1351                                             FALSE /* Don't toggle locale */  ))
1352                                  && strEQ("",  my_nl_langinfo(THOUSEP, FALSE)));
1353     }
1354
1355     /* Save the new name if it isn't the same as the previous one, if any */
1356     if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
1357         Safefree(PL_numeric_name);
1358         PL_numeric_name = save_newnum;
1359     }
1360     else {
1361         Safefree(save_newnum);
1362     }
1363
1364     PL_numeric_underlying_is_standard = PL_numeric_standard;
1365
1366 #  ifdef HAS_POSIX_2008_LOCALE
1367
1368     PL_underlying_numeric_obj = newlocale(LC_NUMERIC_MASK,
1369                                           PL_numeric_name,
1370                                           PL_underlying_numeric_obj);
1371
1372 #endif
1373
1374     if (DEBUG_L_TEST || debug_initialization) {
1375         PerlIO_printf(Perl_debug_log, "Called new_numeric with %s, PL_numeric_name=%s\n", newnum, PL_numeric_name);
1376     }
1377
1378     /* Keep LC_NUMERIC in the C locale.  This is for XS modules, so they don't
1379      * have to worry about the radix being a non-dot.  (Core operations that
1380      * need the underlying locale change to it temporarily). */
1381     if (PL_numeric_standard) {
1382         set_numeric_radix(0);
1383     }
1384     else {
1385         set_numeric_standard();
1386     }
1387
1388 #endif /* USE_LOCALE_NUMERIC */
1389
1390 }
1391
1392 void
1393 Perl_set_numeric_standard(pTHX)
1394 {
1395
1396 #ifdef USE_LOCALE_NUMERIC
1397
1398     /* Toggle the LC_NUMERIC locale to C.  Most code should use the macros like
1399      * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly.  The
1400      * macro avoids calling this routine if toggling isn't necessary according
1401      * to our records (which could be wrong if some XS code has changed the
1402      * locale behind our back) */
1403
1404     do_setlocale_c(LC_NUMERIC, "C");
1405     PL_numeric_standard = TRUE;
1406     PL_numeric_underlying = PL_numeric_underlying_is_standard;
1407     set_numeric_radix(0);
1408
1409 #  ifdef DEBUGGING
1410
1411     if (DEBUG_L_TEST || debug_initialization) {
1412         PerlIO_printf(Perl_debug_log,
1413                           "LC_NUMERIC locale now is standard C\n");
1414     }
1415
1416 #  endif
1417 #endif /* USE_LOCALE_NUMERIC */
1418
1419 }
1420
1421 void
1422 Perl_set_numeric_underlying(pTHX)
1423 {
1424
1425 #ifdef USE_LOCALE_NUMERIC
1426
1427     /* Toggle the LC_NUMERIC locale to the current underlying default.  Most
1428      * code should use the macros like SET_NUMERIC_UNDERLYING() in perl.h
1429      * instead of calling this directly.  The macro avoids calling this routine
1430      * if toggling isn't necessary according to our records (which could be
1431      * wrong if some XS code has changed the locale behind our back) */
1432
1433     do_setlocale_c(LC_NUMERIC, PL_numeric_name);
1434     PL_numeric_standard = PL_numeric_underlying_is_standard;
1435     PL_numeric_underlying = TRUE;
1436     set_numeric_radix(! PL_numeric_standard);
1437
1438 #  ifdef DEBUGGING
1439
1440     if (DEBUG_L_TEST || debug_initialization) {
1441         PerlIO_printf(Perl_debug_log,
1442                           "LC_NUMERIC locale now is %s\n",
1443                           PL_numeric_name);
1444     }
1445
1446 #  endif
1447 #endif /* USE_LOCALE_NUMERIC */
1448
1449 }
1450
1451 /*
1452  * Set up for a new ctype locale.
1453  */
1454 STATIC void
1455 S_new_ctype(pTHX_ const char *newctype)
1456 {
1457
1458 #ifndef USE_LOCALE_CTYPE
1459
1460     PERL_ARGS_ASSERT_NEW_CTYPE;
1461     PERL_UNUSED_ARG(newctype);
1462     PERL_UNUSED_CONTEXT;
1463
1464 #else
1465
1466     /* Called after each libc setlocale() call affecting LC_CTYPE, to tell
1467      * core Perl this and that 'newctype' is the name of the new locale.
1468      *
1469      * This function sets up the folding arrays for all 256 bytes, assuming
1470      * that tofold() is tolc() since fold case is not a concept in POSIX,
1471      *
1472      * Any code changing the locale (outside this file) should use
1473      * Perl_setlocale or POSIX::setlocale, which call this function.  Therefore
1474      * this function should be called directly only from this file and from
1475      * POSIX::setlocale() */
1476
1477     dVAR;
1478     unsigned int i;
1479
1480     /* Don't check for problems if we are suppressing the warnings */
1481     bool check_for_problems = ckWARN_d(WARN_LOCALE) || UNLIKELY(DEBUG_L_TEST);
1482
1483     PERL_ARGS_ASSERT_NEW_CTYPE;
1484
1485     /* We will replace any bad locale warning with 1) nothing if the new one is
1486      * ok; or 2) a new warning for the bad new locale */
1487     if (PL_warn_locale) {
1488         SvREFCNT_dec_NN(PL_warn_locale);
1489         PL_warn_locale = NULL;
1490     }
1491
1492     PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE);
1493
1494     /* A UTF-8 locale gets standard rules.  But note that code still has to
1495      * handle this specially because of the three problematic code points */
1496     if (PL_in_utf8_CTYPE_locale) {
1497         Copy(PL_fold_latin1, PL_fold_locale, 256, U8);
1498     }
1499
1500     /* We don't populate the other lists if a UTF-8 locale, but do check that
1501      * everything works as expected, unless checking turned off */
1502     if (check_for_problems || ! PL_in_utf8_CTYPE_locale) {
1503         /* Assume enough space for every character being bad.  4 spaces each
1504          * for the 94 printable characters that are output like "'x' "; and 5
1505          * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating
1506          * NUL */
1507         char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ] = { '\0' };
1508         bool multi_byte_locale = FALSE;     /* Assume is a single-byte locale
1509                                                to start */
1510         unsigned int bad_count = 0;         /* Count of bad characters */
1511
1512         for (i = 0; i < 256; i++) {
1513             if (! PL_in_utf8_CTYPE_locale) {
1514                 if (isupper(i))
1515                     PL_fold_locale[i] = (U8) tolower(i);
1516                 else if (islower(i))
1517                     PL_fold_locale[i] = (U8) toupper(i);
1518                 else
1519                     PL_fold_locale[i] = (U8) i;
1520             }
1521
1522             /* If checking for locale problems, see if the native ASCII-range
1523              * printables plus \n and \t are in their expected categories in
1524              * the new locale.  If not, this could mean big trouble, upending
1525              * Perl's and most programs' assumptions, like having a
1526              * metacharacter with special meaning become a \w.  Fortunately,
1527              * it's very rare to find locales that aren't supersets of ASCII
1528              * nowadays.  It isn't a problem for most controls to be changed
1529              * into something else; we check only \n and \t, though perhaps \r
1530              * could be an issue as well. */
1531             if (    check_for_problems
1532                 && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n'))
1533             {
1534                 bool is_bad = FALSE;
1535                 char name[3] = { '\0' };
1536
1537                 /* Convert the name into a string */
1538                 if (isPRINT_A(i)) {
1539                     name[0] = i;
1540                     name[1] = '\0';
1541                 }
1542                 else if (i == '\n') {
1543                     my_strlcpy(name, "\n", sizeof(name));
1544                 }
1545                 else {
1546                     my_strlcpy(name, "\t", sizeof(name));
1547                 }
1548
1549                 /* Check each possibe class */
1550                 if (UNLIKELY(cBOOL(isalnum(i)) != cBOOL(isALPHANUMERIC_A(i))))  {
1551                     is_bad = TRUE;
1552                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1553                                           "isalnum('%s') unexpectedly is %d\n",
1554                                           name, cBOOL(isalnum(i))));
1555                 }
1556                 if (UNLIKELY(cBOOL(isalpha(i)) != cBOOL(isALPHA_A(i))))  {
1557                     is_bad = TRUE;
1558                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1559                                           "isalpha('%s') unexpectedly is %d\n",
1560                                           name, cBOOL(isalpha(i))));
1561                 }
1562                 if (UNLIKELY(cBOOL(isdigit(i)) != cBOOL(isDIGIT_A(i))))  {
1563                     is_bad = TRUE;
1564                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1565                                           "isdigit('%s') unexpectedly is %d\n",
1566                                           name, cBOOL(isdigit(i))));
1567                 }
1568                 if (UNLIKELY(cBOOL(isgraph(i)) != cBOOL(isGRAPH_A(i))))  {
1569                     is_bad = TRUE;
1570                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1571                                           "isgraph('%s') unexpectedly is %d\n",
1572                                           name, cBOOL(isgraph(i))));
1573                 }
1574                 if (UNLIKELY(cBOOL(islower(i)) != cBOOL(isLOWER_A(i))))  {
1575                     is_bad = TRUE;
1576                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1577                                           "islower('%s') unexpectedly is %d\n",
1578                                           name, cBOOL(islower(i))));
1579                 }
1580                 if (UNLIKELY(cBOOL(isprint(i)) != cBOOL(isPRINT_A(i))))  {
1581                     is_bad = TRUE;
1582                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1583                                           "isprint('%s') unexpectedly is %d\n",
1584                                           name, cBOOL(isprint(i))));
1585                 }
1586                 if (UNLIKELY(cBOOL(ispunct(i)) != cBOOL(isPUNCT_A(i))))  {
1587                     is_bad = TRUE;
1588                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1589                                           "ispunct('%s') unexpectedly is %d\n",
1590                                           name, cBOOL(ispunct(i))));
1591                 }
1592                 if (UNLIKELY(cBOOL(isspace(i)) != cBOOL(isSPACE_A(i))))  {
1593                     is_bad = TRUE;
1594                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1595                                           "isspace('%s') unexpectedly is %d\n",
1596                                           name, cBOOL(isspace(i))));
1597                 }
1598                 if (UNLIKELY(cBOOL(isupper(i)) != cBOOL(isUPPER_A(i))))  {
1599                     is_bad = TRUE;
1600                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1601                                           "isupper('%s') unexpectedly is %d\n",
1602                                           name, cBOOL(isupper(i))));
1603                 }
1604                 if (UNLIKELY(cBOOL(isxdigit(i))!= cBOOL(isXDIGIT_A(i))))  {
1605                     is_bad = TRUE;
1606                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1607                                           "isxdigit('%s') unexpectedly is %d\n",
1608                                           name, cBOOL(isxdigit(i))));
1609                 }
1610                 if (UNLIKELY(tolower(i) != (int) toLOWER_A(i)))  {
1611                     is_bad = TRUE;
1612                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1613                             "tolower('%s')=0x%x instead of the expected 0x%x\n",
1614                             name, tolower(i), (int) toLOWER_A(i)));
1615                 }
1616                 if (UNLIKELY(toupper(i) != (int) toUPPER_A(i)))  {
1617                     is_bad = TRUE;
1618                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1619                             "toupper('%s')=0x%x instead of the expected 0x%x\n",
1620                             name, toupper(i), (int) toUPPER_A(i)));
1621                 }
1622                 if (UNLIKELY((i == '\n' && ! isCNTRL_LC(i))))  {
1623                     is_bad = TRUE;
1624                     DEBUG_L(PerlIO_printf(Perl_debug_log,
1625                                 "'\\n' (=%02X) is not a control\n", (int) i));
1626                 }
1627
1628                 /* Add to the list;  Separate multiple entries with a blank */
1629                 if (is_bad) {
1630                     if (bad_count) {
1631                         my_strlcat(bad_chars_list, " ", sizeof(bad_chars_list));
1632                     }
1633                     my_strlcat(bad_chars_list, name, sizeof(bad_chars_list));
1634                     bad_count++;
1635                 }
1636             }
1637         }
1638
1639 #  ifdef MB_CUR_MAX
1640
1641         /* We only handle single-byte locales (outside of UTF-8 ones; so if
1642          * this locale requires more than one byte, there are going to be
1643          * problems. */
1644         DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1645                  "%s:%d: check_for_problems=%d, MB_CUR_MAX=%d\n",
1646                  __FILE__, __LINE__, check_for_problems, (int) MB_CUR_MAX));
1647
1648         if (   check_for_problems && MB_CUR_MAX > 1
1649             && ! PL_in_utf8_CTYPE_locale
1650
1651                /* Some platforms return MB_CUR_MAX > 1 for even the "C"
1652                 * locale.  Just assume that the implementation for them (plus
1653                 * for POSIX) is correct and the > 1 value is spurious.  (Since
1654                 * these are specially handled to never be considered UTF-8
1655                 * locales, as long as this is the only problem, everything
1656                 * should work fine */
1657             && strNE(newctype, "C") && strNE(newctype, "POSIX"))
1658         {
1659             multi_byte_locale = TRUE;
1660         }
1661
1662 #  endif
1663
1664         if (UNLIKELY(bad_count) || UNLIKELY(multi_byte_locale)) {
1665             if (UNLIKELY(bad_count) && PL_in_utf8_CTYPE_locale) {
1666                 PL_warn_locale = Perl_newSVpvf(aTHX_
1667                      "Locale '%s' contains (at least) the following characters"
1668                      " which have\nunexpected meanings: %s\nThe Perl program"
1669                      " will use the expected meanings",
1670                       newctype, bad_chars_list);
1671             }
1672             else {
1673                 PL_warn_locale = Perl_newSVpvf(aTHX_
1674                              "Locale '%s' may not work well.%s%s%s\n",
1675                              newctype,
1676                              (multi_byte_locale)
1677                               ? "  Some characters in it are not recognized by"
1678                                 " Perl."
1679                               : "",
1680                              (bad_count)
1681                               ? "\nThe following characters (and maybe others)"
1682                                 " may not have the same meaning as the Perl"
1683                                 " program expects:\n"
1684                               : "",
1685                              (bad_count)
1686                               ? bad_chars_list
1687                               : ""
1688                             );
1689             }
1690
1691 #  ifdef HAS_NL_LANGINFO
1692
1693             Perl_sv_catpvf(aTHX_ PL_warn_locale, "; codeset=%s",
1694                                     /* parameter FALSE is a don't care here */
1695                                     my_nl_langinfo(CODESET, FALSE));
1696
1697 #  endif
1698
1699             Perl_sv_catpvf(aTHX_ PL_warn_locale, "\n");
1700
1701             /* If we are actually in the scope of the locale or are debugging,
1702              * output the message now.  If not in that scope, we save the
1703              * message to be output at the first operation using this locale,
1704              * if that actually happens.  Most programs don't use locales, so
1705              * they are immune to bad ones.  */
1706             if (IN_LC(LC_CTYPE) || UNLIKELY(DEBUG_L_TEST)) {
1707
1708                 /* The '0' below suppresses a bogus gcc compiler warning */
1709                 Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0);
1710
1711                 if (IN_LC(LC_CTYPE)) {
1712                     SvREFCNT_dec_NN(PL_warn_locale);
1713                     PL_warn_locale = NULL;
1714                 }
1715             }
1716         }
1717     }
1718
1719 #endif /* USE_LOCALE_CTYPE */
1720
1721 }
1722
1723 void
1724 Perl__warn_problematic_locale()
1725 {
1726
1727 #ifdef USE_LOCALE_CTYPE
1728
1729     dTHX;
1730
1731     /* Internal-to-core function that outputs the message in PL_warn_locale,
1732      * and then NULLS it.  Should be called only through the macro
1733      * _CHECK_AND_WARN_PROBLEMATIC_LOCALE */
1734
1735     if (PL_warn_locale) {
1736         Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
1737                              SvPVX(PL_warn_locale),
1738                              0 /* dummy to avoid compiler warning */ );
1739         SvREFCNT_dec_NN(PL_warn_locale);
1740         PL_warn_locale = NULL;
1741     }
1742
1743 #endif
1744
1745 }
1746
1747 STATIC void
1748 S_new_collate(pTHX_ const char *newcoll)
1749 {
1750
1751 #ifndef USE_LOCALE_COLLATE
1752
1753     PERL_UNUSED_ARG(newcoll);
1754     PERL_UNUSED_CONTEXT;
1755
1756 #else
1757
1758     /* Called after each libc setlocale() call affecting LC_COLLATE, to tell
1759      * core Perl this and that 'newcoll' is the name of the new locale.
1760      *
1761      * The design of locale collation is that every locale change is given an
1762      * index 'PL_collation_ix'.  The first time a string particpates in an
1763      * operation that requires collation while locale collation is active, it
1764      * is given PERL_MAGIC_collxfrm magic (via sv_collxfrm_flags()).  That
1765      * magic includes the collation index, and the transformation of the string
1766      * by strxfrm(), q.v.  That transformation is used when doing comparisons,
1767      * instead of the string itself.  If a string changes, the magic is
1768      * cleared.  The next time the locale changes, the index is incremented,
1769      * and so we know during a comparison that the transformation is not
1770      * necessarily still valid, and so is recomputed.  Note that if the locale
1771      * changes enough times, the index could wrap (a U32), and it is possible
1772      * that a transformation would improperly be considered valid, leading to
1773      * an unlikely bug */
1774
1775     if (! newcoll) {
1776         if (PL_collation_name) {
1777             ++PL_collation_ix;
1778             Safefree(PL_collation_name);
1779             PL_collation_name = NULL;
1780         }
1781         PL_collation_standard = TRUE;
1782       is_standard_collation:
1783         PL_collxfrm_base = 0;
1784         PL_collxfrm_mult = 2;
1785         PL_in_utf8_COLLATE_locale = FALSE;
1786         PL_strxfrm_NUL_replacement = '\0';
1787         PL_strxfrm_max_cp = 0;
1788         return;
1789     }
1790
1791     /* If this is not the same locale as currently, set the new one up */
1792     if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
1793         ++PL_collation_ix;
1794         Safefree(PL_collation_name);
1795         PL_collation_name = stdize_locale(savepv(newcoll));
1796         PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
1797         if (PL_collation_standard) {
1798             goto is_standard_collation;
1799         }
1800
1801         PL_in_utf8_COLLATE_locale = _is_cur_LC_category_utf8(LC_COLLATE);
1802         PL_strxfrm_NUL_replacement = '\0';
1803         PL_strxfrm_max_cp = 0;
1804
1805         /* A locale collation definition includes primary, secondary, tertiary,
1806          * etc. weights for each character.  To sort, the primary weights are
1807          * used, and only if they compare equal, then the secondary weights are
1808          * used, and only if they compare equal, then the tertiary, etc.
1809          *
1810          * strxfrm() works by taking the input string, say ABC, and creating an
1811          * output transformed string consisting of first the primary weights,
1812          * A¹B¹C¹ followed by the secondary ones, A²B²C²; and then the
1813          * tertiary, etc, yielding A¹B¹C¹ A²B²C² A³B³C³ ....  Some characters
1814          * may not have weights at every level.  In our example, let's say B
1815          * doesn't have a tertiary weight, and A doesn't have a secondary
1816          * weight.  The constructed string is then going to be
1817          *  A¹B¹C¹ B²C² A³C³ ....
1818          * This has the desired effect that strcmp() will look at the secondary
1819          * or tertiary weights only if the strings compare equal at all higher
1820          * priority weights.  The spaces shown here, like in
1821          *  "A¹B¹C¹ A²B²C² "
1822          * are not just for readability.  In the general case, these must
1823          * actually be bytes, which we will call here 'separator weights'; and
1824          * they must be smaller than any other weight value, but since these
1825          * are C strings, only the terminating one can be a NUL (some
1826          * implementations may include a non-NUL separator weight just before
1827          * the NUL).  Implementations tend to reserve 01 for the separator
1828          * weights.  They are needed so that a shorter string's secondary
1829          * weights won't be misconstrued as primary weights of a longer string,
1830          * etc.  By making them smaller than any other weight, the shorter
1831          * string will sort first.  (Actually, if all secondary weights are
1832          * smaller than all primary ones, there is no need for a separator
1833          * weight between those two levels, etc.)
1834          *
1835          * The length of the transformed string is roughly a linear function of
1836          * the input string.  It's not exactly linear because some characters
1837          * don't have weights at all levels.  When we call strxfrm() we have to
1838          * allocate some memory to hold the transformed string.  The
1839          * calculations below try to find coefficients 'm' and 'b' for this
1840          * locale so that m*x + b equals how much space we need, given the size
1841          * of the input string in 'x'.  If we calculate too small, we increase
1842          * the size as needed, and call strxfrm() again, but it is better to
1843          * get it right the first time to avoid wasted expensive string
1844          * transformations. */
1845
1846         {
1847             /* We use the string below to find how long the tranformation of it
1848              * is.  Almost all locales are supersets of ASCII, or at least the
1849              * ASCII letters.  We use all of them, half upper half lower,
1850              * because if we used fewer, we might hit just the ones that are
1851              * outliers in a particular locale.  Most of the strings being
1852              * collated will contain a preponderance of letters, and even if
1853              * they are above-ASCII, they are likely to have the same number of
1854              * weight levels as the ASCII ones.  It turns out that digits tend
1855              * to have fewer levels, and some punctuation has more, but those
1856              * are relatively sparse in text, and khw believes this gives a
1857              * reasonable result, but it could be changed if experience so
1858              * dictates. */
1859             const char longer[] = "ABCDEFGHIJKLMnopqrstuvwxyz";
1860             char * x_longer;        /* Transformed 'longer' */
1861             Size_t x_len_longer;    /* Length of 'x_longer' */
1862
1863             char * x_shorter;   /* We also transform a substring of 'longer' */
1864             Size_t x_len_shorter;
1865
1866             /* _mem_collxfrm() is used get the transformation (though here we
1867              * are interested only in its length).  It is used because it has
1868              * the intelligence to handle all cases, but to work, it needs some
1869              * values of 'm' and 'b' to get it started.  For the purposes of
1870              * this calculation we use a very conservative estimate of 'm' and
1871              * 'b'.  This assumes a weight can be multiple bytes, enough to
1872              * hold any UV on the platform, and there are 5 levels, 4 weight
1873              * bytes, and a trailing NUL.  */
1874             PL_collxfrm_base = 5;
1875             PL_collxfrm_mult = 5 * sizeof(UV);
1876
1877             /* Find out how long the transformation really is */
1878             x_longer = _mem_collxfrm(longer,
1879                                      sizeof(longer) - 1,
1880                                      &x_len_longer,
1881
1882                                      /* We avoid converting to UTF-8 in the
1883                                       * called function by telling it the
1884                                       * string is in UTF-8 if the locale is a
1885                                       * UTF-8 one.  Since the string passed
1886                                       * here is invariant under UTF-8, we can
1887                                       * claim it's UTF-8 even though it isn't.
1888                                       * */
1889                                      PL_in_utf8_COLLATE_locale);
1890             Safefree(x_longer);
1891
1892             /* Find out how long the transformation of a substring of 'longer'
1893              * is.  Together the lengths of these transformations are
1894              * sufficient to calculate 'm' and 'b'.  The substring is all of
1895              * 'longer' except the first character.  This minimizes the chances
1896              * of being swayed by outliers */
1897             x_shorter = _mem_collxfrm(longer + 1,
1898                                       sizeof(longer) - 2,
1899                                       &x_len_shorter,
1900                                       PL_in_utf8_COLLATE_locale);
1901             Safefree(x_shorter);
1902
1903             /* If the results are nonsensical for this simple test, the whole
1904              * locale definition is suspect.  Mark it so that locale collation
1905              * is not active at all for it.  XXX Should we warn? */
1906             if (   x_len_shorter == 0
1907                 || x_len_longer == 0
1908                 || x_len_shorter >= x_len_longer)
1909             {
1910                 PL_collxfrm_mult = 0;
1911                 PL_collxfrm_base = 0;
1912             }
1913             else {
1914                 SSize_t base;       /* Temporary */
1915
1916                 /* We have both:    m * strlen(longer)  + b = x_len_longer
1917                  *                  m * strlen(shorter) + b = x_len_shorter;
1918                  * subtracting yields:
1919                  *          m * (strlen(longer) - strlen(shorter))
1920                  *                             = x_len_longer - x_len_shorter
1921                  * But we have set things up so that 'shorter' is 1 byte smaller
1922                  * than 'longer'.  Hence:
1923                  *          m = x_len_longer - x_len_shorter
1924                  *
1925                  * But if something went wrong, make sure the multiplier is at
1926                  * least 1.
1927                  */
1928                 if (x_len_longer > x_len_shorter) {
1929                     PL_collxfrm_mult = (STRLEN) x_len_longer - x_len_shorter;
1930                 }
1931                 else {
1932                     PL_collxfrm_mult = 1;
1933                 }
1934
1935                 /*     mx + b = len
1936                  * so:      b = len - mx
1937                  * but in case something has gone wrong, make sure it is
1938                  * non-negative */
1939                 base = x_len_longer - PL_collxfrm_mult * (sizeof(longer) - 1);
1940                 if (base < 0) {
1941                     base = 0;
1942                 }
1943
1944                 /* Add 1 for the trailing NUL */
1945                 PL_collxfrm_base = base + 1;
1946             }
1947
1948 #  ifdef DEBUGGING
1949
1950             if (DEBUG_L_TEST || debug_initialization) {
1951                 PerlIO_printf(Perl_debug_log,
1952                     "%s:%d: ?UTF-8 locale=%d; x_len_shorter=%zu, "
1953                     "x_len_longer=%zu,"
1954                     " collate multipler=%zu, collate base=%zu\n",
1955                     __FILE__, __LINE__,
1956                     PL_in_utf8_COLLATE_locale,
1957                     x_len_shorter, x_len_longer,
1958                     PL_collxfrm_mult, PL_collxfrm_base);
1959             }
1960 #  endif
1961
1962         }
1963     }
1964
1965 #endif /* USE_LOCALE_COLLATE */
1966
1967 }
1968
1969 #ifdef WIN32
1970
1971 STATIC char *
1972 S_win32_setlocale(pTHX_ int category, const char* locale)
1973 {
1974     /* This, for Windows, emulates POSIX setlocale() behavior.  There is no
1975      * difference between the two unless the input locale is "", which normally
1976      * means on Windows to get the machine default, which is set via the
1977      * computer's "Regional and Language Options" (or its current equivalent).
1978      * In POSIX, it instead means to find the locale from the user's
1979      * environment.  This routine changes the Windows behavior to first look in
1980      * the environment, and, if anything is found, use that instead of going to
1981      * the machine default.  If there is no environment override, the machine
1982      * default is used, by calling the real setlocale() with "".
1983      *
1984      * The POSIX behavior is to use the LC_ALL variable if set; otherwise to
1985      * use the particular category's variable if set; otherwise to use the LANG
1986      * variable. */
1987
1988     bool override_LC_ALL = FALSE;
1989     char * result;
1990     unsigned int i;
1991
1992     if (locale && strEQ(locale, "")) {
1993
1994 #  ifdef LC_ALL
1995
1996         locale = PerlEnv_getenv("LC_ALL");
1997         if (! locale) {
1998             if (category ==  LC_ALL) {
1999                 override_LC_ALL = TRUE;
2000             }
2001             else {
2002
2003 #  endif
2004
2005                 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
2006                     if (category == categories[i]) {
2007                         locale = PerlEnv_getenv(category_names[i]);
2008                         goto found_locale;
2009                     }
2010                 }
2011
2012                 locale = PerlEnv_getenv("LANG");
2013                 if (! locale) {
2014                     locale = "";
2015                 }
2016
2017               found_locale: ;
2018
2019 #  ifdef LC_ALL
2020
2021             }
2022         }
2023
2024 #  endif
2025
2026     }
2027
2028     result = setlocale(category, locale);
2029     DEBUG_L(STMT_START {
2030                 dSAVE_ERRNO;
2031                 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n", __FILE__, __LINE__,
2032                             setlocale_debug_string(category, locale, result));
2033                 RESTORE_ERRNO;
2034             } STMT_END);
2035
2036     if (! override_LC_ALL)  {
2037         return result;
2038     }
2039
2040     /* Here the input category was LC_ALL, and we have set it to what is in the
2041      * LANG variable or the system default if there is no LANG.  But these have
2042      * lower priority than the other LC_foo variables, so override it for each
2043      * one that is set.  (If they are set to "", it means to use the same thing
2044      * we just set LC_ALL to, so can skip) */
2045
2046     for (i = 0; i < LC_ALL_INDEX; i++) {
2047         result = PerlEnv_getenv(category_names[i]);
2048         if (result && strNE(result, "")) {
2049             setlocale(categories[i], result);
2050             DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
2051                 __FILE__, __LINE__,
2052                 setlocale_debug_string(categories[i], result, "not captured")));
2053         }
2054     }
2055
2056     result = setlocale(LC_ALL, NULL);
2057     DEBUG_L(STMT_START {
2058                 dSAVE_ERRNO;
2059                 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
2060                                __FILE__, __LINE__,
2061                                setlocale_debug_string(LC_ALL, NULL, result));
2062                 RESTORE_ERRNO;
2063             } STMT_END);
2064
2065     return result;
2066 }
2067
2068 #endif
2069
2070 /*
2071
2072 =head1 Locale-related functions and macros
2073
2074 =for apidoc Perl_setlocale
2075
2076 This is an (almost) drop-in replacement for the system L<C<setlocale(3)>>,
2077 taking the same parameters, and returning the same information, except that it
2078 returns the correct underlying C<LC_NUMERIC> locale, instead of C<C> always, as
2079 perl keeps that locale category as C<C>, changing it briefly during the
2080 operations where the underlying one is required.
2081
2082 Another reason it isn't completely a drop-in replacement is that it is
2083 declared to return S<C<const char *>>, whereas the system setlocale omits the
2084 C<const>.  (If it were being written today, plain setlocale would be declared
2085 const, since it is illegal to change the information it returns; doing so leads
2086 to segfaults.)
2087
2088 Finally, C<Perl_setlocale> works under all circumstances, whereas plain
2089 C<setlocale> can be completely ineffective on some platforms under some
2090 configurations.
2091
2092 C<Perl_setlocale> should not be used to change the locale except on systems
2093 where the predefined variable C<${^SAFE_LOCALES}> is 1.  On some such systems,
2094 the system C<setlocale()> is ineffective, returning the wrong information, and
2095 failing to actually change the locale.  C<Perl_setlocale>, however works
2096 properly in all circumstances.
2097
2098 The return points to a per-thread static buffer, which is overwritten the next
2099 time C<Perl_setlocale> is called from the same thread.
2100
2101 =cut
2102
2103 */
2104
2105 const char *
2106 Perl_setlocale(const int category, const char * locale)
2107 {
2108     /* This wraps POSIX::setlocale() */
2109
2110     const char * retval;
2111     const char * newlocale;
2112     dSAVEDERRNO;
2113     DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2114     dTHX;
2115
2116 #ifdef USE_LOCALE_NUMERIC
2117
2118     /* A NULL locale means only query what the current one is.  We have the
2119      * LC_NUMERIC name saved, because we are normally switched into the C
2120      * locale for it.  For an LC_ALL query, switch back to get the correct
2121      * results.  All other categories don't require special handling */
2122     if (locale == NULL) {
2123         if (category == LC_NUMERIC) {
2124
2125             /* We don't have to copy this return value, as it is a per-thread
2126              * variable, and won't change until a future setlocale */
2127             return PL_numeric_name;
2128         }
2129
2130 #  ifdef LC_ALL
2131
2132         else if (category == LC_ALL) {
2133             STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2134         }
2135
2136 #  endif
2137
2138     }
2139
2140 #endif
2141
2142     retval = save_to_buffer(do_setlocale_r(category, locale),
2143                             &PL_setlocale_buf, &PL_setlocale_bufsize, 0);
2144     SAVE_ERRNO;
2145
2146 #if defined(USE_LOCALE_NUMERIC) && defined(LC_ALL)
2147
2148     if (locale == NULL && category == LC_ALL) {
2149         RESTORE_LC_NUMERIC();
2150     }
2151
2152 #endif
2153
2154     DEBUG_L(PerlIO_printf(Perl_debug_log,
2155         "%s:%d: %s\n", __FILE__, __LINE__,
2156             setlocale_debug_string(category, locale, retval)));
2157
2158     RESTORE_ERRNO;
2159
2160     if (! retval) {
2161         return NULL;
2162     }
2163
2164     /* If locale == NULL, we are just querying the state */
2165     if (locale == NULL) {
2166         return retval;
2167     }
2168
2169     /* Now that have switched locales, we have to update our records to
2170      * correspond. */
2171
2172     switch (category) {
2173
2174 #ifdef USE_LOCALE_CTYPE
2175
2176         case LC_CTYPE:
2177             new_ctype(retval);
2178             break;
2179
2180 #endif
2181 #ifdef USE_LOCALE_COLLATE
2182
2183         case LC_COLLATE:
2184             new_collate(retval);
2185             break;
2186
2187 #endif
2188 #ifdef USE_LOCALE_NUMERIC
2189
2190         case LC_NUMERIC:
2191             new_numeric(retval);
2192             break;
2193
2194 #endif
2195 #ifdef LC_ALL
2196
2197         case LC_ALL:
2198
2199             /* LC_ALL updates all the things we care about.  The values may not
2200              * be the same as 'retval', as the locale "" may have set things
2201              * individually */
2202
2203 #  ifdef USE_LOCALE_CTYPE
2204
2205             newlocale = do_setlocale_c(LC_CTYPE, NULL);
2206             new_ctype(newlocale);
2207
2208 #  endif /* USE_LOCALE_CTYPE */
2209 #  ifdef USE_LOCALE_COLLATE
2210
2211             newlocale = do_setlocale_c(LC_COLLATE, NULL);
2212             new_collate(newlocale);
2213
2214 #  endif
2215 #  ifdef USE_LOCALE_NUMERIC
2216
2217             newlocale = do_setlocale_c(LC_NUMERIC, NULL);
2218             new_numeric(newlocale);
2219
2220 #  endif /* USE_LOCALE_NUMERIC */
2221 #endif /* LC_ALL */
2222
2223         default:
2224             break;
2225     }
2226
2227     return retval;
2228
2229 }
2230
2231 PERL_STATIC_INLINE const char *
2232 S_save_to_buffer(const char * string, char **buf, Size_t *buf_size, const Size_t offset)
2233 {
2234     /* Copy the NUL-terminated 'string' to 'buf' + 'offset'.  'buf' has size 'buf_size',
2235      * growing it if necessary */
2236
2237     Size_t string_size;
2238
2239     PERL_ARGS_ASSERT_SAVE_TO_BUFFER;
2240
2241     if (! string) {
2242         return NULL;
2243     }
2244
2245     string_size = strlen(string) + offset + 1;
2246
2247     if (*buf_size == 0) {
2248         Newx(*buf, string_size, char);
2249         *buf_size = string_size;
2250     }
2251     else if (string_size > *buf_size) {
2252         Renew(*buf, string_size, char);
2253         *buf_size = string_size;
2254     }
2255
2256     Copy(string, *buf + offset, string_size - offset, char);
2257     return *buf;
2258 }
2259
2260 /*
2261
2262 =for apidoc Perl_langinfo
2263
2264 This is an (almost) drop-in replacement for the system C<L<nl_langinfo(3)>>,
2265 taking the same C<item> parameter values, and returning the same information.
2266 But it is more thread-safe than regular C<nl_langinfo()>, and hides the quirks
2267 of Perl's locale handling from your code, and can be used on systems that lack
2268 a native C<nl_langinfo>.
2269
2270 Expanding on these:
2271
2272 =over
2273
2274 =item *
2275
2276 The reason it isn't quite a drop-in replacement is actually an advantage.  The
2277 only difference is that it returns S<C<const char *>>, whereas plain
2278 C<nl_langinfo()> returns S<C<char *>>, but you are (only by documentation)
2279 forbidden to write into the buffer.  By declaring this C<const>, the compiler
2280 enforces this restriction, so if it is violated, you know at compilation time,
2281 rather than getting segfaults at runtime.
2282
2283 =item *
2284
2285 It delivers the correct results for the C<RADIXCHAR> and C<THOUSEP> items,
2286 without you having to write extra code.  The reason for the extra code would be
2287 because these are from the C<LC_NUMERIC> locale category, which is normally
2288 kept set to the C locale by Perl, no matter what the underlying locale is
2289 supposed to be, and so to get the expected results, you have to temporarily
2290 toggle into the underlying locale, and later toggle back.  (You could use plain
2291 C<nl_langinfo> and C<L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>> for this but
2292 then you wouldn't get the other advantages of C<Perl_langinfo()>; not keeping
2293 C<LC_NUMERIC> in the C locale would break a lot of CPAN, which is expecting the
2294 radix (decimal point) character to be a dot.)
2295
2296 =item *
2297
2298 The system function it replaces can have its static return buffer trashed,
2299 not only by a subesequent call to that function, but by a C<freelocale>,
2300 C<setlocale>, or other locale change.  The returned buffer of this function is
2301 not changed until the next call to it, so the buffer is never in a trashed
2302 state.
2303
2304 =item *
2305
2306 Its return buffer is per-thread, so it also is never overwritten by a call to
2307 this function from another thread;  unlike the function it replaces.
2308
2309 =item *
2310
2311 But most importantly, it works on systems that don't have C<nl_langinfo>, such
2312 as Windows, hence makes your code more portable.  Of the fifty-some possible
2313 items specified by the POSIX 2008 standard,
2314 L<http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/langinfo.h.html>,
2315 only two are completely unimplemented (though the loss of one of these is
2316 significant).  It uses various techniques to recover the other items, including
2317 calling C<L<localeconv(3)>>, and C<L<strftime(3)>>, both of which are specified
2318 in C89, so should be always be available.  Later C<strftime()> versions have
2319 additional capabilities; C<""> is returned for those not available on your
2320 system.
2321
2322 It is important to note that when called with an item that is recovered by
2323 using C<localeconv>, the buffer from any previous explicit call to
2324 C<localeconv> will be overwritten.  This means you must save that buffer's
2325 contents if you need to access them after a call to this function.
2326
2327 The details for those items which may deviate from what this emulation returns
2328 and what a native C<nl_langinfo()> would return are specified in
2329 L<I18N::Langinfo>.
2330
2331 =back
2332
2333 When using C<Perl_langinfo> on systems that don't have a native
2334 C<nl_langinfo()>, you must
2335
2336  #include "perl_langinfo.h"
2337
2338 before the C<perl.h> C<#include>.  You can replace your C<langinfo.h>
2339 C<#include> with this one.  (Doing it this way keeps out the symbols that plain
2340 C<langinfo.h> imports into the namespace for code that doesn't need it.)
2341
2342 The original impetus for C<Perl_langinfo()> was so that code that needs to
2343 find out the current currency symbol, floating point radix character, or digit
2344 grouping separator can use, on all systems, the simpler and more
2345 thread-friendly C<nl_langinfo> API instead of C<L<localeconv(3)>> which is a
2346 pain to make thread-friendly.  For other fields returned by C<localeconv>, it
2347 is better to use the methods given in L<perlcall> to call
2348 L<C<POSIX::localeconv()>|POSIX/localeconv>, which is thread-friendly.
2349
2350 =cut
2351
2352 */
2353
2354 const char *
2355 #ifdef HAS_NL_LANGINFO
2356 Perl_langinfo(const nl_item item)
2357 #else
2358 Perl_langinfo(const int item)
2359 #endif
2360 {
2361     return my_nl_langinfo(item, TRUE);
2362 }
2363
2364 STATIC const char *
2365 #ifdef HAS_NL_LANGINFO
2366 S_my_nl_langinfo(const nl_item item, bool toggle)
2367 #else
2368 S_my_nl_langinfo(const int item, bool toggle)
2369 #endif
2370 {
2371     dTHX;
2372     const char * retval;
2373
2374     /* We only need to toggle into the underlying LC_NUMERIC locale for these
2375      * two items, and only if not already there */
2376     if (toggle && ((   item != RADIXCHAR && item != THOUSEP)
2377                     || PL_numeric_underlying))
2378     {
2379         toggle = FALSE;
2380     }
2381
2382 #if defined(HAS_NL_LANGINFO) /* nl_langinfo() is available.  */
2383 #  if   ! defined(HAS_THREAD_SAFE_NL_LANGINFO_L)      \
2384      || ! defined(HAS_POSIX_2008_LOCALE)
2385
2386     /* Here, use plain nl_langinfo(), switching to the underlying LC_NUMERIC
2387      * for those items dependent on it.  This must be copied to a buffer before
2388      * switching back, as some systems destroy the buffer when setlocale() is
2389      * called */
2390
2391     {
2392         DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2393
2394         if (toggle) {
2395             STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2396         }
2397
2398         LOCALE_LOCK;    /* Prevent interference from another thread executing
2399                            this code section (the only call to nl_langinfo in
2400                            the core) */
2401
2402
2403         /* Copy to a per-thread buffer, which is also one that won't be
2404          * destroyed by a subsequent setlocale(), such as the
2405          * RESTORE_LC_NUMERIC may do just below. */
2406         retval = save_to_buffer(nl_langinfo(item),
2407                                 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
2408
2409         LOCALE_UNLOCK;
2410
2411         if (toggle) {
2412             RESTORE_LC_NUMERIC();
2413         }
2414     }
2415
2416 #  else /* Use nl_langinfo_l(), avoiding both a mutex and changing the locale */
2417
2418     {
2419         bool do_free = FALSE;
2420         locale_t cur = uselocale((locale_t) 0);
2421
2422         if (cur == LC_GLOBAL_LOCALE) {
2423             cur = duplocale(LC_GLOBAL_LOCALE);
2424             do_free = TRUE;
2425         }
2426
2427         if (toggle) {
2428             if (PL_underlying_numeric_obj) {
2429                 cur = PL_underlying_numeric_obj;
2430             }
2431             else {
2432                 cur = newlocale(LC_NUMERIC_MASK, PL_numeric_name, cur);
2433                 do_free = TRUE;
2434             }
2435         }
2436
2437         /* We have to save it to a buffer, because the freelocale() just below
2438          * can invalidate the internal one */
2439         retval = save_to_buffer(nl_langinfo_l(item, cur),
2440                                 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
2441
2442         if (do_free) {
2443             freelocale(cur);
2444         }
2445     }
2446
2447 #  endif
2448
2449     if (strEQ(retval, "")) {
2450         if (item == YESSTR) {
2451             return "yes";
2452         }
2453         if (item == NOSTR) {
2454             return "no";
2455         }
2456     }
2457
2458     return retval;
2459
2460 #else   /* Below, emulate nl_langinfo as best we can */
2461
2462     {
2463
2464 #  ifdef HAS_LOCALECONV
2465
2466         const struct lconv* lc;
2467         const char * temp;
2468         DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2469
2470 #  endif
2471 #  ifdef HAS_STRFTIME
2472
2473         struct tm tm;
2474         bool return_format = FALSE; /* Return the %format, not the value */
2475         const char * format;
2476
2477 #  endif
2478
2479         /* We copy the results to a per-thread buffer, even if not
2480          * multi-threaded.  This is in part to simplify this code, and partly
2481          * because we need a buffer anyway for strftime(), and partly because a
2482          * call of localeconv() could otherwise wipe out the buffer, and the
2483          * programmer would not be expecting this, as this is a nl_langinfo()
2484          * substitute after all, so s/he might be thinking their localeconv()
2485          * is safe until another localeconv() call. */
2486
2487         switch (item) {
2488             Size_t len;
2489
2490             /* These 2 are unimplemented */
2491             case CODESET:
2492             case ERA:      /* For use with strftime() %E modifier */
2493
2494             default:
2495                 return "";
2496
2497             /* We use only an English set, since we don't know any more */
2498             case YESEXPR:   return "^[+1yY]";
2499             case YESSTR:    return "yes";
2500             case NOEXPR:    return "^[-0nN]";
2501             case NOSTR:     return "no";
2502
2503
2504 #  ifdef HAS_LOCALECONV
2505
2506             case CRNCYSTR:
2507
2508                 /* We don't bother with localeconv_l() because any system that
2509                  * has it is likely to also have nl_langinfo() */
2510
2511                 LOCALE_LOCK;    /* Prevent interference with other threads
2512                                    using localeconv() */
2513
2514                 lc = localeconv();
2515                 if (   ! lc
2516                     || ! lc->currency_symbol
2517                     || strEQ("", lc->currency_symbol))
2518                 {
2519                     LOCALE_UNLOCK;
2520                     return "";
2521                 }
2522
2523                 /* Leave the first spot empty to be filled in below */
2524                 retval = save_to_buffer(lc->currency_symbol, &PL_langinfo_buf,
2525                                         &PL_langinfo_bufsize, 1);
2526                 if (lc->mon_decimal_point && strEQ(lc->mon_decimal_point, ""))
2527                 { /*  khw couldn't figure out how the localedef specifications
2528                       would show that the $ should replace the radix; this is
2529                       just a guess as to how it might work.*/
2530                     PL_langinfo_buf[0] = '.';
2531                 }
2532                 else if (lc->p_cs_precedes) {
2533                     PL_langinfo_buf[0] = '-';
2534                 }
2535                 else {
2536                     PL_langinfo_buf[0] = '+';
2537                 }
2538
2539                 LOCALE_UNLOCK;
2540                 break;
2541
2542             case RADIXCHAR:
2543             case THOUSEP:
2544
2545                 if (toggle) {
2546                     STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2547                 }
2548
2549                 LOCALE_LOCK;    /* Prevent interference with other threads
2550                                    using localeconv() */
2551
2552                 lc = localeconv();
2553                 if (! lc) {
2554                     temp = "";
2555                 }
2556                 else {
2557                     temp = (item == RADIXCHAR)
2558                              ? lc->decimal_point
2559                              : lc->thousands_sep;
2560                     if (! temp) {
2561                         temp = "";
2562                     }
2563                 }
2564
2565                 retval = save_to_buffer(temp, &PL_langinfo_buf,
2566                                         &PL_langinfo_bufsize, 0);
2567
2568                 LOCALE_UNLOCK;
2569
2570                 if (toggle) {
2571                     RESTORE_LC_NUMERIC();
2572                 }
2573
2574                 break;
2575
2576 #  endif
2577 #  ifdef HAS_STRFTIME
2578
2579             /* These are defined by C89, so we assume that strftime supports
2580              * them, and so are returned unconditionally; they may not be what
2581              * the locale actually says, but should give good enough results
2582              * for someone using them as formats (as opposed to trying to parse
2583              * them to figure out what the locale says).  The other format
2584              * items are actually tested to verify they work on the platform */
2585             case D_FMT:         return "%x";
2586             case T_FMT:         return "%X";
2587             case D_T_FMT:       return "%c";
2588
2589             /* These formats are only available in later strfmtime's */
2590             case ERA_D_FMT: case ERA_T_FMT: case ERA_D_T_FMT: case T_FMT_AMPM:
2591
2592             /* The rest can be gotten from most versions of strftime(). */
2593             case ABDAY_1: case ABDAY_2: case ABDAY_3:
2594             case ABDAY_4: case ABDAY_5: case ABDAY_6: case ABDAY_7:
2595             case ALT_DIGITS:
2596             case AM_STR: case PM_STR:
2597             case ABMON_1: case ABMON_2: case ABMON_3: case ABMON_4:
2598             case ABMON_5: case ABMON_6: case ABMON_7: case ABMON_8:
2599             case ABMON_9: case ABMON_10: case ABMON_11: case ABMON_12:
2600             case DAY_1: case DAY_2: case DAY_3: case DAY_4:
2601             case DAY_5: case DAY_6: case DAY_7:
2602             case MON_1: case MON_2: case MON_3: case MON_4:
2603             case MON_5: case MON_6: case MON_7: case MON_8:
2604             case MON_9: case MON_10: case MON_11: case MON_12:
2605
2606                 LOCALE_LOCK;
2607
2608                 init_tm(&tm);   /* Precaution against core dumps */
2609                 tm.tm_sec = 30;
2610                 tm.tm_min = 30;
2611                 tm.tm_hour = 6;
2612                 tm.tm_year = 2017 - 1900;
2613                 tm.tm_wday = 0;
2614                 tm.tm_mon = 0;
2615                 switch (item) {
2616                     default:
2617                         LOCALE_UNLOCK;
2618                         Perl_croak(aTHX_
2619                                     "panic: %s: %d: switch case: %d problem",
2620                                        __FILE__, __LINE__, item);
2621                         NOT_REACHED; /* NOTREACHED */
2622
2623                     case PM_STR: tm.tm_hour = 18;
2624                     case AM_STR:
2625                         format = "%p";
2626                         break;
2627
2628                     case ABDAY_7: tm.tm_wday++;
2629                     case ABDAY_6: tm.tm_wday++;
2630                     case ABDAY_5: tm.tm_wday++;
2631                     case ABDAY_4: tm.tm_wday++;
2632                     case ABDAY_3: tm.tm_wday++;
2633                     case ABDAY_2: tm.tm_wday++;
2634                     case ABDAY_1:
2635                         format = "%a";
2636                         break;
2637
2638                     case DAY_7: tm.tm_wday++;
2639                     case DAY_6: tm.tm_wday++;
2640                     case DAY_5: tm.tm_wday++;
2641                     case DAY_4: tm.tm_wday++;
2642                     case DAY_3: tm.tm_wday++;
2643                     case DAY_2: tm.tm_wday++;
2644                     case DAY_1:
2645                         format = "%A";
2646                         break;
2647
2648                     case ABMON_12: tm.tm_mon++;
2649                     case ABMON_11: tm.tm_mon++;
2650                     case ABMON_10: tm.tm_mon++;
2651                     case ABMON_9: tm.tm_mon++;
2652                     case ABMON_8: tm.tm_mon++;
2653                     case ABMON_7: tm.tm_mon++;
2654                     case ABMON_6: tm.tm_mon++;
2655                     case ABMON_5: tm.tm_mon++;
2656                     case ABMON_4: tm.tm_mon++;
2657                     case ABMON_3: tm.tm_mon++;
2658                     case ABMON_2: tm.tm_mon++;
2659                     case ABMON_1:
2660                         format = "%b";
2661                         break;
2662
2663                     case MON_12: tm.tm_mon++;
2664                     case MON_11: tm.tm_mon++;
2665                     case MON_10: tm.tm_mon++;
2666                     case MON_9: tm.tm_mon++;
2667                     case MON_8: tm.tm_mon++;
2668                     case MON_7: tm.tm_mon++;
2669                     case MON_6: tm.tm_mon++;
2670                     case MON_5: tm.tm_mon++;
2671                     case MON_4: tm.tm_mon++;
2672                     case MON_3: tm.tm_mon++;
2673                     case MON_2: tm.tm_mon++;
2674                     case MON_1:
2675                         format = "%B";
2676                         break;
2677
2678                     case T_FMT_AMPM:
2679                         format = "%r";
2680                         return_format = TRUE;
2681                         break;
2682
2683                     case ERA_D_FMT:
2684                         format = "%Ex";
2685                         return_format = TRUE;
2686                         break;
2687
2688                     case ERA_T_FMT:
2689                         format = "%EX";
2690                         return_format = TRUE;
2691                         break;
2692
2693                     case ERA_D_T_FMT:
2694                         format = "%Ec";
2695                         return_format = TRUE;
2696                         break;
2697
2698                     case ALT_DIGITS:
2699                         tm.tm_wday = 0;
2700                         format = "%Ow"; /* Find the alternate digit for 0 */
2701                         break;
2702                 }
2703
2704                 /* We can't use my_strftime() because it doesn't look at
2705                  * tm_wday  */
2706                 while (0 == strftime(PL_langinfo_buf, PL_langinfo_bufsize,
2707                                      format, &tm))
2708                 {
2709                     /* A zero return means one of:
2710                      *  a)  there wasn't enough space in PL_langinfo_buf
2711                      *  b)  the format, like a plain %p, returns empty
2712                      *  c)  it was an illegal format, though some
2713                      *      implementations of strftime will just return the
2714                      *      illegal format as a plain character sequence.
2715                      *
2716                      *  To quickly test for case 'b)', try again but precede
2717                      *  the format with a plain character.  If that result is
2718                      *  still empty, the problem is either 'a)' or 'c)' */
2719
2720                     Size_t format_size = strlen(format) + 1;
2721                     Size_t mod_size = format_size + 1;
2722                     char * mod_format;
2723                     char * temp_result;
2724
2725                     Newx(mod_format, mod_size, char);
2726                     Newx(temp_result, PL_langinfo_bufsize, char);
2727                     *mod_format = ' ';
2728                     my_strlcpy(mod_format + 1, format, mod_size);
2729                     len = strftime(temp_result,
2730                                    PL_langinfo_bufsize,
2731                                    mod_format, &tm);
2732                     Safefree(mod_format);
2733                     Safefree(temp_result);
2734
2735                     /* If 'len' is non-zero, it means that we had a case like
2736                      * %p which means the current locale doesn't use a.m. or
2737                      * p.m., and that is valid */
2738                     if (len == 0) {
2739
2740                         /* Here, still didn't work.  If we get well beyond a
2741                          * reasonable size, bail out to prevent an infinite
2742                          * loop. */
2743
2744                         if (PL_langinfo_bufsize > 100 * format_size) {
2745                             *PL_langinfo_buf = '\0';
2746                         }
2747                         else {
2748                             /* Double the buffer size to retry;  Add 1 in case
2749                              * original was 0, so we aren't stuck at 0.  */
2750                             PL_langinfo_bufsize *= 2;
2751                             PL_langinfo_bufsize++;
2752                             Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2753                             continue;
2754                         }
2755                     }
2756
2757                     break;
2758                 }
2759
2760                 /* Here, we got a result.
2761                  *
2762                  * If the item is 'ALT_DIGITS', PL_langinfo_buf contains the
2763                  * alternate format for wday 0.  If the value is the same as
2764                  * the normal 0, there isn't an alternate, so clear the buffer.
2765                  * */
2766                 if (   item == ALT_DIGITS
2767                     && strEQ(PL_langinfo_buf, "0"))
2768                 {
2769                     *PL_langinfo_buf = '\0';
2770                 }
2771
2772                 /* ALT_DIGITS is problematic.  Experiments on it showed that
2773                  * strftime() did not always work properly when going from
2774                  * alt-9 to alt-10.  Only a few locales have this item defined,
2775                  * and in all of them on Linux that khw was able to find,
2776                  * nl_langinfo() merely returned the alt-0 character, possibly
2777                  * doubled.  Most Unicode digits are in blocks of 10
2778                  * consecutive code points, so that is sufficient information
2779                  * for those scripts, as we can infer alt-1, alt-2, ....  But
2780                  * for a Japanese locale, a CJK ideographic 0 is returned, and
2781                  * the CJK digits are not in code point order, so you can't
2782                  * really infer anything.  The localedef for this locale did
2783                  * specify the succeeding digits, so that strftime() works
2784                  * properly on them, without needing to infer anything.  But
2785                  * the nl_langinfo() return did not give sufficient information
2786                  * for the caller to understand what's going on.  So until
2787                  * there is evidence that it should work differently, this
2788                  * returns the alt-0 string for ALT_DIGITS.
2789                  *
2790                  * wday was chosen because its range is all a single digit.
2791                  * Things like tm_sec have two digits as the minimum: '00' */
2792
2793                 LOCALE_UNLOCK;
2794
2795                 retval = PL_langinfo_buf;
2796
2797                 /* If to return the format, not the value, overwrite the buffer
2798                  * with it.  But some strftime()s will keep the original format
2799                  * if illegal, so change those to "" */
2800                 if (return_format) {
2801                     if (strEQ(PL_langinfo_buf, format)) {
2802                         *PL_langinfo_buf = '\0';
2803                     }
2804                     else {
2805                         retval = save_to_buffer(format, &PL_langinfo_buf,
2806                                                 &PL_langinfo_bufsize, 0);
2807                     }
2808                 }
2809
2810                 break;
2811
2812 #  endif
2813
2814         }
2815     }
2816
2817     return retval;
2818
2819 #endif
2820
2821 }
2822
2823 /*
2824  * Initialize locale awareness.
2825  */
2826 int
2827 Perl_init_i18nl10n(pTHX_ int printwarn)
2828 {
2829     /* printwarn is
2830      *
2831      *    0 if not to output warning when setup locale is bad
2832      *    1 if to output warning based on value of PERL_BADLANG
2833      *    >1 if to output regardless of PERL_BADLANG
2834      *
2835      * returns
2836      *    1 = set ok or not applicable,
2837      *    0 = fallback to a locale of lower priority
2838      *   -1 = fallback to all locales failed, not even to the C locale
2839      *
2840      * Under -DDEBUGGING, if the environment variable PERL_DEBUG_LOCALE_INIT is
2841      * set, debugging information is output.
2842      *
2843      * This looks more complicated than it is, mainly due to the #ifdefs.
2844      *
2845      * We try to set LC_ALL to the value determined by the environment.  If
2846      * there is no LC_ALL on this platform, we try the individual categories we
2847      * know about.  If this works, we are done.
2848      *
2849      * But if it doesn't work, we have to do something else.  We search the
2850      * environment variables ourselves instead of relying on the system to do
2851      * it.  We look at, in order, LC_ALL, LANG, a system default locale (if we
2852      * think there is one), and the ultimate fallback "C".  This is all done in
2853      * the same loop as above to avoid duplicating code, but it makes things
2854      * more complex.  The 'trial_locales' array is initialized with just one
2855      * element; it causes the behavior described in the paragraph above this to
2856      * happen.  If that fails, we add elements to 'trial_locales', and do extra
2857      * loop iterations to cause the behavior described in this paragraph.
2858      *
2859      * On Ultrix, the locale MUST come from the environment, so there is
2860      * preliminary code to set it.  I (khw) am not sure that it is necessary,
2861      * and that this couldn't be folded into the loop, but barring any real
2862      * platforms to test on, it's staying as-is
2863      *
2864      * A slight complication is that in embedded Perls, the locale may already
2865      * be set-up, and we don't want to get it from the normal environment
2866      * variables.  This is handled by having a special environment variable
2867      * indicate we're in this situation.  We simply set setlocale's 2nd
2868      * parameter to be a NULL instead of "".  That indicates to setlocale that
2869      * it is not to change anything, but to return the current value,
2870      * effectively initializing perl's db to what the locale already is.
2871      *
2872      * We play the same trick with NULL if a LC_ALL succeeds.  We call
2873      * setlocale() on the individual categores with NULL to get their existing
2874      * values for our db, instead of trying to change them.
2875      * */
2876
2877     int ok = 1;
2878
2879 #ifndef USE_LOCALE
2880
2881     PERL_UNUSED_ARG(printwarn);
2882
2883 #else  /* USE_LOCALE */
2884 #  ifdef __GLIBC__
2885
2886     const char * const language   = savepv(PerlEnv_getenv("LANGUAGE"));
2887
2888 #  endif
2889
2890     /* NULL uses the existing already set up locale */
2891     const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
2892                                         ? NULL
2893                                         : "";
2894     const char* trial_locales[5];   /* 5 = 1 each for "", LC_ALL, LANG, "", C */
2895     unsigned int trial_locales_count;
2896     const char * const lc_all     = savepv(PerlEnv_getenv("LC_ALL"));
2897     const char * const lang       = savepv(PerlEnv_getenv("LANG"));
2898     bool setlocale_failure = FALSE;
2899     unsigned int i;
2900
2901     /* A later getenv() could zap this, so only use here */
2902     const char * const bad_lang_use_once = PerlEnv_getenv("PERL_BADLANG");
2903
2904     const bool locwarn = (printwarn > 1
2905                           || (          printwarn
2906                               && (    ! bad_lang_use_once
2907                                   || (
2908                                          /* disallow with "" or "0" */
2909                                          *bad_lang_use_once
2910                                        && strNE("0", bad_lang_use_once)))));
2911
2912     /* setlocale() return vals; not copied so must be looked at immediately */
2913     const char * sl_result[NOMINAL_LC_ALL_INDEX + 1];
2914
2915     /* current locale for given category; should have been copied so aren't
2916      * volatile */
2917     const char * curlocales[NOMINAL_LC_ALL_INDEX + 1];
2918
2919 #  ifdef WIN32
2920
2921     /* In some systems you can find out the system default locale
2922      * and use that as the fallback locale. */
2923 #    define SYSTEM_DEFAULT_LOCALE
2924 #  endif
2925 #  ifdef SYSTEM_DEFAULT_LOCALE
2926
2927     const char *system_default_locale = NULL;
2928
2929 #  endif
2930
2931 #  ifndef DEBUGGING
2932 #    define DEBUG_LOCALE_INIT(a,b,c)
2933 #  else
2934
2935     DEBUG_INITIALIZATION_set(cBOOL(PerlEnv_getenv("PERL_DEBUG_LOCALE_INIT")));
2936
2937 #    define DEBUG_LOCALE_INIT(category, locale, result)                     \
2938         STMT_START {                                                        \
2939                 if (debug_initialization) {                                 \
2940                     PerlIO_printf(Perl_debug_log,                           \
2941                                   "%s:%d: %s\n",                            \
2942                                   __FILE__, __LINE__,                       \
2943                                   setlocale_debug_string(category,          \
2944                                                           locale,           \
2945                                                           result));         \
2946                 }                                                           \
2947         } STMT_END
2948
2949 /* Make sure the parallel arrays are properly set up */
2950 #    ifdef USE_LOCALE_NUMERIC
2951     assert(categories[LC_NUMERIC_INDEX] == LC_NUMERIC);
2952     assert(strEQ(category_names[LC_NUMERIC_INDEX], "LC_NUMERIC"));
2953 #      ifdef USE_POSIX_2008_LOCALE
2954     assert(category_masks[LC_NUMERIC_INDEX] == LC_NUMERIC_MASK);
2955 #      endif
2956 #    endif
2957 #    ifdef USE_LOCALE_CTYPE
2958     assert(categories[LC_CTYPE_INDEX] == LC_CTYPE);
2959     assert(strEQ(category_names[LC_CTYPE_INDEX], "LC_CTYPE"));
2960 #      ifdef USE_POSIX_2008_LOCALE
2961     assert(category_masks[LC_CTYPE_INDEX] == LC_CTYPE_MASK);
2962 #      endif
2963 #    endif
2964 #    ifdef USE_LOCALE_COLLATE
2965     assert(categories[LC_COLLATE_INDEX] == LC_COLLATE);
2966     assert(strEQ(category_names[LC_COLLATE_INDEX], "LC_COLLATE"));
2967 #      ifdef USE_POSIX_2008_LOCALE
2968     assert(category_masks[LC_COLLATE_INDEX] == LC_COLLATE_MASK);
2969 #      endif
2970 #    endif
2971 #    ifdef USE_LOCALE_TIME
2972     assert(categories[LC_TIME_INDEX] == LC_TIME);
2973     assert(strEQ(category_names[LC_TIME_INDEX], "LC_TIME"));
2974 #      ifdef USE_POSIX_2008_LOCALE
2975     assert(category_masks[LC_TIME_INDEX] == LC_TIME_MASK);
2976 #      endif
2977 #    endif
2978 #    ifdef USE_LOCALE_MESSAGES
2979     assert(categories[LC_MESSAGES_INDEX] == LC_MESSAGES);
2980     assert(strEQ(category_names[LC_MESSAGES_INDEX], "LC_MESSAGES"));
2981 #      ifdef USE_POSIX_2008_LOCALE
2982     assert(category_masks[LC_MESSAGES_INDEX] == LC_MESSAGES_MASK);
2983 #      endif
2984 #    endif
2985 #    ifdef USE_LOCALE_MONETARY
2986     assert(categories[LC_MONETARY_INDEX] == LC_MONETARY);
2987     assert(strEQ(category_names[LC_MONETARY_INDEX], "LC_MONETARY"));
2988 #      ifdef USE_POSIX_2008_LOCALE
2989     assert(category_masks[LC_MONETARY_INDEX] == LC_MONETARY_MASK);
2990 #      endif
2991 #    endif
2992 #    ifdef USE_LOCALE_ADDRESS
2993     assert(categories[LC_ADDRESS_INDEX] == LC_ADDRESS);
2994     assert(strEQ(category_names[LC_ADDRESS_INDEX], "LC_ADDRESS"));
2995 #      ifdef USE_POSIX_2008_LOCALE
2996     assert(category_masks[LC_ADDRESS_INDEX] == LC_ADDRESS_MASK);
2997 #      endif
2998 #    endif
2999 #    ifdef USE_LOCALE_IDENTIFICATION
3000     assert(categories[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION);
3001     assert(strEQ(category_names[LC_IDENTIFICATION_INDEX], "LC_IDENTIFICATION"));
3002 #      ifdef USE_POSIX_2008_LOCALE
3003     assert(category_masks[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION_MASK);
3004 #      endif
3005 #    endif
3006 #    ifdef USE_LOCALE_MEASUREMENT
3007     assert(categories[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT);
3008     assert(strEQ(category_names[LC_MEASUREMENT_INDEX], "LC_MEASUREMENT"));
3009 #      ifdef USE_POSIX_2008_LOCALE
3010     assert(category_masks[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT_MASK);
3011 #      endif
3012 #    endif
3013 #    ifdef USE_LOCALE_PAPER
3014     assert(categories[LC_PAPER_INDEX] == LC_PAPER);
3015     assert(strEQ(category_names[LC_PAPER_INDEX], "LC_PAPER"));
3016 #      ifdef USE_POSIX_2008_LOCALE
3017     assert(category_masks[LC_PAPER_INDEX] == LC_PAPER_MASK);
3018 #      endif
3019 #    endif
3020 #    ifdef USE_LOCALE_TELEPHONE
3021     assert(categories[LC_TELEPHONE_INDEX] == LC_TELEPHONE);
3022     assert(strEQ(category_names[LC_TELEPHONE_INDEX], "LC_TELEPHONE"));
3023 #      ifdef USE_POSIX_2008_LOCALE
3024     assert(category_masks[LC_TELEPHONE_INDEX] == LC_TELEPHONE_MASK);
3025 #      endif
3026 #    endif
3027 #    ifdef LC_ALL
3028     assert(categories[LC_ALL_INDEX] == LC_ALL);
3029     assert(strEQ(category_names[LC_ALL_INDEX], "LC_ALL"));
3030     assert(NOMINAL_LC_ALL_INDEX == LC_ALL_INDEX);
3031 #      ifdef USE_POSIX_2008_LOCALE
3032     assert(category_masks[LC_ALL_INDEX] == LC_ALL_MASK);
3033 #      endif
3034 #    endif
3035 #  endif    /* DEBUGGING */
3036
3037     /* Initialize the cache of the program's UTF-8ness for the always known
3038      * locales C and POSIX */
3039     my_strlcpy(PL_locale_utf8ness, C_and_POSIX_utf8ness,
3040                sizeof(PL_locale_utf8ness));
3041
3042 #  ifdef USE_THREAD_SAFE_LOCALE
3043 #    ifdef WIN32
3044
3045     _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
3046
3047 #    endif
3048 #  endif
3049 #  if defined(LC_ALL_MASK) && defined(HAS_POSIX_2008_LOCALE)
3050
3051     PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", (locale_t) 0);
3052     if (! PL_C_locale_obj) {
3053         Perl_croak_nocontext(
3054             "panic: Cannot create POSIX 2008 C locale object; errno=%d", errno);
3055     }
3056     if (DEBUG_Lv_TEST || debug_initialization) {
3057         PerlIO_printf(Perl_debug_log, "%s:%d: created C object %p\n", __FILE__, __LINE__, PL_C_locale_obj);
3058     }
3059
3060 #  endif
3061
3062     PL_numeric_radix_sv = newSVpvs(".");
3063
3064 #  if defined(USE_POSIX_2008_LOCALE) && ! defined(HAS_QUERYLOCALE)
3065
3066     /* Initialize our records.  If we have POSIX 2008, we have LC_ALL */
3067     do_setlocale_c(LC_ALL, my_setlocale(LC_ALL, NULL));
3068
3069 #  endif
3070 #  ifdef LOCALE_ENVIRON_REQUIRED
3071
3072     /*
3073      * Ultrix setlocale(..., "") fails if there are no environment
3074      * variables from which to get a locale name.
3075      */
3076
3077 #    ifndef LC_ALL
3078 #      error Ultrix without LC_ALL not implemented
3079 #    else
3080
3081     {
3082         bool done = FALSE;
3083         if (lang) {
3084             sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, setlocale_init);
3085             DEBUG_LOCALE_INIT(LC_ALL, setlocale_init, sl_result[LC_ALL_INDEX]);
3086             if (sl_result[LC_ALL_INDEX])
3087                 done = TRUE;
3088             else
3089                 setlocale_failure = TRUE;
3090         }
3091         if (! setlocale_failure) {
3092             const char * locale_param;
3093             for (i = 0; i < LC_ALL_INDEX; i++) {
3094                 locale_param = (! done && (lang || PerlEnv_getenv(category_names[i])))
3095                             ? setlocale_init
3096                             : NULL;
3097                 sl_result[i] = do_setlocale_r(categories[i], locale_param);
3098                 if (! sl_result[i]) {
3099                     setlocale_failure = TRUE;
3100                 }
3101                 DEBUG_LOCALE_INIT(categories[i], locale_param, sl_result[i]);
3102             }
3103         }
3104     }
3105
3106 #    endif /* LC_ALL */
3107 #  endif /* LOCALE_ENVIRON_REQUIRED */
3108
3109     /* We try each locale in the list until we get one that works, or exhaust
3110      * the list.  Normally the loop is executed just once.  But if setting the
3111      * locale fails, inside the loop we add fallback trials to the array and so
3112      * will execute the loop multiple times */
3113     trial_locales[0] = setlocale_init;
3114     trial_locales_count = 1;
3115
3116     for (i= 0; i < trial_locales_count; i++) {
3117         const char * trial_locale = trial_locales[i];
3118
3119         if (i > 0) {
3120
3121             /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED
3122              * when i==0, but I (khw) don't think that behavior makes much
3123              * sense */
3124             setlocale_failure = FALSE;
3125
3126 #  ifdef SYSTEM_DEFAULT_LOCALE
3127 #    ifdef WIN32    /* Note that assumes Win32 has LC_ALL */
3128
3129             /* On Windows machines, an entry of "" after the 0th means to use
3130              * the system default locale, which we now proceed to get. */
3131             if (strEQ(trial_locale, "")) {
3132                 unsigned int j;
3133
3134                 /* Note that this may change the locale, but we are going to do
3135                  * that anyway just below */
3136                 system_default_locale = do_setlocale_c(LC_ALL, "");
3137                 DEBUG_LOCALE_INIT(LC_ALL, "", system_default_locale);
3138
3139                 /* Skip if invalid or if it's already on the list of locales to
3140                  * try */
3141                 if (! system_default_locale) {
3142                     goto next_iteration;
3143                 }
3144                 for (j = 0; j < trial_locales_count; j++) {
3145                     if (strEQ(system_default_locale, trial_locales[j])) {
3146                         goto next_iteration;
3147                     }
3148                 }
3149
3150                 trial_locale = system_default_locale;
3151             }
3152 #    else
3153 #      error SYSTEM_DEFAULT_LOCALE only implemented for Win32
3154 #    endif
3155 #  endif /* SYSTEM_DEFAULT_LOCALE */
3156
3157         }   /* For i > 0 */
3158
3159 #  ifdef LC_ALL
3160
3161         sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, trial_locale);
3162         DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result[LC_ALL_INDEX]);
3163         if (! sl_result[LC_ALL_INDEX]) {
3164             setlocale_failure = TRUE;
3165         }
3166         else {
3167             /* Since LC_ALL succeeded, it should have changed all the other
3168              * categories it can to its value; so we massage things so that the
3169              * setlocales below just return their category's current values.
3170              * This adequately handles the case in NetBSD where LC_COLLATE may
3171              * not be defined for a locale, and setting it individually will
3172              * fail, whereas setting LC_ALL succeeds, leaving LC_COLLATE set to
3173              * the POSIX locale. */
3174             trial_locale = NULL;
3175         }
3176
3177 #  endif /* LC_ALL */
3178
3179         if (! setlocale_failure) {
3180             unsigned int j;
3181             for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3182                 curlocales[j]
3183                         = savepv(do_setlocale_r(categories[j], trial_locale));
3184                 if (! curlocales[j]) {
3185                     setlocale_failure = TRUE;
3186                 }
3187                 DEBUG_LOCALE_INIT(categories[j], trial_locale, curlocales[j]);
3188             }
3189
3190             if (! setlocale_failure) {  /* All succeeded */
3191                 break;  /* Exit trial_locales loop */
3192             }
3193         }
3194
3195         /* Here, something failed; will need to try a fallback. */
3196         ok = 0;
3197
3198         if (i == 0) {
3199             unsigned int j;
3200
3201             if (locwarn) { /* Output failure info only on the first one */
3202
3203 #  ifdef LC_ALL
3204
3205                 PerlIO_printf(Perl_error_log,
3206                 "perl: warning: Setting locale failed.\n");
3207
3208 #  else /* !LC_ALL */
3209
3210                 PerlIO_printf(Perl_error_log,
3211                 "perl: warning: Setting locale failed for the categories:\n\t");
3212
3213                 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3214                     if (! curlocales[j]) {
3215                         PerlIO_printf(Perl_error_log, category_names[j]);
3216                     }
3217                     else {
3218                         Safefree(curlocales[j]);
3219                     }
3220                 }
3221
3222 #  endif /* LC_ALL */
3223
3224                 PerlIO_printf(Perl_error_log,
3225                     "perl: warning: Please check that your locale settings:\n");
3226
3227 #  ifdef __GLIBC__
3228
3229                 PerlIO_printf(Perl_error_log,
3230                             "\tLANGUAGE = %c%s%c,\n",
3231                             language ? '"' : '(',
3232                             language ? language : "unset",
3233                             language ? '"' : ')');
3234 #  endif
3235
3236                 PerlIO_printf(Perl_error_log,
3237                             "\tLC_ALL = %c%s%c,\n",
3238                             lc_all ? '"' : '(',
3239                             lc_all ? lc_all : "unset",
3240                             lc_all ? '"' : ')');
3241
3242 #  if defined(USE_ENVIRON_ARRAY)
3243
3244                 {
3245                     char **e;
3246
3247                     /* Look through the environment for any variables of the
3248                      * form qr/ ^ LC_ [A-Z]+ = /x, except LC_ALL which was
3249                      * already handled above.  These are assumed to be locale
3250                      * settings.  Output them and their values. */
3251                     for (e = environ; *e; e++) {
3252                         const STRLEN prefix_len = sizeof("LC_") - 1;
3253                         STRLEN uppers_len;
3254
3255                         if (     strBEGINs(*e, "LC_")
3256                             && ! strBEGINs(*e, "LC_ALL=")
3257                             && (uppers_len = strspn(*e + prefix_len,
3258                                              "ABCDEFGHIJKLMNOPQRSTUVWXYZ"))
3259                             && ((*e)[prefix_len + uppers_len] == '='))
3260                         {
3261                             PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
3262                                 (int) (prefix_len + uppers_len), *e,
3263                                 *e + prefix_len + uppers_len + 1);
3264                         }
3265                     }
3266                 }
3267
3268 #  else
3269
3270                 PerlIO_printf(Perl_error_log,
3271                             "\t(possibly more locale environment variables)\n");
3272
3273 #  endif
3274
3275                 PerlIO_printf(Perl_error_log,
3276                             "\tLANG = %c%s%c\n",
3277                             lang ? '"' : '(',
3278                             lang ? lang : "unset",
3279                             lang ? '"' : ')');
3280
3281                 PerlIO_printf(Perl_error_log,
3282                             "    are supported and installed on your system.\n");
3283             }
3284
3285             /* Calculate what fallback locales to try.  We have avoided this
3286              * until we have to, because failure is quite unlikely.  This will
3287              * usually change the upper bound of the loop we are in.
3288              *
3289              * Since the system's default way of setting the locale has not
3290              * found one that works, We use Perl's defined ordering: LC_ALL,
3291              * LANG, and the C locale.  We don't try the same locale twice, so
3292              * don't add to the list if already there.  (On POSIX systems, the
3293              * LC_ALL element will likely be a repeat of the 0th element "",
3294              * but there's no harm done by doing it explicitly.
3295              *
3296              * Note that this tries the LC_ALL environment variable even on
3297              * systems which have no LC_ALL locale setting.  This may or may
3298              * not have been originally intentional, but there's no real need
3299              * to change the behavior. */
3300             if (lc_all) {
3301                 for (j = 0; j < trial_locales_count; j++) {
3302                     if (strEQ(lc_all, trial_locales[j])) {
3303                         goto done_lc_all;
3304                     }
3305                 }
3306                 trial_locales[trial_locales_count++] = lc_all;
3307             }
3308           done_lc_all:
3309
3310             if (lang) {
3311                 for (j = 0; j < trial_locales_count; j++) {
3312                     if (strEQ(lang, trial_locales[j])) {
3313                         goto done_lang;
3314                     }
3315                 }
3316                 trial_locales[trial_locales_count++] = lang;
3317             }
3318           done_lang:
3319
3320 #  if defined(WIN32) && defined(LC_ALL)
3321
3322             /* For Windows, we also try the system default locale before "C".
3323              * (If there exists a Windows without LC_ALL we skip this because
3324              * it gets too complicated.  For those, the "C" is the next
3325              * fallback possibility).  The "" is the same as the 0th element of
3326              * the array, but the code at the loop above knows to treat it
3327              * differently when not the 0th */
3328             trial_locales[trial_locales_count++] = "";
3329
3330 #  endif
3331
3332             for (j = 0; j < trial_locales_count; j++) {
3333                 if (strEQ("C", trial_locales[j])) {
3334                     goto done_C;
3335                 }
3336             }
3337             trial_locales[trial_locales_count++] = "C";
3338
3339           done_C: ;
3340         }   /* end of first time through the loop */
3341
3342 #  ifdef WIN32
3343
3344       next_iteration: ;
3345
3346 #  endif
3347
3348     }   /* end of looping through the trial locales */
3349
3350     if (ok < 1) {   /* If we tried to fallback */
3351         const char* msg;
3352         if (! setlocale_failure) {  /* fallback succeeded */
3353            msg = "Falling back to";
3354         }
3355         else {  /* fallback failed */
3356             unsigned int j;
3357
3358             /* We dropped off the end of the loop, so have to decrement i to
3359              * get back to the value the last time through */
3360             i--;
3361
3362             ok = -1;
3363             msg = "Failed to fall back to";
3364
3365             /* To continue, we should use whatever values we've got */
3366
3367             for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3368                 Safefree(curlocales[j]);
3369                 curlocales[j] = savepv(do_setlocale_r(categories[j], NULL));
3370                 DEBUG_LOCALE_INIT(categories[j], NULL, curlocales[j]);
3371             }
3372         }
3373
3374         if (locwarn) {
3375             const char * description;
3376             const char * name = "";
3377             if (strEQ(trial_locales[i], "C")) {
3378                 description = "the standard locale";
3379                 name = "C";
3380             }
3381
3382 #  ifdef SYSTEM_DEFAULT_LOCALE
3383
3384             else if (strEQ(trial_locales[i], "")) {
3385                 description = "the system default locale";
3386                 if (system_default_locale) {
3387                     name = system_default_locale;
3388                 }
3389             }
3390
3391 #  endif /* SYSTEM_DEFAULT_LOCALE */
3392
3393             else {
3394                 description = "a fallback locale";
3395                 name = trial_locales[i];
3396             }
3397             if (name && strNE(name, "")) {
3398                 PerlIO_printf(Perl_error_log,
3399                     "perl: warning: %s %s (\"%s\").\n", msg, description, name);
3400             }
3401             else {
3402                 PerlIO_printf(Perl_error_log,
3403                                    "perl: warning: %s %s.\n", msg, description);
3404             }
3405         }
3406     } /* End of tried to fallback */
3407
3408     /* Done with finding the locales; update our records */
3409
3410 #  ifdef USE_LOCALE_CTYPE
3411
3412     new_ctype(curlocales[LC_CTYPE_INDEX]);
3413
3414 #  endif
3415 #  ifdef USE_LOCALE_COLLATE
3416
3417     new_collate(curlocales[LC_COLLATE_INDEX]);
3418
3419 #  endif
3420 #  ifdef USE_LOCALE_NUMERIC
3421
3422     new_numeric(curlocales[LC_NUMERIC_INDEX]);
3423
3424 #  endif
3425
3426     for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
3427
3428 #  if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
3429
3430         /* This caches whether each category's locale is UTF-8 or not.  This
3431          * may involve changing the locale.  It is ok to do this at
3432          * initialization time before any threads have started, but not later
3433          * unless thread-safe operations are used.
3434          * Caching means that if the program heeds our dictate not to change
3435          * locales in threaded applications, this data will remain valid, and
3436          * it may get queried without having to change locales.  If the
3437          * environment is such that all categories have the same locale, this
3438          * isn't needed, as the code will not change the locale; but this
3439          * handles the uncommon case where the environment has disparate
3440          * locales for the categories */
3441         (void) _is_cur_LC_category_utf8(categories[i]);
3442
3443 #  endif
3444
3445         Safefree(curlocales[i]);
3446     }
3447
3448 #  if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE)
3449
3450     /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE
3451      * locale is UTF-8.  The call to new_ctype() just above has already
3452      * calculated the latter value and saved it in PL_in_utf8_CTYPE_locale. If
3453      * both PL_utf8locale and PL_unicode (set by -C or by $ENV{PERL_UNICODE})
3454      * are true, perl.c:S_parse_body() will turn on the PerlIO :utf8 layer on
3455      * STDIN, STDOUT, STDERR, _and_ the default open discipline.  */
3456     PL_utf8locale = PL_in_utf8_CTYPE_locale;
3457
3458     /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
3459        This is an alternative to using the -C command line switch
3460        (the -C if present will override this). */
3461     {
3462          const char *p = PerlEnv_getenv("PERL_UNICODE");
3463          PL_unicode = p ? parse_unicode_opts(&p) : 0;
3464          if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3465              PL_utf8cache = -1;
3466     }
3467
3468 #  endif
3469 #  ifdef __GLIBC__
3470
3471     Safefree(language);
3472
3473 #  endif
3474
3475     Safefree(lc_all);
3476     Safefree(lang);
3477
3478 #endif /* USE_LOCALE */
3479 #ifdef DEBUGGING
3480
3481     /* So won't continue to output stuff */
3482     DEBUG_INITIALIZATION_set(FALSE);
3483
3484 #endif
3485
3486     return ok;
3487 }
3488
3489 #ifdef USE_LOCALE_COLLATE
3490
3491 char *
3492 Perl__mem_collxfrm(pTHX_ const char *input_string,
3493                          STRLEN len,    /* Length of 'input_string' */
3494                          STRLEN *xlen,  /* Set to length of returned string
3495                                            (not including the collation index
3496                                            prefix) */
3497                          bool utf8      /* Is the input in UTF-8? */
3498                    )
3499 {
3500
3501     /* _mem_collxfrm() is a bit like strxfrm() but with two important
3502      * differences. First, it handles embedded NULs. Second, it allocates a bit
3503      * more memory than needed for the transformed data itself.  The real
3504      * transformed data begins at offset COLLXFRM_HDR_LEN.  *xlen is set to
3505      * the length of that, and doesn't include the collation index size.
3506      * Please see sv_collxfrm() to see how this is used. */
3507
3508 #define COLLXFRM_HDR_LEN    sizeof(PL_collation_ix)
3509
3510     char * s = (char *) input_string;
3511     STRLEN s_strlen = strlen(input_string);
3512     char *xbuf = NULL;
3513     STRLEN xAlloc;          /* xalloc is a reserved word in VC */
3514     STRLEN length_in_chars;
3515     bool first_time = TRUE; /* Cleared after first loop iteration */
3516
3517     PERL_ARGS_ASSERT__MEM_COLLXFRM;
3518
3519     /* Must be NUL-terminated */
3520     assert(*(input_string + len) == '\0');
3521
3522     /* If this locale has defective collation, skip */
3523     if (PL_collxfrm_base == 0 && PL_collxfrm_mult == 0) {
3524         DEBUG_L(PerlIO_printf(Perl_debug_log,
3525                       "_mem_collxfrm: locale's collation is defective\n"));
3526         goto bad;
3527     }
3528
3529     /* Replace any embedded NULs with the control that sorts before any others.
3530      * This will give as good as possible results on strings that don't
3531      * otherwise contain that character, but otherwise there may be
3532      * less-than-perfect results with that character and NUL.  This is
3533      * unavoidable unless we replace strxfrm with our own implementation. */
3534     if (UNLIKELY(s_strlen < len)) {   /* Only execute if there is an embedded
3535                                          NUL */
3536         char * e = s + len;
3537         char * sans_nuls;
3538         STRLEN sans_nuls_len;
3539         int try_non_controls;
3540         char this_replacement_char[] = "?\0";   /* Room for a two-byte string,
3541                                                    making sure 2nd byte is NUL.
3542                                                  */
3543         STRLEN this_replacement_len;
3544
3545         /* If we don't know what non-NUL control character sorts lowest for
3546          * this locale, find it */
3547         if (PL_strxfrm_NUL_replacement == '\0') {
3548             int j;
3549             char * cur_min_x = NULL;    /* The min_char's xfrm, (except it also
3550                                            includes the collation index
3551                                            prefixed. */
3552
3553             DEBUG_Lv(PerlIO_printf(Perl_debug_log, "Looking to replace NUL\n"));
3554
3555             /* Unlikely, but it may be that no control will work to replace
3556              * NUL, in which case we instead look for any character.  Controls
3557              * are preferred because collation order is, in general, context
3558              * sensitive, with adjoining characters affecting the order, and
3559              * controls are less likely to have such interactions, allowing the
3560              * NUL-replacement to stand on its own.  (Another way to look at it
3561              * is to imagine what would happen if the NUL were replaced by a
3562              * combining character; it wouldn't work out all that well.) */
3563             for (try_non_controls = 0;
3564                  try_non_controls < 2;
3565                  try_non_controls++)
3566             {
3567                 /* Look through all legal code points (NUL isn't) */
3568                 for (j = 1; j < 256; j++) {
3569                     char * x;       /* j's xfrm plus collation index */
3570                     STRLEN x_len;   /* length of 'x' */
3571                     STRLEN trial_len = 1;
3572                     char cur_source[] = { '\0', '\0' };
3573
3574                     /* Skip non-controls the first time through the loop.  The
3575                      * controls in a UTF-8 locale are the L1 ones */
3576                     if (! try_non_controls && (PL_in_utf8_COLLATE_locale)
3577                                                ? ! isCNTRL_L1(j)
3578                                                : ! isCNTRL_LC(j))
3579                     {
3580                         continue;
3581                     }
3582
3583                     /* Create a 1-char string of the current code point */
3584                     cur_source[0] = (char) j;
3585
3586                     /* Then transform it */
3587                     x = _mem_collxfrm(cur_source, trial_len, &x_len,
3588                                       0 /* The string is not in UTF-8 */);
3589
3590                     /* Ignore any character that didn't successfully transform.
3591                      * */
3592                     if (! x) {
3593                         continue;
3594                     }
3595
3596                     /* If this character's transformation is lower than
3597                      * the current lowest, this one becomes the lowest */
3598                     if (   cur_min_x == NULL
3599                         || strLT(x         + COLLXFRM_HDR_LEN,
3600                                  cur_min_x + COLLXFRM_HDR_LEN))
3601                     {
3602                         PL_strxfrm_NUL_replacement = j;
3603                         cur_min_x = x;
3604                     }
3605                     else {
3606                         Safefree(x);
3607                     }
3608                 } /* end of loop through all 255 characters */
3609
3610                 /* Stop looking if found */
3611                 if (cur_min_x) {
3612                     break;
3613                 }
3614
3615                 /* Unlikely, but possible, if there aren't any controls that
3616                  * work in the locale, repeat the loop, looking for any
3617                  * character that works */
3618                 DEBUG_L(PerlIO_printf(Perl_debug_log,
3619                 "_mem_collxfrm: No control worked.  Trying non-controls\n"));
3620             } /* End of loop to try first the controls, then any char */
3621
3622             if (! cur_min_x) {
3623                 DEBUG_L(PerlIO_printf(Perl_debug_log,
3624                     "_mem_collxfrm: Couldn't find any character to replace"
3625                     " embedded NULs in locale %s with", PL_collation_name));
3626                 goto bad;
3627             }
3628
3629             DEBUG_L(PerlIO_printf(Perl_debug_log,
3630                     "_mem_collxfrm: Replacing embedded NULs in locale %s with "
3631                     "0x%02X\n", PL_collation_name, PL_strxfrm_NUL_replacement));
3632
3633             Safefree(cur_min_x);
3634         } /* End of determining the character that is to replace NULs */
3635
3636         /* If the replacement is variant under UTF-8, it must match the
3637          * UTF8-ness of the original */
3638         if ( ! UVCHR_IS_INVARIANT(PL_strxfrm_NUL_replacement) && utf8) {
3639             this_replacement_char[0] =
3640                                 UTF8_EIGHT_BIT_HI(PL_strxfrm_NUL_replacement);
3641             this_replacement_char[1] =
3642                                 UTF8_EIGHT_BIT_LO(PL_strxfrm_NUL_replacement);
3643             this_replacement_len = 2;
3644         }
3645         else {
3646             this_replacement_char[0] = PL_strxfrm_NUL_replacement;
3647             /* this_replacement_char[1] = '\0' was done at initialization */
3648             this_replacement_len = 1;
3649         }
3650
3651         /* The worst case length for the replaced string would be if every
3652          * character in it is NUL.  Multiply that by the length of each
3653          * replacement, and allow for a trailing NUL */
3654         sans_nuls_len = (len * this_replacement_len) + 1;
3655         Newx(sans_nuls, sans_nuls_len, char);
3656         *sans_nuls = '\0';
3657
3658         /* Replace each NUL with the lowest collating control.  Loop until have
3659          * exhausted all the NULs */
3660         while (s + s_strlen < e) {
3661             my_strlcat(sans_nuls, s, sans_nuls_len);
3662
3663             /* Do the actual replacement */
3664             my_strlcat(sans_nuls, this_replacement_char, sans_nuls_len);
3665
3666             /* Move past the input NUL */
3667             s += s_strlen + 1;
3668             s_strlen = strlen(s);
3669         }
3670
3671         /* And add anything that trails the final NUL */
3672         my_strlcat(sans_nuls, s, sans_nuls_len);
3673
3674         /* Switch so below we transform this modified string */
3675         s = sans_nuls;
3676         len = strlen(s);
3677     } /* End of replacing NULs */
3678
3679     /* Make sure the UTF8ness of the string and locale match */
3680     if (utf8 != PL_in_utf8_COLLATE_locale) {
3681         /* XXX convert above Unicode to 10FFFF? */
3682         const char * const t = s;   /* Temporary so we can later find where the
3683                                        input was */
3684
3685         /* Here they don't match.  Change the string's to be what the locale is
3686          * expecting */
3687
3688         if (! utf8) { /* locale is UTF-8, but input isn't; upgrade the input */
3689             s = (char *) bytes_to_utf8((const U8 *) s, &len);
3690             utf8 = TRUE;
3691         }
3692         else {   /* locale is not UTF-8; but input is; downgrade the input */
3693
3694             s = (char *) bytes_from_utf8((const U8 *) s, &len, &utf8);
3695
3696             /* If the downgrade was successful we are done, but if the input
3697              * contains things that require UTF-8 to represent, have to do
3698              * damage control ... */
3699             if (UNLIKELY(utf8)) {
3700
3701                 /* What we do is construct a non-UTF-8 string with
3702                  *  1) the characters representable by a single byte converted
3703                  *     to be so (if necessary);
3704                  *  2) and the rest converted to collate the same as the
3705                  *     highest collating representable character.  That makes
3706                  *     them collate at the end.  This is similar to how we
3707                  *     handle embedded NULs, but we use the highest collating
3708                  *     code point instead of the smallest.  Like the NUL case,
3709                  *     this isn't perfect, but is the best we can reasonably
3710                  *     do.  Every above-255 code point will sort the same as
3711                  *     the highest-sorting 0-255 code point.  If that code
3712                  *     point can combine in a sequence with some other code
3713                  *     points for weight calculations, us changing something to
3714                  *     be it can adversely affect the results.  But in most
3715                  *     cases, it should work reasonably.  And note that this is
3716                  *     really an illegal situation: using code points above 255
3717                  *     on a locale where only 0-255 are valid.  If two strings
3718                  *     sort entirely equal, then the sort order for the
3719                  *     above-255 code points will be in code point order. */
3720
3721                 utf8 = FALSE;
3722
3723                 /* If we haven't calculated the code point with the maximum
3724                  * collating order for this locale, do so now */
3725                 if (! PL_strxfrm_max_cp) {
3726                     int j;
3727
3728                     /* The current transformed string that collates the
3729                      * highest (except it also includes the prefixed collation
3730                      * index. */
3731                     char * cur_max_x = NULL;
3732
3733                     /* Look through all legal code points (NUL isn't) */
3734                     for (j = 1; j < 256; j++) {
3735                         char * x;
3736                         STRLEN x_len;
3737                         char cur_source[] = { '\0', '\0' };
3738
3739                         /* Create a 1-char string of the current code point */
3740                         cur_source[0] = (char) j;
3741
3742                         /* Then transform it */
3743                         x = _mem_collxfrm(cur_source, 1, &x_len, FALSE);
3744
3745                         /* If something went wrong (which it shouldn't), just
3746                          * ignore this code point */
3747                         if (! x) {
3748                             continue;
3749                         }
3750
3751                         /* If this character's transformation is higher than
3752                          * the current highest, this one becomes the highest */
3753                         if (   cur_max_x == NULL
3754                             || strGT(x         + COLLXFRM_HDR_LEN,
3755                                      cur_max_x + COLLXFRM_HDR_LEN))
3756                         {
3757                             PL_strxfrm_max_cp = j;
3758                             cur_max_x = x;
3759                         }
3760                         else {
3761                             Safefree(x);
3762                         }
3763                     }
3764
3765                     if (! cur_max_x) {
3766                         DEBUG_L(PerlIO_printf(Perl_debug_log,
3767                             "_mem_collxfrm: Couldn't find any character to"
3768                             " replace above-Latin1 chars in locale %s with",
3769                             PL_collation_name));
3770                         goto bad;
3771                     }
3772
3773                     DEBUG_L(PerlIO_printf(Perl_debug_log,
3774                             "_mem_collxfrm: highest 1-byte collating character"
3775                             " in locale %s is 0x%02X\n",
3776                             PL_collation_name,
3777                             PL_strxfrm_max_cp));
3778
3779                     Safefree(cur_max_x);
3780                 }
3781
3782                 /* Here we know which legal code point collates the highest.
3783                  * We are ready to construct the non-UTF-8 string.  The length
3784                  * will be at least 1 byte smaller than the input string
3785                  * (because we changed at least one 2-byte character into a
3786                  * single byte), but that is eaten up by the trailing NUL */
3787                 Newx(s, len, char);
3788
3789                 {
3790                     STRLEN i;
3791                     STRLEN d= 0;
3792                     char * e = (char *) t + len;
3793
3794                     for (i = 0; i < len; i+= UTF8SKIP(t + i)) {
3795                         U8 cur_char = t[i];
3796                         if (UTF8_IS_INVARIANT(cur_char)) {
3797                             s[d++] = cur_char;
3798                         }
3799                         else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(t + i, e)) {
3800                             s[d++] = EIGHT_BIT_UTF8_TO_NATIVE(cur_char, t[i+1]);
3801                         }
3802                         else {  /* Replace illegal cp with highest collating
3803                                    one */
3804                             s[d++] = PL_strxfrm_max_cp;
3805                         }
3806                     }
3807                     s[d++] = '\0';
3808                     Renew(s, d, char);   /* Free up unused space */
3809                 }
3810             }
3811         }
3812
3813         /* Here, we have constructed a modified version of the input.  It could
3814          * be that we already had a modified copy before we did this version.
3815          * If so, that copy is no longer needed */
3816         if (t != input_string) {
3817             Safefree(t);
3818         }
3819     }
3820
3821     length_in_chars = (utf8)
3822                       ? utf8_length((U8 *) s, (U8 *) s + len)
3823                       : len;
3824
3825     /* The first element in the output is the collation id, used by
3826      * sv_collxfrm(); then comes the space for the transformed string.  The
3827      * equation should give us a good estimate as to how much is needed */
3828     xAlloc = COLLXFRM_HDR_LEN
3829            + PL_collxfrm_base
3830            + (PL_collxfrm_mult * length_in_chars);
3831     Newx(xbuf, xAlloc, char);
3832     if (UNLIKELY(! xbuf)) {
3833         DEBUG_L(PerlIO_printf(Perl_debug_log,
3834                       "_mem_collxfrm: Couldn't malloc %zu bytes\n", xAlloc));
3835         goto bad;
3836     }
3837
3838     /* Store the collation id */
3839     *(U32*)xbuf = PL_collation_ix;
3840
3841     /* Then the transformation of the input.  We loop until successful, or we
3842      * give up */
3843     for (;;) {
3844
3845         *xlen = strxfrm(xbuf + COLLXFRM_HDR_LEN, s, xAlloc - COLLXFRM_HDR_LEN);
3846
3847         /* If the transformed string occupies less space than we told strxfrm()
3848          * was available, it means it successfully transformed the whole
3849          * string. */
3850         if (*xlen < xAlloc - COLLXFRM_HDR_LEN) {
3851
3852             /* Some systems include a trailing NUL in the returned length.
3853              * Ignore it, using a loop in case multiple trailing NULs are
3854              * returned. */
3855             while (   (*xlen) > 0
3856                    && *(xbuf + COLLXFRM_HDR_LEN + (*xlen) - 1) == '\0')
3857             {
3858                 (*xlen)--;
3859             }
3860
3861             /* If the first try didn't get it, it means our prediction was low.
3862              * Modify the coefficients so that we predict a larger value in any
3863              * future transformations */
3864             if (! first_time) {
3865                 STRLEN needed = *xlen + 1;   /* +1 For trailing NUL */
3866                 STRLEN computed_guess = PL_collxfrm_base
3867                                       + (PL_collxfrm_mult * length_in_chars);
3868
3869                 /* On zero-length input, just keep current slope instead of
3870                  * dividing by 0 */
3871                 const STRLEN new_m = (length_in_chars != 0)
3872                                      ? needed / length_in_chars
3873                                      : PL_collxfrm_mult;
3874
3875                 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
3876                     "%s: %d: initial size of %zu bytes for a length "
3877                     "%zu string was insufficient, %zu needed\n",
3878                     __FILE__, __LINE__,
3879                     computed_guess, length_in_chars, needed));
3880
3881                 /* If slope increased, use it, but discard this result for
3882                  * length 1 strings, as we can't be sure that it's a real slope
3883                  * change */
3884                 if (length_in_chars > 1 && new_m  > PL_collxfrm_mult) {
3885
3886 #  ifdef DEBUGGING
3887
3888                     STRLEN old_m = PL_collxfrm_mult;
3889                     STRLEN old_b = PL_collxfrm_base;
3890
3891 #  endif
3892
3893                     PL_collxfrm_mult = new_m;
3894                     PL_collxfrm_base = 1;   /* +1 For trailing NUL */
3895                     computed_guess = PL_collxfrm_base
3896                                     + (PL_collxfrm_mult * length_in_chars);
3897                     if (computed_guess < needed) {
3898                         PL_collxfrm_base += needed - computed_guess;
3899                     }
3900
3901                     DEBUG_Lv(PerlIO_printf(Perl_debug_log,
3902                         "%s: %d: slope is now %zu; was %zu, base "
3903                         "is now %zu; was %zu\n",
3904                         __FILE__, __LINE__,
3905                         PL_collxfrm_mult, old_m,
3906                         PL_collxfrm_base, old_b));
3907                 }
3908                 else {  /* Slope didn't change, but 'b' did */
3909                     const STRLEN new_b = needed
3910                                         - computed_guess
3911                                         + PL_collxfrm_base;
3912                     DEBUG_Lv(PerlIO_printf(Perl_debug_log,
3913                         "%s: %d: base is now %zu; was %zu\n",
3914                         __FILE__, __LINE__,
3915                         new_b, PL_collxfrm_base));
3916                     PL_collxfrm_base = new_b;
3917                 }
3918             }
3919
3920             break;
3921         }
3922
3923         if (UNLIKELY(*xlen >= PERL_INT_MAX)) {
3924             DEBUG_L(PerlIO_printf(Perl_debug_log,
3925                   "_mem_collxfrm: Needed %zu bytes, max permissible is %u\n",
3926                   *xlen, PERL_INT_MAX));
3927             goto bad;
3928         }
3929
3930         /* A well-behaved strxfrm() returns exactly how much space it needs
3931          * (usually not including the trailing NUL) when it fails due to not
3932          * enough space being provided.  Assume that this is the case unless
3933          * it's been proven otherwise */
3934         if (LIKELY(PL_strxfrm_is_behaved) && first_time) {
3935             xAlloc = *xlen + COLLXFRM_HDR_LEN + 1;
3936         }
3937         else { /* Here, either:
3938                 *  1)  The strxfrm() has previously shown bad behavior; or
3939                 *  2)  It isn't the first time through the loop, which means
3940                 *      that the strxfrm() is now showing bad behavior, because
3941                 *      we gave it what it said was needed in the previous
3942                 *      iteration, and it came back saying it needed still more.
3943                 *      (Many versions of cygwin fit this.  When the buffer size
3944                 *      isn't sufficient, they return the input size instead of
3945                 *      how much is needed.)
3946                 * Increase the buffer size by a fixed percentage and try again.
3947                 * */
3948             xAlloc += (xAlloc / 4) + 1;
3949             PL_strxfrm_is_behaved = FALSE;
3950
3951 #  ifdef DEBUGGING
3952
3953             if (DEBUG_Lv_TEST || debug_initialization) {
3954                 PerlIO_printf(Perl_debug_log,
3955                 "_mem_collxfrm required more space than previously calculated"
3956                 " for locale %s, trying again with new guess=%d+%zu\n",
3957                 PL_collation_name, (int) COLLXFRM_HDR_LEN,
3958                 xAlloc - COLLXFRM_HDR_LEN);
3959             }
3960
3961 #  endif
3962
3963         }
3964
3965         Renew(xbuf, xAlloc, char);
3966         if (UNLIKELY(! xbuf)) {
3967             DEBUG_L(PerlIO_printf(Perl_debug_log,
3968                       "_mem_collxfrm: Couldn't realloc %zu bytes\n", xAlloc));
3969             goto bad;
3970         }
3971
3972         first_time = FALSE;
3973     }
3974
3975
3976 #  ifdef DEBUGGING
3977
3978     if (DEBUG_Lv_TEST || debug_initialization) {
3979
3980         print_collxfrm_input_and_return(s, s + len, xlen, utf8);
3981         PerlIO_printf(Perl_debug_log, "Its xfrm is:");
3982         PerlIO_printf(Perl_debug_log, "%s\n",
3983                       _byte_dump_string((U8 *) xbuf + COLLXFRM_HDR_LEN,
3984                        *xlen, 1));
3985     }
3986
3987 #  endif
3988
3989     /* Free up unneeded space; retain ehough for trailing NUL */
3990     Renew(xbuf, COLLXFRM_HDR_LEN + *xlen + 1, char);
3991
3992     if (s != input_string) {
3993         Safefree(s);
3994     }
3995
3996     return xbuf;
3997
3998   bad:
3999     Safefree(xbuf);
4000     if (s != input_string) {
4001         Safefree(s);
4002     }
4003     *xlen = 0;
4004
4005 #  ifdef DEBUGGING
4006
4007     if (DEBUG_Lv_TEST || debug_initialization) {
4008         print_collxfrm_input_and_return(s, s + len, NULL, utf8);
4009     }
4010
4011 #  endif
4012
4013     return NULL;
4014 }
4015
4016 #  ifdef DEBUGGING
4017
4018 STATIC void
4019 S_print_collxfrm_input_and_return(pTHX_
4020                                   const char * const s,
4021                                   const char * const e,
4022                                   const STRLEN * const xlen,
4023                                   const bool is_utf8)
4024 {
4025
4026     PERL_ARGS_ASSERT_PRINT_COLLXFRM_INPUT_AND_RETURN;
4027
4028     PerlIO_printf(Perl_debug_log, "_mem_collxfrm[%" UVuf "]: returning ",
4029                                                         (UV)PL_collation_ix);
4030     if (xlen) {
4031         PerlIO_printf(Perl_debug_log, "%zu", *xlen);
4032     }
4033     else {
4034         PerlIO_printf(Perl_debug_log, "NULL");
4035     }
4036     PerlIO_printf(Perl_debug_log, " for locale '%s', string='",
4037                                                             PL_collation_name);
4038     print_bytes_for_locale(s, e, is_utf8);
4039
4040     PerlIO_printf(Perl_debug_log, "'\n");
4041 }
4042
4043 STATIC void
4044 S_print_bytes_for_locale(pTHX_
4045                     const char * const s,
4046                     const char * const e,
4047                     const bool is_utf8)
4048 {
4049     const char * t = s;
4050     bool prev_was_printable = TRUE;
4051     bool first_time = TRUE;
4052
4053     PERL_ARGS_ASSERT_PRINT_BYTES_FOR_LOCALE;
4054
4055     while (t < e) {
4056         UV cp = (is_utf8)
4057                 ?  utf8_to_uvchr_buf((U8 *) t, e, NULL)
4058                 : * (U8 *) t;
4059         if (isPRINT(cp)) {
4060             if (! prev_was_printable) {
4061                 PerlIO_printf(Perl_debug_log, " ");
4062             }
4063             PerlIO_printf(Perl_debug_log, "%c", (U8) cp);
4064             prev_was_printable = TRUE;
4065         }
4066         else {
4067             if (! first_time) {
4068                 PerlIO_printf(Perl_debug_log, " ");
4069             }
4070             PerlIO_printf(Perl_debug_log, "%02" UVXf, cp);
4071             prev_was_printable = FALSE;
4072         }
4073         t += (is_utf8) ? UTF8SKIP(t) : 1;
4074         first_time = FALSE;
4075     }
4076 }
4077
4078 #  endif   /* #ifdef DEBUGGING */
4079 #endif /* USE_LOCALE_COLLATE */
4080
4081 #ifdef USE_LOCALE
4082
4083 STATIC const char *
4084 S_switch_category_locale_to_template(pTHX_ const int switch_category, const int template_category, const char * template_locale)
4085 {
4086     /* Changes the locale for LC_'switch_category" to that of
4087      * LC_'template_category', if they aren't already the same.  If not NULL,
4088      * 'template_locale' is the locale that 'template_category' is in.
4089      *
4090      * Returns a copy of the name of the original locale for 'switch_category'
4091      * so can be switched back to with the companion function
4092      * restore_switched_locale(),  (NULL if no restoral is necessary.) */
4093
4094     char * restore_to_locale = NULL;
4095
4096     if (switch_category == template_category) { /* No changes needed */
4097         return NULL;
4098     }
4099
4100     /* Find the original locale of the category we may need to change, so that
4101      * it can be restored to later */
4102     restore_to_locale = stdize_locale(savepv(do_setlocale_r(switch_category,
4103                                                             NULL)));
4104     if (! restore_to_locale) {
4105         Perl_croak(aTHX_
4106              "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4107                 __FILE__, __LINE__, category_name(switch_category), errno);
4108     }
4109
4110     /* If the locale of the template category wasn't passed in, find it now */
4111     if (template_locale == NULL) {
4112         template_locale = do_setlocale_r(template_category, NULL);
4113         if (! template_locale) {
4114             Perl_croak(aTHX_
4115              "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4116                    __FILE__, __LINE__, category_name(template_category), errno);
4117         }
4118     }
4119
4120     /* It the locales are the same, there's nothing to do */
4121     if (strEQ(restore_to_locale, template_locale)) {
4122         Safefree(restore_to_locale);
4123
4124         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale unchanged as %s\n",
4125                             category_name(switch_category), restore_to_locale));
4126
4127         return NULL;
4128     }
4129
4130     /* Finally, change the locale to the template one */
4131     if (! do_setlocale_r(switch_category, template_locale)) {
4132         Perl_croak(aTHX_
4133          "panic: %s: %d: Could not change %s locale to %s, errno=%d\n",
4134                             __FILE__, __LINE__, category_name(switch_category),
4135                                                        template_locale, errno);
4136     }
4137
4138     DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale switched to %s\n",
4139                             category_name(switch_category), template_locale));
4140
4141     return restore_to_locale;
4142 }
4143
4144 STATIC void
4145 S_restore_switched_locale(pTHX_ const int category, const char * const original_locale)
4146 {
4147     /* Restores the locale for LC_'category' to 'original_locale' (which is a
4148      * copy that will be freed by this function), or do nothing if the latter
4149      * parameter is NULL */
4150
4151     if (original_locale == NULL) {
4152         return;
4153     }
4154
4155     if (! do_setlocale_r(category, original_locale)) {
4156         Perl_croak(aTHX_
4157              "panic: %s: %d: setlocale %s restore to %s failed, errno=%d\n",
4158                  __FILE__, __LINE__,
4159                              category_name(category), original_locale, errno);
4160     }
4161
4162     Safefree(original_locale);
4163 }
4164
4165 bool
4166 Perl__is_cur_LC_category_utf8(pTHX_ int category)
4167 {
4168     /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE
4169      * otherwise. 'category' may not be LC_ALL.  If the platform doesn't have
4170      * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence
4171      * could give the wrong result.  The result will very likely be correct for
4172      * languages that have commonly used non-ASCII characters, but for notably
4173      * English, it comes down to if the locale's name ends in something like
4174      * "UTF-8".  It errs on the side of not being a UTF-8 locale.
4175      *
4176      * If the platform is early C89, not containing mbtowc(), or we are
4177      * compiled to not pay attention to LC_CTYPE, this employs heuristics.
4178      * These work very well for non-Latin locales or those whose currency
4179      * symbol isn't a '$' nor plain ASCII text.  But without LC_CTYPE and at
4180      * least MB_CUR_MAX, English locales with an ASCII currency symbol depend
4181      * on the name containing UTF-8 or not. */
4182
4183     /* Name of current locale corresponding to the input category */
4184     const char *save_input_locale = NULL;
4185
4186     bool is_utf8 = FALSE;                /* The return value */
4187
4188     /* The variables below are for the cache of previous lookups using this
4189      * function.  The cache is a C string, described at the definition for
4190      * 'C_and_POSIX_utf8ness'.
4191      *
4192      * The first part of the cache is fixed, for the C and POSIX locales.  The
4193      * varying part starts just after them. */
4194     char * utf8ness_cache = PL_locale_utf8ness + STRLENs(C_and_POSIX_utf8ness);
4195
4196     Size_t utf8ness_cache_size; /* Size of the varying portion */
4197     Size_t input_name_len;      /* Length in bytes of save_input_locale */
4198     Size_t input_name_len_with_overhead;    /* plus extra chars used to store
4199                                                the name in the cache */
4200     char * delimited;           /* The name plus the delimiters used to store
4201                                    it in the cache */
4202     char * name_pos;            /* position of 'delimited' in the cache, or 0
4203                                    if not there */
4204
4205
4206 #  ifdef LC_ALL
4207
4208     assert(category != LC_ALL);
4209
4210 #  endif
4211
4212     /* Get the desired category's locale */
4213     save_input_locale = stdize_locale(savepv(do_setlocale_r(category, NULL)));
4214     if (! save_input_locale) {
4215         Perl_croak(aTHX_
4216              "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4217                      __FILE__, __LINE__, category_name(category), errno);
4218     }
4219
4220     DEBUG_L(PerlIO_printf(Perl_debug_log,
4221                           "Current locale for %s is %s\n",
4222                           category_name(category), save_input_locale));
4223
4224     input_name_len = strlen(save_input_locale);
4225
4226     /* In our cache, each name is accompanied by two delimiters and a single
4227      * utf8ness digit */
4228     input_name_len_with_overhead = input_name_len + 3;
4229
4230     /* Allocate and populate space for a copy of the name surrounded by the
4231      * delimiters */
4232     Newx(delimited, input_name_len_with_overhead, char);
4233     delimited[0] = UTF8NESS_SEP[0];
4234     Copy(save_input_locale, delimited + 1, input_name_len, char);
4235     delimited[input_name_len+1] = UTF8NESS_PREFIX[0];
4236     delimited[input_name_len+2] = '\0';
4237
4238     /* And see if that is in the cache */
4239     name_pos = instr(PL_locale_utf8ness, delimited);
4240     if (name_pos) {
4241         is_utf8 = *(name_pos + input_name_len_with_overhead - 1) - '0';
4242
4243 #  ifdef DEBUGGING
4244
4245         if (DEBUG_Lv_TEST || debug_initialization) {
4246             PerlIO_printf(Perl_debug_log, "UTF8ness for locale %s=%d, \n",
4247                                           save_input_locale, is_utf8);
4248         }
4249
4250 #  endif
4251
4252         /* And, if not already in that position, move it to the beginning of
4253          * the non-constant portion of the list, since it is the most recently
4254          * used.  (We don't have to worry about overflow, since just moving
4255          * existing names around) */
4256         if (name_pos > utf8ness_cache) {
4257             Move(utf8ness_cache,
4258                  utf8ness_cache + input_name_len_with_overhead,
4259                  name_pos - utf8ness_cache, char);
4260             Copy(delimited,
4261                  utf8ness_cache,
4262                  input_name_len_with_overhead - 1, char);
4263             utf8ness_cache[input_name_len_with_overhead - 1] = is_utf8 + '0';
4264         }
4265
4266         Safefree(delimited);
4267         Safefree(save_input_locale);
4268         return is_utf8;
4269     }
4270
4271     /* Here we don't have stored the utf8ness for the input locale.  We have to
4272      * calculate it */
4273
4274 #  if        defined(USE_LOCALE_CTYPE)                                  \
4275      && (    defined(HAS_NL_LANGINFO)                                   \
4276          || (defined(HAS_MBTOWC) || defined(HAS_MBRTOWC)))
4277
4278     {
4279         const char *original_ctype_locale
4280                         = switch_category_locale_to_template(LC_CTYPE,
4281                                                              category,
4282                                                              save_input_locale);
4283
4284         /* Here the current LC_CTYPE is set to the locale of the category whose
4285          * information is desired.  This means that nl_langinfo() and mbtowc()
4286          * should give the correct results */
4287
4288 #    ifdef MB_CUR_MAX  /* But we can potentially rule out UTF-8ness, avoiding
4289                           calling the functions if we have this */
4290
4291             /* Standard UTF-8 needs at least 4 bytes to represent the maximum
4292              * Unicode code point. */
4293
4294             DEBUG_L(PerlIO_printf(Perl_debug_log, "%s: %d: MB_CUR_MAX=%d\n",
4295                                        __FILE__, __LINE__, (int) MB_CUR_MAX));
4296             if ((unsigned) MB_CUR_MAX < STRLENs(MAX_UNICODE_UTF8)) {
4297                 is_utf8 = FALSE;
4298                 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4299                 goto finish_and_return;
4300             }
4301
4302 #    endif
4303 #    if defined(HAS_NL_LANGINFO)
4304
4305         { /* The t