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