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