locale.c

   1 /*    locale.c
   2  *
   3  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2005, 2006, 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
  21 /* utility functions for handling locale-specific stuff like what
  22  * character represents the decimal point.
  23  */
  24
  25 #include "EXTERN.h"
  26 #define PERL_IN_LOCALE_C
  27 #include "perl.h"
  28
  29 #ifdef I_LOCALE
  30 #  include <locale.h>
  31 #endif
  32
  33 #ifdef I_LANGINFO
  34 #   include <langinfo.h>
  35 #endif
  36
  37 #include "reentr.h"
  38
  39 #if defined(USE_LOCALE_NUMERIC) || defined(USE_LOCALE_COLLATE)
  40 /*
  41  * Standardize the locale name from a string returned by 'setlocale'.
  42  *
  43  * The standard return value of setlocale() is either
  44  * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
  45  * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
  46  *     (the space-separated values represent the various sublocales,
  47  *      in some unspecificed order)
  48  *
  49  * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
  50  * which is harmful for further use of the string in setlocale().
  51  *
  52  */
  53 STATIC char *
  54 S_stdize_locale(pTHX_ char *locs)
  55 {
  56     const char * const s = strchr(locs, '=');
  57     bool okay = TRUE;
  58
  59     if (s) {
  60         const char * const t = strchr(s, '.');
  61         okay = FALSE;
  62         if (t) {
  63             const char * const u = strchr(t, '\n');
  64             if (u && (u[1] == 0)) {
  65                 const STRLEN len = u - s;
  66                 Move(s + 1, locs, len, char);
  67                 locs[len] = 0;
  68                 okay = TRUE;
  69             }
  70         }
  71     }
  72
  73     if (!okay)
  74         Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
  75
  76     return locs;
  77 }
  78 #endif
  79
  80 void
  81 Perl_set_numeric_radix(pTHX)
  82 {
  83 #ifdef USE_LOCALE_NUMERIC
  84     dVAR;
  85 # ifdef HAS_LOCALECONV
  86     const struct lconv* const lc = localeconv();
  87
  88     if (lc && lc->decimal_point) {
  89         if (lc->decimal_point[0] == '.' && lc->decimal_point[1] == 0) {
  90             SvREFCNT_dec(PL_numeric_radix_sv);
  91             PL_numeric_radix_sv = NULL;
  92         }
  93         else {
  94             if (PL_numeric_radix_sv)
  95                 sv_setpv(PL_numeric_radix_sv, lc->decimal_point);
  96             else
  97                 PL_numeric_radix_sv = newSVpv(lc->decimal_point, 0);
  98         }
  99     }
 100     else
 101         PL_numeric_radix_sv = NULL;
 102 # endif /* HAS_LOCALECONV */
 103 #endif /* USE_LOCALE_NUMERIC */
 104 }
 105
 106 /*
 107  * Set up for a new numeric locale.
 108  */
 109 void
 110 Perl_new_numeric(pTHX_ const char *newnum)
 111 {
 112 #ifdef USE_LOCALE_NUMERIC
 113     dVAR;
 114
 115     if (! newnum) {
 116         Safefree(PL_numeric_name);
 117         PL_numeric_name = NULL;
 118         PL_numeric_standard = TRUE;
 119         PL_numeric_local = TRUE;
 120         return;
 121     }
 122
 123     if (! PL_numeric_name || strNE(PL_numeric_name, newnum)) {
 124         Safefree(PL_numeric_name);
 125         PL_numeric_name = stdize_locale(savepv(newnum));
 126         PL_numeric_standard = ((*newnum == 'C' && newnum[1] == '\0')
 127                                || strEQ(newnum, "POSIX"));
 128         PL_numeric_local = TRUE;
 129         set_numeric_radix();
 130     }
 131
 132 #endif /* USE_LOCALE_NUMERIC */
 133 }
 134
 135 void
 136 Perl_set_numeric_standard(pTHX)
 137 {
 138 #ifdef USE_LOCALE_NUMERIC
 139     dVAR;
 140
 141     if (! PL_numeric_standard) {
 142         setlocale(LC_NUMERIC, "C");
 143         PL_numeric_standard = TRUE;
 144         PL_numeric_local = FALSE;
 145         set_numeric_radix();
 146     }
 147
 148 #endif /* USE_LOCALE_NUMERIC */
 149 }
 150
 151 void
 152 Perl_set_numeric_local(pTHX)
 153 {
 154 #ifdef USE_LOCALE_NUMERIC
 155     dVAR;
 156
 157     if (! PL_numeric_local) {
 158         setlocale(LC_NUMERIC, PL_numeric_name);
 159         PL_numeric_standard = FALSE;
 160         PL_numeric_local = TRUE;
 161         set_numeric_radix();
 162     }
 163
 164 #endif /* USE_LOCALE_NUMERIC */
 165 }
 166
 167 /*
 168  * Set up for a new ctype locale.
 169  */
 170 void
 171 Perl_new_ctype(pTHX_ const char *newctype)
 172 {
 173 #ifdef USE_LOCALE_CTYPE
 174     dVAR;
 175     int i;
 176
 177     for (i = 0; i < 256; i++) {
 178         if (isUPPER_LC(i))
 179             PL_fold_locale[i] = toLOWER_LC(i);
 180         else if (isLOWER_LC(i))
 181             PL_fold_locale[i] = toUPPER_LC(i);
 182         else
 183             PL_fold_locale[i] = i;
 184     }
 185
 186 #endif /* USE_LOCALE_CTYPE */
 187     PERL_UNUSED_ARG(newctype);
 188     PERL_UNUSED_CONTEXT;
 189 }
 190
 191 /*
 192  * Set up for a new collation locale.
 193  */
 194 void
 195 Perl_new_collate(pTHX_ const char *newcoll)
 196 {
 197 #ifdef USE_LOCALE_COLLATE
 198     dVAR;
 199
 200     if (! newcoll) {
 201         if (PL_collation_name) {
 202             ++PL_collation_ix;
 203             Safefree(PL_collation_name);
 204             PL_collation_name = NULL;
 205         }
 206         PL_collation_standard = TRUE;
 207         PL_collxfrm_base = 0;
 208         PL_collxfrm_mult = 2;
 209         return;
 210     }
 211
 212     if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
 213         ++PL_collation_ix;
 214         Safefree(PL_collation_name);
 215         PL_collation_name = stdize_locale(savepv(newcoll));
 216         PL_collation_standard = ((*newcoll == 'C' && newcoll[1] == '\0')
 217                                  || strEQ(newcoll, "POSIX"));
 218
 219         {
 220           /*  2: at most so many chars ('a', 'b'). */
 221           /* 50: surely no system expands a char more. */
 222 #define XFRMBUFSIZE  (2 * 50)
 223           char xbuf[XFRMBUFSIZE];
 224           const Size_t fa = strxfrm(xbuf, "a",  XFRMBUFSIZE);
 225           const Size_t fb = strxfrm(xbuf, "ab", XFRMBUFSIZE);
 226           const SSize_t mult = fb - fa;
 227           if (mult < 1)
 228               Perl_croak(aTHX_ "strxfrm() gets absurd");
 229           PL_collxfrm_base = (fa > (Size_t)mult) ? (fa - mult) : 0;
 230           PL_collxfrm_mult = mult;
 231         }
 232     }
 233
 234 #endif /* USE_LOCALE_COLLATE */
 235 }
 236
 237 /*
 238  * Initialize locale awareness.
 239  */
 240 int
 241 Perl_init_i18nl10n(pTHX_ int printwarn)
 242 {
 243     int ok = 1;
 244     /* returns
 245      *    1 = set ok or not applicable,
 246      *    0 = fallback to C locale,
 247      *   -1 = fallback to C locale failed
 248      */
 249
 250 #if defined(USE_LOCALE)
 251     dVAR;
 252
 253 #ifdef USE_LOCALE_CTYPE
 254     char *curctype   = NULL;
 255 #endif /* USE_LOCALE_CTYPE */
 256 #ifdef USE_LOCALE_COLLATE
 257     char *curcoll    = NULL;
 258 #endif /* USE_LOCALE_COLLATE */
 259 #ifdef USE_LOCALE_NUMERIC
 260     char *curnum     = NULL;
 261 #endif /* USE_LOCALE_NUMERIC */
 262 #ifdef __GLIBC__
 263     char * const language   = PerlEnv_getenv("LANGUAGE");
 264 #endif
 265     char * const lc_all     = PerlEnv_getenv("LC_ALL");
 266     char * const lang       = PerlEnv_getenv("LANG");
 267     bool setlocale_failure = FALSE;
 268
 269 #ifdef LOCALE_ENVIRON_REQUIRED
 270
 271     /*
 272      * Ultrix setlocale(..., "") fails if there are no environment
 273      * variables from which to get a locale name.
 274      */
 275
 276     bool done = FALSE;
 277
 278 #ifdef LC_ALL
 279     if (lang) {
 280         if (setlocale(LC_ALL, ""))
 281             done = TRUE;
 282         else
 283             setlocale_failure = TRUE;
 284     }
 285     if (!setlocale_failure) {
 286 #ifdef USE_LOCALE_CTYPE
 287         if (! (curctype =
 288                setlocale(LC_CTYPE,
 289                          (!done && (lang || PerlEnv_getenv("LC_CTYPE")))
 290                                     ? "" : NULL)))
 291             setlocale_failure = TRUE;
 292         else
 293             curctype = savepv(curctype);
 294 #endif /* USE_LOCALE_CTYPE */
 295 #ifdef USE_LOCALE_COLLATE
 296         if (! (curcoll =
 297                setlocale(LC_COLLATE,
 298                          (!done && (lang || PerlEnv_getenv("LC_COLLATE")))
 299                                    ? "" : NULL)))
 300             setlocale_failure = TRUE;
 301         else
 302             curcoll = savepv(curcoll);
 303 #endif /* USE_LOCALE_COLLATE */
 304 #ifdef USE_LOCALE_NUMERIC
 305         if (! (curnum =
 306                setlocale(LC_NUMERIC,
 307                          (!done && (lang || PerlEnv_getenv("LC_NUMERIC")))
 308                                   ? "" : NULL)))
 309             setlocale_failure = TRUE;
 310         else
 311             curnum = savepv(curnum);
 312 #endif /* USE_LOCALE_NUMERIC */
 313     }
 314
 315 #endif /* LC_ALL */
 316
 317 #endif /* !LOCALE_ENVIRON_REQUIRED */
 318
 319 #ifdef LC_ALL
 320     if (! setlocale(LC_ALL, ""))
 321         setlocale_failure = TRUE;
 322 #endif /* LC_ALL */
 323
 324     if (!setlocale_failure) {
 325 #ifdef USE_LOCALE_CTYPE
 326         Safefree(curctype);
 327         if (! (curctype = setlocale(LC_CTYPE, "")))
 328             setlocale_failure = TRUE;
 329         else
 330             curctype = savepv(curctype);
 331 #endif /* USE_LOCALE_CTYPE */
 332 #ifdef USE_LOCALE_COLLATE
 333         Safefree(curcoll);
 334         if (! (curcoll = setlocale(LC_COLLATE, "")))
 335             setlocale_failure = TRUE;
 336         else
 337             curcoll = savepv(curcoll);
 338 #endif /* USE_LOCALE_COLLATE */
 339 #ifdef USE_LOCALE_NUMERIC
 340         Safefree(curnum);
 341         if (! (curnum = setlocale(LC_NUMERIC, "")))
 342             setlocale_failure = TRUE;
 343         else
 344             curnum = savepv(curnum);
 345 #endif /* USE_LOCALE_NUMERIC */
 346     }
 347
 348     if (setlocale_failure) {
 349         char *p;
 350         const bool locwarn = (printwarn > 1 ||
 351                         (printwarn &&
 352                          (!(p = PerlEnv_getenv("PERL_BADLANG")) || atoi(p))));
 353
 354         if (locwarn) {
 355 #ifdef LC_ALL
 356
 357             PerlIO_printf(Perl_error_log,
 358                "perl: warning: Setting locale failed.\n");
 359
 360 #else /* !LC_ALL */
 361
 362             PerlIO_printf(Perl_error_log,
 363                "perl: warning: Setting locale failed for the categories:\n\t");
 364 #ifdef USE_LOCALE_CTYPE
 365             if (! curctype)
 366                 PerlIO_printf(Perl_error_log, "LC_CTYPE ");
 367 #endif /* USE_LOCALE_CTYPE */
 368 #ifdef USE_LOCALE_COLLATE
 369             if (! curcoll)
 370                 PerlIO_printf(Perl_error_log, "LC_COLLATE ");
 371 #endif /* USE_LOCALE_COLLATE */
 372 #ifdef USE_LOCALE_NUMERIC
 373             if (! curnum)
 374                 PerlIO_printf(Perl_error_log, "LC_NUMERIC ");
 375 #endif /* USE_LOCALE_NUMERIC */
 376             PerlIO_printf(Perl_error_log, "\n");
 377
 378 #endif /* LC_ALL */
 379
 380             PerlIO_printf(Perl_error_log,
 381                 "perl: warning: Please check that your locale settings:\n");
 382
 383 #ifdef __GLIBC__
 384             PerlIO_printf(Perl_error_log,
 385                           "\tLANGUAGE = %c%s%c,\n",
 386                           language ? '"' : '(',
 387                           language ? language : "unset",
 388                           language ? '"' : ')');
 389 #endif
 390
 391             PerlIO_printf(Perl_error_log,
 392                           "\tLC_ALL = %c%s%c,\n",
 393                           lc_all ? '"' : '(',
 394                           lc_all ? lc_all : "unset",
 395                           lc_all ? '"' : ')');
 396
 397 #if defined(USE_ENVIRON_ARRAY)
 398             {
 399               char **e;
 400               for (e = environ; *e; e++) {
 401                   if (strnEQ(*e, "LC_", 3)
 402                         && strnNE(*e, "LC_ALL=", 7)
 403                         && (p = strchr(*e, '=')))
 404                       PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
 405                                     (int)(p - *e), *e, p + 1);
 406               }
 407             }
 408 #else
 409             PerlIO_printf(Perl_error_log,
 410                           "\t(possibly more locale environment variables)\n");
 411 #endif
 412
 413             PerlIO_printf(Perl_error_log,
 414                           "\tLANG = %c%s%c\n",
 415                           lang ? '"' : '(',
 416                           lang ? lang : "unset",
 417                           lang ? '"' : ')');
 418
 419             PerlIO_printf(Perl_error_log,
 420                           "    are supported and installed on your system.\n");
 421         }
 422
 423 #ifdef LC_ALL
 424
 425         if (setlocale(LC_ALL, "C")) {
 426             if (locwarn)
 427                 PerlIO_printf(Perl_error_log,
 428       "perl: warning: Falling back to the standard locale (\"C\").\n");
 429             ok = 0;
 430         }
 431         else {
 432             if (locwarn)
 433                 PerlIO_printf(Perl_error_log,
 434       "perl: warning: Failed to fall back to the standard locale (\"C\").\n");
 435             ok = -1;
 436         }
 437
 438 #else /* ! LC_ALL */
 439
 440         if (0
 441 #ifdef USE_LOCALE_CTYPE
 442             || !(curctype || setlocale(LC_CTYPE, "C"))
 443 #endif /* USE_LOCALE_CTYPE */
 444 #ifdef USE_LOCALE_COLLATE
 445             || !(curcoll || setlocale(LC_COLLATE, "C"))
 446 #endif /* USE_LOCALE_COLLATE */
 447 #ifdef USE_LOCALE_NUMERIC
 448             || !(curnum || setlocale(LC_NUMERIC, "C"))
 449 #endif /* USE_LOCALE_NUMERIC */
 450             )
 451         {
 452             if (locwarn)
 453                 PerlIO_printf(Perl_error_log,
 454       "perl: warning: Cannot fall back to the standard locale (\"C\").\n");
 455             ok = -1;
 456         }
 457
 458 #endif /* ! LC_ALL */
 459
 460 #ifdef USE_LOCALE_CTYPE
 461         curctype = savepv(setlocale(LC_CTYPE, NULL));
 462 #endif /* USE_LOCALE_CTYPE */
 463 #ifdef USE_LOCALE_COLLATE
 464         curcoll = savepv(setlocale(LC_COLLATE, NULL));
 465 #endif /* USE_LOCALE_COLLATE */
 466 #ifdef USE_LOCALE_NUMERIC
 467         curnum = savepv(setlocale(LC_NUMERIC, NULL));
 468 #endif /* USE_LOCALE_NUMERIC */
 469     }
 470     else {
 471
 472 #ifdef USE_LOCALE_CTYPE
 473     new_ctype(curctype);
 474 #endif /* USE_LOCALE_CTYPE */
 475
 476 #ifdef USE_LOCALE_COLLATE
 477     new_collate(curcoll);
 478 #endif /* USE_LOCALE_COLLATE */
 479
 480 #ifdef USE_LOCALE_NUMERIC
 481     new_numeric(curnum);
 482 #endif /* USE_LOCALE_NUMERIC */
 483
 484     }
 485
 486 #endif /* USE_LOCALE */
 487
 488 #ifdef USE_PERLIO
 489     {
 490       /* Set PL_utf8locale to TRUE if using PerlIO _and_
 491          any of the following are true:
 492          - nl_langinfo(CODESET) contains /^utf-?8/i
 493          - $ENV{LC_ALL}   contains /^utf-?8/i
 494          - $ENV{LC_CTYPE} contains /^utf-?8/i
 495          - $ENV{LANG}     contains /^utf-?8/i
 496          The LC_ALL, LC_CTYPE, LANG obey the usual override
 497          hierarchy of locale environment variables.  (LANGUAGE
 498          affects only LC_MESSAGES only under glibc.) (If present,
 499          it overrides LC_MESSAGES for GNU gettext, and it also
 500          can have more than one locale, separated by spaces,
 501          in case you need to know.)
 502          If PL_utf8locale and PL_unicode (set by -C or by $ENV{PERL_UNICODE})
 503          are true, perl.c:S_parse_body() will turn on the PerlIO :utf8 layer
 504          on STDIN, STDOUT, STDERR, _and_ the default open discipline.
 505       */
 506          bool utf8locale = FALSE;
 507          char *codeset = NULL;
 508 #if defined(HAS_NL_LANGINFO) && defined(CODESET)
 509          codeset = nl_langinfo(CODESET);
 510 #endif
 511          if (codeset)
 512               utf8locale = (Perl_ibcmp(aTHX_ codeset, STR_WITH_LEN("UTF-8")) == 0 ||
 513                             Perl_ibcmp(aTHX_ codeset, STR_WITH_LEN("UTF8") ) == 0);
 514 #if defined(USE_LOCALE)
 515          else { /* nl_langinfo(CODESET) is supposed to correctly
 516                  * interpret the locale environment variables,
 517                  * but just in case it fails, let's do this manually. */
 518               if (lang)
 519                    utf8locale = (Perl_ibcmp(aTHX_ lang, STR_WITH_LEN("UTF-8")) == 0 ||
 520                                  Perl_ibcmp(aTHX_ lang, STR_WITH_LEN("UTF8") ) == 0);
 521 #ifdef USE_LOCALE_CTYPE
 522               if (curctype)
 523                    utf8locale = (Perl_ibcmp(aTHX_ curctype, STR_WITH_LEN("UTF-8")) == 0 ||
 524                                  Perl_ibcmp(aTHX_ curctype, STR_WITH_LEN("UTF8") ) == 0);
 525 #endif
 526               if (lc_all)
 527                    utf8locale = (Perl_ibcmp(aTHX_ lc_all, STR_WITH_LEN("UTF-8")) == 0 ||
 528                                  Perl_ibcmp(aTHX_ lc_all, STR_WITH_LEN("UTF8") ) == 0);
 529          }
 530 #endif /* USE_LOCALE */
 531          if (utf8locale)
 532               PL_utf8locale = TRUE;
 533     }
 534     /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
 535        This is an alternative to using the -C command line switch
 536        (the -C if present will override this). */
 537     {
 538          const char *p = PerlEnv_getenv("PERL_UNICODE");
 539          PL_unicode = p ? parse_unicode_opts(&p) : 0;
 540     }
 541 #endif
 542
 543 #ifdef USE_LOCALE_CTYPE
 544     Safefree(curctype);
 545 #endif /* USE_LOCALE_CTYPE */
 546 #ifdef USE_LOCALE_COLLATE
 547     Safefree(curcoll);
 548 #endif /* USE_LOCALE_COLLATE */
 549 #ifdef USE_LOCALE_NUMERIC
 550     Safefree(curnum);
 551 #endif /* USE_LOCALE_NUMERIC */
 552     return ok;
 553 }
 554
 555 #ifdef USE_LOCALE_COLLATE
 556
 557 /*
 558  * mem_collxfrm() is a bit like strxfrm() but with two important
 559  * differences. First, it handles embedded NULs. Second, it allocates
 560  * a bit more memory than needed for the transformed data itself.
 561  * The real transformed data begins at offset sizeof(collationix).
 562  * Please see sv_collxfrm() to see how this is used.
 563  */
 564
 565 char *
 566 Perl_mem_collxfrm(pTHX_ const char *s, STRLEN len, STRLEN *xlen)
 567 {
 568     dVAR;
 569     char *xbuf;
 570     STRLEN xAlloc, xin, xout; /* xalloc is a reserved word in VC */
 571
 572     /* the first sizeof(collationix) bytes are used by sv_collxfrm(). */
 573     /* the +1 is for the terminating NUL. */
 574
 575     xAlloc = sizeof(PL_collation_ix) + PL_collxfrm_base + (PL_collxfrm_mult * len) + 1;
 576     Newx(xbuf, xAlloc, char);
 577     if (! xbuf)
 578         goto bad;
 579
 580     *(U32*)xbuf = PL_collation_ix;
 581     xout = sizeof(PL_collation_ix);
 582     for (xin = 0; xin < len; ) {
 583         SSize_t xused;
 584
 585         for (;;) {
 586             xused = strxfrm(xbuf + xout, s + xin, xAlloc - xout);
 587             if (xused == -1)
 588                 goto bad;
 589             if ((STRLEN)xused < xAlloc - xout)
 590                 break;
 591             xAlloc = (2 * xAlloc) + 1;
 592             Renew(xbuf, xAlloc, char);
 593             if (! xbuf)
 594                 goto bad;
 595         }
 596
 597         xin += strlen(s + xin) + 1;
 598         xout += xused;
 599
 600         /* Embedded NULs are understood but silently skipped
 601          * because they make no sense in locale collation. */
 602     }
 603
 604     xbuf[xout] = '\0';
 605     *xlen = xout - sizeof(PL_collation_ix);
 606     return xbuf;
 607
 608   bad:
 609     Safefree(xbuf);
 610     *xlen = 0;
 611     return NULL;
 612 }
 613
 614 #endif /* USE_LOCALE_COLLATE */
 615
 616 /*
 617  * Local variables:
 618  * c-indentation-style: bsd
 619  * c-basic-offset: 4
 620  * indent-tabs-mode: t
 621  * End:
 622  *
 623  * ex: set ts=8 sts=4 sw=4 noet:
 624  */