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.
  33  */
  34
  35 #include "EXTERN.h"
  36 #define PERL_IN_LOCALE_C
  37 #include "perl.h"
  38
  39 #ifdef I_LANGINFO
  40 #   include <langinfo.h>
  41 #endif
  42
  43 #include "reentr.h"
  44
  45 #ifdef USE_LOCALE
  46
  47 /*
  48  * Standardize the locale name from a string returned by 'setlocale', possibly
  49  * modifying that string.
  50  *
  51  * The typical return value of setlocale() is either
  52  * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
  53  * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
  54  *     (the space-separated values represent the various sublocales,
  55  *      in some unspecified order).  This is not handled by this function.
  56  *
  57  * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
  58  * which is harmful for further use of the string in setlocale().  This
  59  * function removes the trailing new line and everything up through the '='
  60  *
  61  */
  62 STATIC char *
  63 S_stdize_locale(pTHX_ char *locs)
  64 {
  65     const char * const s = strchr(locs, '=');
  66     bool okay = TRUE;
  67
  68     PERL_ARGS_ASSERT_STDIZE_LOCALE;
  69
  70     if (s) {
  71         const char * const t = strchr(s, '.');
  72         okay = FALSE;
  73         if (t) {
  74             const char * const u = strchr(t, '\n');
  75             if (u && (u[1] == 0)) {
  76                 const STRLEN len = u - s;
  77                 Move(s + 1, locs, len, char);
  78                 locs[len] = 0;
  79                 okay = TRUE;
  80             }
  81         }
  82     }
  83
  84     if (!okay)
  85         Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
  86
  87     return locs;
  88 }
  89
  90 #endif
  91
  92 void
  93 Perl_set_numeric_radix(pTHX)
  94 {
  95 #ifdef USE_LOCALE_NUMERIC
  96 # ifdef HAS_LOCALECONV
  97     const struct lconv* const lc = localeconv();
  98
  99     if (lc && lc->decimal_point) {
 100         if (lc->decimal_point[0] == '.' && lc->decimal_point[1] == 0) {
 101             SvREFCNT_dec(PL_numeric_radix_sv);
 102             PL_numeric_radix_sv = NULL;
 103         }
 104         else {
 105             if (PL_numeric_radix_sv)
 106                 sv_setpv(PL_numeric_radix_sv, lc->decimal_point);
 107             else
 108                 PL_numeric_radix_sv = newSVpv(lc->decimal_point, 0);
 109             if (! is_invariant_string((U8 *) lc->decimal_point, 0)
 110                 && is_utf8_string((U8 *) lc->decimal_point, 0)
 111                 && _is_cur_LC_category_utf8(LC_NUMERIC))
 112             {
 113                 SvUTF8_on(PL_numeric_radix_sv);
 114             }
 115         }
 116     }
 117     else
 118         PL_numeric_radix_sv = NULL;
 119
 120     DEBUG_L(PerlIO_printf(Perl_debug_log, "Locale radix is %s\n",
 121                                           (PL_numeric_radix_sv)
 122                                           ? lc->decimal_point
 123                                           : "NULL"));
 124
 125 # endif /* HAS_LOCALECONV */
 126 #endif /* USE_LOCALE_NUMERIC */
 127 }
 128
 129 /* Is the C string input 'name' "C" or "POSIX"?  If so, and 'name' is the
 130  * return of setlocale(), then this is extremely likely to be the C or POSIX
 131  * locale.  However, the output of setlocale() is documented to be opaque, but
 132  * the odds are extremely small that it would return these two strings for some
 133  * other locale.  Note that VMS in these two locales includes many non-ASCII
 134  * characters as controls and punctuation (below are hex bytes):
 135  *   cntrl:  00-1F 7F 84-97 9B-9F
 136  *   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
 137  * Oddly, none there are listed as alphas, though some represent alphabetics
 138  * http://www.nntp.perl.org/group/perl.perl5.porters/2013/02/msg198753.html */
 139 #define isNAME_C_OR_POSIX(name) ((name) != NULL                                 \
 140                                   && ((*(name) == 'C' && (*(name + 1)) == '\0') \
 141                                        || strEQ((name), "POSIX")))
 142
 143 void
 144 Perl_new_numeric(pTHX_ const char *newnum)
 145 {
 146 #ifdef USE_LOCALE_NUMERIC
 147
 148     /* Called after all libc setlocale() calls affecting LC_NUMERIC, to tell
 149      * core Perl this and that 'newnum' is the name of the new locale.
 150      * It installs this locale as the current underlying default.
 151      *
 152      * The default locale and the C locale can be toggled between by use of the
 153      * set_numeric_local() and set_numeric_standard() functions, which should
 154      * probably not be called directly, but only via macros like
 155      * SET_NUMERIC_STANDARD() in perl.h.
 156      *
 157      * The toggling is necessary mainly so that a non-dot radix decimal point
 158      * character can be output, while allowing internal calculations to use a
 159      * dot.
 160      *
 161      * This sets several interpreter-level variables:
 162      * PL_numeric_name  The underlying locale's name: a copy of 'newnum'
 163      * PL_numeric_local A boolean indicating if the toggled state is such
 164      *                  that the current locale is the program's underlying
 165      *                  locale
 166      * PL_numeric_standard An int indicating if the toggled state is such
 167      *                  that the current locale is the C locale.  If non-zero,
 168      *                  it is in C; if > 1, it means it may not be toggled away
 169      *                  from C.
 170      * Note that both of the last two variables can be true at the same time,
 171      * if the underlying locale is C.  (Toggling is a no-op under these
 172      * circumstances.)
 173      *
 174      * Any code changing the locale (outside this file) should use
 175      * POSIX::setlocale, which calls this function.  Therefore this function
 176      * should be called directly only from this file and from
 177      * POSIX::setlocale() */
 178
 179     char *save_newnum;
 180
 181     if (! newnum) {
 182         Safefree(PL_numeric_name);
 183         PL_numeric_name = NULL;
 184         PL_numeric_standard = TRUE;
 185         PL_numeric_local = TRUE;
 186         return;
 187     }
 188
 189     save_newnum = stdize_locale(savepv(newnum));
 190     if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
 191         Safefree(PL_numeric_name);
 192         PL_numeric_name = save_newnum;
 193     }
 194
 195     PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
 196     PL_numeric_local = TRUE;
 197
 198     /* Keep LC_NUMERIC in the C locale.  This is for XS modules, so they don't
 199      * have to worry about the radix being a non-dot.  (Core operations that
 200      * need the underlying locale change to it temporarily). */
 201     set_numeric_standard();
 202
 203     set_numeric_radix();
 204
 205 #else
 206     PERL_UNUSED_ARG(newnum);
 207 #endif /* USE_LOCALE_NUMERIC */
 208 }
 209
 210 void
 211 Perl_set_numeric_standard(pTHX)
 212 {
 213 #ifdef USE_LOCALE_NUMERIC
 214     /* Toggle the LC_NUMERIC locale to C.  Most code should use the macros like
 215      * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly.  The
 216      * macro avoids calling this routine if toggling isn't necessary according
 217      * to our records (which could be wrong if some XS code has changed the
 218      * locale behind our back) */
 219
 220     setlocale(LC_NUMERIC, "C");
 221     PL_numeric_standard = TRUE;
 222     PL_numeric_local = isNAME_C_OR_POSIX(PL_numeric_name);
 223     set_numeric_radix();
 224     DEBUG_L(PerlIO_printf(Perl_debug_log,
 225                           "Underlying LC_NUMERIC locale now is C\n"));
 226
 227 #endif /* USE_LOCALE_NUMERIC */
 228 }
 229
 230 void
 231 Perl_set_numeric_local(pTHX)
 232 {
 233 #ifdef USE_LOCALE_NUMERIC
 234     /* Toggle the LC_NUMERIC locale to the current underlying default.  Most
 235      * code should use the macros like SET_NUMERIC_LOCAL() in perl.h instead of
 236      * calling this directly.  The macro avoids calling this routine if
 237      * toggling isn't necessary according to our records (which could be wrong
 238      * if some XS code has changed the locale behind our back) */
 239
 240     setlocale(LC_NUMERIC, PL_numeric_name);
 241     PL_numeric_standard = isNAME_C_OR_POSIX(PL_numeric_name);
 242     PL_numeric_local = TRUE;
 243     set_numeric_radix();
 244     DEBUG_L(PerlIO_printf(Perl_debug_log,
 245                           "Underlying LC_NUMERIC locale now is %s\n",
 246                           PL_numeric_name));
 247
 248 #endif /* USE_LOCALE_NUMERIC */
 249 }
 250
 251 /*
 252  * Set up for a new ctype locale.
 253  */
 254 void
 255 Perl_new_ctype(pTHX_ const char *newctype)
 256 {
 257 #ifdef USE_LOCALE_CTYPE
 258
 259     /* Called after all libc setlocale() calls affecting LC_CTYPE, to tell
 260      * core Perl this and that 'newctype' is the name of the new locale.
 261      *
 262      * This function sets up the folding arrays for all 256 bytes, assuming
 263      * that tofold() is tolc() since fold case is not a concept in POSIX,
 264      *
 265      * Any code changing the locale (outside this file) should use
 266      * POSIX::setlocale, which calls this function.  Therefore this function
 267      * should be called directly only from this file and from
 268      * POSIX::setlocale() */
 269
 270     dVAR;
 271     UV i;
 272
 273     PERL_ARGS_ASSERT_NEW_CTYPE;
 274
 275     /* We will replace any bad locale warning with 1) nothing if the new one is
 276      * ok; or 2) a new warning for the bad new locale */
 277     if (PL_warn_locale) {
 278         SvREFCNT_dec_NN(PL_warn_locale);
 279         PL_warn_locale = NULL;
 280     }
 281
 282     PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE);
 283
 284     /* A UTF-8 locale gets standard rules.  But note that code still has to
 285      * handle this specially because of the three problematic code points */
 286     if (PL_in_utf8_CTYPE_locale) {
 287         Copy(PL_fold_latin1, PL_fold_locale, 256, U8);
 288     }
 289     else {
 290         /* Assume enough space for every character being bad.  4 spaces each
 291          * for the 94 printable characters that are output like "'x' "; and 5
 292          * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating
 293          * NUL */
 294         char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ];
 295
 296         bool check_for_problems = ckWARN_d(WARN_LOCALE); /* No warnings means
 297                                                             no check */
 298         bool multi_byte_locale = FALSE;     /* Assume is a single-byte locale
 299                                                to start */
 300         unsigned int bad_count = 0;         /* Count of bad characters */
 301
 302         for (i = 0; i < 256; i++) {
 303             if (isUPPER_LC((U8) i))
 304                 PL_fold_locale[i] = (U8) toLOWER_LC((U8) i);
 305             else if (isLOWER_LC((U8) i))
 306                 PL_fold_locale[i] = (U8) toUPPER_LC((U8) i);
 307             else
 308                 PL_fold_locale[i] = (U8) i;
 309
 310             /* If checking for locale problems, see if the native ASCII-range
 311              * printables plus \n and \t are in their expected categories in
 312              * the new locale.  If not, this could mean big trouble, upending
 313              * Perl's and most programs' assumptions, like having a
 314              * metacharacter with special meaning become a \w.  Fortunately,
 315              * it's very rare to find locales that aren't supersets of ASCII
 316              * nowadays.  It isn't a problem for most controls to be changed
 317              * into something else; we check only \n and \t, though perhaps \r
 318              * could be an issue as well. */
 319             if (check_for_problems
 320                 && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n'))
 321             {
 322                 if ((isALPHANUMERIC_A(i) && ! isALPHANUMERIC_LC(i))
 323                      || (isPUNCT_A(i) && ! isPUNCT_LC(i))
 324                      || (isBLANK_A(i) && ! isBLANK_LC(i))
 325                      || (i == '\n' && ! isCNTRL_LC(i)))
 326                 {
 327                     if (bad_count) {    /* Separate multiple entries with a
 328                                            blank */
 329                         bad_chars_list[bad_count++] = ' ';
 330                     }
 331                     bad_chars_list[bad_count++] = '\'';
 332                     if (isPRINT_A(i)) {
 333                         bad_chars_list[bad_count++] = (char) i;
 334                     }
 335                     else {
 336                         bad_chars_list[bad_count++] = '\\';
 337                         if (i == '\n') {
 338                             bad_chars_list[bad_count++] = 'n';
 339                         }
 340                         else {
 341                             assert(i == '\t');
 342                             bad_chars_list[bad_count++] = 't';
 343                         }
 344                     }
 345                     bad_chars_list[bad_count++] = '\'';
 346                     bad_chars_list[bad_count] = '\0';
 347                 }
 348             }
 349         }
 350
 351 #ifdef MB_CUR_MAX
 352         /* We only handle single-byte locales (outside of UTF-8 ones; so if
 353          * this locale requires than one byte, there are going to be
 354          * problems. */
 355         if (check_for_problems && MB_CUR_MAX > 1
 356
 357                /* Some platforms return MB_CUR_MAX > 1 for even the "C"
 358                 * locale.  Just assume that the implementation for them (plus
 359                 * for POSIX) is correct and the > 1 value is spurious.  (Since
 360                 * these are specially handled to never be considered UTF-8
 361                 * locales, as long as this is the only problem, everything
 362                 * should work fine */
 363             && strNE(newctype, "C") && strNE(newctype, "POSIX"))
 364         {
 365             multi_byte_locale = TRUE;
 366         }
 367 #endif
 368
 369         if (bad_count || multi_byte_locale) {
 370             PL_warn_locale = Perl_newSVpvf(aTHX_
 371                              "Locale '%s' may not work well.%s%s%s\n",
 372                              newctype,
 373                              (multi_byte_locale)
 374                               ? "  Some characters in it are not recognized by"
 375                                 " Perl."
 376                               : "",
 377                              (bad_count)
 378                               ? "\nThe following characters (and maybe others)"
 379                                 " may not have the same meaning as the Perl"
 380                                 " program expects:\n"
 381                               : "",
 382                              (bad_count)
 383                               ? bad_chars_list
 384                               : ""
 385                             );
 386             /* If we are actually in the scope of the locale, output the
 387              * message now.  Otherwise we save it to be output at the first
 388              * operation using this locale, if that actually happens.  Most
 389              * programs don't use locales, so they are immune to bad ones */
 390             if (IN_LC(LC_CTYPE)) {
 391
 392                 /* We have to save 'newctype' because the setlocale() just
 393                  * below may destroy it.  The next setlocale() further down
 394                  * should restore it properly so that the intermediate change
 395                  * here is transparent to this function's caller */
 396                 const char * const badlocale = savepv(newctype);
 397
 398                 setlocale(LC_CTYPE, "C");
 399
 400                 /* The '0' below suppresses a bogus gcc compiler warning */
 401                 Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0);
 402                 setlocale(LC_CTYPE, badlocale);
 403                 SvREFCNT_dec_NN(PL_warn_locale);
 404                 PL_warn_locale = NULL;
 405             }
 406         }
 407     }
 408
 409 #endif /* USE_LOCALE_CTYPE */
 410     PERL_ARGS_ASSERT_NEW_CTYPE;
 411     PERL_UNUSED_ARG(newctype);
 412     PERL_UNUSED_CONTEXT;
 413 }
 414
 415 void
 416 Perl_new_collate(pTHX_ const char *newcoll)
 417 {
 418 #ifdef USE_LOCALE_COLLATE
 419
 420     /* Called after all libc setlocale() calls affecting LC_COLLATE, to tell
 421      * core Perl this and that 'newcoll' is the name of the new locale.
 422      *
 423      * Any code changing the locale (outside this file) should use
 424      * POSIX::setlocale, which calls this function.  Therefore this function
 425      * should be called directly only from this file and from
 426      * POSIX::setlocale() */
 427
 428     if (! newcoll) {
 429         if (PL_collation_name) {
 430             ++PL_collation_ix;
 431             Safefree(PL_collation_name);
 432             PL_collation_name = NULL;
 433         }
 434         PL_collation_standard = TRUE;
 435         PL_collxfrm_base = 0;
 436         PL_collxfrm_mult = 2;
 437         return;
 438     }
 439
 440     if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
 441         ++PL_collation_ix;
 442         Safefree(PL_collation_name);
 443         PL_collation_name = stdize_locale(savepv(newcoll));
 444         PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
 445
 446         {
 447           /*  2: at most so many chars ('a', 'b'). */
 448           /* 50: surely no system expands a char more. */
 449 #define XFRMBUFSIZE  (2 * 50)
 450           char xbuf[XFRMBUFSIZE];
 451           const Size_t fa = strxfrm(xbuf, "a",  XFRMBUFSIZE);
 452           const Size_t fb = strxfrm(xbuf, "ab", XFRMBUFSIZE);
 453           const SSize_t mult = fb - fa;
 454           if (mult < 1 && !(fa == 0 && fb == 0))
 455               Perl_croak(aTHX_ "panic: strxfrm() gets absurd - a => %"UVuf", ab => %"UVuf,
 456                          (UV) fa, (UV) fb);
 457           PL_collxfrm_base = (fa > (Size_t)mult) ? (fa - mult) : 0;
 458           PL_collxfrm_mult = mult;
 459         }
 460     }
 461
 462 #else
 463     PERL_UNUSED_ARG(newcoll);
 464 #endif /* USE_LOCALE_COLLATE */
 465 }
 466
 467 #ifdef WIN32
 468
 469 char *
 470 Perl_my_setlocale(pTHX_ int category, const char* locale)
 471 {
 472     /* This, for Windows, emulates POSIX setlocale() behavior.  There is no
 473      * difference unless the input locale is "", which means on Windows to get
 474      * the machine default, which is set via the computer's "Regional and
 475      * Language Options" (or its current equivalent).  In POSIX, it instead
 476      * means to find the locale from the user's environment.  This routine
 477      * looks in the environment, and, if anything is found, uses that instead
 478      * of going to the machine default.  If there is no environment override,
 479      * the machine default is used, as normal, by calling the real setlocale()
 480      * with "".  The POSIX behavior is to use the LC_ALL variable if set;
 481      * otherwise to use the particular category's variable if set; otherwise to
 482      * use the LANG variable. */
 483
 484     bool override_LC_ALL = 0;
 485     char * result;
 486
 487     if (locale && strEQ(locale, "")) {
 488 #   ifdef LC_ALL
 489         locale = PerlEnv_getenv("LC_ALL");
 490         if (! locale) {
 491 #endif
 492             switch (category) {
 493 #   ifdef LC_ALL
 494                 case LC_ALL:
 495                     override_LC_ALL = TRUE;
 496                     break;  /* We already know its variable isn't set */
 497 #   endif
 498 #   ifdef USE_LOCALE_TIME
 499                 case LC_TIME:
 500                     locale = PerlEnv_getenv("LC_TIME");
 501                     break;
 502 #   endif
 503 #   ifdef USE_LOCALE_CTYPE
 504                 case LC_CTYPE:
 505                     locale = PerlEnv_getenv("LC_CTYPE");
 506                     break;
 507 #   endif
 508 #   ifdef USE_LOCALE_COLLATE
 509                 case LC_COLLATE:
 510                     locale = PerlEnv_getenv("LC_COLLATE");
 511                     break;
 512 #   endif
 513 #   ifdef USE_LOCALE_MONETARY
 514                 case LC_MONETARY:
 515                     locale = PerlEnv_getenv("LC_MONETARY");
 516                     break;
 517 #   endif
 518 #   ifdef USE_LOCALE_NUMERIC
 519                 case LC_NUMERIC:
 520                     locale = PerlEnv_getenv("LC_NUMERIC");
 521                     break;
 522 #   endif
 523 #   ifdef USE_LOCALE_MESSAGES
 524                 case LC_MESSAGES:
 525                     locale = PerlEnv_getenv("LC_MESSAGES");
 526                     break;
 527 #   endif
 528                 default:
 529                     /* This is a category, like PAPER_SIZE that we don't
 530                      * know about; and so can't provide a wrapper. */
 531                     break;
 532             }
 533             if (! locale) {
 534                 locale = PerlEnv_getenv("LANG");
 535                 if (! locale) {
 536                     locale = "";
 537                 }
 538             }
 539 #   ifdef LC_ALL
 540         }
 541 #   endif
 542     }
 543
 544     result = setlocale(category, locale);
 545
 546     if (! override_LC_ALL)  {
 547         return result;
 548     }
 549
 550     /* Here the input locale was LC_ALL, and we have set it to what is in the
 551      * LANG variable or the system default if there is no LANG.  But these have
 552      * lower priority than the other LC_foo variables, so override it for each
 553      * one that is set.  (If they are set to "", it means to use the same thing
 554      * we just set LC_ALL to, so can skip) */
 555 #   ifdef USE_LOCALE_TIME
 556     result = PerlEnv_getenv("LC_TIME");
 557     if (result && strNE(result, "")) {
 558         setlocale(LC_TIME, result);
 559     }
 560 #   endif
 561 #   ifdef USE_LOCALE_CTYPE
 562     result = PerlEnv_getenv("LC_CTYPE");
 563     if (result && strNE(result, "")) {
 564         setlocale(LC_CTYPE, result);
 565     }
 566 #   endif
 567 #   ifdef USE_LOCALE_COLLATE
 568     result = PerlEnv_getenv("LC_COLLATE");
 569     if (result && strNE(result, "")) {
 570         setlocale(LC_COLLATE, result);
 571     }
 572 #   endif
 573 #   ifdef USE_LOCALE_MONETARY
 574     result = PerlEnv_getenv("LC_MONETARY");
 575     if (result && strNE(result, "")) {
 576         setlocale(LC_MONETARY, result);
 577     }
 578 #   endif
 579 #   ifdef USE_LOCALE_NUMERIC
 580     result = PerlEnv_getenv("LC_NUMERIC");
 581     if (result && strNE(result, "")) {
 582         setlocale(LC_NUMERIC, result);
 583     }
 584 #   endif
 585 #   ifdef USE_LOCALE_MESSAGES
 586     result = PerlEnv_getenv("LC_MESSAGES");
 587     if (result && strNE(result, "")) {
 588         setlocale(LC_MESSAGES, result);
 589     }
 590 #   endif
 591
 592     return setlocale(LC_ALL, NULL);
 593
 594 }
 595
 596 #endif
 597
 598
 599 /*
 600  * Initialize locale awareness.
 601  */
 602 int
 603 Perl_init_i18nl10n(pTHX_ int printwarn)
 604 {
 605     /* printwarn is
 606      *
 607      *    0 if not to output warning when setup locale is bad
 608      *    1 if to output warning based on value of PERL_BADLANG
 609      *    >1 if to output regardless of PERL_BADLANG
 610      *
 611      * returns
 612      *    1 = set ok or not applicable,
 613      *    0 = fallback to a locale of lower priority
 614      *   -1 = fallback to all locales failed, not even to the C locale
 615      */
 616
 617     int ok = 1;
 618
 619 #if defined(USE_LOCALE)
 620 #ifdef USE_LOCALE_CTYPE
 621     char *curctype   = NULL;
 622 #endif /* USE_LOCALE_CTYPE */
 623 #ifdef USE_LOCALE_COLLATE
 624     char *curcoll    = NULL;
 625 #endif /* USE_LOCALE_COLLATE */
 626 #ifdef USE_LOCALE_NUMERIC
 627     char *curnum     = NULL;
 628 #endif /* USE_LOCALE_NUMERIC */
 629 #ifdef __GLIBC__
 630     char * const language   = PerlEnv_getenv("LANGUAGE");
 631 #endif
 632
 633     /* NULL uses the existing already set up locale */
 634     const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
 635                                         ? NULL
 636                                         : "";
 637     const char* trial_locales[5];   /* 5 = 1 each for "", LC_ALL, LANG, "", C */
 638     unsigned int trial_locales_count;
 639     char * const lc_all     = PerlEnv_getenv("LC_ALL");
 640     char * const lang       = PerlEnv_getenv("LANG");
 641     bool setlocale_failure = FALSE;
 642     unsigned int i;
 643     char *p;
 644     const bool locwarn = (printwarn > 1 ||
 645                     (printwarn &&
 646                      (!(p = PerlEnv_getenv("PERL_BADLANG")) ||
 647                       grok_atou(p, NULL))));
 648     bool done = FALSE;
 649 #ifdef WIN32
 650     /* In some systems you can find out the system default locale
 651      * and use that as the fallback locale. */
 652 #   define SYSTEM_DEFAULT_LOCALE
 653 #endif
 654 #ifdef SYSTEM_DEFAULT_LOCALE
 655     const char *system_default_locale = NULL;
 656 #endif
 657
 658 #ifndef LOCALE_ENVIRON_REQUIRED
 659     PERL_UNUSED_VAR(done);
 660 #else
 661
 662     /*
 663      * Ultrix setlocale(..., "") fails if there are no environment
 664      * variables from which to get a locale name.
 665      */
 666
 667 #   ifdef LC_ALL
 668     if (lang) {
 669         if (my_setlocale(LC_ALL, setlocale_init))
 670             done = TRUE;
 671         else
 672             setlocale_failure = TRUE;
 673     }
 674     if (!setlocale_failure) {
 675 #       ifdef USE_LOCALE_CTYPE
 676         Safefree(curctype);
 677         if (! (curctype =
 678                my_setlocale(LC_CTYPE,
 679                          (!done && (lang || PerlEnv_getenv("LC_CTYPE")))
 680                                     ? setlocale_init : NULL)))
 681             setlocale_failure = TRUE;
 682         else
 683             curctype = savepv(curctype);
 684 #       endif /* USE_LOCALE_CTYPE */
 685 #       ifdef USE_LOCALE_COLLATE
 686         Safefree(curcoll);
 687         if (! (curcoll =
 688                my_setlocale(LC_COLLATE,
 689                          (!done && (lang || PerlEnv_getenv("LC_COLLATE")))
 690                                    ? setlocale_init : NULL)))
 691             setlocale_failure = TRUE;
 692         else
 693             curcoll = savepv(curcoll);
 694 #       endif /* USE_LOCALE_COLLATE */
 695 #       ifdef USE_LOCALE_NUMERIC
 696         Safefree(curnum);
 697         if (! (curnum =
 698                my_setlocale(LC_NUMERIC,
 699                          (!done && (lang || PerlEnv_getenv("LC_NUMERIC")))
 700                                   ? setlocale_init : NULL)))
 701             setlocale_failure = TRUE;
 702         else
 703             curnum = savepv(curnum);
 704 #       endif /* USE_LOCALE_NUMERIC */
 705 #       ifdef USE_LOCALE_MESSAGES
 706         if (! my_setlocale(LC_MESSAGES,
 707                          (!done && (lang || PerlEnv_getenv("LC_MESSAGES")))
 708                                   ? setlocale_init : NULL))
 709         {
 710             setlocale_failure = TRUE;
 711         }
 712 #       endif /* USE_LOCALE_MESSAGES */
 713 #       ifdef USE_LOCALE_MONETARY
 714         if (! my_setlocale(LC_MONETARY,
 715                          (!done && (lang || PerlEnv_getenv("LC_MONETARY")))
 716                                   ? setlocale_init : NULL))
 717         {
 718             setlocale_failure = TRUE;
 719         }
 720 #       endif /* USE_LOCALE_MONETARY */
 721     }
 722
 723 #   endif /* LC_ALL */
 724
 725 #endif /* !LOCALE_ENVIRON_REQUIRED */
 726
 727     /* We try each locale in the list until we get one that works, or exhaust
 728      * the list */
 729     trial_locales[0] = setlocale_init;
 730     trial_locales_count = 1;
 731     for (i= 0; i < trial_locales_count; i++) {
 732         const char * trial_locale = trial_locales[i];
 733
 734         if (i > 0) {
 735
 736             /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED
 737              * when i==0, but I (khw) don't think that behavior makes much
 738              * sense */
 739             setlocale_failure = FALSE;
 740
 741 #ifdef SYSTEM_DEFAULT_LOCALE
 742 #  ifdef WIN32
 743             /* On Windows machines, an entry of "" after the 0th means to use
 744              * the system default locale, which we now proceed to get. */
 745             if (strEQ(trial_locale, "")) {
 746                 unsigned int j;
 747
 748                 /* Note that this may change the locale, but we are going to do
 749                  * that anyway just below */
 750                 system_default_locale = setlocale(LC_ALL, "");
 751
 752                 /* Skip if invalid or it's already on the list of locales to
 753                  * try */
 754                 if (! system_default_locale) {
 755                     goto next_iteration;
 756                 }
 757                 for (j = 0; j < trial_locales_count; j++) {
 758                     if (strEQ(system_default_locale, trial_locales[j])) {
 759                         goto next_iteration;
 760                     }
 761                 }
 762
 763                 trial_locale = system_default_locale;
 764             }
 765 #  endif /* WIN32 */
 766 #endif /* SYSTEM_DEFAULT_LOCALE */
 767         }
 768
 769 #ifdef LC_ALL
 770         if (! my_setlocale(LC_ALL, trial_locale)) {
 771             setlocale_failure = TRUE;
 772         }
 773         else {
 774             /* Since LC_ALL succeeded, it should have changed all the other
 775              * categories it can to its value; so we massage things so that the
 776              * setlocales below just return their category's current values.
 777              * This adequately handles the case in NetBSD where LC_COLLATE may
 778              * not be defined for a locale, and setting it individually will
 779              * fail, whereas setting LC_ALL suceeds, leaving LC_COLLATE set to
 780              * the POSIX locale. */
 781             trial_locale = NULL;
 782         }
 783 #endif /* LC_ALL */
 784
 785         if (!setlocale_failure) {
 786 #ifdef USE_LOCALE_CTYPE
 787             Safefree(curctype);
 788             if (! (curctype = my_setlocale(LC_CTYPE, trial_locale)))
 789                 setlocale_failure = TRUE;
 790             else
 791                 curctype = savepv(curctype);
 792 #endif /* USE_LOCALE_CTYPE */
 793 #ifdef USE_LOCALE_COLLATE
 794             Safefree(curcoll);
 795             if (! (curcoll = my_setlocale(LC_COLLATE, trial_locale)))
 796                 setlocale_failure = TRUE;
 797             else
 798                 curcoll = savepv(curcoll);
 799 #endif /* USE_LOCALE_COLLATE */
 800 #ifdef USE_LOCALE_NUMERIC
 801             Safefree(curnum);
 802             if (! (curnum = my_setlocale(LC_NUMERIC, trial_locale)))
 803                 setlocale_failure = TRUE;
 804             else
 805                 curnum = savepv(curnum);
 806 #endif /* USE_LOCALE_NUMERIC */
 807 #ifdef USE_LOCALE_MESSAGES
 808             if (! (my_setlocale(LC_MESSAGES, trial_locale)))
 809                 setlocale_failure = TRUE;
 810 #endif /* USE_LOCALE_MESSAGES */
 811 #ifdef USE_LOCALE_MONETARY
 812             if (! (my_setlocale(LC_MONETARY, trial_locale)))
 813                 setlocale_failure = TRUE;
 814 #endif /* USE_LOCALE_MONETARY */
 815
 816             if (! setlocale_failure) {  /* Success */
 817                 break;
 818             }
 819         }
 820
 821         /* Here, something failed; will need to try a fallback. */
 822         ok = 0;
 823
 824         if (i == 0) {
 825             unsigned int j;
 826
 827             if (locwarn) { /* Output failure info only on the first one */
 828 #ifdef LC_ALL
 829
 830                 PerlIO_printf(Perl_error_log,
 831                 "perl: warning: Setting locale failed.\n");
 832
 833 #else /* !LC_ALL */
 834
 835                 PerlIO_printf(Perl_error_log,
 836                 "perl: warning: Setting locale failed for the categories:\n\t");
 837 #ifdef USE_LOCALE_CTYPE
 838                 if (! curctype)
 839                     PerlIO_printf(Perl_error_log, "LC_CTYPE ");
 840 #endif /* USE_LOCALE_CTYPE */
 841 #ifdef USE_LOCALE_COLLATE
 842                 if (! curcoll)
 843                     PerlIO_printf(Perl_error_log, "LC_COLLATE ");
 844 #endif /* USE_LOCALE_COLLATE */
 845 #ifdef USE_LOCALE_NUMERIC
 846                 if (! curnum)
 847                     PerlIO_printf(Perl_error_log, "LC_NUMERIC ");
 848 #endif /* USE_LOCALE_NUMERIC */
 849                 PerlIO_printf(Perl_error_log, "and possibly others\n");
 850
 851 #endif /* LC_ALL */
 852
 853                 PerlIO_printf(Perl_error_log,
 854                     "perl: warning: Please check that your locale settings:\n");
 855
 856 #ifdef __GLIBC__
 857                 PerlIO_printf(Perl_error_log,
 858                             "\tLANGUAGE = %c%s%c,\n",
 859                             language ? '"' : '(',
 860                             language ? language : "unset",
 861                             language ? '"' : ')');
 862 #endif
 863
 864                 PerlIO_printf(Perl_error_log,
 865                             "\tLC_ALL = %c%s%c,\n",
 866                             lc_all ? '"' : '(',
 867                             lc_all ? lc_all : "unset",
 868                             lc_all ? '"' : ')');
 869
 870 #if defined(USE_ENVIRON_ARRAY)
 871                 {
 872                 char **e;
 873                 for (e = environ; *e; e++) {
 874                     if (strnEQ(*e, "LC_", 3)
 875                             && strnNE(*e, "LC_ALL=", 7)
 876                             && (p = strchr(*e, '=')))
 877                         PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
 878                                         (int)(p - *e), *e, p + 1);
 879                 }
 880                 }
 881 #else
 882                 PerlIO_printf(Perl_error_log,
 883                             "\t(possibly more locale environment variables)\n");
 884 #endif
 885
 886                 PerlIO_printf(Perl_error_log,
 887                             "\tLANG = %c%s%c\n",
 888                             lang ? '"' : '(',
 889                             lang ? lang : "unset",
 890                             lang ? '"' : ')');
 891
 892                 PerlIO_printf(Perl_error_log,
 893                             "    are supported and installed on your system.\n");
 894             }
 895
 896             /* Calculate what fallback locales to try.  We have avoided this
 897              * until we have to, becuase failure is quite unlikely.  This will
 898              * usually change the upper bound of the loop we are in.
 899              *
 900              * Since the system's default way of setting the locale has not
 901              * found one that works, We use Perl's defined ordering: LC_ALL,
 902              * LANG, and the C locale.  We don't try the same locale twice, so
 903              * don't add to the list if already there.  (On POSIX systems, the
 904              * LC_ALL element will likely be a repeat of the 0th element "",
 905              * but there's no harm done by doing it explicitly */
 906             if (lc_all) {
 907                 for (j = 0; j < trial_locales_count; j++) {
 908                     if (strEQ(lc_all, trial_locales[j])) {
 909                         goto done_lc_all;
 910                     }
 911                 }
 912                 trial_locales[trial_locales_count++] = lc_all;
 913             }
 914           done_lc_all:
 915
 916             if (lang) {
 917                 for (j = 0; j < trial_locales_count; j++) {
 918                     if (strEQ(lang, trial_locales[j])) {
 919                         goto done_lang;
 920                     }
 921                 }
 922                 trial_locales[trial_locales_count++] = lang;
 923             }
 924           done_lang:
 925
 926 #if defined(WIN32) && defined(LC_ALL)
 927             /* For Windows, we also try the system default locale before "C".
 928              * (If there exists a Windows without LC_ALL we skip this because
 929              * it gets too complicated.  For those, the "C" is the next
 930              * fallback possibility).  The "" is the same as the 0th element of
 931              * the array, but the code at the loop above knows to treat it
 932              * differently when not the 0th */
 933             trial_locales[trial_locales_count++] = "";
 934 #endif
 935
 936             for (j = 0; j < trial_locales_count; j++) {
 937                 if (strEQ("C", trial_locales[j])) {
 938                     goto done_C;
 939                 }
 940             }
 941             trial_locales[trial_locales_count++] = "C";
 942
 943           done_C: ;
 944         }   /* end of first time through the loop */
 945
 946 #ifdef WIN32
 947       next_iteration: ;
 948 #endif
 949
 950     }   /* end of looping through the trial locales */
 951
 952     if (ok < 1) {   /* If we tried to fallback */
 953         const char* msg;
 954         if (! setlocale_failure) {  /* fallback succeeded */
 955            msg = "Falling back to";
 956         }
 957         else {  /* fallback failed */
 958
 959             /* We dropped off the end of the loop, so have to decrement i to
 960              * get back to the value the last time through */
 961             i--;
 962
 963             ok = -1;
 964             msg = "Failed to fall back to";
 965
 966             /* To continue, we should use whatever values we've got */
 967 #ifdef USE_LOCALE_CTYPE
 968             Safefree(curctype);
 969             curctype = savepv(setlocale(LC_CTYPE, NULL));
 970 #endif /* USE_LOCALE_CTYPE */
 971 #ifdef USE_LOCALE_COLLATE
 972             Safefree(curcoll);
 973             curcoll = savepv(setlocale(LC_COLLATE, NULL));
 974 #endif /* USE_LOCALE_COLLATE */
 975 #ifdef USE_LOCALE_NUMERIC
 976             Safefree(curnum);
 977             curnum = savepv(setlocale(LC_NUMERIC, NULL));
 978 #endif /* USE_LOCALE_NUMERIC */
 979         }
 980
 981         if (locwarn) {
 982             const char * description;
 983             const char * name = "";
 984             if (strEQ(trial_locales[i], "C")) {
 985                 description = "the standard locale";
 986                 name = "C";
 987             }
 988 #ifdef SYSTEM_DEFAULT_LOCALE
 989             else if (strEQ(trial_locales[i], "")) {
 990                 description = "the system default locale";
 991                 if (system_default_locale) {
 992                     name = system_default_locale;
 993                 }
 994             }
 995 #endif /* SYSTEM_DEFAULT_LOCALE */
 996             else {
 997                 description = "a fallback locale";
 998                 name = trial_locales[i];
 999             }
1000             if (name && strNE(name, "")) {
1001                 PerlIO_printf(Perl_error_log,
1002                     "perl: warning: %s %s (\"%s\").\n", msg, description, name);
1003             }
1004             else {
1005                 PerlIO_printf(Perl_error_log,
1006                                    "perl: warning: %s %s.\n", msg, description);
1007             }
1008         }
1009     } /* End of tried to fallback */
1010
1011 #ifdef USE_LOCALE_CTYPE
1012     new_ctype(curctype);
1013 #endif /* USE_LOCALE_CTYPE */
1014
1015 #ifdef USE_LOCALE_COLLATE
1016     new_collate(curcoll);
1017 #endif /* USE_LOCALE_COLLATE */
1018
1019 #ifdef USE_LOCALE_NUMERIC
1020     new_numeric(curnum);
1021 #endif /* USE_LOCALE_NUMERIC */
1022
1023 #if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE)
1024     /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE
1025      * locale is UTF-8.  If PL_utf8locale and PL_unicode (set by -C or by
1026      * $ENV{PERL_UNICODE}) are true, perl.c:S_parse_body() will turn on the
1027      * PerlIO :utf8 layer on STDIN, STDOUT, STDERR, _and_ the default open
1028      * discipline.  */
1029     PL_utf8locale = _is_cur_LC_category_utf8(LC_CTYPE);
1030
1031     /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
1032        This is an alternative to using the -C command line switch
1033        (the -C if present will override this). */
1034     {
1035          const char *p = PerlEnv_getenv("PERL_UNICODE");
1036          PL_unicode = p ? parse_unicode_opts(&p) : 0;
1037          if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
1038              PL_utf8cache = -1;
1039     }
1040 #endif
1041
1042 #ifdef USE_LOCALE_CTYPE
1043     Safefree(curctype);
1044 #endif /* USE_LOCALE_CTYPE */
1045 #ifdef USE_LOCALE_COLLATE
1046     Safefree(curcoll);
1047 #endif /* USE_LOCALE_COLLATE */
1048 #ifdef USE_LOCALE_NUMERIC
1049     Safefree(curnum);
1050 #endif /* USE_LOCALE_NUMERIC */
1051
1052 #else  /* !USE_LOCALE */
1053     PERL_UNUSED_ARG(printwarn);
1054 #endif /* USE_LOCALE */
1055
1056     return ok;
1057 }
1058
1059
1060 #ifdef USE_LOCALE_COLLATE
1061
1062 /*
1063  * mem_collxfrm() is a bit like strxfrm() but with two important
1064  * differences. First, it handles embedded NULs. Second, it allocates
1065  * a bit more memory than needed for the transformed data itself.
1066  * The real transformed data begins at offset sizeof(collationix).
1067  * Please see sv_collxfrm() to see how this is used.
1068  */
1069
1070 char *
1071 Perl_mem_collxfrm(pTHX_ const char *s, STRLEN len, STRLEN *xlen)
1072 {
1073     char *xbuf;
1074     STRLEN xAlloc, xin, xout; /* xalloc is a reserved word in VC */
1075
1076     PERL_ARGS_ASSERT_MEM_COLLXFRM;
1077
1078     /* the first sizeof(collationix) bytes are used by sv_collxfrm(). */
1079     /* the +1 is for the terminating NUL. */
1080
1081     xAlloc = sizeof(PL_collation_ix) + PL_collxfrm_base + (PL_collxfrm_mult * len) + 1;
1082     Newx(xbuf, xAlloc, char);
1083     if (! xbuf)
1084         goto bad;
1085
1086     *(U32*)xbuf = PL_collation_ix;
1087     xout = sizeof(PL_collation_ix);
1088     for (xin = 0; xin < len; ) {
1089         Size_t xused;
1090
1091         for (;;) {
1092             xused = strxfrm(xbuf + xout, s + xin, xAlloc - xout);
1093             if (xused >= PERL_INT_MAX)
1094                 goto bad;
1095             if ((STRLEN)xused < xAlloc - xout)
1096                 break;
1097             xAlloc = (2 * xAlloc) + 1;
1098             Renew(xbuf, xAlloc, char);
1099             if (! xbuf)
1100                 goto bad;
1101         }
1102
1103         xin += strlen(s + xin) + 1;
1104         xout += xused;
1105
1106         /* Embedded NULs are understood but silently skipped
1107          * because they make no sense in locale collation. */
1108     }
1109
1110     xbuf[xout] = '\0';
1111     *xlen = xout - sizeof(PL_collation_ix);
1112     return xbuf;
1113
1114   bad:
1115     Safefree(xbuf);
1116     *xlen = 0;
1117     return NULL;
1118 }
1119
1120 #endif /* USE_LOCALE_COLLATE */
1121
1122 #ifdef USE_LOCALE
1123
1124 bool
1125 Perl__is_cur_LC_category_utf8(pTHX_ int category)
1126 {
1127     /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE
1128      * otherwise. 'category' may not be LC_ALL.  If the platform doesn't have
1129      * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence
1130      * could give the wrong result.  The result will very likely be correct for
1131      * languages that have commonly used non-ASCII characters, but for notably
1132      * English, it comes down to if the locale's name ends in something like
1133      * "UTF-8".  It errs on the side of not being a UTF-8 locale. */
1134
1135     char *save_input_locale = NULL;
1136     STRLEN final_pos;
1137
1138 #ifdef LC_ALL
1139     assert(category != LC_ALL);
1140 #endif
1141
1142     /* First dispose of the trivial cases */
1143     save_input_locale = setlocale(category, NULL);
1144     if (! save_input_locale) {
1145         DEBUG_L(PerlIO_printf(Perl_debug_log,
1146                               "Could not find current locale for category %d\n",
1147                               category));
1148         return FALSE;   /* XXX maybe should croak */
1149     }
1150     save_input_locale = stdize_locale(savepv(save_input_locale));
1151     if (isNAME_C_OR_POSIX(save_input_locale)) {
1152         DEBUG_L(PerlIO_printf(Perl_debug_log,
1153                               "Current locale for category %d is %s\n",
1154                               category, save_input_locale));
1155         Safefree(save_input_locale);
1156         return FALSE;
1157     }
1158
1159 #if defined(USE_LOCALE_CTYPE)    \
1160     && (defined(MB_CUR_MAX) || (defined(HAS_NL_LANGINFO) && defined(CODESET)))
1161
1162     { /* Next try nl_langinfo or MB_CUR_MAX if available */
1163
1164         char *save_ctype_locale = NULL;
1165         bool is_utf8;
1166
1167         if (category != LC_CTYPE) { /* These work only on LC_CTYPE */
1168
1169             /* Get the current LC_CTYPE locale */
1170             save_ctype_locale = setlocale(LC_CTYPE, NULL);
1171             if (! save_ctype_locale) {
1172                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1173                                "Could not find current locale for LC_CTYPE\n"));
1174                 goto cant_use_nllanginfo;
1175             }
1176             save_ctype_locale = stdize_locale(savepv(save_ctype_locale));
1177
1178             /* If LC_CTYPE and the desired category use the same locale, this
1179              * means that finding the value for LC_CTYPE is the same as finding
1180              * the value for the desired category.  Otherwise, switch LC_CTYPE
1181              * to the desired category's locale */
1182             if (strEQ(save_ctype_locale, save_input_locale)) {
1183                 Safefree(save_ctype_locale);
1184                 save_ctype_locale = NULL;
1185             }
1186             else if (! setlocale(LC_CTYPE, save_input_locale)) {
1187                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1188                                     "Could not change LC_CTYPE locale to %s\n",
1189                                     save_input_locale));
1190                 Safefree(save_ctype_locale);
1191                 goto cant_use_nllanginfo;
1192             }
1193         }
1194
1195         DEBUG_L(PerlIO_printf(Perl_debug_log, "Current LC_CTYPE locale=%s\n",
1196                                               save_input_locale));
1197
1198         /* Here the current LC_CTYPE is set to the locale of the category whose
1199          * information is desired.  This means that nl_langinfo() and MB_CUR_MAX
1200          * should give the correct results */
1201
1202 #   if defined(HAS_NL_LANGINFO) && defined(CODESET)
1203         {
1204             char *codeset = nl_langinfo(CODESET);
1205             if (codeset && strNE(codeset, "")) {
1206                 codeset = savepv(codeset);
1207
1208                 /* If we switched LC_CTYPE, switch back */
1209                 if (save_ctype_locale) {
1210                     setlocale(LC_CTYPE, save_ctype_locale);
1211                     Safefree(save_ctype_locale);
1212                 }
1213
1214                 is_utf8 = foldEQ(codeset, STR_WITH_LEN("UTF-8"))
1215                         || foldEQ(codeset, STR_WITH_LEN("UTF8"));
1216
1217                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1218                        "\tnllanginfo returned CODESET '%s'; ?UTF8 locale=%d\n",
1219                                                      codeset,         is_utf8));
1220                 Safefree(codeset);
1221                 Safefree(save_input_locale);
1222                 return is_utf8;
1223             }
1224         }
1225
1226 #   endif
1227 #   ifdef MB_CUR_MAX
1228
1229         /* Here, either we don't have nl_langinfo, or it didn't return a
1230          * codeset.  Try MB_CUR_MAX */
1231
1232         /* Standard UTF-8 needs at least 4 bytes to represent the maximum
1233          * Unicode code point.  Since UTF-8 is the only non-single byte
1234          * encoding we handle, we just say any such encoding is UTF-8, and if
1235          * turns out to be wrong, other things will fail */
1236         is_utf8 = MB_CUR_MAX >= 4;
1237
1238         DEBUG_L(PerlIO_printf(Perl_debug_log,
1239                               "\tMB_CUR_MAX=%d; ?UTF8 locale=%d\n",
1240                                    (int) MB_CUR_MAX,      is_utf8));
1241
1242         Safefree(save_input_locale);
1243
1244 #       ifdef HAS_MBTOWC
1245
1246         /* ... But, most system that have MB_CUR_MAX will also have mbtowc(),
1247          * since they are both in the C99 standard.  We can feed a known byte
1248          * string to the latter function, and check that it gives the expected
1249          * result */
1250         if (is_utf8) {
1251             wchar_t wc;
1252             PERL_UNUSED_RESULT(mbtowc(&wc, NULL, 0));/* Reset any shift state */
1253             errno = 0;
1254             if ((size_t)mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8))
1255                                                         != strlen(HYPHEN_UTF8)
1256                 || wc != (wchar_t) 0x2010)
1257             {
1258                 is_utf8 = FALSE;
1259                 DEBUG_L(PerlIO_printf(Perl_debug_log, "\thyphen=U+%x\n", (unsigned int)wc));
1260                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1261                         "\treturn from mbtowc=%d; errno=%d; ?UTF8 locale=0\n",
1262                         mbtowc(&wc, HYPHEN_UTF8, strlen(HYPHEN_UTF8)), errno));
1263             }
1264         }
1265 #       endif
1266
1267         /* If we switched LC_CTYPE, switch back */
1268         if (save_ctype_locale) {
1269             setlocale(LC_CTYPE, save_ctype_locale);
1270             Safefree(save_ctype_locale);
1271         }
1272
1273         return is_utf8;
1274 #   endif
1275     }
1276
1277   cant_use_nllanginfo:
1278
1279 #else   /* nl_langinfo should work if available, so don't bother compiling this
1280            fallback code.  The final fallback of looking at the name is
1281            compiled, and will be executed if nl_langinfo fails */
1282
1283     /* nl_langinfo not available or failed somehow.  Next try looking at the
1284      * currency symbol to see if it disambiguates things.  Often that will be
1285      * in the native script, and if the symbol isn't in UTF-8, we know that the
1286      * locale isn't.  If it is non-ASCII UTF-8, we infer that the locale is
1287      * too, as the odds of a non-UTF8 string being valid UTF-8 are quite small
1288      * */
1289
1290 #ifdef HAS_LOCALECONV
1291 #   ifdef USE_LOCALE_MONETARY
1292     {
1293         char *save_monetary_locale = NULL;
1294         bool only_ascii = FALSE;
1295         bool is_utf8 = FALSE;
1296         struct lconv* lc;
1297
1298         /* Like above for LC_CTYPE, we first set LC_MONETARY to the locale of
1299          * the desired category, if it isn't that locale already */
1300
1301         if (category != LC_MONETARY) {
1302
1303             save_monetary_locale = setlocale(LC_MONETARY, NULL);
1304             if (! save_monetary_locale) {
1305                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1306                             "Could not find current locale for LC_MONETARY\n"));
1307                 goto cant_use_monetary;
1308             }
1309             save_monetary_locale = stdize_locale(savepv(save_monetary_locale));
1310
1311             if (strEQ(save_monetary_locale, save_input_locale)) {
1312                 Safefree(save_monetary_locale);
1313                 save_monetary_locale = NULL;
1314             }
1315             else if (! setlocale(LC_MONETARY, save_input_locale)) {
1316                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1317                             "Could not change LC_MONETARY locale to %s\n",
1318                                                         save_input_locale));
1319                 Safefree(save_monetary_locale);
1320                 goto cant_use_monetary;
1321             }
1322         }
1323
1324         /* Here the current LC_MONETARY is set to the locale of the category
1325          * whose information is desired. */
1326
1327         lc = localeconv();
1328         if (! lc
1329             || ! lc->currency_symbol
1330             || is_invariant_string((U8 *) lc->currency_symbol, 0))
1331         {
1332             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));
1333             only_ascii = TRUE;
1334         }
1335         else {
1336             is_utf8 = is_utf8_string((U8 *) lc->currency_symbol, 0);
1337         }
1338
1339         /* If we changed it, restore LC_MONETARY to its original locale */
1340         if (save_monetary_locale) {
1341             setlocale(LC_MONETARY, save_monetary_locale);
1342             Safefree(save_monetary_locale);
1343         }
1344
1345         if (! only_ascii) {
1346
1347             /* It isn't a UTF-8 locale if the symbol is not legal UTF-8;
1348              * otherwise assume the locale is UTF-8 if and only if the symbol
1349              * is non-ascii UTF-8. */
1350             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?Currency symbol for %s is UTF-8=%d\n",
1351                                     save_input_locale, is_utf8));
1352             Safefree(save_input_locale);
1353             return is_utf8;
1354         }
1355     }
1356   cant_use_monetary:
1357
1358 #   endif /* USE_LOCALE_MONETARY */
1359 #endif /* HAS_LOCALECONV */
1360
1361 #if defined(HAS_STRFTIME) && defined(USE_LOCALE_TIME)
1362
1363 /* Still haven't found a non-ASCII string to disambiguate UTF-8 or not.  Try
1364  * the names of the months and weekdays, timezone, and am/pm indicator */
1365     {
1366         char *save_time_locale = NULL;
1367         int hour = 10;
1368         bool is_dst = FALSE;
1369         int dom = 1;
1370         int month = 0;
1371         int i;
1372         char * formatted_time;
1373
1374
1375         /* Like above for LC_MONETARY, we set LC_TIME to the locale of the
1376          * desired category, if it isn't that locale already */
1377
1378         if (category != LC_TIME) {
1379
1380             save_time_locale = setlocale(LC_TIME, NULL);
1381             if (! save_time_locale) {
1382                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1383                             "Could not find current locale for LC_TIME\n"));
1384                 goto cant_use_time;
1385             }
1386             save_time_locale = stdize_locale(savepv(save_time_locale));
1387
1388             if (strEQ(save_time_locale, save_input_locale)) {
1389                 Safefree(save_time_locale);
1390                 save_time_locale = NULL;
1391             }
1392             else if (! setlocale(LC_TIME, save_input_locale)) {
1393                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1394                             "Could not change LC_TIME locale to %s\n",
1395                                                         save_input_locale));
1396                 Safefree(save_time_locale);
1397                 goto cant_use_time;
1398             }
1399         }
1400
1401         /* Here the current LC_TIME is set to the locale of the category
1402          * whose information is desired.  Look at all the days of the week and
1403          * month names, and the timezone and am/pm indicator for UTF-8 variant
1404          * characters.  The first such a one found will tell us if the locale
1405          * is UTF-8 or not */
1406
1407         for (i = 0; i < 7 + 12; i++) {  /* 7 days; 12 months */
1408             formatted_time = my_strftime("%A %B %Z %p",
1409                                     0, 0, hour, dom, month, 112, 0, 0, is_dst);
1410             if (! formatted_time || is_invariant_string((U8 *) formatted_time, 0)) {
1411
1412                 /* Here, we didn't find a non-ASCII.  Try the next time through
1413                  * with the complemented dst and am/pm, and try with the next
1414                  * weekday.  After we have gotten all weekdays, try the next
1415                  * month */
1416                 is_dst = ! is_dst;
1417                 hour = (hour + 12) % 24;
1418                 dom++;
1419                 if (i > 6) {
1420                     month++;
1421                 }
1422                 continue;
1423             }
1424
1425             /* Here, we have a non-ASCII.  Return TRUE is it is valid UTF8;
1426              * false otherwise.  But first, restore LC_TIME to its original
1427              * locale if we changed it */
1428             if (save_time_locale) {
1429                 setlocale(LC_TIME, save_time_locale);
1430                 Safefree(save_time_locale);
1431             }
1432
1433             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?time-related strings for %s are UTF-8=%d\n",
1434                                 save_input_locale,
1435                                 is_utf8_string((U8 *) formatted_time, 0)));
1436             Safefree(save_input_locale);
1437             return is_utf8_string((U8 *) formatted_time, 0);
1438         }
1439
1440         /* Falling off the end of the loop indicates all the names were just
1441          * ASCII.  Go on to the next test.  If we changed it, restore LC_TIME
1442          * to its original locale */
1443         if (save_time_locale) {
1444             setlocale(LC_TIME, save_time_locale);
1445             Safefree(save_time_locale);
1446         }
1447         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));
1448     }
1449   cant_use_time:
1450
1451 #endif
1452
1453 #if 0 && defined(USE_LOCALE_MESSAGES) && defined(HAS_SYS_ERRLIST)
1454
1455 /* This code is ifdefd out because it was found to not be necessary in testing
1456  * on our dromedary test machine, which has over 700 locales.  There, this
1457  * added no value to looking at the currency symbol and the time strings.  I
1458  * left it in so as to avoid rewriting it if real-world experience indicates
1459  * that dromedary is an outlier.  Essentially, instead of returning abpve if we
1460  * haven't found illegal utf8, we continue on and examine all the strerror()
1461  * messages on the platform for utf8ness.  If all are ASCII, we still don't
1462  * know the answer; but otherwise we have a pretty good indication of the
1463  * utf8ness.  The reason this doesn't help much is that the messages may not
1464  * have been translated into the locale.  The currency symbol and time strings
1465  * are much more likely to have been translated.  */
1466     {
1467         int e;
1468         bool is_utf8 = FALSE;
1469         bool non_ascii = FALSE;
1470         char *save_messages_locale = NULL;
1471         const char * errmsg = NULL;
1472
1473         /* Like above, we set LC_MESSAGES to the locale of the desired
1474          * category, if it isn't that locale already */
1475
1476         if (category != LC_MESSAGES) {
1477
1478             save_messages_locale = setlocale(LC_MESSAGES, NULL);
1479             if (! save_messages_locale) {
1480                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1481                             "Could not find current locale for LC_MESSAGES\n"));
1482                 goto cant_use_messages;
1483             }
1484             save_messages_locale = stdize_locale(savepv(save_messages_locale));
1485
1486             if (strEQ(save_messages_locale, save_input_locale)) {
1487                 Safefree(save_messages_locale);
1488                 save_messages_locale = NULL;
1489             }
1490             else if (! setlocale(LC_MESSAGES, save_input_locale)) {
1491                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1492                             "Could not change LC_MESSAGES locale to %s\n",
1493                                                         save_input_locale));
1494                 Safefree(save_messages_locale);
1495                 goto cant_use_messages;
1496             }
1497         }
1498
1499         /* Here the current LC_MESSAGES is set to the locale of the category
1500          * whose information is desired.  Look through all the messages.  We
1501          * can't use Strerror() here because it may expand to code that
1502          * segfaults in miniperl */
1503
1504         for (e = 0; e <= sys_nerr; e++) {
1505             errno = 0;
1506             errmsg = sys_errlist[e];
1507             if (errno || !errmsg) {
1508                 break;
1509             }
1510             errmsg = savepv(errmsg);
1511             if (! is_invariant_string((U8 *) errmsg, 0)) {
1512                 non_ascii = TRUE;
1513                 is_utf8 = is_utf8_string((U8 *) errmsg, 0);
1514                 break;
1515             }
1516         }
1517         Safefree(errmsg);
1518
1519         /* And, if we changed it, restore LC_MESSAGES to its original locale */
1520         if (save_messages_locale) {
1521             setlocale(LC_MESSAGES, save_messages_locale);
1522             Safefree(save_messages_locale);
1523         }
1524
1525         if (non_ascii) {
1526
1527             /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid,
1528              * any non-ascii means it is one; otherwise we assume it isn't */
1529             DEBUG_L(PerlIO_printf(Perl_debug_log, "\t?error messages for %s are UTF-8=%d\n",
1530                                 save_input_locale,
1531                                 is_utf8));
1532             Safefree(save_input_locale);
1533             return is_utf8;
1534         }
1535
1536         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));
1537     }
1538   cant_use_messages:
1539
1540 #endif
1541
1542 #endif /* the code that is compiled when no nl_langinfo */
1543
1544 #ifndef EBCDIC  /* On os390, even if the name ends with "UTF-8', it isn't a
1545                    UTF-8 locale */
1546     /* As a last resort, look at the locale name to see if it matches
1547      * qr/UTF -?  * 8 /ix, or some other common locale names.  This "name", the
1548      * return of setlocale(), is actually defined to be opaque, so we can't
1549      * really rely on the absence of various substrings in the name to indicate
1550      * its UTF-8ness, but if it has UTF8 in the name, it is extremely likely to
1551      * be a UTF-8 locale.  Similarly for the other common names */
1552
1553     final_pos = strlen(save_input_locale) - 1;
1554     if (final_pos >= 3) {
1555         char *name = save_input_locale;
1556
1557         /* Find next 'U' or 'u' and look from there */
1558         while ((name += strcspn(name, "Uu") + 1)
1559                                             <= save_input_locale + final_pos - 2)
1560         {
1561             if (!isALPHA_FOLD_NE(*name, 't')
1562                 || isALPHA_FOLD_NE(*(name + 1), 'f'))
1563             {
1564                 continue;
1565             }
1566             name += 2;
1567             if (*(name) == '-') {
1568                 if ((name > save_input_locale + final_pos - 1)) {
1569                     break;
1570                 }
1571                 name++;
1572             }
1573             if (*(name) == '8') {
1574                 DEBUG_L(PerlIO_printf(Perl_debug_log,
1575                                       "Locale %s ends with UTF-8 in name\n",
1576                                       save_input_locale));
1577                 Safefree(save_input_locale);
1578                 return TRUE;
1579             }
1580         }
1581         DEBUG_L(PerlIO_printf(Perl_debug_log,
1582                               "Locale %s doesn't end with UTF-8 in name\n",
1583                                 save_input_locale));
1584     }
1585 #endif
1586
1587 #ifdef WIN32
1588     /* http://msdn.microsoft.com/en-us/library/windows/desktop/dd317756.aspx */
1589     if (final_pos >= 4
1590         && *(save_input_locale + final_pos - 0) == '1'
1591         && *(save_input_locale + final_pos - 1) == '0'
1592         && *(save_input_locale + final_pos - 2) == '0'
1593         && *(save_input_locale + final_pos - 3) == '5'
1594         && *(save_input_locale + final_pos - 4) == '6')
1595     {
1596         DEBUG_L(PerlIO_printf(Perl_debug_log,
1597                         "Locale %s ends with 10056 in name, is UTF-8 locale\n",
1598                         save_input_locale));
1599         Safefree(save_input_locale);
1600         return TRUE;
1601     }
1602 #endif
1603
1604     /* Other common encodings are the ISO 8859 series, which aren't UTF-8.  But
1605      * since we are about to return FALSE anyway, there is no point in doing
1606      * this extra work */
1607 #if 0
1608     if (instr(save_input_locale, "8859")) {
1609         DEBUG_L(PerlIO_printf(Perl_debug_log,
1610                              "Locale %s has 8859 in name, not UTF-8 locale\n",
1611                              save_input_locale));
1612         Safefree(save_input_locale);
1613         return FALSE;
1614     }
1615 #endif
1616
1617     DEBUG_L(PerlIO_printf(Perl_debug_log,
1618                           "Assuming locale %s is not a UTF-8 locale\n",
1619                                     save_input_locale));
1620     Safefree(save_input_locale);
1621     return FALSE;
1622 }
1623
1624 #endif
1625
1626
1627 bool
1628 Perl__is_in_locale_category(pTHX_ const bool compiling, const int category)
1629 {
1630     dVAR;
1631     /* Internal function which returns if we are in the scope of a pragma that
1632      * enables the locale category 'category'.  'compiling' should indicate if
1633      * this is during the compilation phase (TRUE) or not (FALSE). */
1634
1635     const COP * const cop = (compiling) ? &PL_compiling : PL_curcop;
1636
1637     SV *categories = cop_hints_fetch_pvs(cop, "locale", 0);
1638     if (! categories || categories == &PL_sv_placeholder) {
1639         return FALSE;
1640     }
1641
1642     /* The pseudo-category 'not_characters' is -1, so just add 1 to each to get
1643      * a valid unsigned */
1644     assert(category >= -1);
1645     return cBOOL(SvUV(categories) & (1U << (category + 1)));
1646 }
1647
1648 char *
1649 Perl_my_strerror(pTHX_ const int errnum) {
1650
1651     /* Uses C locale for the error text unless within scope of 'use locale' for
1652      * LC_MESSAGES */
1653
1654 #ifdef USE_LOCALE_MESSAGES
1655     if (! IN_LC(LC_MESSAGES)) {
1656         char * save_locale = setlocale(LC_MESSAGES, NULL);
1657         if (! isNAME_C_OR_POSIX(save_locale)) {
1658             char *errstr;
1659
1660             /* The next setlocale likely will zap this, so create a copy */
1661             save_locale = savepv(save_locale);
1662
1663             setlocale(LC_MESSAGES, "C");
1664
1665             /* This points to the static space in Strerror, with all its
1666              * limitations */
1667             errstr = Strerror(errnum);
1668
1669             setlocale(LC_MESSAGES, save_locale);
1670             Safefree(save_locale);
1671             return errstr;
1672         }
1673     }
1674 #endif
1675
1676     return Strerror(errnum);
1677 }
1678
1679 /*
1680
1681 =head1 Locale-related functions and macros
1682
1683 =for apidoc sync_locale
1684
1685 Changing the program's locale should be avoided by XS code.  Nevertheless,
1686 certain non-Perl libraries called from XS, such as C<Gtk> do so.  When this
1687 happens, Perl needs to be told that the locale has changed.  Use this function
1688 to do so, before returning to Perl.
1689
1690 =cut
1691 */
1692
1693 void
1694 Perl_sync_locale(pTHX)
1695 {
1696
1697 #ifdef USE_LOCALE_CTYPE
1698     new_ctype(setlocale(LC_CTYPE, NULL));
1699 #endif /* USE_LOCALE_CTYPE */
1700
1701 #ifdef USE_LOCALE_COLLATE
1702     new_collate(setlocale(LC_COLLATE, NULL));
1703 #endif
1704
1705 #ifdef USE_LOCALE_NUMERIC
1706     set_numeric_local();    /* Switch from "C" to underlying LC_NUMERIC */
1707     new_numeric(setlocale(LC_NUMERIC, NULL));
1708 #endif /* USE_LOCALE_NUMERIC */
1709
1710 }
1711
1712
1713
1714 /*
1715  * Local variables:
1716  * c-indentation-style: bsd
1717  * c-basic-offset: 4
1718  * indent-tabs-mode: nil
1719  * End:
1720  *
1721  * ex: set ts=8 sts=4 sw=4 et:
1722  */