This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
locale.c: Free over-allocated space early
[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 generally doesn't pay any
27  * 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.h"
40
41 #ifdef I_LANGINFO
42 #   include <langinfo.h>
43 #endif
44
45 #include "reentr.h"
46
47 #ifdef USE_LOCALE
48
49 /*
50  * Standardize the locale name from a string returned by 'setlocale', possibly
51  * modifying that string.
52  *
53  * The typical return value of setlocale() is either
54  * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
55  * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
56  *     (the space-separated values represent the various sublocales,
57  *      in some unspecified order).  This is not handled by this function.
58  *
59  * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
60  * which is harmful for further use of the string in setlocale().  This
61  * function removes the trailing new line and everything up through the '='
62  *
63  */
64 STATIC char *
65 S_stdize_locale(pTHX_ char *locs)
66 {
67     const char * const s = strchr(locs, '=');
68     bool okay = TRUE;
69
70     PERL_ARGS_ASSERT_STDIZE_LOCALE;
71
72     if (s) {
73         const char * const t = strchr(s, '.');
74         okay = FALSE;
75         if (t) {
76             const char * const u = strchr(t, '\n');
77             if (u && (u[1] == 0)) {
78                 const STRLEN len = u - s;
79                 Move(s + 1, locs, len, char);
80                 locs[len] = 0;
81                 okay = TRUE;
82             }
83         }
84     }
85
86     if (!okay)
87         Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
88
89     return locs;
90 }
91
92 #endif
93
94 void
95 Perl_set_numeric_radix(pTHX)
96 {
97 #ifdef USE_LOCALE_NUMERIC
98 # ifdef HAS_LOCALECONV
99     const struct lconv* const lc = localeconv();
100
101     if (lc && lc->decimal_point) {
102         if (lc->decimal_point[0] == '.' && lc->decimal_point[1] == 0) {
103             SvREFCNT_dec(PL_numeric_radix_sv);
104             PL_numeric_radix_sv = NULL;
105         }
106         else {
107             if (PL_numeric_radix_sv)
108                 sv_setpv(PL_numeric_radix_sv, lc->decimal_point);
109             else
110                 PL_numeric_radix_sv = newSVpv(lc->decimal_point, 0);
111             if (! is_invariant_string((U8 *) lc->decimal_point, 0)
112                 && is_utf8_string((U8 *) lc->decimal_point, 0)
113                 && _is_cur_LC_category_utf8(LC_NUMERIC))
114             {
115                 SvUTF8_on(PL_numeric_radix_sv);
116             }
117         }
118     }
119     else
120         PL_numeric_radix_sv = NULL;
121
122     DEBUG_L(PerlIO_printf(Perl_debug_log, "Locale radix is '%s', ?UTF-8=%d\n",
123                                           (PL_numeric_radix_sv)
124                                            ? SvPVX(PL_numeric_radix_sv)
125                                            : "NULL",
126                                           (PL_numeric_radix_sv)
127                                            ? cBOOL(SvUTF8(PL_numeric_radix_sv))
128                                            : 0));
129
130 # endif /* HAS_LOCALECONV */
131 #endif /* USE_LOCALE_NUMERIC */
132 }
133
134 /* Is the C string input 'name' "C" or "POSIX"?  If so, and 'name' is the
135  * return of setlocale(), then this is extremely likely to be the C or POSIX
136  * locale.  However, the output of setlocale() is documented to be opaque, but
137  * the odds are extremely small that it would return these two strings for some
138  * other locale.  Note that VMS in these two locales includes many non-ASCII
139  * characters as controls and punctuation (below are hex bytes):
140  *   cntrl:  00-1F 7F 84-97 9B-9F
141  *   punct:  21-2F 3A-40 5B-60 7B-7E A1-A3 A5 A7-AB B0-B3 B5-B7 B9-BD BF-CF D1-DD DF-EF F1-FD
142  * Oddly, none there are listed as alphas, though some represent alphabetics
143  * http://www.nntp.perl.org/group/perl.perl5.porters/2013/02/msg198753.html */
144 #define isNAME_C_OR_POSIX(name) ((name) != NULL                                 \
145                                   && ((*(name) == 'C' && (*(name + 1)) == '\0') \
146                                        || strEQ((name), "POSIX")))
147
148 void
149 Perl_new_numeric(pTHX_ const char *newnum)
150 {
151 #ifdef USE_LOCALE_NUMERIC
152
153     /* Called after all libc setlocale() calls affecting LC_NUMERIC, to tell
154      * core Perl this and that 'newnum' is the name of the new locale.
155      * It installs this locale as the current underlying default.
156      *
157      * The default locale and the C locale can be toggled between by use of the
158      * set_numeric_local() and set_numeric_standard() functions, which should
159      * probably not be called directly, but only via macros like
160      * SET_NUMERIC_STANDARD() in perl.h.
161      *
162      * The toggling is necessary mainly so that a non-dot radix decimal point
163      * character can be output, while allowing internal calculations to use a
164      * dot.
165      *
166      * This sets several interpreter-level variables:
167      * PL_numeric_name  The underlying locale's name: a copy of 'newnum'
168      * PL_numeric_local A boolean indicating if the toggled state is such
169      *                  that the current locale is the program's underlying
170      *                  locale
171      * PL_numeric_standard An int indicating if the toggled state is such
172      *                  that the current locale is the C locale.  If non-zero,
173      *                  it is in C; if > 1, it means it may not be toggled away
174      *                  from C.
175      * Note that both of the last two variables can be true at the same time,
176      * if the underlying locale is C.  (Toggling is a no-op under these
177      * circumstances.)
178      *
179      * Any code changing the locale (outside this file) should use
180      * POSIX::setlocale, which calls this function.  Therefore this function
181      * should be called directly only from this file and from
182      * POSIX::setlocale() */
183
184     char *save_newnum;
185
186     if (! newnum) {
187         Safefree(PL_numeric_name);
188         PL_numeric_name = NULL;
189         PL_numeric_standard = TRUE;
190         PL_numeric_local = TRUE;
191         return;
192     }
193
194     save_newnum = stdize_locale(savepv(newnum));
195
196     PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
197     PL_numeric_local = TRUE;
198
199     if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
200         Safefree(PL_numeric_name);
201         PL_numeric_name = save_newnum;
202     }
203     else {
204         Safefree(save_newnum);
205     }
206
207     /* Keep LC_NUMERIC in the C locale.  This is for XS modules, so they don't
208      * have to worry about the radix being a non-dot.  (Core operations that
209      * need the underlying locale change to it temporarily). */
210     set_numeric_standard();
211
212     set_numeric_radix();
213
214 #else
215     PERL_UNUSED_ARG(newnum);
216 #endif /* USE_LOCALE_NUMERIC */
217 }
218
219 void
220 Perl_set_numeric_standard(pTHX)
221 {
222 #ifdef USE_LOCALE_NUMERIC
223     /* Toggle the LC_NUMERIC locale to C.  Most code should use the macros like
224      * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly.  The
225      * macro avoids calling this routine if toggling isn't necessary according
226      * to our records (which could be wrong if some XS code has changed the
227      * locale behind our back) */
228
229     setlocale(LC_NUMERIC, "C");
230     PL_numeric_standard = TRUE;
231     PL_numeric_local = isNAME_C_OR_POSIX(PL_numeric_name);
232     set_numeric_radix();
233     DEBUG_L(PerlIO_printf(Perl_debug_log,
234                           "Underlying LC_NUMERIC locale now is C\n"));
235
236 #endif /* USE_LOCALE_NUMERIC */
237 }
238
239 void
240 Perl_set_numeric_local(pTHX)
241 {
242 #ifdef USE_LOCALE_NUMERIC
243     /* Toggle the LC_NUMERIC locale to the current underlying default.  Most
244      * code should use the macros like SET_NUMERIC_LOCAL() in perl.h instead of
245      * calling this directly.  The macro avoids calling this routine if
246      * toggling isn't necessary according to our records (which could be wrong
247      * if some XS code has changed the locale behind our back) */
248
249     setlocale(LC_NUMERIC, PL_numeric_name);
250     PL_numeric_standard = isNAME_C_OR_POSIX(PL_numeric_name);
251     PL_numeric_local = TRUE;
252     set_numeric_radix();
253     DEBUG_L(PerlIO_printf(Perl_debug_log,
254                           "Underlying LC_NUMERIC locale now is %s\n",
255                           PL_numeric_name));
256
257 #endif /* USE_LOCALE_NUMERIC */
258 }
259
260 /*
261  * Set up for a new ctype locale.
262  */
263 void
264 Perl_new_ctype(pTHX_ const char *newctype)
265 {
266 #ifdef USE_LOCALE_CTYPE
267
268     /* Called after all libc setlocale() calls affecting LC_CTYPE, to tell
269      * core Perl this and that 'newctype' is the name of the new locale.
270      *
271      * This function sets up the folding arrays for all 256 bytes, assuming
272      * that tofold() is tolc() since fold case is not a concept in POSIX,
273      *
274      * Any code changing the locale (outside this file) should use
275      * POSIX::setlocale, which calls this function.  Therefore this function
276      * should be called directly only from this file and from
277      * POSIX::setlocale() */
278
279     dVAR;
280     UV i;
281
282     PERL_ARGS_ASSERT_NEW_CTYPE;
283
284     /* We will replace any bad locale warning with 1) nothing if the new one is
285      * ok; or 2) a new warning for the bad new locale */
286     if (PL_warn_locale) {
287         SvREFCNT_dec_NN(PL_warn_locale);
288         PL_warn_locale = NULL;
289     }
290
291     PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE);
292
293     /* A UTF-8 locale gets standard rules.  But note that code still has to
294      * handle this specially because of the three problematic code points */
295     if (PL_in_utf8_CTYPE_locale) {
296         Copy(PL_fold_latin1, PL_fold_locale, 256, U8);
297     }
298     else {
299         /* Assume enough space for every character being bad.  4 spaces each
300          * for the 94 printable characters that are output like "'x' "; and 5
301          * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating
302          * NUL */
303         char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ];
304
305         bool check_for_problems = ckWARN_d(WARN_LOCALE); /* No warnings means
306                                                             no check */
307         bool multi_byte_locale = FALSE;     /* Assume is a single-byte locale
308                                                to start */
309         unsigned int bad_count = 0;         /* Count of bad characters */
310
311         for (i = 0; i < 256; i++) {
312             if (isUPPER_LC((U8) i))
313                 PL_fold_locale[i] = (U8) toLOWER_LC((U8) i);
314             else if (isLOWER_LC((U8) i))
315                 PL_fold_locale[i] = (U8) toUPPER_LC((U8) i);
316             else
317                 PL_fold_locale[i] = (U8) i;
318
319             /* If checking for locale problems, see if the native ASCII-range
320              * printables plus \n and \t are in their expected categories in
321              * the new locale.  If not, this could mean big trouble, upending
322              * Perl's and most programs' assumptions, like having a
323              * metacharacter with special meaning become a \w.  Fortunately,
324              * it's very rare to find locales that aren't supersets of ASCII
325              * nowadays.  It isn't a problem for most controls to be changed
326              * into something else; we check only \n and \t, though perhaps \r
327              * could be an issue as well. */
328             if (check_for_problems
329                 && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n'))
330             {
331                 if ((isALPHANUMERIC_A(i) && ! isALPHANUMERIC_LC(i))
332                      || (isPUNCT_A(i) && ! isPUNCT_LC(i))
333                      || (isBLANK_A(i) && ! isBLANK_LC(i))
334                      || (i == '\n' && ! isCNTRL_LC(i)))
335                 {
336                     if (bad_count) {    /* Separate multiple entries with a
337                                            blank */
338                         bad_chars_list[bad_count++] = ' ';
339                     }
340                     bad_chars_list[bad_count++] = '\'';
341                     if (isPRINT_A(i)) {
342                         bad_chars_list[bad_count++] = (char) i;
343                     }
344                     else {
345                         bad_chars_list[bad_count++] = '\\';
346                         if (i == '\n') {
347                             bad_chars_list[bad_count++] = 'n';
348                         }
349                         else {
350                             assert(i == '\t');
351                             bad_chars_list[bad_count++] = 't';
352                         }
353                     }
354                     bad_chars_list[bad_count++] = '\'';
355                     bad_chars_list[bad_count] = '\0';
356                 }
357             }
358         }
359
360 #ifdef MB_CUR_MAX
361         /* We only handle single-byte locales (outside of UTF-8 ones; so if
362          * this locale requires more than one byte, there are going to be
363          * problems. */
364         if (check_for_problems && MB_CUR_MAX > 1
365
366                /* Some platforms return MB_CUR_MAX > 1 for even the "C"
367                 * locale.  Just assume that the implementation for them (plus
368                 * for POSIX) is correct and the > 1 value is spurious.  (Since
369                 * these are specially handled to never be considered UTF-8
370                 * locales, as long as this is the only problem, everything
371                 * should work fine */
372             && strNE(newctype, "C") && strNE(newctype, "POSIX"))
373         {
374             multi_byte_locale = TRUE;
375         }
376 #endif
377
378         if (bad_count || multi_byte_locale) {
379             PL_warn_locale = Perl_newSVpvf(aTHX_
380                              "Locale '%s' may not work well.%s%s%s\n",
381                              newctype,
382                              (multi_byte_locale)
383                               ? "  Some characters in it are not recognized by"
384                                 " Perl."
385                               : "",
386                              (bad_count)
387                               ? "\nThe following characters (and maybe others)"
388                                 " may not have the same meaning as the Perl"
389                                 " program expects:\n"
390                               : "",
391                              (bad_count)
392                               ? bad_chars_list
393                               : ""
394                             );
395             /* If we are actually in the scope of the locale, output the
396              * message now.  Otherwise we save it to be output at the first
397              * operation using this locale, if that actually happens.  Most
398              * programs don't use locales, so they are immune to bad ones */
399             if (IN_LC(LC_CTYPE)) {
400
401                 /* We have to save 'newctype' because the setlocale() just
402                  * below may destroy it.  The next setlocale() further down
403                  * should restore it properly so that the intermediate change
404                  * here is transparent to this function's caller */
405                 const char * const badlocale = savepv(newctype);
406
407                 setlocale(LC_CTYPE, "C");
408
409                 /* The '0' below suppresses a bogus gcc compiler warning */
410                 Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0);
411                 setlocale(LC_CTYPE, badlocale);
412                 Safefree(badlocale);
413                 SvREFCNT_dec_NN(PL_warn_locale);
414                 PL_warn_locale = NULL;
415             }
416         }
417     }
418
419 #endif /* USE_LOCALE_CTYPE */
420     PERL_ARGS_ASSERT_NEW_CTYPE;
421     PERL_UNUSED_ARG(newctype);
422     PERL_UNUSED_CONTEXT;
423 }
424
425 void
426 Perl__warn_problematic_locale()
427 {
428
429 #ifdef USE_LOCALE_CTYPE
430
431     dTHX;
432
433     /* Internal-to-core function that outputs the message in PL_warn_locale,
434      * and then NULLS it.  Should be called only through the macro
435      * _CHECK_AND_WARN_PROBLEMATIC_LOCALE */
436
437     if (PL_warn_locale) {
438         /*GCC_DIAG_IGNORE(-Wformat-security);   Didn't work */
439         Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
440                              SvPVX(PL_warn_locale),
441                              0 /* dummy to avoid compiler warning */ );
442         /* GCC_DIAG_RESTORE; */
443         SvREFCNT_dec_NN(PL_warn_locale);
444         PL_warn_locale = NULL;
445     }
446
447 #endif
448
449 }
450
451 void
452 Perl_new_collate(pTHX_ const char *newcoll)
453 {
454 #ifdef USE_LOCALE_COLLATE
455
456     /* Called after all libc setlocale() calls affecting LC_COLLATE, to tell
457      * core Perl this and that 'newcoll' is the name of the new locale.
458      *
459      * Any code changing the locale (outside this file) should use
460      * POSIX::setlocale, which calls this function.  Therefore this function
461      * should be called directly only from this file and from
462      * POSIX::setlocale().
463      *
464      * The design of locale collation is that every locale change is given an
465      * index 'PL_collation_ix'.  The first time a string particpates in an
466      * operation that requires collation while locale collation is active, it
467      * is given PERL_MAGIC_collxfrm magic (via sv_collxfrm_flags()).  That
468      * magic includes the collation index, and the transformation of the string
469      * by strxfrm(), q.v.  That transformation is used when doing comparisons,
470      * instead of the string itself.  If a string changes, the magic is
471      * cleared.  The next time the locale changes, the index is incremented,
472      * and so we know during a comparison that the transformation is not
473      * necessarily still valid, and so is recomputed.  Note that if the locale
474      * changes enough times, the index could wrap (a U32), and it is possible
475      * that a transformation would improperly be considered valid, leading to
476      * an unlikely bug */
477
478     if (! newcoll) {
479         if (PL_collation_name) {
480             ++PL_collation_ix;
481             Safefree(PL_collation_name);
482             PL_collation_name = NULL;
483         }
484         PL_collation_standard = TRUE;
485       is_standard_collation:
486         PL_collxfrm_base = 0;
487         PL_collxfrm_mult = 2;
488         PL_in_utf8_COLLATE_locale = FALSE;
489         *PL_strxfrm_min_char = '\0';
490         return;
491     }
492
493     /* If this is not the same locale as currently, set the new one up */
494     if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
495         ++PL_collation_ix;
496         Safefree(PL_collation_name);
497         PL_collation_name = stdize_locale(savepv(newcoll));
498         PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
499         if (PL_collation_standard) {
500             goto is_standard_collation;
501         }
502
503         PL_in_utf8_COLLATE_locale = _is_cur_LC_category_utf8(LC_COLLATE);
504         *PL_strxfrm_min_char = '\0';
505
506         /* A locale collation definition includes primary, secondary, tertiary,
507          * etc. weights for each character.  To sort, the primary weights are
508          * used, and only if they compare equal, then the secondary weights are
509          * used, and only if they compare equal, then the tertiary, etc.
510          *
511          * strxfrm() works by taking the input string, say ABC, and creating an
512          * output transformed string consisting of first the primary weights,
513          * A¹B¹C¹ followed by the secondary ones, A²B²C²; and then the
514          * tertiary, etc, yielding A¹B¹C¹ A²B²C² A³B³C³ ....  Some characters
515          * may not have weights at every level.  In our example, let's say B
516          * doesn't have a tertiary weight, and A doesn't have a secondary
517          * weight.  The constructed string is then going to be
518          *  A¹B¹C¹ B²C² A³C³ ....
519          * This has the desired effect that strcmp() will look at the secondary
520          * or tertiary weights only if the strings compare equal at all higher
521          * priority weights.  The spaces shown here, like in
522          *  "A¹B¹C¹ * A²B²C² "
523          * are not just for readability.  In the general case, these must
524          * actually be bytes, which we will call here 'separator weights'; and
525          * they must be smaller than any other weight value, but since these
526          * are C strings, only the terminating one can be a NUL (some
527          * implementations may include a non-NUL separator weight just before
528          * the NUL).  Implementations tend to reserve 01 for the separator
529          * weights.  They are needed so that a shorter string's secondary
530          * weights won't be misconstrued as primary weights of a longer string,
531          * etc.  By making them smaller than any other weight, the shorter
532          * string will sort first.  (Actually, if all secondary weights are
533          * smaller than all primary ones, there is no need for a separator
534          * weight between those two levels, etc.)
535          *
536          * The length of the transformed string is roughly a linear function of
537          * the input string.  It's not exactly linear because some characters
538          * don't have weights at all levels.  When we call strxfrm() we have to
539          * allocate some memory to hold the transformed string.  The
540          * calculations below try to find coefficients 'm' and 'b' for this
541          * locale so that m*x + b equals how much space we need, given the size
542          * of the input string in 'x'.  If we calculate too small, we increase
543          * the size as needed, and call strxfrm() again, but it is better to
544          * get it right the first time to avoid wasted expensive string
545          * transformations. */
546
547         {
548           /*  2: at most so many chars ('a', 'b'). */
549           /* 50: surely no system expands a char more. */
550 #define XFRMBUFSIZE  (2 * 50)
551           char xbuf[XFRMBUFSIZE];
552           const Size_t fa = strxfrm(xbuf, "a",  XFRMBUFSIZE);
553           const Size_t fb = strxfrm(xbuf, "ab", XFRMBUFSIZE);
554           const SSize_t mult = fb - fa;
555           if (mult < 1 && !(fa == 0 && fb == 0))
556               Perl_croak(aTHX_ "panic: strxfrm() gets absurd - a => %"UVuf", ab => %"UVuf,
557                          (UV) fa, (UV) fb);
558           PL_collxfrm_base = (fa > (Size_t)mult) ? (fa - mult) : 0;
559           PL_collxfrm_mult = mult;
560         }
561     }
562
563 #else
564     PERL_UNUSED_ARG(newcoll);
565 #endif /* USE_LOCALE_COLLATE */
566 }
567
568 #ifdef WIN32
569
570 char *
571 Perl_my_setlocale(pTHX_ int category, const char* locale)
572 {
573     /* This, for Windows, emulates POSIX setlocale() behavior.  There is no
574      * difference unless the input locale is "", which means on Windows to get
575      * the machine default, which is set via the computer's "Regional and
576      * Language Options" (or its current equivalent).  In POSIX, it instead
577      * means to find the locale from the user's environment.  This routine
578      * looks in the environment, and, if anything is found, uses that instead
579      * of going to the machine default.  If there is no environment override,
580      * the machine default is used, as normal, by calling the real setlocale()
581      * with "".  The POSIX behavior is to use the LC_ALL variable if set;
582      * otherwise to use the particular category's variable if set; otherwise to
583      * use the LANG variable. */
584
585     bool override_LC_ALL = FALSE;
586     char * result;
587
588     if (locale && strEQ(locale, "")) {
589 #   ifdef LC_ALL
590         locale = PerlEnv_getenv("LC_ALL");
591         if (! locale) {
592 #endif
593             switch (category) {
594 #   ifdef LC_ALL
595                 case LC_ALL:
596                     override_LC_ALL = TRUE;
597                     break;  /* We already know its variable isn't set */
598 #   endif
599 #   ifdef USE_LOCALE_TIME
600                 case LC_TIME:
601                     locale = PerlEnv_getenv("LC_TIME");
602                     break;
603 #   endif
604 #   ifdef USE_LOCALE_CTYPE
605                 case LC_CTYPE:
606                     locale = PerlEnv_getenv("LC_CTYPE");
607                     break;
608 #   endif
609 #   ifdef USE_LOCALE_COLLATE
610                 case LC_COLLATE:
611                     locale = PerlEnv_getenv("LC_COLLATE");
612                     break;
613 #   endif
614 #   ifdef USE_LOCALE_MONETARY
615                 case LC_MONETARY:
616                     locale = PerlEnv_getenv("LC_MONETARY");
617                     break;
618 #   endif
619 #   ifdef USE_LOCALE_NUMERIC
620                 case LC_NUMERIC:
621                     locale = PerlEnv_getenv("LC_NUMERIC");
622                     break;
623 #   endif
624 #   ifdef USE_LOCALE_MESSAGES
625                 case LC_MESSAGES:
626                     locale = PerlEnv_getenv("LC_MESSAGES");
627                     break;
628 #   endif
629                 default:
630                     /* This is a category, like PAPER_SIZE that we don't
631                      * know about; and so can't provide a wrapper. */
632                     break;
633             }
634             if (! locale) {
635                 locale = PerlEnv_getenv("LANG");
636                 if (! locale) {
637                     locale = "";
638                 }
639             }
640 #   ifdef LC_ALL
641         }
642 #   endif
643     }
644
645     result = setlocale(category, locale);
646     DEBUG_L(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n", __FILE__, __LINE__,
647                             _setlocale_debug_string(category, locale, result)));
648
649     if (! override_LC_ALL)  {
650         return result;
651     }
652
653     /* Here the input category was LC_ALL, and we have set it to what is in the
654      * LANG variable or the system default if there is no LANG.  But these have
655      * lower priority than the other LC_foo variables, so override it for each
656      * one that is set.  (If they are set to "", it means to use the same thing
657      * we just set LC_ALL to, so can skip) */
658 #   ifdef USE_LOCALE_TIME
659     result = PerlEnv_getenv("LC_TIME");
660     if (result && strNE(result, "")) {
661         setlocale(LC_TIME, result);
662         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
663                     __FILE__, __LINE__,
664                     _setlocale_debug_string(LC_TIME, result, "not captured")));
665     }
666 #   endif
667 #   ifdef USE_LOCALE_CTYPE
668     result = PerlEnv_getenv("LC_CTYPE");
669     if (result && strNE(result, "")) {
670         setlocale(LC_CTYPE, result);
671         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
672                     __FILE__, __LINE__,
673                     _setlocale_debug_string(LC_CTYPE, result, "not captured")));
674     }
675 #   endif
676 #   ifdef USE_LOCALE_COLLATE
677     result = PerlEnv_getenv("LC_COLLATE");
678     if (result && strNE(result, "")) {
679         setlocale(LC_COLLATE, result);
680         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
681                   __FILE__, __LINE__,
682                   _setlocale_debug_string(LC_COLLATE, result, "not captured")));
683     }
684 #   endif
685 #   ifdef USE_LOCALE_MONETARY
686     result = PerlEnv_getenv("LC_MONETARY");
687     if (result && strNE(result, "")) {
688         setlocale(LC_MONETARY, result);
689         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
690                  __FILE__, __LINE__,
691                  _setlocale_debug_string(LC_MONETARY, result, "not captured")));
692     }
693 #   endif
694 #   ifdef USE_LOCALE_NUMERIC
695     result = PerlEnv_getenv("LC_NUMERIC");
696     if (result && strNE(result, "")) {
697         setlocale(LC_NUMERIC, result);
698         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
699                  __FILE__, __LINE__,
700                  _setlocale_debug_string(LC_NUMERIC, result, "not captured")));
701     }
702 #   endif
703 #   ifdef USE_LOCALE_MESSAGES
704     result = PerlEnv_getenv("LC_MESSAGES");
705     if (result && strNE(result, "")) {
706         setlocale(LC_MESSAGES, result);
707         DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
708                  __FILE__, __LINE__,
709                  _setlocale_debug_string(LC_MESSAGES, result, "not captured")));
710     }
711 #   endif
712
713     result = setlocale(LC_ALL, NULL);
714     DEBUG_L(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
715                                __FILE__, __LINE__,
716                                _setlocale_debug_string(LC_ALL, NULL, result)));
717
718     return result;
719 }
720
721 #endif
722
723
724 /*
725  * Initialize locale awareness.
726  */
727 int
728 Perl_init_i18nl10n(pTHX_ int printwarn)
729 {
730     /* printwarn is
731      *
732      *    0 if not to output warning when setup locale is bad
733      *    1 if to output warning based on value of PERL_BADLANG
734      *    >1 if to output regardless of PERL_BADLANG
735      *
736      * returns
737      *    1 = set ok or not applicable,
738      *    0 = fallback to a locale of lower priority
739      *   -1 = fallback to all locales failed, not even to the C locale
740      *
741      * Under -DDEBUGGING, if the environment variable PERL_DEBUG_LOCALE_INIT is
742      * set, debugging information is output.
743      *
744      * This looks more complicated than it is, mainly due to the #ifdefs.
745      *
746      * We try to set LC_ALL to the value determined by the environment.  If
747      * there is no LC_ALL on this platform, we try the individual categories we
748      * know about.  If this works, we are done.
749      *
750      * But if it doesn't work, we have to do something else.  We search the
751      * environment variables ourselves instead of relying on the system to do
752      * it.  We look at, in order, LC_ALL, LANG, a system default locale (if we
753      * think there is one), and the ultimate fallback "C".  This is all done in
754      * the same loop as above to avoid duplicating code, but it makes things
755      * more complex.  After the original failure, we add the fallback
756      * possibilities to the list of locales to try, and iterate the loop
757      * through them all until one succeeds.
758      *
759      * On Ultrix, the locale MUST come from the environment, so there is
760      * preliminary code to set it.  I (khw) am not sure that it is necessary,
761      * and that this couldn't be folded into the loop, but barring any real
762      * platforms to test on, it's staying as-is
763      *
764      * A slight complication is that in embedded Perls, the locale may already
765      * be set-up, and we don't want to get it from the normal environment
766      * variables.  This is handled by having a special environment variable
767      * indicate we're in this situation.  We simply set setlocale's 2nd
768      * parameter to be a NULL instead of "".  That indicates to setlocale that
769      * it is not to change anything, but to return the current value,
770      * effectively initializing perl's db to what the locale already is.
771      *
772      * We play the same trick with NULL if a LC_ALL succeeds.  We call
773      * setlocale() on the individual categores with NULL to get their existing
774      * values for our db, instead of trying to change them.
775      * */
776
777     int ok = 1;
778
779 #if defined(USE_LOCALE)
780 #ifdef USE_LOCALE_CTYPE
781     char *curctype   = NULL;
782 #endif /* USE_LOCALE_CTYPE */
783 #ifdef USE_LOCALE_COLLATE
784     char *curcoll    = NULL;
785 #endif /* USE_LOCALE_COLLATE */
786 #ifdef USE_LOCALE_NUMERIC
787     char *curnum     = NULL;
788 #endif /* USE_LOCALE_NUMERIC */
789 #ifdef __GLIBC__
790     const char * const language   = savepv(PerlEnv_getenv("LANGUAGE"));
791 #endif
792
793     /* NULL uses the existing already set up locale */
794     const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
795                                         ? NULL
796                                         : "";
797 #ifdef DEBUGGING
798     const bool debug = (PerlEnv_getenv("PERL_DEBUG_LOCALE_INIT"))
799                        ? TRUE
800                        : FALSE;
801 #   define DEBUG_LOCALE_INIT(category, locale, result)                      \
802         STMT_START {                                                        \
803                 if (debug) {                                                \
804                     PerlIO_printf(Perl_debug_log,                           \
805                                   "%s:%d: %s\n",                            \
806                                   __FILE__, __LINE__,                       \
807                                   _setlocale_debug_string(category,         \
808                                                           locale,           \
809                                                           result));         \
810                 }                                                           \
811         } STMT_END
812 #else
813 #   define DEBUG_LOCALE_INIT(a,b,c)
814 #endif
815     const char* trial_locales[5];   /* 5 = 1 each for "", LC_ALL, LANG, "", C */
816     unsigned int trial_locales_count;
817     const char * const lc_all     = savepv(PerlEnv_getenv("LC_ALL"));
818     const char * const lang       = savepv(PerlEnv_getenv("LANG"));
819     bool setlocale_failure = FALSE;
820     unsigned int i;
821     char *p;
822
823     /* A later getenv() could zap this, so only use here */
824     const char * const bad_lang_use_once = PerlEnv_getenv("PERL_BADLANG");
825
826     const bool locwarn = (printwarn > 1
827                           || (printwarn
828                               && (! bad_lang_use_once
829                                   || (
830                                     /* disallow with "" or "0" */
831                                     *bad_lang_use_once
832                                     && strNE("0", bad_lang_use_once)))));
833     bool done = FALSE;
834     char * sl_result;   /* return from setlocale() */
835     char * locale_param;
836 #ifdef WIN32
837     /* In some systems you can find out the system default locale
838      * and use that as the fallback locale. */
839 #   define SYSTEM_DEFAULT_LOCALE
840 #endif
841 #ifdef SYSTEM_DEFAULT_LOCALE
842     const char *system_default_locale = NULL;
843 #endif
844
845 #ifndef LOCALE_ENVIRON_REQUIRED
846     PERL_UNUSED_VAR(done);
847     PERL_UNUSED_VAR(locale_param);
848 #else
849
850     /*
851      * Ultrix setlocale(..., "") fails if there are no environment
852      * variables from which to get a locale name.
853      */
854
855 #   ifdef LC_ALL
856     if (lang) {
857         sl_result = my_setlocale(LC_ALL, setlocale_init);
858         DEBUG_LOCALE_INIT(LC_ALL, setlocale_init, sl_result);
859         if (sl_result)
860             done = TRUE;
861         else
862             setlocale_failure = TRUE;
863     }
864     if (! setlocale_failure) {
865 #       ifdef USE_LOCALE_CTYPE
866         locale_param = (! done && (lang || PerlEnv_getenv("LC_CTYPE")))
867                        ? setlocale_init
868                        : NULL;
869         curctype = my_setlocale(LC_CTYPE, locale_param);
870         DEBUG_LOCALE_INIT(LC_CTYPE, locale_param, sl_result);
871         if (! curctype)
872             setlocale_failure = TRUE;
873         else
874             curctype = savepv(curctype);
875 #       endif /* USE_LOCALE_CTYPE */
876 #       ifdef USE_LOCALE_COLLATE
877         locale_param = (! done && (lang || PerlEnv_getenv("LC_COLLATE")))
878                        ? setlocale_init
879                        : NULL;
880         curcoll = my_setlocale(LC_COLLATE, locale_param);
881         DEBUG_LOCALE_INIT(LC_COLLATE, locale_param, sl_result);
882         if (! curcoll)
883             setlocale_failure = TRUE;
884         else
885             curcoll = savepv(curcoll);
886 #       endif /* USE_LOCALE_COLLATE */
887 #       ifdef USE_LOCALE_NUMERIC
888         locale_param = (! done && (lang || PerlEnv_getenv("LC_NUMERIC")))
889                        ? setlocale_init
890                        : NULL;
891         curnum = my_setlocale(LC_NUMERIC, locale_param);
892         DEBUG_LOCALE_INIT(LC_NUMERIC, locale_param, sl_result);
893         if (! curnum)
894             setlocale_failure = TRUE;
895         else
896             curnum = savepv(curnum);
897 #       endif /* USE_LOCALE_NUMERIC */
898 #       ifdef USE_LOCALE_MESSAGES
899         locale_param = (! done && (lang || PerlEnv_getenv("LC_MESSAGES")))
900                        ? setlocale_init
901                        : NULL;
902         sl_result = my_setlocale(LC_MESSAGES, locale_param);
903         DEBUG_LOCALE_INIT(LC_MESSAGES, locale_param, sl_result);
904         if (! sl_result)
905             setlocale_failure = TRUE;
906         }
907 #       endif /* USE_LOCALE_MESSAGES */
908 #       ifdef USE_LOCALE_MONETARY
909         locale_param = (! done && (lang || PerlEnv_getenv("LC_MONETARY")))
910                        ? setlocale_init
911                        : NULL;
912         sl_result = my_setlocale(LC_MONETARY, locale_param);
913         DEBUG_LOCALE_INIT(LC_MONETARY, locale_param, sl_result);
914         if (! sl_result) {
915             setlocale_failure = TRUE;
916         }
917 #       endif /* USE_LOCALE_MONETARY */
918     }
919
920 #   endif /* LC_ALL */
921
922 #endif /* !LOCALE_ENVIRON_REQUIRED */
923
924     /* We try each locale in the list until we get one that works, or exhaust
925      * the list.  Normally the loop is executed just once.  But if setting the
926      * locale fails, inside the loop we add fallback trials to the array and so
927      * will execute the loop multiple times */
928     trial_locales[0] = setlocale_init;
929     trial_locales_count = 1;
930     for (i= 0; i < trial_locales_count; i++) {
931         const char * trial_locale = trial_locales[i];
932
933         if (i > 0) {
934
935             /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED
936              * when i==0, but I (khw) don't think that behavior makes much
937              * sense */
938             setlocale_failure = FALSE;
939
940 #ifdef SYSTEM_DEFAULT_LOCALE
941 #  ifdef WIN32
942             /* On Windows machines, an entry of "" after the 0th means to use
943              * the system default locale, which we now proceed to get. */
944             if (strEQ(trial_locale, "")) {
945                 unsigned int j;
946
947                 /* Note that this may change the locale, but we are going to do
948                  * that anyway just below */
949                 system_default_locale = setlocale(LC_ALL, "");
950                 DEBUG_LOCALE_INIT(LC_ALL, "", system_default_locale);
951
952                 /* Skip if invalid or it's already on the list of locales to
953                  * try */
954                 if (! system_default_locale) {
955                     goto next_iteration;
956                 }
957                 for (j = 0; j < trial_locales_count; j++) {
958                     if (strEQ(system_default_locale, trial_locales[j])) {
959                         goto next_iteration;
960                     }
961                 }
962
963                 trial_locale = system_default_locale;
964             }
965 #  endif /* WIN32 */
966 #endif /* SYSTEM_DEFAULT_LOCALE */
967         }
968
969 #ifdef LC_ALL
970         sl_result = my_setlocale(LC_ALL, trial_locale);
971         DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result);
972         if (! sl_result) {
973             setlocale_failure = TRUE;
974         }
975         else {
976             /* Since LC_ALL succeeded, it should have changed all the other
977              * categories it can to its value; so we massage things so that the
978              * setlocales below just return their category's current values.
979              * This adequately handles the case in NetBSD where LC_COLLATE may
980              * not be defined for a locale, and setting it individually will
981              * fail, whereas setting LC_ALL suceeds, leaving LC_COLLATE set to
982              * the POSIX locale. */
983             trial_locale = NULL;
984         }
985 #endif /* LC_ALL */
986
987         if (!setlocale_failure) {
988 #ifdef USE_LOCALE_CTYPE
989             Safefree(curctype);
990             curctype = my_setlocale(LC_CTYPE, trial_locale);
991             DEBUG_LOCALE_INIT(LC_CTYPE, trial_locale, curctype);
992             if (! curctype)
993                 setlocale_failure = TRUE;
994             else
995                 curctype = savepv(curctype);
996 #endif /* USE_LOCALE_CTYPE */
997 #ifdef USE_LOCALE_COLLATE
998             Safefree(curcoll);
999             curcoll = my_setlocale(LC_COLLATE, trial_locale);
1000             DEBUG_LOCALE_INIT(LC_COLLATE, trial_locale, curcoll);
1001             if (! curcoll)
1002                 setlocale_failure = TRUE;
1003             else
1004                 curcoll = savepv(curcoll);
1005 #endif /* USE_LOCALE_COLLATE */
1006 #ifdef USE_LOCALE_NUMERIC
1007             Safefree(curnum);
1008             curnum = my_setlocale(LC_NUMERIC, trial_locale);
1009             DEBUG_LOCALE_INIT(LC_NUMERIC, trial_locale, curnum);
1010             if (! curnum)
1011                 setlocale_failure = TRUE;
1012             else
1013                 curnum = savepv(curnum);
1014 #endif /* USE_LOCALE_NUMERIC */
1015 #ifdef USE_LOCALE_MESSAGES
1016             sl_result = my_setlocale(LC_MESSAGES, trial_locale);
1017             DEBUG_LOCALE_INIT(LC_MESSAGES, trial_locale, sl_result);
1018             if (! (sl_result))
1019                 setlocale_failure = TRUE;
1020 #endif /* USE_LOCALE_MESSAGES */
1021 #ifdef USE_LOCALE_MONETARY
1022             sl_result = my_setlocale(LC_MONETARY, trial_locale);
1023             DEBUG_LOCALE_INIT(LC_MONETARY, trial_locale, sl_result);
1024             if (! (sl_result))
1025                 setlocale_failure = TRUE;
1026 #endif /* USE_LOCALE_MONETARY */
1027
1028             if (! setlocale_failure) {  /* Success */
1029                 break;
1030             }
1031         }
1032
1033         /* Here, something failed; will need to try a fallback. */
1034         ok = 0;
1035
1036         if (i == 0) {
1037             unsigned int j;
1038
1039             if (locwarn) { /* Output failure info only on the first one */
1040 #ifdef LC_ALL
1041
1042                 PerlIO_printf(Perl_error_log,
1043                 "perl: warning: Setting locale failed.\n");
1044
1045 #else /* !LC_ALL */
1046
1047                 PerlIO_printf(Perl_error_log,
1048                 "perl: warning: Setting locale failed for the categories:\n\t");
1049 #  ifdef USE_LOCALE_CTYPE
1050                 if (! curctype)
1051                     PerlIO_printf(Perl_error_log, "LC_CTYPE ");
1052 #  endif /* USE_LOCALE_CTYPE */
1053 #  ifdef USE_LOCALE_COLLATE
1054                 if (! curcoll)
1055                     PerlIO_printf(Perl_error_log, "LC_COLLATE ");
1056 #  endif /* USE_LOCALE_COLLATE */
1057 #  ifdef USE_LOCALE_NUMERIC
1058                 if (! curnum)
1059                     PerlIO_printf(Perl_error_log, "LC_NUMERIC ");
1060 #  endif /* USE_LOCALE_NUMERIC */
1061                 PerlIO_printf(Perl_error_log, "and possibly others\n");
1062
1063 #endif /* LC_ALL */
1064
1065                 PerlIO_printf(Perl_error_log,
1066                     "perl: warning: Please check that your locale settings:\n");
1067
1068 #ifdef __GLIBC__
1069                 PerlIO_printf(Perl_error_log,
1070                             "\tLANGUAGE = %c%s%c,\n",
1071                             language ? '"' : '(',
1072                             language ? language : "unset",
1073                             language ? '"' : ')');
1074 #endif
1075
1076                 PerlIO_printf(Perl_error_log,
1077                             "\tLC_ALL = %c%s%c,\n",
1078                             lc_all ? '"' : '(',
1079                             lc_all ? lc_all : "unset",
1080                             lc_all ? '"' : ')');
1081
1082 #if defined(USE_ENVIRON_ARRAY)
1083                 {
1084                 char **e;
1085                 for (e = environ; *e; e++) {
1086                     if (strnEQ(*e, "LC_", 3)
1087                             && strnNE(*e, "LC_ALL=", 7)
1088                             && (p = strchr(*e, '=')))
1089                         PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
1090                                         (int)(p - *e), *e, p + 1);
1091                 }
1092                 }
1093 #else
1094                 PerlIO_printf(Perl_error_log,
1095                             "\t(possibly more locale environment variables)\n");
1096 #endif
1097
1098                 PerlIO_printf(Perl_error_log,
1099                             "\tLANG = %c%s%c\n",
1100                             lang ? '"' : '(',
1101                             lang ? lang : "unset",
1102                             lang ? '"' : ')');
1103
1104                 PerlIO_printf(Perl_error_log,
1105                             "    are supported and installed on your system.\n");
1106             }
1107
1108             /* Calculate what fallback locales to try.  We have avoided this
1109              * until we have to, because failure is quite unlikely.  This will
1110              * usually change the upper bound of the loop we are in.
1111              *
1112              * Since the system's default way of setting the locale has not
1113              * found one that works, We use Perl's defined ordering: LC_ALL,
1114              * LANG, and the C locale.  We don't try the same locale twice, so
1115              * don't add to the list if already there.  (On POSIX systems, the
1116              * LC_ALL element will likely be a repeat of the 0th element "",
1117              * but there's no harm done by doing it explicitly.
1118              *
1119              * Note that this tries the LC_ALL environment variable even on
1120              * systems which have no LC_ALL locale setting.  This may or may
1121              * not have been originally intentional, but there's no real need
1122              * to change the behavior. */
1123             if (lc_all) {
1124                 for (j = 0; j < trial_locales_count; j++) {
1125                     if (strEQ(lc_all, trial_locales[j])) {
1126                         goto done_lc_all;
1127                     }
1128                 }
1129                 trial_locales[trial_locales_count++] = lc_all;
1130             }
1131           done_lc_all:
1132
1133             if (lang) {
1134                 for (j = 0; j < trial_locales_count; j++) {
1135                     if (strEQ(lang, trial_locales[j])) {
1136                         goto done_lang;
1137                     }
1138                 }
1139                 trial_locales[trial_locales_count++] = lang;
1140             }
1141           done_lang:
1142
1143 #if defined(WIN32) && defined(LC_ALL)
1144             /* For Windows, we also try the system default locale before "C".
1145              * (If there exists a Windows without LC_ALL we skip this because
1146              * it gets too complicated.  For those, the "C" is the next
1147              * fallback possibility).  The "" is the same as the 0th element of
1148              * the array, but the code at the loop above knows to treat it
1149              * differently when not the 0th */
1150             trial_locales[trial_locales_count++] = "";
1151 #endif
1152
1153             for (j = 0; j < trial_locales_count; j++) {
1154                 if (strEQ("C", trial_locales[j])) {
1155                     goto done_C;
1156                 }
1157             }
1158             trial_locales[trial_locales_count++] = "C";
1159
1160           done_C: ;
1161         }   /* end of first time through the loop */
1162
1163 #ifdef WIN32
1164       next_iteration: ;
1165 #endif
1166
1167     }   /* end of looping through the trial locales */
1168
1169     if (ok < 1) {   /* If we tried to fallback */
1170         const char* msg;
1171         if (! setlocale_failure) {  /* fallback succeeded */
1172            msg = "Falling back to";
1173         }
1174         else {  /* fallback failed */
1175
1176             /* We dropped off the end of the loop, so have to decrement i to
1177              * get back to the value the last time through */
1178             i--;
1179
1180             ok = -1;
1181             msg = "Failed to fall back to";
1182
1183             /* To continue, we should use whatever values we've got */
1184 #ifdef USE_LOCALE_CTYPE
1185             Safefree(curctype);
1186             curctype = savepv(setlocale(LC_CTYPE, NULL));
1187             DEBUG_LOCALE_INIT(LC_CTYPE, NULL, curctype);
1188 #endif /* USE_LOCALE_CTYPE */
1189 #ifdef USE_LOCALE_COLLATE
1190             Safefree(curcoll);
1191             curcoll = savepv(setlocale(LC_COLLATE, NULL));
1192             DEBUG_LOCALE_INIT(LC_COLLATE, NULL, curcoll);
1193 #endif /* USE_LOCALE_COLLATE */
1194 #ifdef USE_LOCALE_NUMERIC
1195             Safefree(curnum);
1196             curnum = savepv(setlocale(LC_NUMERIC, NULL));
1197             DEBUG_LOCALE_INIT(LC_NUMERIC, NULL, curnum);
1198 #endif /* USE_LOCALE_NUMERIC */
1199         }
1200
1201         if (locwarn) {
1202             const char * description;
1203             const char * name = "";
1204             if (strEQ(trial_locales[i], "C")) {
1205                 description = "the standard locale";
1206                 name = "C";
1207             }
1208 #ifdef SYSTEM_DEFAULT_LOCALE
1209             else if (strEQ(trial_locales[i], "")) {
1210                 description = "the system default locale";
1211                 if (system_default_locale) {
1212                     name = system_default_locale;
1213                 }
1214             }
1215 #endif /* SYSTEM_DEFAULT_LOCALE */
1216             else {
1217                 description = "a fallback locale";
1218                 name = trial_locales[i];
1219             }
1220             if (name && strNE(name, "")) {
1221                 PerlIO_printf(Perl_error_log,
1222                     "perl: warning: %s %s (\"%s\").\n", msg, description, name);
1223             }
1224             else {
1225                 PerlIO_printf(Perl_error_log,
1226                                    "perl: warning: %s %s.\n", msg, description);
1227             }
1228         }
1229     } /* End of tried to fallback */
1230
1231 #ifdef USE_LOCALE_CTYPE
1232     new_ctype(curctype);
1233 #endif /* USE_LOCALE_CTYPE */
1234
1235 #ifdef USE_LOCALE_COLLATE
1236     new_collate(curcoll);
1237 #endif /* USE_LOCALE_COLLATE */
1238
1239 #ifdef USE_LOCALE_NUMERIC
1240     new_numeric(curnum);
1241 #endif /* USE_LOCALE_NUMERIC */
1242
1243 #if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE)
1244     /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE
1245      * locale is UTF-8.  If PL_utf8locale and PL_unicode (set by -C or by
1246      * $ENV{PERL_UNICODE}) are true, perl.c:S_parse_body() will turn on the
1247      * PerlIO :utf8 layer on STDIN, STDOUT, STDERR, _and_ the default open
1248      * discipline.  */
1249     PL_utf8locale = _is_cur_LC_category_utf8(LC_CTYPE);
1250
1251     /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
1252        This is an alternative to using the -C command line switch
1253        (the -C if present will override this). */
1254     {
1255          const char *p = PerlEnv_getenv("PERL_UNICODE");
1256          PL_unicode = p ? parse_unicode_opts(&p) : 0;
1257          if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
1258              PL_utf8cache = -1;
1259     }
1260 #endif
1261
1262 #ifdef USE_LOCALE_CTYPE
1263     Safefree(curctype);
1264 #endif /* USE_LOCALE_CTYPE */
1265 #ifdef USE_LOCALE_COLLATE
1266     Safefree(curcoll);
1267 #endif /* USE_LOCALE_COLLATE */
1268 #ifdef USE_LOCALE_NUMERIC
1269     Safefree(curnum);
1270 #endif /* USE_LOCALE_NUMERIC */
1271
1272 #ifdef __GLIBC__
1273     Safefree(language);
1274 #endif
1275
1276     Safefree(lc_all);
1277     Safefree(lang);
1278
1279 #else  /* !USE_LOCALE */
1280     PERL_UNUSED_ARG(printwarn);
1281 #endif /* USE_LOCALE */
1282
1283     return ok;
1284 }
1285
1286
1287 #ifdef USE_LOCALE_COLLATE
1288
1289 /*
1290  * mem_collxfrm() is a bit like strxfrm() but with two important
1291  * differences. First, it handles embedded NULs. Second, it allocates
1292  * a bit more memory than needed for the transformed data itself.
1293  * The real transformed data begins at offset sizeof(collationix).
1294  * *xlen is set to the length of that, and doesn't include the collation index
1295  * size.
1296  * Please see sv_collxfrm() to see how this is used.
1297  */
1298
1299 char *
1300 Perl_mem_collxfrm(pTHX_ const char *input_string,
1301                          STRLEN len,
1302                          STRLEN *xlen
1303                    )
1304 {
1305     char * s = (char *) input_string;
1306     STRLEN s_strlen = strlen(input_string);
1307     char *xbuf;
1308     STRLEN xAlloc, xout; /* xalloc is a reserved word in VC */
1309
1310     PERL_ARGS_ASSERT_MEM_COLLXFRM;
1311
1312     /* Replace any embedded NULs with the control that sorts before any others.
1313      * This will give as good as possible results on strings that don't
1314      * otherwise contain that character, but otherwise there may be
1315      * less-than-perfect results with that character and NUL.  This is
1316      * unavoidable unless we replace strxfrm with our own implementation.
1317      *
1318      * XXX This code may be overkill.  khw wrote it before realizing that if
1319      * you change a NUL into some other character, that that may change the
1320      * strxfrm results if that character is part of a sequence with other
1321      * characters for weight calculations.  To minimize the chances of this,
1322      * now the replacement is restricted to another control (likely to be
1323      * \001).  But the full generality has been retained.
1324      *
1325      * This is one of the few places in the perl core, where we can use
1326      * standard functions like strlen() and strcat().  It's because we're
1327      * looking for NULs. */
1328     if (s_strlen < len) {
1329         char * e = s + len;
1330         char * sans_nuls;
1331         STRLEN cur_min_char_len;
1332
1333         /* If we don't know what control character sorts lowest for this
1334          * locale, find it */
1335         if (*PL_strxfrm_min_char == '\0') {
1336             int j;
1337             char * cur_min_x = NULL;    /* Cur cp's xfrm, (except it also
1338                                            includes the collation index
1339                                            prefixed. */
1340
1341             /* Look through all legal code points (NUL isn't) */
1342             for (j = 1; j < 256; j++) {
1343                 char * x;       /* j's xfrm plus collation index */
1344                 STRLEN x_len;   /* length of 'x' */
1345                 STRLEN trial_len = 1;
1346
1347                 /* Create a 1 byte string of the current code point, but with
1348                  * room to be 2 bytes */
1349                 char cur_source[] = { (char) j, '\0' , '\0' };
1350
1351                 if (PL_in_utf8_COLLATE_locale) {
1352                     if (! isCNTRL_L1(j)) {
1353                         continue;
1354                     }
1355
1356                     /* If needs to be 2 bytes, find them */
1357                     if (! UVCHR_IS_INVARIANT(j)) {
1358                         continue;  /* Can't handle variants yet */
1359                     }
1360                 }
1361                 else if (! isCNTRL_LC(j)) {
1362                     continue;
1363                 }
1364
1365                 /* Then transform it */
1366                 x = mem_collxfrm(cur_source, trial_len, &x_len);
1367
1368                 /* If something went wrong (which it shouldn't), just
1369                  * ignore this code point */
1370                 if (   x_len == 0
1371                     || strlen(x + sizeof(PL_collation_ix)) < x_len)
1372                 {
1373                     continue;
1374                 }
1375
1376                 /* If this character's transformation is lower than
1377                  * the current lowest, this one becomes the lowest */
1378                 if (   cur_min_x == NULL
1379                     || strLT(x         + sizeof(PL_collation_ix),
1380                              cur_min_x + sizeof(PL_collation_ix)))
1381                 {
1382                     strcpy(PL_strxfrm_min_char, cur_source);
1383                     cur_min_x = x;
1384                 }
1385                 else {
1386                     Safefree(x);
1387                 }
1388             } /* end of loop through all bytes */
1389
1390             /* Unlikely, but possible, if there aren't any controls in the
1391              * locale, arbitrarily use \001 */
1392             if (cur_min_x == NULL) {
1393                 STRLEN x_len;   /* temporary */
1394                 cur_min_x = mem_collxfrm("\001", 1, &x_len);
1395                 /* cur_min_cp was already initialized to 1 */
1396             }
1397
1398             Safefree(cur_min_x);
1399         }
1400
1401         /* The worst case length for the replaced string would be if every
1402          * character in it is NUL.  Multiply that by the length of each
1403          * replacement, and allow for a trailing NUL */
1404         cur_min_char_len = strlen(PL_strxfrm_min_char);
1405         Newx(sans_nuls, (len * cur_min_char_len) + 1, char);
1406         *sans_nuls = '\0';
1407
1408
1409         /* Replace each NUL with the lowest collating control.  Loop until have
1410          * exhausted all the NULs */
1411         while (s + s_strlen < e) {
1412             strcat(sans_nuls, s);
1413
1414             /* Do the actual replacement */
1415             strcat(sans_nuls, PL_strxfrm_min_char);
1416
1417             /* Move past the input NUL */
1418             s += s_strlen + 1;
1419             s_strlen = strlen(s);
1420         }
1421
1422         /* And add anything that trails the final NUL */
1423         strcat(sans_nuls, s);
1424
1425         /* Switch so below we transform this modified string */
1426         s = sans_nuls;
1427         len = strlen(s);
1428     }
1429
1430     /* The first element in the output is the collation id, used by
1431      * sv_collxfrm(); then comes the space for the transformed string.  The
1432      * equation should give us a good estimate as to how much is needed */
1433     xAlloc = sizeof(PL_collation_ix) + PL_collxfrm_base + (PL_collxfrm_mult * len) + 1;
1434     Newx(xbuf, xAlloc, char);
1435     if (UNLIKELY(! xbuf))
1436         goto bad;
1437
1438     /* Store the collation id */
1439     *(U32*)xbuf = PL_collation_ix;
1440     xout = sizeof(PL_collation_ix);
1441
1442     /* Then the transformation of the input.  We loop until successful, or we
1443      * give up */
1444     for (;;) {
1445         STRLEN xused = strxfrm(xbuf + xout, s, xAlloc - xout);
1446
1447         /* If the transformed string occupies less space than we told strxfrm()
1448          * was available, it means it successfully transformed the whole
1449          * string. */
1450         if (xused < xAlloc - xout) {
1451             xout += xused;
1452             break;
1453         }
1454
1455         if (UNLIKELY(xused >= PERL_INT_MAX))
1456             goto bad;
1457
1458         /* Otherwise it should be that the transformation stopped in the middle
1459          * because it ran out of space.  Malloc more, and try again.  */
1460         xAlloc = (2 * xAlloc) + 1;
1461         Renew(xbuf, xAlloc, char);
1462         if (UNLIKELY(! xbuf))
1463             goto bad;
1464     }
1465
1466     *xlen = xout - sizeof(PL_collation_ix);
1467
1468     /* Free up unneeded space; retain ehough for trailing NUL */
1469     Renew(xbuf, xout + 1, char);
1470
1471     if (s != input_string) {
1472         Safefree(s);
1473     }
1474
1475     return xbuf;
1476
1477   bad:
1478     Safefree(xbuf);
1479     if (s != input_string) {
1480         Safefree(s);
1481     }
1482     *xlen = 0;
1483     return NULL;
1484 }
1485
1486 #endif /* USE_LOCALE_COLLATE */
1487
1488 #ifdef USE_LOCALE
1489
1490 bool
1491 Perl__is_cur_LC_category_utf8(pTHX_ int category)
1492 {
1493     /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE
1494      * otherwise. 'category' may not be LC_ALL.  If the platform doesn't have
1495      * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence
1496      * could give the wrong result.  The result will very likely be correct for
1497      * languages that have commonly used non-ASCII characters, but for notably
1498      * English, it comes down to if the locale's name ends in something like
1499      * "UTF-8".  It errs on the side of not being a UTF-8 locale. */
1500
1501     char *save_input_locale = NULL;
1502     STRLEN final_pos;
1503
1504 #ifdef LC_ALL
1505     assert(category != LC_ALL);
1506 #endif
1507
1508     /* First dispose of the trivial cases */
1509     save_input_locale = setlocale(category, NULL);
1510     if (! save_input_locale) {
1511         DEBUG_L(PerlIO_printf(Perl_debug_log,
1512                               "Could not find current locale for category %d\n",
1513                               category));
1514         return FALSE;   /* XXX maybe should croak */
1515     }
1516     save_input_locale = stdize_locale(savepv(save_input_locale));
1517     if (isNAME_C_OR_POSIX(save_input_locale)) {
1518         DEBUG_L(PerlIO_printf(Perl_debug_log,
1519                               "Current locale for category %d is %s\n",
1520                               category, save_input_locale));
1521         Safefree(save_input_locale);
1522         return FALSE;
1523     }
1524
1525 #if defined(USE_LOCALE_CTYPE)    \
1526     && (defined(MB_CUR_MAX) || (defined(HAS_NL_LANGINFO) && defined(CODESET)))
1527
1528     { /* Next try nl_langinfo or MB_CUR_MAX if available */
1529
1530         char *save_ctype_locale = NULL;
1531         bool is_utf8;
1532
1533         if (category != LC_CTYPE) { /* These work only on LC_CTYPE */
1534
1535             /* Get the current LC_CTYPE locale */
1536             save_ctype_locale = setlocale(LC_CTYPE, NULL);
1537             if (! save_ctype_locale) {
1538                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1539                                "Could not find current locale for LC_CTYPE\n"));
1540                 goto cant_use_nllanginfo;
1541             }
1542             save_ctype_locale = stdize_locale(savepv(save_ctype_locale));
1543
1544             /* If LC_CTYPE and the desired category use the same locale, this
1545              * means that finding the value for LC_CTYPE is the same as finding
1546              * the value for the desired category.  Otherwise, switch LC_CTYPE
1547              * to the desired category's locale */
1548             if (strEQ(save_ctype_locale, save_input_locale)) {
1549                 Safefree(save_ctype_locale);
1550                 save_ctype_locale = NULL;
1551             }
1552             else if (! setlocale(LC_CTYPE, save_input_locale)) {
1553                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1554                                     "Could not change LC_CTYPE locale to %s\n",
1555                                     save_input_locale));
1556                 Safefree(save_ctype_locale);
1557                 goto cant_use_nllanginfo;
1558             }
1559         }
1560
1561         DEBUG_L(PerlIO_printf(Perl_debug_log, "Current LC_CTYPE locale=%s\n",
1562                                               save_input_locale));
1563
1564         /* Here the current LC_CTYPE is set to the locale of the category whose
1565          * information is desired.  This means that nl_langinfo() and MB_CUR_MAX
1566          * should give the correct results */
1567
1568 #   if defined(HAS_NL_LANGINFO) && defined(CODESET)
1569         {
1570             char *codeset = nl_langinfo(CODESET);
1571             if (codeset && strNE(codeset, "")) {
1572                 codeset = savepv(codeset);
1573
1574                 /* If we switched LC_CTYPE, switch back */
1575                 if (save_ctype_locale) {
1576                     setlocale(LC_CTYPE, save_ctype_locale);
1577                     Safefree(save_ctype_locale);
1578                 }
1579
1580                 is_utf8 = foldEQ(codeset, STR_WITH_LEN("UTF-8"))
1581                         || foldEQ(codeset, STR_WITH_LEN("UTF8"));
1582
1583                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1584                        "\tnllanginfo returned CODESET '%s'; ?UTF8 locale=%d\n",
1585                                                      codeset,         is_utf8));
1586                 Safefree(codeset);
1587                 Safefree(save_input_locale);
1588                 return is_utf8;
1589             }
1590         }
1591
1592 #   endif
1593 #   ifdef MB_CUR_MAX
1594
1595         /* Here, either we don't have nl_langinfo, or it didn't return a
1596          * codeset.  Try MB_CUR_MAX */
1597
1598         /* Standard UTF-8 needs at least 4 bytes to represent the maximum
1599          * Unicode code point.  Since UTF-8 is the only non-single byte
1600          * encoding we handle, we just say any such encoding is UTF-8, and if
1601          * turns out to be wrong, other things will fail */
1602         is_utf8 = MB_CUR_MAX >= 4;
1603
1604         DEBUG_L(PerlIO_printf(Perl_debug_log,
1605                               "\tMB_CUR_MAX=%d; ?UTF8 locale=%d\n",
1606                                    (int) MB_CUR_MAX,      is_utf8));
1607
1608         Safefree(save_input_locale);
1609
1610 #       ifdef HAS_MBTOWC
1611
1612         /* ... But, most system that have MB_CUR_MAX will also have mbtowc(),
1613          * since they are both in the C99 standard.  We can feed a known byte
1614          * string to the latter function, and check that it gives the expected
1615          * result */
1616         if (is_utf8) {
1617             wchar_t wc;
1618             PERL_UNUSED_RESULT(mbtowc(&wc, NULL, 0));/* Reset any shift state */
1619             errno = 0;
1620             if ((size_t)mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8))
1621                                                         != strlen(HYPHEN_UTF8)
1622                 || wc != (wchar_t) 0x2010)
1623             {
1624                 is_utf8 = FALSE;
1625                 DEBUG_L(PerlIO_printf(Perl_debug_log, "\thyphen=U+%x\n", (unsigned int)wc));
1626                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1627                         "\treturn from mbtowc=%d; errno=%d; ?UTF8 locale=0\n",
1628                         mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8)), errno));
1629             }
1630         }
1631 #       endif
1632
1633         /* If we switched LC_CTYPE, switch back */
1634         if (save_ctype_locale) {
1635             setlocale(LC_CTYPE, save_ctype_locale);
1636             Safefree(save_ctype_locale);
1637         }
1638
1639         return is_utf8;
1640 #   endif
1641     }
1642
1643   cant_use_nllanginfo:
1644
1645 #else   /* nl_langinfo should work if available, so don't bother compiling this
1646            fallback code.  The final fallback of looking at the name is
1647            compiled, and will be executed if nl_langinfo fails */
1648
1649     /* nl_langinfo not available or failed somehow.  Next try looking at the
1650      * currency symbol to see if it disambiguates things.  Often that will be
1651      * in the native script, and if the symbol isn't in UTF-8, we know that the
1652      * locale isn't.  If it is non-ASCII UTF-8, we infer that the locale is
1653      * too, as the odds of a non-UTF8 string being valid UTF-8 are quite small
1654      * */
1655
1656 #ifdef HAS_LOCALECONV
1657 #   ifdef USE_LOCALE_MONETARY
1658     {
1659         char *save_monetary_locale = NULL;
1660         bool only_ascii = FALSE;
1661         bool is_utf8 = FALSE;
1662         struct lconv* lc;
1663
1664         /* Like above for LC_CTYPE, we first set LC_MONETARY to the locale of
1665          * the desired category, if it isn't that locale already */
1666
1667         if (category != LC_MONETARY) {
1668
1669             save_monetary_locale = setlocale(LC_MONETARY, NULL);
1670             if (! save_monetary_locale) {
1671                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1672                             "Could not find current locale for LC_MONETARY\n"));
1673                 goto cant_use_monetary;
1674             }
1675             save_monetary_locale = stdize_locale(savepv(save_monetary_locale));
1676
1677             if (strEQ(save_monetary_locale, save_input_locale)) {
1678                 Safefree(save_monetary_locale);
1679                 save_monetary_locale = NULL;
1680             }
1681             else if (! setlocale(LC_MONETARY, save_input_locale)) {
1682                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1683                             "Could not change LC_MONETARY locale to %s\n",
1684                                                         save_input_locale));
1685                 Safefree(save_monetary_locale);
1686                 goto cant_use_monetary;
1687             }
1688         }
1689
1690         /* Here the current LC_MONETARY is set to the locale of the category
1691          * whose information is desired. */
1692
1693         lc = localeconv();
1694         if (! lc
1695             || ! lc->currency_symbol
1696             || is_invariant_string((U8 *) lc->currency_symbol, 0))
1697         {
1698             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));
1699             only_ascii = TRUE;
1700         }
1701         else {
1702             is_utf8 = is_utf8_string((U8 *) lc->currency_symbol, 0);
1703         }
1704
1705         /* If we changed it, restore LC_MONETARY to its original locale */
1706         if (save_monetary_locale) {
1707             setlocale(LC_MONETARY, save_monetary_locale);
1708             Safefree(save_monetary_locale);
1709         }
1710
1711         if (! only_ascii) {
1712
1713             /* It isn't a UTF-8 locale if the symbol is not legal UTF-8;
1714              * otherwise assume the locale is UTF-8 if and only if the symbol
1715              * is non-ascii UTF-8. */
1716             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?Currency symbol for %s is UTF-8=%d\n",
1717                                     save_input_locale, is_utf8));
1718             Safefree(save_input_locale);
1719             return is_utf8;
1720         }
1721     }
1722   cant_use_monetary:
1723
1724 #   endif /* USE_LOCALE_MONETARY */
1725 #endif /* HAS_LOCALECONV */
1726
1727 #if defined(HAS_STRFTIME) && defined(USE_LOCALE_TIME)
1728
1729 /* Still haven't found a non-ASCII string to disambiguate UTF-8 or not.  Try
1730  * the names of the months and weekdays, timezone, and am/pm indicator */
1731     {
1732         char *save_time_locale = NULL;
1733         int hour = 10;
1734         bool is_dst = FALSE;
1735         int dom = 1;
1736         int month = 0;
1737         int i;
1738         char * formatted_time;
1739
1740
1741         /* Like above for LC_MONETARY, we set LC_TIME to the locale of the
1742          * desired category, if it isn't that locale already */
1743
1744         if (category != LC_TIME) {
1745
1746             save_time_locale = setlocale(LC_TIME, NULL);
1747             if (! save_time_locale) {
1748                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1749                             "Could not find current locale for LC_TIME\n"));
1750                 goto cant_use_time;
1751             }
1752             save_time_locale = stdize_locale(savepv(save_time_locale));
1753
1754             if (strEQ(save_time_locale, save_input_locale)) {
1755                 Safefree(save_time_locale);
1756                 save_time_locale = NULL;
1757             }
1758             else if (! setlocale(LC_TIME, save_input_locale)) {
1759                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1760                             "Could not change LC_TIME locale to %s\n",
1761                                                         save_input_locale));
1762                 Safefree(save_time_locale);
1763                 goto cant_use_time;
1764             }
1765         }
1766
1767         /* Here the current LC_TIME is set to the locale of the category
1768          * whose information is desired.  Look at all the days of the week and
1769          * month names, and the timezone and am/pm indicator for UTF-8 variant
1770          * characters.  The first such a one found will tell us if the locale
1771          * is UTF-8 or not */
1772
1773         for (i = 0; i < 7 + 12; i++) {  /* 7 days; 12 months */
1774             formatted_time = my_strftime("%A %B %Z %p",
1775                                     0, 0, hour, dom, month, 112, 0, 0, is_dst);
1776             if (! formatted_time || is_invariant_string((U8 *) formatted_time, 0)) {
1777
1778                 /* Here, we didn't find a non-ASCII.  Try the next time through
1779                  * with the complemented dst and am/pm, and try with the next
1780                  * weekday.  After we have gotten all weekdays, try the next
1781                  * month */
1782                 is_dst = ! is_dst;
1783                 hour = (hour + 12) % 24;
1784                 dom++;
1785                 if (i > 6) {
1786                     month++;
1787                 }
1788                 continue;
1789             }
1790
1791             /* Here, we have a non-ASCII.  Return TRUE is it is valid UTF8;
1792              * false otherwise.  But first, restore LC_TIME to its original
1793              * locale if we changed it */
1794             if (save_time_locale) {
1795                 setlocale(LC_TIME, save_time_locale);
1796                 Safefree(save_time_locale);
1797             }
1798
1799             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?time-related strings for %s are UTF-8=%d\n",
1800                                 save_input_locale,
1801                                 is_utf8_string((U8 *) formatted_time, 0)));
1802             Safefree(save_input_locale);
1803             return is_utf8_string((U8 *) formatted_time, 0);
1804         }
1805
1806         /* Falling off the end of the loop indicates all the names were just
1807          * ASCII.  Go on to the next test.  If we changed it, restore LC_TIME
1808          * to its original locale */
1809         if (save_time_locale) {
1810             setlocale(LC_TIME, save_time_locale);
1811             Safefree(save_time_locale);
1812         }
1813         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));
1814     }
1815   cant_use_time:
1816
1817 #endif
1818
1819 #if 0 && defined(USE_LOCALE_MESSAGES) && defined(HAS_SYS_ERRLIST)
1820
1821 /* This code is ifdefd out because it was found to not be necessary in testing
1822  * on our dromedary test machine, which has over 700 locales.  There, this
1823  * added no value to looking at the currency symbol and the time strings.  I
1824  * left it in so as to avoid rewriting it if real-world experience indicates
1825  * that dromedary is an outlier.  Essentially, instead of returning abpve if we
1826  * haven't found illegal utf8, we continue on and examine all the strerror()
1827  * messages on the platform for utf8ness.  If all are ASCII, we still don't
1828  * know the answer; but otherwise we have a pretty good indication of the
1829  * utf8ness.  The reason this doesn't help much is that the messages may not
1830  * have been translated into the locale.  The currency symbol and time strings
1831  * are much more likely to have been translated.  */
1832     {
1833         int e;
1834         bool is_utf8 = FALSE;
1835         bool non_ascii = FALSE;
1836         char *save_messages_locale = NULL;
1837         const char * errmsg = NULL;
1838
1839         /* Like above, we set LC_MESSAGES to the locale of the desired
1840          * category, if it isn't that locale already */
1841
1842         if (category != LC_MESSAGES) {
1843
1844             save_messages_locale = setlocale(LC_MESSAGES, NULL);
1845             if (! save_messages_locale) {
1846                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1847                             "Could not find current locale for LC_MESSAGES\n"));
1848                 goto cant_use_messages;
1849             }
1850             save_messages_locale = stdize_locale(savepv(save_messages_locale));
1851
1852             if (strEQ(save_messages_locale, save_input_locale)) {
1853                 Safefree(save_messages_locale);
1854                 save_messages_locale = NULL;
1855             }
1856             else if (! setlocale(LC_MESSAGES, save_input_locale)) {
1857                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1858                             "Could not change LC_MESSAGES locale to %s\n",
1859                                                         save_input_locale));
1860                 Safefree(save_messages_locale);
1861                 goto cant_use_messages;
1862             }
1863         }
1864
1865         /* Here the current LC_MESSAGES is set to the locale of the category
1866          * whose information is desired.  Look through all the messages.  We
1867          * can't use Strerror() here because it may expand to code that
1868          * segfaults in miniperl */
1869
1870         for (e = 0; e <= sys_nerr; e++) {
1871             errno = 0;
1872             errmsg = sys_errlist[e];
1873             if (errno || !errmsg) {
1874                 break;
1875             }
1876             errmsg = savepv(errmsg);
1877             if (! is_invariant_string((U8 *) errmsg, 0)) {
1878                 non_ascii = TRUE;
1879                 is_utf8 = is_utf8_string((U8 *) errmsg, 0);
1880                 break;
1881             }
1882         }
1883         Safefree(errmsg);
1884
1885         /* And, if we changed it, restore LC_MESSAGES to its original locale */
1886         if (save_messages_locale) {
1887             setlocale(LC_MESSAGES, save_messages_locale);
1888             Safefree(save_messages_locale);
1889         }
1890
1891         if (non_ascii) {
1892
1893             /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid,
1894              * any non-ascii means it is one; otherwise we assume it isn't */
1895             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?error messages for %s are UTF-8=%d\n",
1896                                 save_input_locale,
1897                                 is_utf8));
1898             Safefree(save_input_locale);
1899             return is_utf8;
1900         }
1901
1902         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));
1903     }
1904   cant_use_messages:
1905
1906 #endif
1907
1908 #endif /* the code that is compiled when no nl_langinfo */
1909
1910 #ifndef EBCDIC  /* On os390, even if the name ends with "UTF-8', it isn't a
1911                    UTF-8 locale */
1912     /* As a last resort, look at the locale name to see if it matches
1913      * qr/UTF -?  * 8 /ix, or some other common locale names.  This "name", the
1914      * return of setlocale(), is actually defined to be opaque, so we can't
1915      * really rely on the absence of various substrings in the name to indicate
1916      * its UTF-8ness, but if it has UTF8 in the name, it is extremely likely to
1917      * be a UTF-8 locale.  Similarly for the other common names */
1918
1919     final_pos = strlen(save_input_locale) - 1;
1920     if (final_pos >= 3) {
1921         char *name = save_input_locale;
1922
1923         /* Find next 'U' or 'u' and look from there */
1924         while ((name += strcspn(name, "Uu") + 1)
1925                                             <= save_input_locale + final_pos - 2)
1926         {
1927             if (!isALPHA_FOLD_NE(*name, 't')
1928                 || isALPHA_FOLD_NE(*(name + 1), 'f'))
1929             {
1930                 continue;
1931             }
1932             name += 2;
1933             if (*(name) == '-') {
1934                 if ((name > save_input_locale + final_pos - 1)) {
1935                     break;
1936                 }
1937                 name++;
1938             }
1939             if (*(name) == '8') {
1940                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1941                                       "Locale %s ends with UTF-8 in name\n",
1942                                       save_input_locale));
1943                 Safefree(save_input_locale);
1944                 return TRUE;
1945             }
1946         }
1947         DEBUG_L(PerlIO_printf(Perl_debug_log,
1948                               "Locale %s doesn't end with UTF-8 in name\n",
1949                                 save_input_locale));
1950     }
1951 #endif
1952
1953 #ifdef WIN32
1954     /* http://msdn.microsoft.com/en-us/library/windows/desktop/dd317756.aspx */
1955     if (final_pos >= 4
1956         && *(save_input_locale + final_pos - 0) == '1'
1957         && *(save_input_locale + final_pos - 1) == '0'
1958         && *(save_input_locale + final_pos - 2) == '0'
1959         && *(save_input_locale + final_pos - 3) == '5'
1960         && *(save_input_locale + final_pos - 4) == '6')
1961     {
1962         DEBUG_L(PerlIO_printf(Perl_debug_log,
1963                         "Locale %s ends with 10056 in name, is UTF-8 locale\n",
1964                         save_input_locale));
1965         Safefree(save_input_locale);
1966         return TRUE;
1967     }
1968 #endif
1969
1970     /* Other common encodings are the ISO 8859 series, which aren't UTF-8.  But
1971      * since we are about to return FALSE anyway, there is no point in doing
1972      * this extra work */
1973 #if 0
1974     if (instr(save_input_locale, "8859")) {
1975         DEBUG_L(PerlIO_printf(Perl_debug_log,
1976                              "Locale %s has 8859 in name, not UTF-8 locale\n",
1977                              save_input_locale));
1978         Safefree(save_input_locale);
1979         return FALSE;
1980     }
1981 #endif
1982
1983     DEBUG_L(PerlIO_printf(Perl_debug_log,
1984                           "Assuming locale %s is not a UTF-8 locale\n",
1985                                     save_input_locale));
1986     Safefree(save_input_locale);
1987     return FALSE;
1988 }
1989
1990 #endif
1991
1992
1993 bool
1994 Perl__is_in_locale_category(pTHX_ const bool compiling, const int category)
1995 {
1996     dVAR;
1997     /* Internal function which returns if we are in the scope of a pragma that
1998      * enables the locale category 'category'.  'compiling' should indicate if
1999      * this is during the compilation phase (TRUE) or not (FALSE). */
2000
2001     const COP * const cop = (compiling) ? &PL_compiling : PL_curcop;
2002
2003     SV *categories = cop_hints_fetch_pvs(cop, "locale", 0);
2004     if (! categories || categories == &PL_sv_placeholder) {
2005         return FALSE;
2006     }
2007
2008     /* The pseudo-category 'not_characters' is -1, so just add 1 to each to get
2009      * a valid unsigned */
2010     assert(category >= -1);
2011     return cBOOL(SvUV(categories) & (1U << (category + 1)));
2012 }
2013
2014 char *
2015 Perl_my_strerror(pTHX_ const int errnum) {
2016     dVAR;
2017
2018     /* Uses C locale for the error text unless within scope of 'use locale' for
2019      * LC_MESSAGES */
2020
2021 #ifdef USE_LOCALE_MESSAGES
2022     if (! IN_LC(LC_MESSAGES)) {
2023         char * save_locale;
2024
2025         /* We have a critical section to prevent another thread from changing
2026          * the locale out from under us (or zapping the buffer returned from
2027          * setlocale() ) */
2028         LOCALE_LOCK;
2029
2030         save_locale = setlocale(LC_MESSAGES, NULL);
2031         if (! isNAME_C_OR_POSIX(save_locale)) {
2032             char *errstr;
2033
2034             /* The next setlocale likely will zap this, so create a copy */
2035             save_locale = savepv(save_locale);
2036
2037             setlocale(LC_MESSAGES, "C");
2038
2039             /* This points to the static space in Strerror, with all its
2040              * limitations */
2041             errstr = Strerror(errnum);
2042
2043             setlocale(LC_MESSAGES, save_locale);
2044             Safefree(save_locale);
2045
2046             LOCALE_UNLOCK;
2047
2048             return errstr;
2049         }
2050
2051         LOCALE_UNLOCK;
2052     }
2053 #endif
2054
2055     return Strerror(errnum);
2056 }
2057
2058 /*
2059
2060 =head1 Locale-related functions and macros
2061
2062 =for apidoc sync_locale
2063
2064 Changing the program's locale should be avoided by XS code.  Nevertheless,
2065 certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
2066 happens, Perl needs to be told that the locale has changed.  Use this function
2067 to do so, before returning to Perl.
2068
2069 =cut
2070 */
2071
2072 void
2073 Perl_sync_locale(pTHX)
2074 {
2075
2076 #ifdef USE_LOCALE_CTYPE
2077     new_ctype(setlocale(LC_CTYPE, NULL));
2078 #endif /* USE_LOCALE_CTYPE */
2079
2080 #ifdef USE_LOCALE_COLLATE
2081     new_collate(setlocale(LC_COLLATE, NULL));
2082 #endif
2083
2084 #ifdef USE_LOCALE_NUMERIC
2085     set_numeric_local();    /* Switch from "C" to underlying LC_NUMERIC */
2086     new_numeric(setlocale(LC_NUMERIC, NULL));
2087 #endif /* USE_LOCALE_NUMERIC */
2088
2089 }
2090
2091 #if defined(DEBUGGING) && defined(USE_LOCALE)
2092
2093 char *
2094 Perl__setlocale_debug_string(const int category,        /* category number,
2095                                                            like LC_ALL */
2096                             const char* const locale,   /* locale name */
2097
2098                             /* return value from setlocale() when attempting to
2099                              * set 'category' to 'locale' */
2100                             const char* const retval)
2101 {
2102     /* Returns a pointer to a NUL-terminated string in static storage with
2103      * added text about the info passed in.  This is not thread safe and will
2104      * be overwritten by the next call, so this should be used just to
2105      * formulate a string to immediately print or savepv() on. */
2106
2107     /* initialise to a non-null value to keep it out of BSS and so keep
2108      * -DPERL_GLOBAL_STRUCT_PRIVATE happy */
2109     static char ret[128] = "x";
2110
2111     my_strlcpy(ret, "setlocale(", sizeof(ret));
2112
2113     switch (category) {
2114         default:
2115             my_snprintf(ret, sizeof(ret), "%s? %d", ret, category);
2116             break;
2117 #   ifdef LC_ALL
2118         case LC_ALL:
2119             my_strlcat(ret, "LC_ALL", sizeof(ret));
2120             break;
2121 #   endif
2122 #   ifdef LC_CTYPE
2123         case LC_CTYPE:
2124             my_strlcat(ret, "LC_CTYPE", sizeof(ret));
2125             break;
2126 #   endif
2127 #   ifdef LC_NUMERIC
2128         case LC_NUMERIC:
2129             my_strlcat(ret, "LC_NUMERIC", sizeof(ret));
2130             break;
2131 #   endif
2132 #   ifdef LC_COLLATE
2133         case LC_COLLATE:
2134             my_strlcat(ret, "LC_COLLATE", sizeof(ret));
2135             break;
2136 #   endif
2137 #   ifdef LC_TIME
2138         case LC_TIME:
2139             my_strlcat(ret, "LC_TIME", sizeof(ret));
2140             break;
2141 #   endif
2142 #   ifdef LC_MONETARY
2143         case LC_MONETARY:
2144             my_strlcat(ret, "LC_MONETARY", sizeof(ret));
2145             break;
2146 #   endif
2147 #   ifdef LC_MESSAGES
2148         case LC_MESSAGES:
2149             my_strlcat(ret, "LC_MESSAGES", sizeof(ret));
2150             break;
2151 #   endif
2152     }
2153
2154     my_strlcat(ret, ", ", sizeof(ret));
2155
2156     if (locale) {
2157         my_strlcat(ret, "\"", sizeof(ret));
2158         my_strlcat(ret, locale, sizeof(ret));
2159         my_strlcat(ret, "\"", sizeof(ret));
2160     }
2161     else {
2162         my_strlcat(ret, "NULL", sizeof(ret));
2163     }
2164
2165     my_strlcat(ret, ") returned ", sizeof(ret));
2166
2167     if (retval) {
2168         my_strlcat(ret, "\"", sizeof(ret));
2169         my_strlcat(ret, retval, sizeof(ret));
2170         my_strlcat(ret, "\"", sizeof(ret));
2171     }
2172     else {
2173         my_strlcat(ret, "NULL", sizeof(ret));
2174     }
2175
2176     assert(strlen(ret) < sizeof(ret));
2177
2178     return ret;
2179 }
2180
2181 #endif
2182
2183
2184 /*
2185  * ex: set ts=8 sts=4 sw=4 et:
2186  */