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