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