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