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