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