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