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