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