This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
perlapi: Add markup
[perl5.git] / locale.c
CommitLineData
98994639
HS		 1/* locale.c
2 *
1129b882
NC		 3 * Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
4 * 2002, 2003, 2005, 2006, 2007, 2008 by Larry Wall and others
98994639
HS		 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/*
4ac71550 12 * A Elbereth Gilthoniel,
cdad3b53 13 * silivren penna míriel
4ac71550 14 * o menel aglar elenath!
cdad3b53 15 * Na-chaered palan-díriel
4ac71550
TC		 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"]
98994639
HS		 21 */
22
166f8a29
DM		 23/* utility functions for handling locale-specific stuff like what
24 * character represents the decimal point.
0d071d52 25 *
7d4bcc4a
KW		 26 * All C programs have an underlying locale. Perl code generally doesn't pay
27 * any attention to it except within the scope of a 'use locale'. For most
0d071d52
KW		 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
a9ad02a8
KW		 32 * the desired behavior of those functions at the moment. And, LC_MESSAGES is
33 * switched to the C locale for outputting the message unless within the scope
34 * of 'use locale'.
e9bc6d6b
KW		 35 *
36 * This code now has multi-thread-safe locale handling on systems that support
37 * that. This is completely transparent to most XS code. On earlier systems,
38 * it would be possible to emulate thread-safe locales, but this likely would
39 * involve a lot of locale switching, and would require XS code changes.
40 * Macros could be written so that the code wouldn't have to know which type of
41 * system is being used. It's unlikely that we would ever do that, since most
42 * modern systems support thread-safe locales, but there was code written to
43 * this end, and is retained, #ifdef'd out.
166f8a29
DM		 44 */
45
98994639
HS		 46#include "EXTERN.h"
47#define PERL_IN_LOCALE_C
f7416781 48#include "perl_langinfo.h"
98994639
HS		 49#include "perl.h"
50
a4af207c
JH		 51#include "reentr.h"
52
0dec74cd
KW		 53#ifdef I_WCHAR
54# include <wchar.h>
55#endif
5b64f24c
KW		 56#ifdef I_WCTYPE
57# include <wctype.h>
58#endif
0dec74cd 59
2fcc0ca9
KW		 60/* If the environment says to, we can output debugging information during
61 * initialization. This is done before option parsing, and before any thread
62 * creation, so can be a file-level static */
8c3a0f6c 63#if ! defined(DEBUGGING)
5a4b0634
KW		 64# define debug_initialization 0
65# define DEBUG_INITIALIZATION_set(v)
66#else
2fcc0ca9 67static bool debug_initialization = FALSE;
5a4b0634 68# define DEBUG_INITIALIZATION_set(v) (debug_initialization = v)
2fcc0ca9
KW		 69#endif
70
48015184
KW		 71
72/* Returns the Unix errno portion; ignoring any others. This is a macro here
73 * instead of putting it into perl.h, because unclear to khw what should be
74 * done generally. */
75#define GET_ERRNO saved_errno
76
291a84fb
KW		 77/* strlen() of a literal string constant. We might want this more general,
78 * but using it in just this file for now. A problem with more generality is
79 * the compiler warnings about comparing unlike signs */
ff1b739b
KW		 80#define STRLENs(s) (sizeof("" s "") - 1)
81
63e5b0d7
KW		 82/* Is the C string input 'name' "C" or "POSIX"? If so, and 'name' is the
83 * return of setlocale(), then this is extremely likely to be the C or POSIX
84 * locale. However, the output of setlocale() is documented to be opaque, but
85 * the odds are extremely small that it would return these two strings for some
86 * other locale. Note that VMS in these two locales includes many non-ASCII
87 * characters as controls and punctuation (below are hex bytes):
88 * cntrl: 84-97 9B-9F
89 * punct: A1-A3 A5 A7-AB B0-B3 B5-B7 B9-BD BF-CF D1-DD DF-EF F1-FD
90 * Oddly, none there are listed as alphas, though some represent alphabetics
91 * http://www.nntp.perl.org/group/perl.perl5.porters/2013/02/msg198753.html */
92#define isNAME_C_OR_POSIX(name) \
93 ( (name) != NULL \
94 && (( *(name) == 'C' && (*(name + 1)) == '\0') \
95 || strEQ((name), "POSIX")))
96
8ef6e574
KW		 97#ifdef USE_LOCALE
98
47280b20
KW		 99/* This code keeps a LRU cache of the UTF-8ness of the locales it has so-far
100 * looked up. This is in the form of a C string: */
101
102#define UTF8NESS_SEP "\v"
103#define UTF8NESS_PREFIX "\f"
104
105/* So, the string looks like:
98994639 106 *
47280b20 107 * \vC\a0\vPOSIX\a0\vam_ET\a0\vaf_ZA.utf8\a1\ven_US.UTF-8\a1\0
98994639 108 *
47280b20
KW		 109 * where the digit 0 after the \a indicates that the locale starting just
110 * after the preceding \v is not UTF-8, and the digit 1 mean it is. */
111
112STATIC_ASSERT_DECL(STRLENs(UTF8NESS_SEP) == 1);
113STATIC_ASSERT_DECL(STRLENs(UTF8NESS_PREFIX) == 1);
114
115#define C_and_POSIX_utf8ness UTF8NESS_SEP "C" UTF8NESS_PREFIX "0" \
116 UTF8NESS_SEP "POSIX" UTF8NESS_PREFIX "0"
117
118/* The cache is initialized to C_and_POSIX_utf8ness at start up. These are
119 * kept there always. The remining portion of the cache is LRU, with the
120 * oldest looked-up locale at the tail end */
121
98994639
HS		 122STATIC char *
123S_stdize_locale(pTHX_ char *locs)
124{
47280b20
KW		 125 /* Standardize the locale name from a string returned by 'setlocale',
126 * possibly modifying that string.
127 *
128 * The typical return value of setlocale() is either
129 * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
130 * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
131 * (the space-separated values represent the various sublocales,
132 * in some unspecified order). This is not handled by this function.
133 *
134 * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
135 * which is harmful for further use of the string in setlocale(). This
136 * function removes the trailing new line and everything up through the '='
137 * */
138
7452cf6a 139 const char * const s = strchr(locs, '=');
98994639
HS		 140 bool okay = TRUE;
141
7918f24d
NC		 142 PERL_ARGS_ASSERT_STDIZE_LOCALE;
143
8772537c
AL		 144 if (s) {
145 const char * const t = strchr(s, '.');
98994639 146 okay = FALSE;
8772537c
AL		 147 if (t) {
148 const char * const u = strchr(t, '\n');
149 if (u && (u[1] == 0)) {
150 const STRLEN len = u - s;
151 Move(s + 1, locs, len, char);
152 locs[len] = 0;
153 okay = TRUE;
98994639
HS		 154 }
155 }
156 }
157
158 if (!okay)
159 Perl_croak(aTHX_ "Can't fix broken locale name \"%s\"", locs);
160
161 return locs;
162}
163
e5f10d49
KW		 164/* Two parallel arrays; first the locale categories Perl uses on this system;
165 * the second array is their names. These arrays are in mostly arbitrary
166 * order. */
167
168const int categories[] = {
169
170# ifdef USE_LOCALE_NUMERIC
171 LC_NUMERIC,
172# endif
173# ifdef USE_LOCALE_CTYPE
174 LC_CTYPE,
175# endif
176# ifdef USE_LOCALE_COLLATE
177 LC_COLLATE,
178# endif
179# ifdef USE_LOCALE_TIME
180 LC_TIME,
181# endif
182# ifdef USE_LOCALE_MESSAGES
183 LC_MESSAGES,
184# endif
185# ifdef USE_LOCALE_MONETARY
186 LC_MONETARY,
187# endif
9821811f
KW		 188# ifdef USE_LOCALE_ADDRESS
189 LC_ADDRESS,
190# endif
191# ifdef USE_LOCALE_IDENTIFICATION
192 LC_IDENTIFICATION,
193# endif
194# ifdef USE_LOCALE_MEASUREMENT
195 LC_MEASUREMENT,
196# endif
197# ifdef USE_LOCALE_PAPER
198 LC_PAPER,
199# endif
200# ifdef USE_LOCALE_TELEPHONE
201 LC_TELEPHONE,
202# endif
36dbc955
KW		 203# ifdef USE_LOCALE_SYNTAX
204 LC_SYNTAX,
205# endif
206# ifdef USE_LOCALE_TOD
207 LC_TOD,
208# endif
e5f10d49
KW		 209# ifdef LC_ALL
210 LC_ALL,
211# endif
212 -1 /* Placeholder because C doesn't allow a
213 trailing comma, and it would get complicated
214 with all the #ifdef's */
215};
216
217/* The top-most real element is LC_ALL */
218
4ef8bdf9 219const char * const category_names[] = {
e5f10d49
KW		 220
221# ifdef USE_LOCALE_NUMERIC
222 "LC_NUMERIC",
223# endif
224# ifdef USE_LOCALE_CTYPE
225 "LC_CTYPE",
226# endif
227# ifdef USE_LOCALE_COLLATE
228 "LC_COLLATE",
229# endif
230# ifdef USE_LOCALE_TIME
231 "LC_TIME",
232# endif
233# ifdef USE_LOCALE_MESSAGES
234 "LC_MESSAGES",
235# endif
236# ifdef USE_LOCALE_MONETARY
237 "LC_MONETARY",
238# endif
9821811f
KW		 239# ifdef USE_LOCALE_ADDRESS
240 "LC_ADDRESS",
241# endif
242# ifdef USE_LOCALE_IDENTIFICATION
243 "LC_IDENTIFICATION",
244# endif
245# ifdef USE_LOCALE_MEASUREMENT
246 "LC_MEASUREMENT",
247# endif
248# ifdef USE_LOCALE_PAPER
249 "LC_PAPER",
250# endif
251# ifdef USE_LOCALE_TELEPHONE
252 "LC_TELEPHONE",
253# endif
36dbc955
KW		 254# ifdef USE_LOCALE_SYNTAX
255 "LC_SYNTAX",
256# endif
257# ifdef USE_LOCALE_TOD
258 "LC_TOD",
259# endif
e5f10d49
KW		 260# ifdef LC_ALL
261 "LC_ALL",
262# endif
263 NULL /* Placeholder */
264 };
265
266# ifdef LC_ALL
267
268 /* On systems with LC_ALL, it is kept in the highest index position. (-2
269 * to account for the final unused placeholder element.) */
270# define NOMINAL_LC_ALL_INDEX (C_ARRAY_LENGTH(categories) - 2)
271
272# else
273
274 /* On systems without LC_ALL, we pretend it is there, one beyond the real
275 * top element, hence in the unused placeholder element. */
276# define NOMINAL_LC_ALL_INDEX (C_ARRAY_LENGTH(categories) - 1)
277
278# endif
279
280/* Pretending there is an LC_ALL element just above allows us to avoid most
281 * special cases. Most loops through these arrays in the code below are
282 * written like 'for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++)'. They will work
283 * on either type of system. But the code must be written to not access the
948523db
KW		 284 * element at 'LC_ALL_INDEX' except on platforms that have it. This can be
285 * checked for at compile time by using the #define LC_ALL_INDEX which is only
286 * defined if we do have LC_ALL. */
e5f10d49 287
b09aaf40
KW		 288STATIC const char *
289S_category_name(const int category)
290{
291 unsigned int i;
292
293#ifdef LC_ALL
294
295 if (category == LC_ALL) {
296 return "LC_ALL";
297 }
298
299#endif
300
301 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
302 if (category == categories[i]) {
303 return category_names[i];
304 }
305 }
306
307 {
308 const char suffix[] = " (unknown)";
309 int temp = category;
310 Size_t length = sizeof(suffix) + 1;
311 char * unknown;
312 dTHX;
313
314 if (temp < 0) {
315 length++;
316 temp = - temp;
317 }
318
319 /* Calculate the number of digits */
320 while (temp >= 10) {
321 temp /= 10;
322 length++;
323 }
324
325 Newx(unknown, length, char);
326 my_snprintf(unknown, length, "%d%s", category, suffix);
327 SAVEFREEPV(unknown);
328 return unknown;
329 }
330}
331
948523db
KW		 332/* Now create LC_foo_INDEX #defines for just those categories on this system */
333# ifdef USE_LOCALE_NUMERIC
334# define LC_NUMERIC_INDEX 0
335# define _DUMMY_NUMERIC LC_NUMERIC_INDEX
336# else
337# define _DUMMY_NUMERIC -1
338# endif
339# ifdef USE_LOCALE_CTYPE
340# define LC_CTYPE_INDEX _DUMMY_NUMERIC + 1
341# define _DUMMY_CTYPE LC_CTYPE_INDEX
342# else
343# define _DUMMY_CTYPE _DUMMY_NUMERIC
344# endif
345# ifdef USE_LOCALE_COLLATE
346# define LC_COLLATE_INDEX _DUMMY_CTYPE + 1
347# define _DUMMY_COLLATE LC_COLLATE_INDEX
348# else
8203b3c3 349# define _DUMMY_COLLATE _DUMMY_CTYPE
948523db
KW		 350# endif
351# ifdef USE_LOCALE_TIME
352# define LC_TIME_INDEX _DUMMY_COLLATE + 1
353# define _DUMMY_TIME LC_TIME_INDEX
354# else
355# define _DUMMY_TIME _DUMMY_COLLATE
356# endif
357# ifdef USE_LOCALE_MESSAGES
358# define LC_MESSAGES_INDEX _DUMMY_TIME + 1
359# define _DUMMY_MESSAGES LC_MESSAGES_INDEX
360# else
361# define _DUMMY_MESSAGES _DUMMY_TIME
362# endif
363# ifdef USE_LOCALE_MONETARY
364# define LC_MONETARY_INDEX _DUMMY_MESSAGES + 1
365# define _DUMMY_MONETARY LC_MONETARY_INDEX
366# else
367# define _DUMMY_MONETARY _DUMMY_MESSAGES
368# endif
9821811f
KW		 369# ifdef USE_LOCALE_ADDRESS
370# define LC_ADDRESS_INDEX _DUMMY_MONETARY + 1
371# define _DUMMY_ADDRESS LC_ADDRESS_INDEX
372# else
373# define _DUMMY_ADDRESS _DUMMY_MONETARY
374# endif
375# ifdef USE_LOCALE_IDENTIFICATION
376# define LC_IDENTIFICATION_INDEX _DUMMY_ADDRESS + 1
377# define _DUMMY_IDENTIFICATION LC_IDENTIFICATION_INDEX
378# else
379# define _DUMMY_IDENTIFICATION _DUMMY_ADDRESS
380# endif
381# ifdef USE_LOCALE_MEASUREMENT
382# define LC_MEASUREMENT_INDEX _DUMMY_IDENTIFICATION + 1
383# define _DUMMY_MEASUREMENT LC_MEASUREMENT_INDEX
384# else
385# define _DUMMY_MEASUREMENT _DUMMY_IDENTIFICATION
386# endif
387# ifdef USE_LOCALE_PAPER
388# define LC_PAPER_INDEX _DUMMY_MEASUREMENT + 1
389# define _DUMMY_PAPER LC_PAPER_INDEX
390# else
391# define _DUMMY_PAPER _DUMMY_MEASUREMENT
392# endif
393# ifdef USE_LOCALE_TELEPHONE
394# define LC_TELEPHONE_INDEX _DUMMY_PAPER + 1
395# define _DUMMY_TELEPHONE LC_TELEPHONE_INDEX
396# else
397# define _DUMMY_TELEPHONE _DUMMY_PAPER
398# endif
36dbc955
KW		 399# ifdef USE_LOCALE_SYNTAX
400# define LC_SYNTAX_INDEX _DUMMY_TELEPHONE + 1
401# define _DUMMY_SYNTAX LC_SYNTAX_INDEX
402# else
403# define _DUMMY_SYNTAX _DUMMY_TELEPHONE
404# endif
405# ifdef USE_LOCALE_TOD
406# define LC_TOD_INDEX _DUMMY_SYNTAX + 1
407# define _DUMMY_TOD LC_TOD_INDEX
408# else
409# define _DUMMY_TOD _DUMMY_SYNTAX
410# endif
948523db 411# ifdef LC_ALL
36dbc955 412# define LC_ALL_INDEX _DUMMY_TOD + 1
948523db
KW		 413# endif
414#endif /* ifdef USE_LOCALE */
8ef6e574 415
d2b24094 416/* Windows requres a customized base-level setlocale() */
e9bc6d6b
KW		 417#ifdef WIN32
418# define my_setlocale(cat, locale) win32_setlocale(cat, locale)
419#else
420# define my_setlocale(cat, locale) setlocale(cat, locale)
421#endif
422
423#ifndef USE_POSIX_2008_LOCALE
424
425/* "do_setlocale_c" is intended to be called when the category is a constant
426 * known at compile time; "do_setlocale_r", not known until run time */
427# define do_setlocale_c(cat, locale) my_setlocale(cat, locale)
428# define do_setlocale_r(cat, locale) my_setlocale(cat, locale)
45cef8fb 429# define FIX_GLIBC_LC_MESSAGES_BUG(i)
e9bc6d6b
KW		 430
431#else /* Below uses POSIX 2008 */
432
433/* We emulate setlocale with our own function. LC_foo is not valid for the
434 * POSIX 2008 functions. Instead LC_foo_MASK is used, which we use an array
435 * lookup to convert to. At compile time we have defined LC_foo_INDEX as the
436 * proper offset into the array 'category_masks[]'. At runtime, we have to
437 * search through the array (as the actual numbers may not be small contiguous
438 * positive integers which would lend themselves to array lookup). */
439# define do_setlocale_c(cat, locale) \
440 emulate_setlocale(cat, locale, cat ## _INDEX, TRUE)
441# define do_setlocale_r(cat, locale) emulate_setlocale(cat, locale, 0, FALSE)
442
45cef8fb
KW		 443# if ! defined(__GLIBC__) || ! defined(USE_LOCALE_MESSAGES)
444
445# define FIX_GLIBC_LC_MESSAGES_BUG(i)
446
447# else /* Invalidate glibc cache of loaded translations, see [perl #134264] */
448
449# include <libintl.h>
450# define FIX_GLIBC_LC_MESSAGES_BUG(i) \
451 STMT_START { \
452 if ((i) == LC_MESSAGES_INDEX) { \
453 textdomain(textdomain(NULL)); \
454 } \
455 } STMT_END
456
457# endif
458
e9bc6d6b
KW		 459/* A third array, parallel to the ones above to map from category to its
460 * equivalent mask */
461const int category_masks[] = {
462# ifdef USE_LOCALE_NUMERIC
463 LC_NUMERIC_MASK,
464# endif
465# ifdef USE_LOCALE_CTYPE
466 LC_CTYPE_MASK,
467# endif
468# ifdef USE_LOCALE_COLLATE
469 LC_COLLATE_MASK,
470# endif
471# ifdef USE_LOCALE_TIME
472 LC_TIME_MASK,
473# endif
474# ifdef USE_LOCALE_MESSAGES
475 LC_MESSAGES_MASK,
476# endif
477# ifdef USE_LOCALE_MONETARY
478 LC_MONETARY_MASK,
479# endif
480# ifdef USE_LOCALE_ADDRESS
481 LC_ADDRESS_MASK,
482# endif
483# ifdef USE_LOCALE_IDENTIFICATION
484 LC_IDENTIFICATION_MASK,
485# endif
486# ifdef USE_LOCALE_MEASUREMENT
487 LC_MEASUREMENT_MASK,
488# endif
489# ifdef USE_LOCALE_PAPER
490 LC_PAPER_MASK,
491# endif
492# ifdef USE_LOCALE_TELEPHONE
493 LC_TELEPHONE_MASK,
494# endif
36dbc955
KW		 495# ifdef USE_LOCALE_SYNTAX
496 LC_SYNTAX_MASK,
497# endif
498# ifdef USE_LOCALE_TOD
499 LC_TOD_MASK,
500# endif
e9bc6d6b
KW		 501 /* LC_ALL can't be turned off by a Configure
502 * option, and in Posix 2008, should always be
503 * here, so compile it in unconditionally.
504 * This could catch some glitches at compile
505 * time */
506 LC_ALL_MASK
507 };
508
509STATIC const char *
510S_emulate_setlocale(const int category,
511 const char * locale,
512 unsigned int index,
513 const bool is_index_valid
514 )
515{
516 /* This function effectively performs a setlocale() on just the current
517 * thread; thus it is thread-safe. It does this by using the POSIX 2008
518 * locale functions to emulate the behavior of setlocale(). Similar to
519 * regular setlocale(), the return from this function points to memory that
520 * can be overwritten by other system calls, so needs to be copied
521 * immediately if you need to retain it. The difference here is that
522 * system calls besides another setlocale() can overwrite it.
523 *
524 * By doing this, most locale-sensitive functions become thread-safe. The
525 * exceptions are mostly those that return a pointer to static memory.
526 *
527 * This function takes the same parameters, 'category' and 'locale', that
528 * the regular setlocale() function does, but it also takes two additional
529 * ones. This is because the 2008 functions don't use a category; instead
530 * they use a corresponding mask. Because this function operates in both
531 * worlds, it may need one or the other or both. This function can
532 * calculate the mask from the input category, but to avoid this
533 * calculation, if the caller knows at compile time what the mask is, it
534 * can pass it, setting 'is_index_valid' to TRUE; otherwise the mask
535 * parameter is ignored.
536 *
537 * POSIX 2008, for some sick reason, chose not to provide a method to find
538 * the category name of a locale. Some vendors have created a
539 * querylocale() function to do just that. This function is a lot simpler
540 * to implement on systems that have this. Otherwise, we have to keep
541 * track of what the locale has been set to, so that we can return its
542 * name to emulate setlocale(). It's also possible for C code in some
543 * library to change the locale without us knowing it, though as of
544 * September 2017, there are no occurrences in CPAN of uselocale(). Some
545 * libraries do use setlocale(), but that changes the global locale, and
546 * threads using per-thread locales will just ignore those changes.
547 * Another problem is that without querylocale(), we have to guess at what
548 * was meant by setting a locale of "". We handle this by not actually
549 * ever setting to "" (unless querylocale exists), but to emulate what we
550 * think should happen for "".
551 */
552
553 int mask;
554 locale_t old_obj;
555 locale_t new_obj;
556 dTHX;
557
558# ifdef DEBUGGING
559
560 if (DEBUG_Lv_TEST || debug_initialization) {
561 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale input=%d (%s), \"%s\", %d, %d\n", __FILE__, __LINE__, category, category_name(category), locale, index, is_index_valid);
562 }
563
564# endif
565
566 /* If the input mask might be incorrect, calculate the correct one */
567 if (! is_index_valid) {
568 unsigned int i;
569
570# ifdef DEBUGGING
571
572 if (DEBUG_Lv_TEST || debug_initialization) {
573 PerlIO_printf(Perl_debug_log, "%s:%d: finding index of category %d (%s)\n", __FILE__, __LINE__, category, category_name(category));
574 }
575
576# endif
577
578 for (i = 0; i <= LC_ALL_INDEX; i++) {
579 if (category == categories[i]) {
580 index = i;
581 goto found_index;
582 }
583 }
584
585 /* Here, we don't know about this category, so can't handle it.
586 * Fallback to the early POSIX usages */
587 Perl_warner(aTHX_ packWARN(WARN_LOCALE),
588 "Unknown locale category %d; can't set it to %s\n",
589 category, locale);
590 return NULL;
591
592 found_index: ;
593
594# ifdef DEBUGGING
595
596 if (DEBUG_Lv_TEST || debug_initialization) {
597 PerlIO_printf(Perl_debug_log, "%s:%d: index is %d for %s\n", __FILE__, __LINE__, index, category_name(category));
598 }
599
600# endif
601
602 }
603
604 mask = category_masks[index];
605
606# ifdef DEBUGGING
607
608 if (DEBUG_Lv_TEST || debug_initialization) {
609 PerlIO_printf(Perl_debug_log, "%s:%d: category name is %s; mask is 0x%x\n", __FILE__, __LINE__, category_names[index], mask);
610 }
611
612# endif
613
614 /* If just querying what the existing locale is ... */
615 if (locale == NULL) {
616 locale_t cur_obj = uselocale((locale_t) 0);
617
618# ifdef DEBUGGING
619
620 if (DEBUG_Lv_TEST || debug_initialization) {
621 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale querying %p\n", __FILE__, __LINE__, cur_obj);
622 }
623
624# endif
625
626 if (cur_obj == LC_GLOBAL_LOCALE) {
627 return my_setlocale(category, NULL);
628 }
629
630# ifdef HAS_QUERYLOCALE
631
632 return (char *) querylocale(mask, cur_obj);
633
d2b24094 634# else
ecdda939
KW		 635
636 /* If this assert fails, adjust the size of curlocales in intrpvar.h */
637 STATIC_ASSERT_STMT(C_ARRAY_LENGTH(PL_curlocales) > LC_ALL_INDEX);
638
f33fd0eb
KW		 639# if defined(_NL_LOCALE_NAME) \
640 && defined(DEBUGGING) \
641 /* On systems that accept any locale name, the real underlying \
642 * locale is often returned by this internal function, so we \
643 * can't use it */ \
8e13243a 644 && ! defined(SETLOCALE_ACCEPTS_ANY_LOCALE_NAME)
e9bc6d6b
KW		 645 {
646 /* Internal glibc for querylocale(), but doesn't handle
647 * empty-string ("") locale properly; who knows what other
3a732259 648 * glitches. Check for it now, under debug. */
e9bc6d6b
KW		 649
650 char * temp_name = nl_langinfo_l(_NL_LOCALE_NAME(category),
651 uselocale((locale_t) 0));
652 /*
653 PerlIO_printf(Perl_debug_log, "%s:%d: temp_name=%s\n", __FILE__, __LINE__, temp_name ? temp_name : "NULL");
654 PerlIO_printf(Perl_debug_log, "%s:%d: index=%d\n", __FILE__, __LINE__, index);
655 PerlIO_printf(Perl_debug_log, "%s:%d: PL_curlocales[index]=%s\n", __FILE__, __LINE__, PL_curlocales[index]);
656 */
657 if (temp_name && PL_curlocales[index] && strNE(temp_name, "")) {
658 if ( strNE(PL_curlocales[index], temp_name)
659 && ! ( isNAME_C_OR_POSIX(temp_name)
660 && isNAME_C_OR_POSIX(PL_curlocales[index]))) {
661
662# ifdef USE_C_BACKTRACE
663
664 dump_c_backtrace(Perl_debug_log, 20, 1);
665
666# endif
667
668 Perl_croak(aTHX_ "panic: Mismatch between what Perl thinks %s is"
669 " (%s) and what internal glibc thinks"
670 " (%s)\n", category_names[index],
671 PL_curlocales[index], temp_name);
672 }
673
674 return temp_name;
675 }
676 }
677
678# endif
679
680 /* Without querylocale(), we have to use our record-keeping we've
681 * done. */
682
683 if (category != LC_ALL) {
684
685# ifdef DEBUGGING
686
687 if (DEBUG_Lv_TEST || debug_initialization) {
688 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, PL_curlocales[index]);
689 }
690
691# endif
692
693 return PL_curlocales[index];
694 }
695 else { /* For LC_ALL */
696 unsigned int i;
697 Size_t names_len = 0;
698 char * all_string;
7c93a471 699 bool are_all_categories_the_same_locale = TRUE;
e9bc6d6b
KW		 700
701 /* If we have a valid LC_ALL value, just return it */
702 if (PL_curlocales[LC_ALL_INDEX]) {
703
704# ifdef DEBUGGING
705
706 if (DEBUG_Lv_TEST || debug_initialization) {
707 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, PL_curlocales[LC_ALL_INDEX]);
708 }
709
710# endif
711
712 return PL_curlocales[LC_ALL_INDEX];
713 }
714
715 /* Otherwise, we need to construct a string of name=value pairs.
716 * We use the glibc syntax, like
717 * LC_NUMERIC=C;LC_TIME=en_US.UTF-8;...
7c93a471
KW		 718 * First calculate the needed size. Along the way, check if all
719 * the locale names are the same */
e9bc6d6b
KW		 720 for (i = 0; i < LC_ALL_INDEX; i++) {
721
722# ifdef DEBUGGING
723
724 if (DEBUG_Lv_TEST || debug_initialization) {
725 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale i=%d, name=%s, locale=%s\n", __FILE__, __LINE__, i, category_names[i], PL_curlocales[i]);
726 }
727
728# endif
729
730 names_len += strlen(category_names[i])
731 + 1 /* '=' */
732 + strlen(PL_curlocales[i])
733 + 1; /* ';' */
7c93a471
KW		 734
735 if (i > 0 && strNE(PL_curlocales[i], PL_curlocales[i-1])) {
736 are_all_categories_the_same_locale = FALSE;
737 }
738 }
739
740 /* If they are the same, we don't actually have to construct the
741 * string; we just make the entry in LC_ALL_INDEX valid, and be
742 * that single name */
743 if (are_all_categories_the_same_locale) {
744 PL_curlocales[LC_ALL_INDEX] = savepv(PL_curlocales[0]);
745 return PL_curlocales[LC_ALL_INDEX];
e9bc6d6b 746 }
7c93a471 747
e9bc6d6b
KW		 748 names_len++; /* Trailing '\0' */
749 SAVEFREEPV(Newx(all_string, names_len, char));
750 *all_string = '\0';
751
752 /* Then fill in the string */
753 for (i = 0; i < LC_ALL_INDEX; i++) {
754
755# ifdef DEBUGGING
756
757 if (DEBUG_Lv_TEST || debug_initialization) {
758 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale i=%d, name=%s, locale=%s\n", __FILE__, __LINE__, i, category_names[i], PL_curlocales[i]);
759 }
760
761# endif
762
763 my_strlcat(all_string, category_names[i], names_len);
764 my_strlcat(all_string, "=", names_len);
765 my_strlcat(all_string, PL_curlocales[i], names_len);
766 my_strlcat(all_string, ";", names_len);
767 }
768
769# ifdef DEBUGGING
770
771 if (DEBUG_L_TEST || debug_initialization) {
772 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale returning %s\n", __FILE__, __LINE__, all_string);
773 }
774
775 #endif
776
777 return all_string;
778 }
779
780# ifdef EINVAL
781
782 SETERRNO(EINVAL, LIB_INVARG);
783
784# endif
785
786 return NULL;
787
d2b24094
KW		 788# endif
789
6aba5c5e 790 } /* End of this being setlocale(LC_foo, NULL) */
e9bc6d6b 791
f8115d60 792 /* Here, we are switching locales. */
e9bc6d6b
KW		 793
794# ifndef HAS_QUERYLOCALE
795
796 if (strEQ(locale, "")) {
797
798 /* For non-querylocale() systems, we do the setting of "" ourselves to
799 * be sure that we really know what's going on. We follow the Linux
800 * documented behavior (but if that differs from the actual behavior,
801 * this won't work exactly as the OS implements). We go out and
802 * examine the environment based on our understanding of how the system
803 * works, and use that to figure things out */
804
805 const char * const lc_all = PerlEnv_getenv("LC_ALL");
806
807 /* Use any "LC_ALL" environment variable, as it overrides everything
808 * else. */
809 if (lc_all && strNE(lc_all, "")) {
810 locale = lc_all;
811 }
812 else {
813
814 /* Otherwise, we need to dig deeper. Unless overridden, the
815 * default is the LANG environment variable; if it doesn't exist,
816 * then "C" */
817
818 const char * default_name;
819
207cc8df 820 default_name = PerlEnv_getenv("LANG");
e9bc6d6b
KW		 821
822 if (! default_name || strEQ(default_name, "")) {
929a7f8c 823 default_name = "C";
e9bc6d6b 824 }
e9bc6d6b
KW		 825
826 if (category != LC_ALL) {
827 const char * const name = PerlEnv_getenv(category_names[index]);
828
829 /* Here we are setting a single category. Assume will have the
830 * default name */
831 locale = default_name;
832
833 /* But then look for an overriding environment variable */
834 if (name && strNE(name, "")) {
835 locale = name;
836 }
837 }
838 else {
839 bool did_override = FALSE;
840 unsigned int i;
841
842 /* Here, we are getting LC_ALL. Any categories that don't have
843 * a corresponding environment variable set should be set to
844 * LANG, or to "C" if there is no LANG. If no individual
845 * categories differ from this, we can just set LC_ALL. This
846 * is buggy on systems that have extra categories that we don't
847 * know about. If there is an environment variable that sets
848 * that category, we won't know to look for it, and so our use
849 * of LANG or "C" improperly overrides it. On the other hand,
850 * if we don't do what is done here, and there is no
851 * environment variable, the category's locale should be set to
852 * LANG or "C". So there is no good solution. khw thinks the
853 * best is to look at systems to see what categories they have,
854 * and include them, and then to assume that we know the
855 * complete set */
856
857 for (i = 0; i < LC_ALL_INDEX; i++) {
858 const char * const env_override
24f3e849 859 = PerlEnv_getenv(category_names[i]);
e9bc6d6b
KW		 860 const char * this_locale = ( env_override
861 && strNE(env_override, ""))
862 ? env_override
863 : default_name;
6435f98d
KW		 864 if (! emulate_setlocale(categories[i], this_locale, i, TRUE))
865 {
6435f98d
KW		 866 return NULL;
867 }
e9bc6d6b
KW		 868
869 if (strNE(this_locale, default_name)) {
870 did_override = TRUE;
871 }
e9bc6d6b
KW		 872 }
873
874 /* If all the categories are the same, we can set LC_ALL to
875 * that */
876 if (! did_override) {
877 locale = default_name;
878 }
879 else {
880
881 /* Here, LC_ALL is no longer valid, as some individual
882 * categories don't match it. We call ourselves
883 * recursively, as that will execute the code that
884 * generates the proper locale string for this situation.
885 * We don't do the remainder of this function, as that is
886 * to update our records, and we've just done that for the
887 * individual categories in the loop above, and doing so
888 * would cause LC_ALL to be done as well */
889 return emulate_setlocale(LC_ALL, NULL, LC_ALL_INDEX, TRUE);
890 }
891 }
892 }
6aba5c5e 893 } /* End of this being setlocale(LC_foo, "") */
e9bc6d6b
KW		 894 else if (strchr(locale, ';')) {
895
896 /* LC_ALL may actually incude a conglomeration of various categories.
897 * Without querylocale, this code uses the glibc (as of this writing)
898 * syntax for representing that, but that is not a stable API, and
899 * other platforms do it differently, so we have to handle all cases
900 * ourselves */
901
f0023d47 902 unsigned int i;
e9bc6d6b
KW		 903 const char * s = locale;
904 const char * e = locale + strlen(locale);
905 const char * p = s;
906 const char * category_end;
907 const char * name_start;
908 const char * name_end;
909
f0023d47
KW		 910 /* If the string that gives what to set doesn't include all categories,
911 * the omitted ones get set to "C". To get this behavior, first set
912 * all the individual categories to "C", and override the furnished
913 * ones below */
914 for (i = 0; i < LC_ALL_INDEX; i++) {
915 if (! emulate_setlocale(categories[i], "C", i, TRUE)) {
916 return NULL;
917 }
918 }
919
e9bc6d6b 920 while (s < e) {
e9bc6d6b
KW		 921
922 /* Parse through the category */
923 while (isWORDCHAR(*p)) {
924 p++;
925 }
926 category_end = p;
927
928 if (*p++ != '=') {
929 Perl_croak(aTHX_
930 "panic: %s: %d: Unexpected character in locale name '%02X",
931 __FILE__, __LINE__, *(p-1));
932 }
933
934 /* Parse through the locale name */
935 name_start = p;
bee74f4b
KW		 936 while (p < e && *p != ';') {
937 if (! isGRAPH(*p)) {
938 Perl_croak(aTHX_
939 "panic: %s: %d: Unexpected character in locale name '%02X",
940 __FILE__, __LINE__, *(p-1));
941 }
e9bc6d6b
KW		 942 p++;
943 }
944 name_end = p;
945
bee74f4b
KW		 946 /* Space past the semi-colon */
947 if (p < e) {
948 p++;
e9bc6d6b
KW		 949 }
950
951 /* Find the index of the category name in our lists */
952 for (i = 0; i < LC_ALL_INDEX; i++) {
3c76a412 953 char * individ_locale;
e9bc6d6b
KW		 954
955 /* Keep going if this isn't the index. The strnNE() avoids a
956 * Perl_form(), but would fail if ever a category name could be
957 * a substring of another one, like if there were a
958 * "LC_TIME_DATE" */
959 if strnNE(s, category_names[i], category_end - s) {
960 continue;
961 }
962
963 /* If this index is for the single category we're changing, we
964 * have found the locale to set it to. */
965 if (category == categories[i]) {
966 locale = Perl_form(aTHX_ "%.*s",
967 (int) (name_end - name_start),
968 name_start);
969 goto ready_to_set;
970 }
971
3c76a412 972 assert(category == LC_ALL);
bee74f4b
KW		 973 individ_locale = Perl_form(aTHX_ "%.*s",
974 (int) (name_end - name_start), name_start);
6435f98d
KW		 975 if (! emulate_setlocale(categories[i], individ_locale, i, TRUE))
976 {
977 return NULL;
978 }
e9bc6d6b
KW		 979 }
980
981 s = p;
982 }
983
984 /* Here we have set all the individual categories by recursive calls.
985 * These collectively should have fixed up LC_ALL, so can just query
986 * what that now is */
987 assert(category == LC_ALL);
988
989 return do_setlocale_c(LC_ALL, NULL);
6aba5c5e
KW		 990 } /* End of this being setlocale(LC_ALL,
991 "LC_CTYPE=foo;LC_NUMERIC=bar;...") */
e9bc6d6b
KW		 992
993 ready_to_set: ;
994
f8115d60
KW		 995 /* Here at the end of having to deal with the absence of querylocale().
996 * Some cases have already been fully handled by recursive calls to this
997 * function. But at this point, we haven't dealt with those, but are now
998 * prepared to, knowing what the locale name to set this category to is.
999 * This would have come for free if this system had had querylocale() */
1000
e9bc6d6b
KW		 1001# endif /* end of ! querylocale */
1002
f8115d60
KW		 1003 assert(PL_C_locale_obj);
1004
1005 /* Switching locales generally entails freeing the current one's space (at
1006 * the C library's discretion). We need to stop using that locale before
1007 * the switch. So switch to a known locale object that we don't otherwise
1008 * mess with. This returns the locale object in effect at the time of the
1009 * switch. */
1010 old_obj = uselocale(PL_C_locale_obj);
1011
1012# ifdef DEBUGGING
1013
1014 if (DEBUG_Lv_TEST || debug_initialization) {
1015 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale was using %p\n", __FILE__, __LINE__, old_obj);
1016 }
1017
1018# endif
1019
1020 if (! old_obj) {
1021
1022# ifdef DEBUGGING
1023
1024 if (DEBUG_L_TEST || debug_initialization) {
1025 dSAVE_ERRNO;
1026 PerlIO_printf(Perl_debug_log, "%s:%d: emulate_setlocale switching to C failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1027 RESTORE_ERRNO;
1028 }
1029
1030# endif
1031
1032 return NULL;
1033 }
1034
1035# ifdef DEBUGGING
1036
1037 if (DEBUG_Lv_TEST || debug_initialization) {
b22e9937
KW		 1038 PerlIO_printf(Perl_debug_log,
1039 "%s:%d: emulate_setlocale now using %p\n",
1040 __FILE__, __LINE__, PL_C_locale_obj);
f8115d60
KW		 1041 }
1042
1043# endif
1044
6aba5c5e
KW		 1045 /* If this call is to switch to the LC_ALL C locale, it already exists, and
1046 * in fact, we already have switched to it (in preparation for what
1047 * normally is to come). But since we're already there, continue to use
70bd6bc8
KW		 1048 * it instead of trying to create a new locale */
1049 if (mask == LC_ALL_MASK && isNAME_C_OR_POSIX(locale)) {
1050
1051# ifdef DEBUGGING
1052
1053 if (DEBUG_Lv_TEST || debug_initialization) {
1054 PerlIO_printf(Perl_debug_log,
1055 "%s:%d: will stay in C object\n", __FILE__, __LINE__);
1056 }
1057
1058# endif
1059
1060 new_obj = PL_C_locale_obj;
1061
1062 /* We already had switched to the C locale in preparation for freeing
b22e9937 1063 * 'old_obj' */
70bd6bc8
KW		 1064 if (old_obj != LC_GLOBAL_LOCALE && old_obj != PL_C_locale_obj) {
1065 freelocale(old_obj);
1066 }
1067 }
1068 else {
b22e9937
KW		 1069 /* If we weren't in a thread safe locale, set so that newlocale() below
1070 * which uses 'old_obj', uses an empty one. Same for our reserved C
1071 * object. The latter is defensive coding, so that, even if there is
1072 * some bug, we will never end up trying to modify either of these, as
1073 * if passed to newlocale(), they can be. */
1074 if (old_obj == LC_GLOBAL_LOCALE || old_obj == PL_C_locale_obj) {
1075 old_obj = (locale_t) 0;
1076 }
f8115d60 1077
b22e9937
KW		 1078 /* Ready to create a new locale by modification of the exising one */
1079 new_obj = newlocale(mask, locale, old_obj);
e9bc6d6b 1080
b22e9937
KW		 1081 if (! new_obj) {
1082 dSAVE_ERRNO;
e9bc6d6b
KW		 1083
1084# ifdef DEBUGGING
1085
b22e9937
KW		 1086 if (DEBUG_L_TEST || debug_initialization) {
1087 PerlIO_printf(Perl_debug_log,
1088 "%s:%d: emulate_setlocale creating new object"
1089 " failed: %d\n", __FILE__, __LINE__, GET_ERRNO);
1090 }
e9bc6d6b
KW		 1091
1092# endif
1093
b22e9937 1094 if (! uselocale(old_obj)) {
e9bc6d6b
KW		 1095
1096# ifdef DEBUGGING
1097
b22e9937
KW		 1098 if (DEBUG_L_TEST || debug_initialization) {
1099 PerlIO_printf(Perl_debug_log,
1100 "%s:%d: switching back failed: %d\n",
1101 __FILE__, __LINE__, GET_ERRNO);
1102 }
e9bc6d6b
KW		 1103
1104# endif
1105
b22e9937
KW		 1106 }
1107 RESTORE_ERRNO;
1108 return NULL;
e9bc6d6b 1109 }
e9bc6d6b
KW		 1110
1111# ifdef DEBUGGING
1112
b22e9937
KW		 1113 if (DEBUG_Lv_TEST || debug_initialization) {
1114 PerlIO_printf(Perl_debug_log,
1115 "%s:%d: emulate_setlocale created %p",
1116 __FILE__, __LINE__, new_obj);
1117 if (old_obj) {
1118 PerlIO_printf(Perl_debug_log,
1119 "; should have freed %p", old_obj);
1120 }
1121 PerlIO_printf(Perl_debug_log, "\n");
19ee3daf 1122 }
e9bc6d6b
KW		 1123
1124# endif
1125
b22e9937
KW		 1126 /* And switch into it */
1127 if (! uselocale(new_obj)) {
1128 dSAVE_ERRNO;
e9bc6d6b
KW		 1129
1130# ifdef DEBUGGING
1131
b22e9937
KW		 1132 if (DEBUG_L_TEST || debug_initialization) {
1133 PerlIO_printf(Perl_debug_log,
1134 "%s:%d: emulate_setlocale switching to new object"
1135 " failed\n", __FILE__, __LINE__);
1136 }
e9bc6d6b
KW		 1137
1138# endif
1139
b22e9937 1140 if (! uselocale(old_obj)) {
e9bc6d6b
KW		 1141
1142# ifdef DEBUGGING
1143
b22e9937
KW		 1144 if (DEBUG_L_TEST || debug_initialization) {
1145 PerlIO_printf(Perl_debug_log,
1146 "%s:%d: switching back failed: %d\n",
1147 __FILE__, __LINE__, GET_ERRNO);
1148 }
e9bc6d6b
KW		 1149
1150# endif
1151
b22e9937
KW		 1152 }
1153 freelocale(new_obj);
1154 RESTORE_ERRNO;
1155 return NULL;
e9bc6d6b 1156 }
70bd6bc8 1157 }
e9bc6d6b
KW		 1158
1159# ifdef DEBUGGING
1160
1161 if (DEBUG_Lv_TEST || debug_initialization) {
b22e9937
KW		 1162 PerlIO_printf(Perl_debug_log,
1163 "%s:%d: emulate_setlocale now using %p\n",
1164 __FILE__, __LINE__, new_obj);
e9bc6d6b
KW		 1165 }
1166
1167# endif
1168
1169 /* We are done, except for updating our records (if the system doesn't keep
1170 * them) and in the case of locale "", we don't actually know what the
1171 * locale that got switched to is, as it came from the environment. So
1172 * have to find it */
1173
1174# ifdef HAS_QUERYLOCALE
1175
1176 if (strEQ(locale, "")) {
1177 locale = querylocale(mask, new_obj);
1178 }
1179
1180# else
1181
1182 /* Here, 'locale' is the return value */
1183
1184 /* Without querylocale(), we have to update our records */
1185
1186 if (category == LC_ALL) {
1187 unsigned int i;
1188
1189 /* For LC_ALL, we change all individual categories to correspond */
1190 /* PL_curlocales is a parallel array, so has same
1191 * length as 'categories' */
1192 for (i = 0; i <= LC_ALL_INDEX; i++) {
1193 Safefree(PL_curlocales[i]);
1194 PL_curlocales[i] = savepv(locale);
1195 }
45cef8fb
KW		 1196
1197 FIX_GLIBC_LC_MESSAGES_BUG(LC_MESSAGES_INDEX);
e9bc6d6b
KW		 1198 }
1199 else {
1200
1201 /* For a single category, if it's not the same as the one in LC_ALL, we
1202 * nullify LC_ALL */
1203
1204 if (PL_curlocales[LC_ALL_INDEX] && strNE(PL_curlocales[LC_ALL_INDEX], locale)) {
1205 Safefree(PL_curlocales[LC_ALL_INDEX]);
1206 PL_curlocales[LC_ALL_INDEX] = NULL;
1207 }
1208
1209 /* Then update the category's record */
1210 Safefree(PL_curlocales[index]);
1211 PL_curlocales[index] = savepv(locale);
45cef8fb
KW		 1212
1213 FIX_GLIBC_LC_MESSAGES_BUG(index);
e9bc6d6b
KW		 1214 }
1215
1216# endif
1217
1218 return locale;
1219}
1220
1221#endif /* USE_POSIX_2008_LOCALE */
1222
1223#if 0 /* Code that was to emulate thread-safe locales on platforms that
1224 didn't natively support them */
1225
1226/* The way this would work is that we would keep a per-thread list of the
1227 * correct locale for that thread. Any operation that was locale-sensitive
1228 * would have to be changed so that it would look like this:
1229 *
7953f73f 1230 * SETLOCALE_LOCK;
e9bc6d6b
KW		 1231 * setlocale to the correct locale for this operation
1232 * do operation
7953f73f 1233 * SETLOCALE_UNLOCK
e9bc6d6b
KW		 1234 *
1235 * This leaves the global locale in the most recently used operation's, but it
1236 * was locked long enough to get the result. If that result is static, it
1237 * needs to be copied before the unlock.
1238 *
1239 * Macros could be written like SETUP_LOCALE_DEPENDENT_OP(category) that did
1240 * the setup, but are no-ops when not needed, and similarly,
1241 * END_LOCALE_DEPENDENT_OP for the tear-down
1242 *
1243 * But every call to a locale-sensitive function would have to be changed, and
1244 * if a module didn't cooperate by using the mutex, things would break.
1245 *
1246 * This code was abandoned before being completed or tested, and is left as-is
1247*/
1248
1249# define do_setlocale_c(cat, locale) locking_setlocale(cat, locale, cat ## _INDEX, TRUE)
1250# define do_setlocale_r(cat, locale) locking_setlocale(cat, locale, 0, FALSE)
1251
1252STATIC char *
1253S_locking_setlocale(pTHX_
1254 const int category,
1255 const char * locale,
1256 int index,
1257 const bool is_index_valid
1258 )
1259{
1260 /* This function kind of performs a setlocale() on just the current thread;
1261 * thus it is kind of thread-safe. It does this by keeping a thread-level
1262 * array of the current locales for each category. Every time a locale is
1263 * switched to, it does the switch globally, but updates the thread's
1264 * array. A query as to what the current locale is just returns the
1265 * appropriate element from the array, and doesn't actually call the system
1266 * setlocale(). The saving into the array is done in an uninterruptible
1267 * section of code, so is unaffected by whatever any other threads might be
1268 * doing.
1269 *
1270 * All locale-sensitive operations must work by first starting a critical
1271 * section, then switching to the thread's locale as kept by this function,
1272 * and then doing the operation, then ending the critical section. Thus,
1273 * each gets done in the appropriate locale. simulating thread-safety.
1274 *
1275 * This function takes the same parameters, 'category' and 'locale', that
1276 * the regular setlocale() function does, but it also takes two additional
1277 * ones. This is because as described earlier. If we know on input the
1278 * index corresponding to the category into the array where we store the
1279 * current locales, we don't have to calculate it. If the caller knows at
06cc5386 1280 * compile time what the index is, it can pass it, setting
e9bc6d6b
KW		 1281 * 'is_index_valid' to TRUE; otherwise the index parameter is ignored.
1282 *
1283 */
1284
1285 /* If the input index might be incorrect, calculate the correct one */
1286 if (! is_index_valid) {
1287 unsigned int i;
1288
1289 if (DEBUG_Lv_TEST || debug_initialization) {
1290 PerlIO_printf(Perl_debug_log, "%s:%d: converting category %d to index\n", __FILE__, __LINE__, category);
1291 }
1292
1293 for (i = 0; i <= LC_ALL_INDEX; i++) {
1294 if (category == categories[i]) {
1295 index = i;
1296 goto found_index;
1297 }
1298 }
1299
1300 /* Here, we don't know about this category, so can't handle it.
1301 * XXX best we can do is to unsafely set this
1302 * XXX warning */
1303
1304 return my_setlocale(category, locale);
1305
1306 found_index: ;
1307
1308 if (DEBUG_Lv_TEST || debug_initialization) {
1309 PerlIO_printf(Perl_debug_log, "%s:%d: index is 0x%x\n", __FILE__, __LINE__, index);
1310 }
1311 }
1312
1313 /* For a query, just return what's in our records */
1314 if (new_locale == NULL) {
1315 return curlocales[index];
1316 }
1317
1318
1319 /* Otherwise, we need to do the switch, and save the result, all in a
1320 * critical section */
1321
1322 Safefree(curlocales[[index]]);
1323
1324 /* It might be that this is called from an already-locked section of code.
1325 * We would have to detect and skip the LOCK/UNLOCK if so */
7953f73f 1326 SETLOCALE_LOCK;
e9bc6d6b
KW		 1327
1328 curlocales[index] = savepv(my_setlocale(category, new_locale));
1329
1330 if (strEQ(new_locale, "")) {
1331
1332#ifdef LC_ALL
1333
1334 /* The locale values come from the environment, and may not all be the
1335 * same, so for LC_ALL, we have to update all the others, while the
1336 * mutex is still locked */
1337
1338 if (category == LC_ALL) {
1339 unsigned int i;
1340 for (i = 0; i < LC_ALL_INDEX) {
1341 curlocales[i] = my_setlocale(categories[i], NULL);
1342 }
1343 }
1344 }
1345
1346#endif
1347
7953f73f 1348 SETLOCALE_UNLOCK;
e9bc6d6b
KW		 1349
1350 return curlocales[index];
1351}
1352
1353#endif
d36adde0 1354#ifdef USE_LOCALE
837ce802 1355
a4f00dcc 1356STATIC void
86799d2d 1357S_set_numeric_radix(pTHX_ const bool use_locale)
98994639 1358{
86799d2d
KW		 1359 /* If 'use_locale' is FALSE, set to use a dot for the radix character. If
1360 * TRUE, use the radix character derived from the current locale */
7d4bcc4a 1361
86799d2d
KW		 1362#if defined(USE_LOCALE_NUMERIC) && ( defined(HAS_LOCALECONV) \
1363 || defined(HAS_NL_LANGINFO))
98994639 1364
87f8e8e7 1365 const char * radix = (use_locale)
4e6826bf 1366 ? my_nl_langinfo(RADIXCHAR, FALSE)
87f8e8e7
KW		 1367 /* FALSE => already in dest locale */
1368 : ".";
2213a3be 1369
87f8e8e7 1370 sv_setpv(PL_numeric_radix_sv, radix);
86799d2d 1371
87f8e8e7
KW		 1372 /* If this is valid UTF-8 that isn't totally ASCII, and we are in
1373 * a UTF-8 locale, then mark the radix as being in UTF-8 */
1374 if (is_utf8_non_invariant_string((U8 *) SvPVX(PL_numeric_radix_sv),
7a393424 1375 SvCUR(PL_numeric_radix_sv))
87f8e8e7
KW		 1376 && _is_cur_LC_category_utf8(LC_NUMERIC))
1377 {
1378 SvUTF8_on(PL_numeric_radix_sv);
1379 }
86799d2d
KW		 1380
1381# ifdef DEBUGGING
7d4bcc4a 1382
2fcc0ca9
KW		 1383 if (DEBUG_L_TEST || debug_initialization) {
1384 PerlIO_printf(Perl_debug_log, "Locale radix is '%s', ?UTF-8=%d\n",
3ca88433
KW		 1385 SvPVX(PL_numeric_radix_sv),
1386 cBOOL(SvUTF8(PL_numeric_radix_sv)));
2fcc0ca9 1387 }
69014004 1388
86799d2d 1389# endif
d36adde0
KW		 1390#else
1391
1392 PERL_UNUSED_ARG(use_locale);
1393
86799d2d 1394#endif /* USE_LOCALE_NUMERIC and can find the radix char */
7d4bcc4a 1395
98994639
HS		 1396}
1397
398eeea9
KW		 1398STATIC void
1399S_new_numeric(pTHX_ const char *newnum)
98994639 1400{
7d4bcc4a
KW		 1401
1402#ifndef USE_LOCALE_NUMERIC
1403
1404 PERL_UNUSED_ARG(newnum);
1405
1406#else
0d071d52 1407
291a84fb 1408 /* Called after each libc setlocale() call affecting LC_NUMERIC, to tell
0d071d52
KW		 1409 * core Perl this and that 'newnum' is the name of the new locale.
1410 * It installs this locale as the current underlying default.
1411 *
1412 * The default locale and the C locale can be toggled between by use of the
5792c642
KW		 1413 * set_numeric_underlying() and set_numeric_standard() functions, which
1414 * should probably not be called directly, but only via macros like
0d071d52
KW		 1415 * SET_NUMERIC_STANDARD() in perl.h.
1416 *
1417 * The toggling is necessary mainly so that a non-dot radix decimal point
1418 * character can be output, while allowing internal calculations to use a
1419 * dot.
1420 *
1421 * This sets several interpreter-level variables:
bb304765 1422 * PL_numeric_name The underlying locale's name: a copy of 'newnum'
892e6465 1423 * PL_numeric_underlying A boolean indicating if the toggled state is such
7738054c
KW		 1424 * that the current locale is the program's underlying
1425 * locale
1426 * PL_numeric_standard An int indicating if the toggled state is such
4c68b815
KW		 1427 * that the current locale is the C locale or
1428 * indistinguishable from the C locale. If non-zero, it
1429 * is in C; if > 1, it means it may not be toggled away
7738054c 1430 * from C.
4c68b815
KW		 1431 * PL_numeric_underlying_is_standard A bool kept by this function
1432 * indicating that the underlying locale and the standard
1433 * C locale are indistinguishable for the purposes of
1434 * LC_NUMERIC. This happens when both of the above two
1435 * variables are true at the same time. (Toggling is a
1436 * no-op under these circumstances.) This variable is
1437 * used to avoid having to recalculate.
398eeea9 1438 */
0d071d52 1439
b03f34cf 1440 char *save_newnum;
98994639
HS		 1441
1442 if (! newnum) {
43c5f42d
NC		 1443 Safefree(PL_numeric_name);
1444 PL_numeric_name = NULL;
98994639 1445 PL_numeric_standard = TRUE;
892e6465 1446 PL_numeric_underlying = TRUE;
4c68b815 1447 PL_numeric_underlying_is_standard = TRUE;
98994639
HS		 1448 return;
1449 }
1450
b03f34cf 1451 save_newnum = stdize_locale(savepv(newnum));
892e6465 1452 PL_numeric_underlying = TRUE;
4c68b815
KW		 1453 PL_numeric_standard = isNAME_C_OR_POSIX(save_newnum);
1454
69c5e0db
KW		 1455#ifndef TS_W32_BROKEN_LOCALECONV
1456
4c68b815 1457 /* If its name isn't C nor POSIX, it could still be indistinguishable from
69c5e0db
KW		 1458 * them. But on broken Windows systems calling my_nl_langinfo() for
1459 * THOUSEP can currently (but rarely) cause a race, so avoid doing that,
1460 * and just always change the locale if not C nor POSIX on those systems */
4c68b815 1461 if (! PL_numeric_standard) {
4e6826bf 1462 PL_numeric_standard = cBOOL(strEQ(".", my_nl_langinfo(RADIXCHAR,
4c68b815 1463 FALSE /* Don't toggle locale */ ))
4e6826bf 1464 && strEQ("", my_nl_langinfo(THOUSEP, FALSE)));
4c68b815 1465 }
abe1abcf 1466
69c5e0db
KW		 1467#endif
1468
4c68b815 1469 /* Save the new name if it isn't the same as the previous one, if any */
b03f34cf 1470 if (! PL_numeric_name || strNE(PL_numeric_name, save_newnum)) {
98994639 1471 Safefree(PL_numeric_name);
b03f34cf 1472 PL_numeric_name = save_newnum;
b03f34cf 1473 }
abe1abcf
KW		 1474 else {
1475 Safefree(save_newnum);
1476 }
4c28b29c 1477
4c68b815
KW		 1478 PL_numeric_underlying_is_standard = PL_numeric_standard;
1479
7e5377f7 1480# ifdef HAS_POSIX_2008_LOCALE
e1aa2579
KW		 1481
1482 PL_underlying_numeric_obj = newlocale(LC_NUMERIC_MASK,
1483 PL_numeric_name,
1484 PL_underlying_numeric_obj);
1485
1486#endif
1487
4c68b815
KW		 1488 if (DEBUG_L_TEST || debug_initialization) {
1489 PerlIO_printf(Perl_debug_log, "Called new_numeric with %s, PL_numeric_name=%s\n", newnum, PL_numeric_name);
1490 }
1491
4c28b29c
KW		 1492 /* Keep LC_NUMERIC in the C locale. This is for XS modules, so they don't
1493 * have to worry about the radix being a non-dot. (Core operations that
1494 * need the underlying locale change to it temporarily). */
84f1d29f
KW		 1495 if (PL_numeric_standard) {
1496 set_numeric_radix(0);
1497 }
1498 else {
1499 set_numeric_standard();
1500 }
4c28b29c 1501
98994639 1502#endif /* USE_LOCALE_NUMERIC */
7d4bcc4a 1503
98994639
HS		 1504}
1505
1506void
1507Perl_set_numeric_standard(pTHX)
1508{
7d4bcc4a 1509
98994639 1510#ifdef USE_LOCALE_NUMERIC
7d4bcc4a 1511
28c1bf33
KW		 1512 /* Toggle the LC_NUMERIC locale to C. Most code should use the macros like
1513 * SET_NUMERIC_STANDARD() in perl.h instead of calling this directly. The
1514 * macro avoids calling this routine if toggling isn't necessary according
1515 * to our records (which could be wrong if some XS code has changed the
1516 * locale behind our back) */
0d071d52 1517
7d4bcc4a
KW		 1518# ifdef DEBUGGING
1519
2fcc0ca9
KW		 1520 if (DEBUG_L_TEST || debug_initialization) {
1521 PerlIO_printf(Perl_debug_log,
7bb8f702 1522 "Setting LC_NUMERIC locale to standard C\n");
2fcc0ca9 1523 }
98994639 1524
7d4bcc4a 1525# endif
7bb8f702
KW		 1526
1527 do_setlocale_c(LC_NUMERIC, "C");
1528 PL_numeric_standard = TRUE;
1529 PL_numeric_underlying = PL_numeric_underlying_is_standard;
1530 set_numeric_radix(0);
1531
98994639 1532#endif /* USE_LOCALE_NUMERIC */
7d4bcc4a 1533
98994639
HS		 1534}
1535
1536void
5792c642 1537Perl_set_numeric_underlying(pTHX)
98994639 1538{
7d4bcc4a 1539
98994639 1540#ifdef USE_LOCALE_NUMERIC
7d4bcc4a 1541
28c1bf33 1542 /* Toggle the LC_NUMERIC locale to the current underlying default. Most
7d4bcc4a
KW		 1543 * code should use the macros like SET_NUMERIC_UNDERLYING() in perl.h
1544 * instead of calling this directly. The macro avoids calling this routine
1545 * if toggling isn't necessary according to our records (which could be
1546 * wrong if some XS code has changed the locale behind our back) */
a9b8c0d8 1547
7d4bcc4a
KW		 1548# ifdef DEBUGGING
1549
2fcc0ca9
KW		 1550 if (DEBUG_L_TEST || debug_initialization) {
1551 PerlIO_printf(Perl_debug_log,
7bb8f702 1552 "Setting LC_NUMERIC locale to %s\n",
2fcc0ca9
KW		 1553 PL_numeric_name);
1554 }
98994639 1555
7d4bcc4a 1556# endif
7bb8f702
KW		 1557
1558 do_setlocale_c(LC_NUMERIC, PL_numeric_name);
1559 PL_numeric_standard = PL_numeric_underlying_is_standard;
1560 PL_numeric_underlying = TRUE;
1561 set_numeric_radix(! PL_numeric_standard);
1562
98994639 1563#endif /* USE_LOCALE_NUMERIC */
7d4bcc4a 1564
98994639
HS		 1565}
1566
1567/*
1568 * Set up for a new ctype locale.
1569 */
a4f00dcc
KW		 1570STATIC void
1571S_new_ctype(pTHX_ const char *newctype)
98994639 1572{
7d4bcc4a
KW		 1573
1574#ifndef USE_LOCALE_CTYPE
1575
7d4bcc4a
KW		 1576 PERL_UNUSED_ARG(newctype);
1577 PERL_UNUSED_CONTEXT;
1578
1579#else
0d071d52 1580
291a84fb 1581 /* Called after each libc setlocale() call affecting LC_CTYPE, to tell
0d071d52
KW		 1582 * core Perl this and that 'newctype' is the name of the new locale.
1583 *
1584 * This function sets up the folding arrays for all 256 bytes, assuming
1585 * that tofold() is tolc() since fold case is not a concept in POSIX,
1586 *
1587 * Any code changing the locale (outside this file) should use
9aac5db8
KW		 1588 * Perl_setlocale or POSIX::setlocale, which call this function. Therefore
1589 * this function should be called directly only from this file and from
0d071d52
KW		 1590 * POSIX::setlocale() */
1591
013f4e03 1592 unsigned int i;
98994639 1593
8b7358b9
KW		 1594 /* Don't check for problems if we are suppressing the warnings */
1595 bool check_for_problems = ckWARN_d(WARN_LOCALE) || UNLIKELY(DEBUG_L_TEST);
30d8090d 1596 bool maybe_utf8_turkic = FALSE;
8b7358b9 1597
7918f24d
NC		 1598 PERL_ARGS_ASSERT_NEW_CTYPE;
1599
215c5139
KW		 1600 /* We will replace any bad locale warning with 1) nothing if the new one is
1601 * ok; or 2) a new warning for the bad new locale */
1602 if (PL_warn_locale) {
1603 SvREFCNT_dec_NN(PL_warn_locale);
1604 PL_warn_locale = NULL;
1605 }
1606
c1284011 1607 PL_in_utf8_CTYPE_locale = _is_cur_LC_category_utf8(LC_CTYPE);
31f05a37
KW		 1608
1609 /* A UTF-8 locale gets standard rules. But note that code still has to
1610 * handle this specially because of the three problematic code points */
1611 if (PL_in_utf8_CTYPE_locale) {
1612 Copy(PL_fold_latin1, PL_fold_locale, 256, U8);
30d8090d
KW		 1613
1614 /* UTF-8 locales can have special handling for 'I' and 'i' if they are
1615 * Turkic. Make sure these two are the only anomalies. (We don't use
1616 * towupper and towlower because they aren't in C89.) */
5b64f24c
KW		 1617
1618#if defined(HAS_TOWUPPER) && defined (HAS_TOWLOWER)
1619
1620 if (towupper('i') == 0x130 && towlower('I') == 0x131) {
1621
1622#else
1623
30d8090d 1624 if (toupper('i') == 'i' && tolower('I') == 'I') {
5b64f24c
KW		 1625
1626#endif
30d8090d
KW		 1627 check_for_problems = TRUE;
1628 maybe_utf8_turkic = TRUE;
1629 }
31f05a37 1630 }
8b7358b9
KW		 1631
1632 /* We don't populate the other lists if a UTF-8 locale, but do check that
1633 * everything works as expected, unless checking turned off */
1634 if (check_for_problems || ! PL_in_utf8_CTYPE_locale) {
8c6180a9
KW		 1635 /* Assume enough space for every character being bad. 4 spaces each
1636 * for the 94 printable characters that are output like "'x' "; and 5
1637 * spaces each for "'\\' ", "'\t' ", and "'\n' "; plus a terminating
1638 * NUL */
8b7358b9 1639 char bad_chars_list[ (94 * 4) + (3 * 5) + 1 ] = { '\0' };
8c6180a9
KW		 1640 bool multi_byte_locale = FALSE; /* Assume is a single-byte locale
1641 to start */
1642 unsigned int bad_count = 0; /* Count of bad characters */
1643
baa60164 1644 for (i = 0; i < 256; i++) {
8b7358b9 1645 if (! PL_in_utf8_CTYPE_locale) {
bd6d0898
KW		 1646 if (isupper(i))
1647 PL_fold_locale[i] = (U8) tolower(i);
1648 else if (islower(i))
1649 PL_fold_locale[i] = (U8) toupper(i);
1650 else
1651 PL_fold_locale[i] = (U8) i;
8b7358b9 1652 }
8c6180a9
KW		 1653
1654 /* If checking for locale problems, see if the native ASCII-range
1655 * printables plus \n and \t are in their expected categories in
1656 * the new locale. If not, this could mean big trouble, upending
1657 * Perl's and most programs' assumptions, like having a
1658 * metacharacter with special meaning become a \w. Fortunately,
1659 * it's very rare to find locales that aren't supersets of ASCII
1660 * nowadays. It isn't a problem for most controls to be changed
1661 * into something else; we check only \n and \t, though perhaps \r
1662 * could be an issue as well. */
7d4bcc4a 1663 if ( check_for_problems
8c6180a9
KW		 1664 && (isGRAPH_A(i) || isBLANK_A(i) || i == '\n'))
1665 {
8b7358b9 1666 bool is_bad = FALSE;
6726b4f4 1667 char name[4] = { '\0' };
8b7358b9
KW		 1668
1669 /* Convert the name into a string */
6726b4f4 1670 if (isGRAPH_A(i)) {
8b7358b9
KW		 1671 name[0] = i;
1672 name[1] = '\0';
1673 }
1674 else if (i == '\n') {
6726b4f4
KW		 1675 my_strlcpy(name, "\\n", sizeof(name));
1676 }
1677 else if (i == '\t') {
1678 my_strlcpy(name, "\\t", sizeof(name));
8b7358b9
KW		 1679 }
1680 else {
6726b4f4
KW		 1681 assert(i == ' ');
1682 my_strlcpy(name, "' '", sizeof(name));
8b7358b9
KW		 1683 }
1684
1685 /* Check each possibe class */
1686 if (UNLIKELY(cBOOL(isalnum(i)) != cBOOL(isALPHANUMERIC_A(i)))) {
1687 is_bad = TRUE;
1688 DEBUG_L(PerlIO_printf(Perl_debug_log,
1689 "isalnum('%s') unexpectedly is %d\n",
1690 name, cBOOL(isalnum(i))));
1691 }
1692 if (UNLIKELY(cBOOL(isalpha(i)) != cBOOL(isALPHA_A(i)))) {
1693 is_bad = TRUE;
1694 DEBUG_L(PerlIO_printf(Perl_debug_log,
1695 "isalpha('%s') unexpectedly is %d\n",
1696 name, cBOOL(isalpha(i))));
1697 }
1698 if (UNLIKELY(cBOOL(isdigit(i)) != cBOOL(isDIGIT_A(i)))) {
1699 is_bad = TRUE;
1700 DEBUG_L(PerlIO_printf(Perl_debug_log,
1701 "isdigit('%s') unexpectedly is %d\n",
1702 name, cBOOL(isdigit(i))));
1703 }
1704 if (UNLIKELY(cBOOL(isgraph(i)) != cBOOL(isGRAPH_A(i)))) {
1705 is_bad = TRUE;
1706 DEBUG_L(PerlIO_printf(Perl_debug_log,
1707 "isgraph('%s') unexpectedly is %d\n",
1708 name, cBOOL(isgraph(i))));
1709 }
1710 if (UNLIKELY(cBOOL(islower(i)) != cBOOL(isLOWER_A(i)))) {
1711 is_bad = TRUE;
1712 DEBUG_L(PerlIO_printf(Perl_debug_log,
1713 "islower('%s') unexpectedly is %d\n",
1714 name, cBOOL(islower(i))));
1715 }
1716 if (UNLIKELY(cBOOL(isprint(i)) != cBOOL(isPRINT_A(i)))) {
1717 is_bad = TRUE;
1718 DEBUG_L(PerlIO_printf(Perl_debug_log,
1719 "isprint('%s') unexpectedly is %d\n",
1720 name, cBOOL(isprint(i))));
1721 }
1722 if (UNLIKELY(cBOOL(ispunct(i)) != cBOOL(isPUNCT_A(i)))) {
1723 is_bad = TRUE;
1724 DEBUG_L(PerlIO_printf(Perl_debug_log,
1725 "ispunct('%s') unexpectedly is %d\n",
1726 name, cBOOL(ispunct(i))));
1727 }
1728 if (UNLIKELY(cBOOL(isspace(i)) != cBOOL(isSPACE_A(i)))) {
1729 is_bad = TRUE;
1730 DEBUG_L(PerlIO_printf(Perl_debug_log,
1731 "isspace('%s') unexpectedly is %d\n",
1732 name, cBOOL(isspace(i))));
1733 }
1734 if (UNLIKELY(cBOOL(isupper(i)) != cBOOL(isUPPER_A(i)))) {
1735 is_bad = TRUE;
1736 DEBUG_L(PerlIO_printf(Perl_debug_log,
1737 "isupper('%s') unexpectedly is %d\n",
1738 name, cBOOL(isupper(i))));
1739 }
1740 if (UNLIKELY(cBOOL(isxdigit(i))!= cBOOL(isXDIGIT_A(i)))) {
1741 is_bad = TRUE;
1742 DEBUG_L(PerlIO_printf(Perl_debug_log,
1743 "isxdigit('%s') unexpectedly is %d\n",
1744 name, cBOOL(isxdigit(i))));
1745 }
65c15174 1746 if (UNLIKELY(tolower(i) != (int) toLOWER_A(i))) {
8b7358b9
KW		 1747 is_bad = TRUE;
1748 DEBUG_L(PerlIO_printf(Perl_debug_log,
1749 "tolower('%s')=0x%x instead of the expected 0x%x\n",
1750 name, tolower(i), (int) toLOWER_A(i)));
1751 }
65c15174 1752 if (UNLIKELY(toupper(i) != (int) toUPPER_A(i))) {
8b7358b9
KW		 1753 is_bad = TRUE;
1754 DEBUG_L(PerlIO_printf(Perl_debug_log,
1755 "toupper('%s')=0x%x instead of the expected 0x%x\n",
1756 name, toupper(i), (int) toUPPER_A(i)));
1757 }
1758 if (UNLIKELY((i == '\n' && ! isCNTRL_LC(i)))) {
1759 is_bad = TRUE;
1760 DEBUG_L(PerlIO_printf(Perl_debug_log,
1761 "'\\n' (=%02X) is not a control\n", (int) i));
1762 }
1763
1764 /* Add to the list; Separate multiple entries with a blank */
1765 if (is_bad) {
1766 if (bad_count) {
1767 my_strlcat(bad_chars_list, " ", sizeof(bad_chars_list));
8c6180a9 1768 }
8b7358b9
KW		 1769 my_strlcat(bad_chars_list, name, sizeof(bad_chars_list));
1770 bad_count++;
8c6180a9
KW		 1771 }
1772 }
1773 }
1774
30d8090d
KW		 1775 if (bad_count == 2 && maybe_utf8_turkic) {
1776 bad_count = 0;
1777 *bad_chars_list = '\0';
1778 PL_fold_locale['I'] = 'I';
1779 PL_fold_locale['i'] = 'i';
1780 PL_in_utf8_turkic_locale = TRUE;
1781 DEBUG_L(PerlIO_printf(Perl_debug_log, "%s:%d: %s is turkic\n",
1782 __FILE__, __LINE__, newctype));
1783 }
1784 else {
b8df1494 1785 PL_in_utf8_turkic_locale = FALSE;
30d8090d 1786 }
b8df1494 1787
7d4bcc4a
KW		 1788# ifdef MB_CUR_MAX
1789
8c6180a9 1790 /* We only handle single-byte locales (outside of UTF-8 ones; so if
d35fca5f 1791 * this locale requires more than one byte, there are going to be
8c6180a9 1792 * problems. */
9c8a6dc2
KW		 1793 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
1794 "%s:%d: check_for_problems=%d, MB_CUR_MAX=%d\n",
1795 __FILE__, __LINE__, check_for_problems, (int) MB_CUR_MAX));
1796
8b7358b9
KW		 1797 if ( check_for_problems && MB_CUR_MAX > 1
1798 && ! PL_in_utf8_CTYPE_locale
ba1a4362
KW		 1799
1800 /* Some platforms return MB_CUR_MAX > 1 for even the "C"
1801 * locale. Just assume that the implementation for them (plus
1802 * for POSIX) is correct and the > 1 value is spurious. (Since
1803 * these are specially handled to never be considered UTF-8
1804 * locales, as long as this is the only problem, everything
1805 * should work fine */
1806 && strNE(newctype, "C") && strNE(newctype, "POSIX"))
1807 {
8c6180a9
KW		 1808 multi_byte_locale = TRUE;
1809 }
7d4bcc4a
KW		 1810
1811# endif
8c6180a9 1812
30d8090d
KW		 1813 /* If we found problems and we want them output, do so */
1814 if ( (UNLIKELY(bad_count) || UNLIKELY(multi_byte_locale))
1815 && (LIKELY(ckWARN_d(WARN_LOCALE)) || UNLIKELY(DEBUG_L_TEST)))
1816 {
8b7358b9
KW		 1817 if (UNLIKELY(bad_count) && PL_in_utf8_CTYPE_locale) {
1818 PL_warn_locale = Perl_newSVpvf(aTHX_
1819 "Locale '%s' contains (at least) the following characters"
578a6a87
KW		 1820 " which have\nunexpected meanings: %s\nThe Perl program"
1821 " will use the expected meanings",
8b7358b9 1822 newctype, bad_chars_list);
8b7358b9
KW		 1823 }
1824 else {
1825 PL_warn_locale = Perl_newSVpvf(aTHX_
8c6180a9 1826 "Locale '%s' may not work well.%s%s%s\n",
780fcc9f 1827 newctype,
8c6180a9
KW		 1828 (multi_byte_locale)
1829 ? " Some characters in it are not recognized by"
1830 " Perl."
1831 : "",
1832 (bad_count)
1833 ? "\nThe following characters (and maybe others)"
1834 " may not have the same meaning as the Perl"
1835 " program expects:\n"
1836 : "",
1837 (bad_count)
1838 ? bad_chars_list
1839 : ""
1840 );
8b7358b9
KW		 1841 }
1842
b119c2be
KW		 1843# ifdef HAS_NL_LANGINFO
1844
1845 Perl_sv_catpvf(aTHX_ PL_warn_locale, "; codeset=%s",
1846 /* parameter FALSE is a don't care here */
4e6826bf 1847 my_nl_langinfo(CODESET, FALSE));
b119c2be
KW		 1848
1849# endif
1850
8b7358b9
KW		 1851 Perl_sv_catpvf(aTHX_ PL_warn_locale, "\n");
1852
cc9eaeb0 1853 /* If we are actually in the scope of the locale or are debugging,
bddebb56
KW		 1854 * output the message now. If not in that scope, we save the
1855 * message to be output at the first operation using this locale,
1856 * if that actually happens. Most programs don't use locales, so
1857 * they are immune to bad ones. */
cc9eaeb0 1858 if (IN_LC(LC_CTYPE) || UNLIKELY(DEBUG_L_TEST)) {
780fcc9f 1859
780fcc9f
KW		 1860 /* The '0' below suppresses a bogus gcc compiler warning */
1861 Perl_warner(aTHX_ packWARN(WARN_LOCALE), SvPVX(PL_warn_locale), 0);
bddebb56 1862
bddebb56
KW		 1863 if (IN_LC(LC_CTYPE)) {
1864 SvREFCNT_dec_NN(PL_warn_locale);
1865 PL_warn_locale = NULL;
1866 }
780fcc9f 1867 }
baa60164 1868 }
31f05a37 1869 }
98994639
HS		 1870
1871#endif /* USE_LOCALE_CTYPE */
7d4bcc4a 1872
98994639
HS		 1873}
1874
98994639 1875void
2726666d
KW		 1876Perl__warn_problematic_locale()
1877{
2726666d
KW		 1878
1879#ifdef USE_LOCALE_CTYPE
1880
5f04a188
KW		 1881 dTHX;
1882
1883 /* Internal-to-core function that outputs the message in PL_warn_locale,
1884 * and then NULLS it. Should be called only through the macro
1885 * _CHECK_AND_WARN_PROBLEMATIC_LOCALE */
1886
2726666d 1887 if (PL_warn_locale) {
2726666d
KW		 1888 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
1889 SvPVX(PL_warn_locale),
1890 0 /* dummy to avoid compiler warning */ );
2726666d
KW		 1891 SvREFCNT_dec_NN(PL_warn_locale);
1892 PL_warn_locale = NULL;
1893 }
1894
1895#endif
1896
1897}
1898
a4f00dcc
KW		 1899STATIC void
1900S_new_collate(pTHX_ const char *newcoll)
98994639 1901{
7d4bcc4a
KW		 1902
1903#ifndef USE_LOCALE_COLLATE
1904
1905 PERL_UNUSED_ARG(newcoll);
1906 PERL_UNUSED_CONTEXT;
1907
1908#else
0d071d52 1909
291a84fb 1910 /* Called after each libc setlocale() call affecting LC_COLLATE, to tell
0d071d52
KW		 1911 * core Perl this and that 'newcoll' is the name of the new locale.
1912 *
d35fca5f
KW		 1913 * The design of locale collation is that every locale change is given an
1914 * index 'PL_collation_ix'. The first time a string particpates in an
1915 * operation that requires collation while locale collation is active, it
1916 * is given PERL_MAGIC_collxfrm magic (via sv_collxfrm_flags()). That
1917 * magic includes the collation index, and the transformation of the string
1918 * by strxfrm(), q.v. That transformation is used when doing comparisons,
1919 * instead of the string itself. If a string changes, the magic is
1920 * cleared. The next time the locale changes, the index is incremented,
1921 * and so we know during a comparison that the transformation is not
1922 * necessarily still valid, and so is recomputed. Note that if the locale
1923 * changes enough times, the index could wrap (a U32), and it is possible
1924 * that a transformation would improperly be considered valid, leading to
1925 * an unlikely bug */
0d071d52 1926
98994639
HS		 1927 if (! newcoll) {
1928 if (PL_collation_name) {
1929 ++PL_collation_ix;
1930 Safefree(PL_collation_name);
1931 PL_collation_name = NULL;
1932 }
1933 PL_collation_standard = TRUE;
00bf60ca 1934 is_standard_collation:
98994639
HS		 1935 PL_collxfrm_base = 0;
1936 PL_collxfrm_mult = 2;
165a1c52 1937 PL_in_utf8_COLLATE_locale = FALSE;
f28f4d2a 1938 PL_strxfrm_NUL_replacement = '\0';
a4a439fb 1939 PL_strxfrm_max_cp = 0;
98994639
HS		 1940 return;
1941 }
1942
d35fca5f 1943 /* If this is not the same locale as currently, set the new one up */
98994639
HS		 1944 if (! PL_collation_name || strNE(PL_collation_name, newcoll)) {
1945 ++PL_collation_ix;
1946 Safefree(PL_collation_name);
1947 PL_collation_name = stdize_locale(savepv(newcoll));
a39edc4c 1948 PL_collation_standard = isNAME_C_OR_POSIX(newcoll);
00bf60ca
KW		 1949 if (PL_collation_standard) {
1950 goto is_standard_collation;
1951 }
98994639 1952
165a1c52 1953 PL_in_utf8_COLLATE_locale = _is_cur_LC_category_utf8(LC_COLLATE);
f28f4d2a 1954 PL_strxfrm_NUL_replacement = '\0';
a4a439fb 1955 PL_strxfrm_max_cp = 0;
165a1c52 1956
59c018b9
KW		 1957 /* A locale collation definition includes primary, secondary, tertiary,
1958 * etc. weights for each character. To sort, the primary weights are
1959 * used, and only if they compare equal, then the secondary weights are
1960 * used, and only if they compare equal, then the tertiary, etc.
1961 *
1962 * strxfrm() works by taking the input string, say ABC, and creating an
1963 * output transformed string consisting of first the primary weights,
1964 * A¹B¹C¹ followed by the secondary ones, A²B²C²; and then the
1965 * tertiary, etc, yielding A¹B¹C¹ A²B²C² A³B³C³ .... Some characters
1966 * may not have weights at every level. In our example, let's say B
1967 * doesn't have a tertiary weight, and A doesn't have a secondary
1968 * weight. The constructed string is then going to be
1969 * A¹B¹C¹ B²C² A³C³ ....
1970 * This has the desired effect that strcmp() will look at the secondary
1971 * or tertiary weights only if the strings compare equal at all higher
1972 * priority weights. The spaces shown here, like in
c342d20e 1973 * "A¹B¹C¹ A²B²C² "
59c018b9
KW		 1974 * are not just for readability. In the general case, these must
1975 * actually be bytes, which we will call here 'separator weights'; and
1976 * they must be smaller than any other weight value, but since these
1977 * are C strings, only the terminating one can be a NUL (some
1978 * implementations may include a non-NUL separator weight just before
1979 * the NUL). Implementations tend to reserve 01 for the separator
1980 * weights. They are needed so that a shorter string's secondary
1981 * weights won't be misconstrued as primary weights of a longer string,
1982 * etc. By making them smaller than any other weight, the shorter
1983 * string will sort first. (Actually, if all secondary weights are
1984 * smaller than all primary ones, there is no need for a separator
1985 * weight between those two levels, etc.)
1986 *
1987 * The length of the transformed string is roughly a linear function of
1988 * the input string. It's not exactly linear because some characters
1989 * don't have weights at all levels. When we call strxfrm() we have to
1990 * allocate some memory to hold the transformed string. The
1991 * calculations below try to find coefficients 'm' and 'b' for this
1992 * locale so that m*x + b equals how much space we need, given the size
1993 * of the input string in 'x'. If we calculate too small, we increase
1994 * the size as needed, and call strxfrm() again, but it is better to
1995 * get it right the first time to avoid wasted expensive string
1996 * transformations. */
1997
98994639 1998 {
79f120c8
KW		 1999 /* We use the string below to find how long the tranformation of it
2000 * is. Almost all locales are supersets of ASCII, or at least the
2001 * ASCII letters. We use all of them, half upper half lower,
2002 * because if we used fewer, we might hit just the ones that are
2003 * outliers in a particular locale. Most of the strings being
2004 * collated will contain a preponderance of letters, and even if
2005 * they are above-ASCII, they are likely to have the same number of
2006 * weight levels as the ASCII ones. It turns out that digits tend
2007 * to have fewer levels, and some punctuation has more, but those
2008 * are relatively sparse in text, and khw believes this gives a
2009 * reasonable result, but it could be changed if experience so
2010 * dictates. */
2011 const char longer[] = "ABCDEFGHIJKLMnopqrstuvwxyz";
2012 char * x_longer; /* Transformed 'longer' */
2013 Size_t x_len_longer; /* Length of 'x_longer' */
2014
2015 char * x_shorter; /* We also transform a substring of 'longer' */
2016 Size_t x_len_shorter;
2017
a4a439fb 2018 /* _mem_collxfrm() is used get the transformation (though here we
79f120c8
KW		 2019 * are interested only in its length). It is used because it has
2020 * the intelligence to handle all cases, but to work, it needs some
2021 * values of 'm' and 'b' to get it started. For the purposes of
2022 * this calculation we use a very conservative estimate of 'm' and
2023 * 'b'. This assumes a weight can be multiple bytes, enough to
2024 * hold any UV on the platform, and there are 5 levels, 4 weight
2025 * bytes, and a trailing NUL. */
2026 PL_collxfrm_base = 5;
2027 PL_collxfrm_mult = 5 * sizeof(UV);
2028
2029 /* Find out how long the transformation really is */
a4a439fb
KW		 2030 x_longer = _mem_collxfrm(longer,
2031 sizeof(longer) - 1,
2032 &x_len_longer,
2033
2034 /* We avoid converting to UTF-8 in the
2035 * called function by telling it the
2036 * string is in UTF-8 if the locale is a
2037 * UTF-8 one. Since the string passed
2038 * here is invariant under UTF-8, we can
2039 * claim it's UTF-8 even though it isn't.
2040 * */
2041 PL_in_utf8_COLLATE_locale);
79f120c8
KW		 2042 Safefree(x_longer);
2043
2044 /* Find out how long the transformation of a substring of 'longer'
2045 * is. Together the lengths of these transformations are
2046 * sufficient to calculate 'm' and 'b'. The substring is all of
2047 * 'longer' except the first character. This minimizes the chances
2048 * of being swayed by outliers */
a4a439fb 2049 x_shorter = _mem_collxfrm(longer + 1,
79f120c8 2050 sizeof(longer) - 2,
a4a439fb
KW		 2051 &x_len_shorter,
2052 PL_in_utf8_COLLATE_locale);
79f120c8
KW		 2053 Safefree(x_shorter);
2054
2055 /* If the results are nonsensical for this simple test, the whole
2056 * locale definition is suspect. Mark it so that locale collation
2057 * is not active at all for it. XXX Should we warn? */
2058 if ( x_len_shorter == 0
2059 || x_len_longer == 0
2060 || x_len_shorter >= x_len_longer)
2061 {
2062 PL_collxfrm_mult = 0;
2063 PL_collxfrm_base = 0;
2064 }
2065 else {
2066 SSize_t base; /* Temporary */
2067
2068 /* We have both: m * strlen(longer) + b = x_len_longer
2069 * m * strlen(shorter) + b = x_len_shorter;
2070 * subtracting yields:
2071 * m * (strlen(longer) - strlen(shorter))
2072 * = x_len_longer - x_len_shorter
2073 * But we have set things up so that 'shorter' is 1 byte smaller
2074 * than 'longer'. Hence:
2075 * m = x_len_longer - x_len_shorter
2076 *
2077 * But if something went wrong, make sure the multiplier is at
2078 * least 1.
2079 */
2080 if (x_len_longer > x_len_shorter) {
2081 PL_collxfrm_mult = (STRLEN) x_len_longer - x_len_shorter;
2082 }
2083 else {
2084 PL_collxfrm_mult = 1;
2085 }
2086
2087 /* mx + b = len
2088 * so: b = len - mx
2089 * but in case something has gone wrong, make sure it is
2090 * non-negative */
2091 base = x_len_longer - PL_collxfrm_mult * (sizeof(longer) - 1);
2092 if (base < 0) {
2093 base = 0;
2094 }
2095
2096 /* Add 1 for the trailing NUL */
2097 PL_collxfrm_base = base + 1;
2098 }
58eebef2 2099
7d4bcc4a
KW		 2100# ifdef DEBUGGING
2101
58eebef2
KW		 2102 if (DEBUG_L_TEST || debug_initialization) {
2103 PerlIO_printf(Perl_debug_log,
b07929e4
KW		 2104 "%s:%d: ?UTF-8 locale=%d; x_len_shorter=%zu, "
2105 "x_len_longer=%zu,"
2106 " collate multipler=%zu, collate base=%zu\n",
58eebef2
KW		 2107 __FILE__, __LINE__,
2108 PL_in_utf8_COLLATE_locale,
2109 x_len_shorter, x_len_longer,
2110 PL_collxfrm_mult, PL_collxfrm_base);
2111 }
7d4bcc4a
KW		 2112# endif
2113
98994639
HS		 2114 }
2115 }
2116
2117#endif /* USE_LOCALE_COLLATE */
7d4bcc4a 2118
98994639
HS		 2119}
2120
d36adde0
KW		 2121#endif
2122
d2b24094 2123#ifdef WIN32
b8cc575c 2124
6c332036
TC		 2125#define USE_WSETLOCALE
2126
2127#ifdef USE_WSETLOCALE
2128
2129STATIC char *
2130S_wrap_wsetlocale(pTHX_ int category, const char *locale) {
2131 wchar_t *wlocale;
2132 wchar_t *wresult;
2133 char *result;
2134
2135 if (locale) {
2136 int req_size =
2137 MultiByteToWideChar(CP_UTF8, 0, locale, -1, NULL, 0);
2138
2139 if (!req_size) {
2140 errno = EINVAL;
2141 return NULL;
2142 }
2143
2144 Newx(wlocale, req_size, wchar_t);
2145 if (!MultiByteToWideChar(CP_UTF8, 0, locale, -1, wlocale, req_size)) {
2146 Safefree(wlocale);
2147 errno = EINVAL;
2148 return NULL;
2149 }
2150 }
2151 else {
2152 wlocale = NULL;
2153 }
2154 wresult = _wsetlocale(category, wlocale);
2155 Safefree(wlocale);
2156 if (wresult) {
2157 int req_size =
2158 WideCharToMultiByte(CP_UTF8, 0, wresult, -1, NULL, 0, NULL, NULL);
2159 Newx(result, req_size, char);
2160 SAVEFREEPV(result); /* is there something better we can do here? */
2161 if (!WideCharToMultiByte(CP_UTF8, 0, wresult, -1,
2162 result, req_size, NULL, NULL)) {
2163 errno = EINVAL;
2164 return NULL;
2165 }
2166 }
2167 else {
2168 result = NULL;
2169 }
2170
2171 return result;
2172}
2173
2174#endif
2175
a4f00dcc 2176STATIC char *
b8cc575c 2177S_win32_setlocale(pTHX_ int category, const char* locale)
b385bb4d
KW		 2178{
2179 /* This, for Windows, emulates POSIX setlocale() behavior. There is no
7d4bcc4a
KW		 2180 * difference between the two unless the input locale is "", which normally
2181 * means on Windows to get the machine default, which is set via the
2182 * computer's "Regional and Language Options" (or its current equivalent).
2183 * In POSIX, it instead means to find the locale from the user's
2184 * environment. This routine changes the Windows behavior to first look in
2185 * the environment, and, if anything is found, use that instead of going to
2186 * the machine default. If there is no environment override, the machine
2187 * default is used, by calling the real setlocale() with "".
2188 *
2189 * The POSIX behavior is to use the LC_ALL variable if set; otherwise to
2190 * use the particular category's variable if set; otherwise to use the LANG
2191 * variable. */
b385bb4d 2192
175c4cf9 2193 bool override_LC_ALL = FALSE;
89f7b9aa 2194 char * result;
e5f10d49 2195 unsigned int i;
89f7b9aa 2196
b385bb4d 2197 if (locale && strEQ(locale, "")) {
7d4bcc4a
KW		 2198
2199# ifdef LC_ALL
2200
b385bb4d
KW		 2201 locale = PerlEnv_getenv("LC_ALL");
2202 if (! locale) {
e5f10d49
KW		 2203 if (category == LC_ALL) {
2204 override_LC_ALL = TRUE;
2205 }
2206 else {
7d4bcc4a
KW		 2207
2208# endif
7d4bcc4a 2209
e5f10d49
KW		 2210 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
2211 if (category == categories[i]) {
2212 locale = PerlEnv_getenv(category_names[i]);
2213 goto found_locale;
2214 }
2215 }
7d4bcc4a 2216
b385bb4d 2217 locale = PerlEnv_getenv("LANG");
481465ea 2218 if (! locale) {
b385bb4d
KW		 2219 locale = "";
2220 }
e5f10d49
KW		 2221
2222 found_locale: ;
7d4bcc4a
KW		 2223
2224# ifdef LC_ALL
2225
e5f10d49 2226 }
b385bb4d 2227 }
7d4bcc4a
KW		 2228
2229# endif
2230
b385bb4d
KW		 2231 }
2232
6c332036
TC		 2233#ifdef USE_WSETLOCALE
2234 result = S_wrap_wsetlocale(aTHX_ category, locale);
2235#else
89f7b9aa 2236 result = setlocale(category, locale);
6c332036 2237#endif
48015184
KW		 2238 DEBUG_L(STMT_START {
2239 dSAVE_ERRNO;
2240 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n", __FILE__, __LINE__,
2241 setlocale_debug_string(category, locale, result));
2242 RESTORE_ERRNO;
2243 } STMT_END);
89f7b9aa 2244
481465ea 2245 if (! override_LC_ALL) {
89f7b9aa
KW		 2246 return result;
2247 }
2248
dfd77d7a 2249 /* Here the input category was LC_ALL, and we have set it to what is in the
481465ea
KW		 2250 * LANG variable or the system default if there is no LANG. But these have
2251 * lower priority than the other LC_foo variables, so override it for each
2252 * one that is set. (If they are set to "", it means to use the same thing
2253 * we just set LC_ALL to, so can skip) */
7d4bcc4a 2254
948523db 2255 for (i = 0; i < LC_ALL_INDEX; i++) {
e5f10d49
KW		 2256 result = PerlEnv_getenv(category_names[i]);
2257 if (result && strNE(result, "")) {
6c332036 2258#ifdef USE_WSETLOCALE
17a1e9ac 2259 S_wrap_wsetlocale(aTHX_ categories[i], result);
6c332036 2260#else
17a1e9ac 2261 setlocale(categories[i], result);
6c332036 2262#endif
e5f10d49
KW		 2263 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
2264 __FILE__, __LINE__,
2265 setlocale_debug_string(categories[i], result, "not captured")));
2266 }
89f7b9aa 2267 }
7d4bcc4a 2268
bbc98134 2269 result = setlocale(LC_ALL, NULL);
48015184
KW		 2270 DEBUG_L(STMT_START {
2271 dSAVE_ERRNO;
2272 PerlIO_printf(Perl_debug_log, "%s:%d: %s\n",
bbc98134 2273 __FILE__, __LINE__,
48015184
KW		 2274 setlocale_debug_string(LC_ALL, NULL, result));
2275 RESTORE_ERRNO;
2276 } STMT_END);
89f7b9aa 2277
bbc98134 2278 return result;
b385bb4d
KW		 2279}
2280
2281#endif
2282
9aac5db8 2283/*
9aac5db8
KW		 2284=for apidoc Perl_setlocale
2285
2286This is an (almost) drop-in replacement for the system L<C<setlocale(3)>>,
2287taking the same parameters, and returning the same information, except that it
9487427b
KW		 2288returns the correct underlying C<LC_NUMERIC> locale. Regular C<setlocale> will
2289instead return C<C> if the underlying locale has a non-dot decimal point
2290character, or a non-empty thousands separator for displaying floating point
2291numbers. This is because perl keeps that locale category such that it has a
2292dot and empty separator, changing the locale briefly during the operations
2293where the underlying one is required. C<Perl_setlocale> knows about this, and
2294compensates; regular C<setlocale> doesn't.
9aac5db8 2295
e9bc6d6b 2296Another reason it isn't completely a drop-in replacement is that it is
9aac5db8 2297declared to return S<C<const char *>>, whereas the system setlocale omits the
163deff3
KW		 2298C<const> (presumably because its API was specified long ago, and can't be
2299updated; it is illegal to change the information C<setlocale> returns; doing
2300so leads to segfaults.)
9aac5db8 2301
e9bc6d6b
KW		 2302Finally, C<Perl_setlocale> works under all circumstances, whereas plain
2303C<setlocale> can be completely ineffective on some platforms under some
2304configurations.
2305
9aac5db8 2306C<Perl_setlocale> should not be used to change the locale except on systems
e9bc6d6b
KW		 2307where the predefined variable C<${^SAFE_LOCALES}> is 1. On some such systems,
2308the system C<setlocale()> is ineffective, returning the wrong information, and
2309failing to actually change the locale. C<Perl_setlocale>, however works
2310properly in all circumstances.
9aac5db8
KW		 2311
2312The return points to a per-thread static buffer, which is overwritten the next
2313time C<Perl_setlocale> is called from the same thread.
2314
2315=cut
2316
2317*/
2318
2319const char *
2320Perl_setlocale(const int category, const char * locale)
a4f00dcc
KW		 2321{
2322 /* This wraps POSIX::setlocale() */
2323
52129632 2324#ifndef USE_LOCALE
d36adde0
KW		 2325
2326 PERL_UNUSED_ARG(category);
2327 PERL_UNUSED_ARG(locale);
2328
2329 return "C";
2330
2331#else
2332
9aac5db8
KW		 2333 const char * retval;
2334 const char * newlocale;
2335 dSAVEDERRNO;
a4f00dcc 2336 dTHX;
d36adde0 2337 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
a4f00dcc 2338
a4f00dcc
KW		 2339#ifdef USE_LOCALE_NUMERIC
2340
291a84fb
KW		 2341 /* A NULL locale means only query what the current one is. We have the
2342 * LC_NUMERIC name saved, because we are normally switched into the C
9487427b
KW		 2343 * (or equivalent) locale for it. For an LC_ALL query, switch back to get
2344 * the correct results. All other categories don't require special
2345 * handling */
a4f00dcc
KW		 2346 if (locale == NULL) {
2347 if (category == LC_NUMERIC) {
9aac5db8
KW		 2348
2349 /* We don't have to copy this return value, as it is a per-thread
2350 * variable, and won't change until a future setlocale */
2351 return PL_numeric_name;
a4f00dcc
KW		 2352 }
2353
7d4bcc4a 2354# ifdef LC_ALL
a4f00dcc 2355
9aac5db8
KW		 2356 else if (category == LC_ALL) {
2357 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
a4f00dcc
KW		 2358 }
2359
7d4bcc4a 2360# endif
a4f00dcc
KW		 2361
2362 }
2363
2364#endif
2365
33e5a354
KW		 2366 retval = save_to_buffer(do_setlocale_r(category, locale),
2367 &PL_setlocale_buf, &PL_setlocale_bufsize, 0);
9aac5db8
KW		 2368 SAVE_ERRNO;
2369
2370#if defined(USE_LOCALE_NUMERIC) && defined(LC_ALL)
2371
2372 if (locale == NULL && category == LC_ALL) {
2373 RESTORE_LC_NUMERIC();
2374 }
2375
2376#endif
a4f00dcc
KW		 2377
2378 DEBUG_L(PerlIO_printf(Perl_debug_log,
2379 "%s:%d: %s\n", __FILE__, __LINE__,
2380 setlocale_debug_string(category, locale, retval)));
7d4bcc4a 2381
9aac5db8
KW		 2382 RESTORE_ERRNO;
2383
2384 if (! retval) {
a4f00dcc
KW		 2385 return NULL;
2386 }
2387
9aac5db8 2388 /* If locale == NULL, we are just querying the state */
a4f00dcc 2389 if (locale == NULL) {
a4f00dcc
KW		 2390 return retval;
2391 }
a4f00dcc 2392
1159483a
KW		 2393 /* Now that have switched locales, we have to update our records to
2394 * correspond. */
a4f00dcc 2395
1159483a 2396 switch (category) {
a4f00dcc 2397
1159483a 2398#ifdef USE_LOCALE_CTYPE
a4f00dcc 2399
1159483a
KW		 2400 case LC_CTYPE:
2401 new_ctype(retval);
2402 break;
a4f00dcc 2403
1159483a 2404#endif
a4f00dcc
KW		 2405#ifdef USE_LOCALE_COLLATE
2406
1159483a
KW		 2407 case LC_COLLATE:
2408 new_collate(retval);
2409 break;
a4f00dcc 2410
1159483a 2411#endif
a4f00dcc
KW		 2412#ifdef USE_LOCALE_NUMERIC
2413
1159483a
KW		 2414 case LC_NUMERIC:
2415 new_numeric(retval);
2416 break;
a4f00dcc 2417
1159483a
KW		 2418#endif
2419#ifdef LC_ALL
a4f00dcc 2420
1159483a 2421 case LC_ALL:
a4f00dcc 2422
1159483a
KW		 2423 /* LC_ALL updates all the things we care about. The values may not
2424 * be the same as 'retval', as the locale "" may have set things
2425 * individually */
a4f00dcc 2426
1159483a 2427# ifdef USE_LOCALE_CTYPE
a4f00dcc 2428
b0bde642 2429 newlocale = savepv(do_setlocale_c(LC_CTYPE, NULL));
1159483a 2430 new_ctype(newlocale);
b0bde642 2431 Safefree(newlocale);
a4f00dcc 2432
1159483a
KW		 2433# endif /* USE_LOCALE_CTYPE */
2434# ifdef USE_LOCALE_COLLATE
2435
b0bde642 2436 newlocale = savepv(do_setlocale_c(LC_COLLATE, NULL));
1159483a 2437 new_collate(newlocale);
b0bde642 2438 Safefree(newlocale);
a4f00dcc 2439
7d4bcc4a 2440# endif
1159483a 2441# ifdef USE_LOCALE_NUMERIC
a4f00dcc 2442
b0bde642 2443 newlocale = savepv(do_setlocale_c(LC_NUMERIC, NULL));
1159483a 2444 new_numeric(newlocale);
b0bde642 2445 Safefree(newlocale);
a4f00dcc 2446
1159483a
KW		 2447# endif /* USE_LOCALE_NUMERIC */
2448#endif /* LC_ALL */
a4f00dcc 2449
1159483a
KW		 2450 default:
2451 break;
a4f00dcc
KW		 2452 }
2453
2454 return retval;
2455
d36adde0
KW		 2456#endif
2457
f7416781
KW		 2458}
2459
2460PERL_STATIC_INLINE const char *
2461S_save_to_buffer(const char * string, char **buf, Size_t *buf_size, const Size_t offset)
2462{
2463 /* Copy the NUL-terminated 'string' to 'buf' + 'offset'. 'buf' has size 'buf_size',
2464 * growing it if necessary */
2465
0b6697c5 2466 Size_t string_size;
f7416781
KW		 2467
2468 PERL_ARGS_ASSERT_SAVE_TO_BUFFER;
2469
0b6697c5
KW		 2470 if (! string) {
2471 return NULL;
2472 }
2473
2474 string_size = strlen(string) + offset + 1;
2475
f7416781
KW		 2476 if (*buf_size == 0) {
2477 Newx(*buf, string_size, char);
2478 *buf_size = string_size;
2479 }
2480 else if (string_size > *buf_size) {
2481 Renew(*buf, string_size, char);
2482 *buf_size = string_size;
2483 }
2484
2485 Copy(string, *buf + offset, string_size - offset, char);
2486 return *buf;
2487}
2488
2489/*
2490
f7416781
KW		 2491=for apidoc Perl_langinfo
2492
ce181bf6 2493This is an (almost) drop-in replacement for the system C<L<nl_langinfo(3)>>,
f7416781
KW		 2494taking the same C<item> parameter values, and returning the same information.
2495But it is more thread-safe than regular C<nl_langinfo()>, and hides the quirks
2496of Perl's locale handling from your code, and can be used on systems that lack
2497a native C<nl_langinfo>.
2498
2499Expanding on these:
2500
2501=over
2502
2503=item *
2504
ce181bf6
KW		 2505The reason it isn't quite a drop-in replacement is actually an advantage. The
2506only difference is that it returns S<C<const char *>>, whereas plain
2507C<nl_langinfo()> returns S<C<char *>>, but you are (only by documentation)
2508forbidden to write into the buffer. By declaring this C<const>, the compiler
2509enforces this restriction, so if it is violated, you know at compilation time,
2510rather than getting segfaults at runtime.
2511
2512=item *
2513
69e2275e 2514It delivers the correct results for the C<RADIXCHAR> and C<THOUSEP> items,
f7416781
KW		 2515without you having to write extra code. The reason for the extra code would be
2516because these are from the C<LC_NUMERIC> locale category, which is normally
9487427b
KW		 2517kept set by Perl so that the radix is a dot, and the separator is the empty
2518string, no matter what the underlying locale is supposed to be, and so to get
2519the expected results, you have to temporarily toggle into the underlying
2520locale, and later toggle back. (You could use plain C<nl_langinfo> and
2521C<L</STORE_LC_NUMERIC_FORCE_TO_UNDERLYING>> for this but then you wouldn't get
2522the other advantages of C<Perl_langinfo()>; not keeping C<LC_NUMERIC> in the C
2523(or equivalent) locale would break a lot of CPAN, which is expecting the radix
2524(decimal point) character to be a dot.)
ce181bf6
KW		 2525
2526=item *
2527
2528The system function it replaces can have its static return buffer trashed,
f1460a66 2529not only by a subsequent call to that function, but by a C<freelocale>,
ce181bf6
KW		 2530C<setlocale>, or other locale change. The returned buffer of this function is
2531not changed until the next call to it, so the buffer is never in a trashed
2532state.
f7416781
KW		 2533
2534=item *
2535
ce181bf6
KW		 2536Its return buffer is per-thread, so it also is never overwritten by a call to
2537this function from another thread; unlike the function it replaces.
2538
2539=item *
2540
2541But most importantly, it works on systems that don't have C<nl_langinfo>, such
2542as Windows, hence makes your code more portable. Of the fifty-some possible
2543items specified by the POSIX 2008 standard,
f7416781 2544L<http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/langinfo.h.html>,
8d72e74e
KW		 2545only one is completely unimplemented, though on non-Windows platforms, another
2546significant one is also not implemented). It uses various techniques to
2547recover the other items, including calling C<L<localeconv(3)>>, and
2548C<L<strftime(3)>>, both of which are specified in C89, so should be always be
2549available. Later C<strftime()> versions have additional capabilities; C<""> is
2550returned for those not available on your system.
ce181bf6
KW		 2551
2552It is important to note that when called with an item that is recovered by
2553using C<localeconv>, the buffer from any previous explicit call to
2554C<localeconv> will be overwritten. This means you must save that buffer's
c3997e39
KW		 2555contents if you need to access them after a call to this function. (But note
2556that you might not want to be using C<localeconv()> directly anyway, because of
2557issues like the ones listed in the second item of this list (above) for
2558C<RADIXCHAR> and C<THOUSEP>. You can use the methods given in L<perlcall> to
2559call L<POSIX/localeconv> and avoid all the issues, but then you have a hash to
2560unpack).
9f0bc911 2561
6201c220
KW		 2562The details for those items which may deviate from what this emulation returns
2563and what a native C<nl_langinfo()> would return are specified in
2564L<I18N::Langinfo>.
f7416781 2565
ce181bf6
KW		 2566=back
2567
f7416781
KW		 2568When using C<Perl_langinfo> on systems that don't have a native
2569C<nl_langinfo()>, you must
2570
2571 #include "perl_langinfo.h"
2572
2573before the C<perl.h> C<#include>. You can replace your C<langinfo.h>
2574C<#include> with this one. (Doing it this way keeps out the symbols that plain
c3997e39
KW		 2575C<langinfo.h> would try to import into the namespace for code that doesn't need
2576it.)
f7416781 2577
f7416781
KW		 2578The original impetus for C<Perl_langinfo()> was so that code that needs to
2579find out the current currency symbol, floating point radix character, or digit
2580grouping separator can use, on all systems, the simpler and more
2581thread-friendly C<nl_langinfo> API instead of C<L<localeconv(3)>> which is a
2582pain to make thread-friendly. For other fields returned by C<localeconv>, it
2583is better to use the methods given in L<perlcall> to call
2584L<C<POSIX::localeconv()>|POSIX/localeconv>, which is thread-friendly.
2585
2586=cut
2587
2588*/
2589
2590const char *
2591#ifdef HAS_NL_LANGINFO
2592Perl_langinfo(const nl_item item)
2593#else
2594Perl_langinfo(const int item)
2595#endif
2596{
f61748ac
KW		 2597 return my_nl_langinfo(item, TRUE);
2598}
2599
59a15af0 2600STATIC const char *
f61748ac
KW		 2601#ifdef HAS_NL_LANGINFO
2602S_my_nl_langinfo(const nl_item item, bool toggle)
2603#else
2604S_my_nl_langinfo(const int item, bool toggle)
2605#endif
2606{
ae74815b 2607 dTHX;
0b6697c5 2608 const char * retval;
f7416781 2609
d36adde0
KW		 2610#ifdef USE_LOCALE_NUMERIC
2611
5a854ab3
KW		 2612 /* We only need to toggle into the underlying LC_NUMERIC locale for these
2613 * two items, and only if not already there */
4e6826bf 2614 if (toggle && (( item != RADIXCHAR && item != THOUSEP)
5a854ab3 2615 || PL_numeric_underlying))
d36adde0
KW		 2616
2617#endif /* No toggling needed if not using LC_NUMERIC */
2618
5a854ab3 2619 toggle = FALSE;
5a854ab3 2620
ab340fff 2621#if defined(HAS_NL_LANGINFO) /* nl_langinfo() is available. */
ee90eb2d 2622# if ! defined(HAS_THREAD_SAFE_NL_LANGINFO_L) \
8fdf38a3 2623 || ! defined(HAS_POSIX_2008_LOCALE)
f7416781 2624
ab340fff 2625 /* Here, use plain nl_langinfo(), switching to the underlying LC_NUMERIC
ae74815b
KW		 2626 * for those items dependent on it. This must be copied to a buffer before
2627 * switching back, as some systems destroy the buffer when setlocale() is
2628 * called */
f7416781 2629
038d3702
KW		 2630 {
2631 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
2632
b2fee59c 2633 if (toggle) {
038d3702 2634 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
b2fee59c 2635 }
f7416781 2636
7953f73f
KW		 2637 /* Prevent interference from another thread executing this code
2638 * section. */
2639 NL_LANGINFO_LOCK;
ee90eb2d 2640
628ff75a
KW		 2641 /* Copy to a per-thread buffer, which is also one that won't be
2642 * destroyed by a subsequent setlocale(), such as the
2643 * RESTORE_LC_NUMERIC may do just below. */
0b6697c5
KW		 2644 retval = save_to_buffer(nl_langinfo(item),
2645 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
7953f73f 2646 NL_LANGINFO_UNLOCK;
5acc4454 2647
b2fee59c 2648 if (toggle) {
038d3702 2649 RESTORE_LC_NUMERIC();
b2fee59c 2650 }
f7416781
KW		 2651 }
2652
ab340fff
KW		 2653# else /* Use nl_langinfo_l(), avoiding both a mutex and changing the locale */
2654
5a854ab3 2655 {
b2fee59c
KW		 2656 bool do_free = FALSE;
2657 locale_t cur = uselocale((locale_t) 0);
ab340fff 2658
b2fee59c
KW		 2659 if (cur == LC_GLOBAL_LOCALE) {
2660 cur = duplocale(LC_GLOBAL_LOCALE);
2661 do_free = TRUE;
2662 }
ab340fff 2663
d36adde0
KW		 2664# ifdef USE_LOCALE_NUMERIC
2665
b2fee59c 2666 if (toggle) {
e1aa2579
KW		 2667 if (PL_underlying_numeric_obj) {
2668 cur = PL_underlying_numeric_obj;
2669 }
2670 else {
2671 cur = newlocale(LC_NUMERIC_MASK, PL_numeric_name, cur);
2672 do_free = TRUE;
2673 }
b2fee59c 2674 }
ab340fff 2675
d36adde0
KW		 2676# endif
2677
628ff75a
KW		 2678 /* We have to save it to a buffer, because the freelocale() just below
2679 * can invalidate the internal one */
0b6697c5
KW		 2680 retval = save_to_buffer(nl_langinfo_l(item, cur),
2681 &PL_langinfo_buf, &PL_langinfo_bufsize, 0);
ee90eb2d 2682
b2fee59c
KW		 2683 if (do_free) {
2684 freelocale(cur);
2685 }
5a854ab3 2686 }
ab340fff 2687
c1566110
KW		 2688# endif
2689
0b6697c5 2690 if (strEQ(retval, "")) {
4e6826bf 2691 if (item == YESSTR) {
c1566110
KW		 2692 return "yes";
2693 }
4e6826bf 2694 if (item == NOSTR) {
c1566110
KW		 2695 return "no";
2696 }
2697 }
2698
0b6697c5 2699 return retval;
ab340fff 2700
f7416781 2701#else /* Below, emulate nl_langinfo as best we can */
43dd6b15
KW		 2702
2703 {
2704
f7416781
KW		 2705# ifdef HAS_LOCALECONV
2706
43dd6b15 2707 const struct lconv* lc;
628ff75a 2708 const char * temp;
038d3702 2709 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
f7416781 2710
69c5e0db
KW		 2711# ifdef TS_W32_BROKEN_LOCALECONV
2712
2713 const char * save_global;
2714 const char * save_thread;
2715 int needed_size;
2716 char * ptr;
2717 char * e;
2718 char * item_start;
2719
2720# endif
f7416781
KW		 2721# endif
2722# ifdef HAS_STRFTIME
2723
43dd6b15
KW		 2724 struct tm tm;
2725 bool return_format = FALSE; /* Return the %format, not the value */
2726 const char * format;
f7416781
KW		 2727
2728# endif
2729
43dd6b15
KW		 2730 /* We copy the results to a per-thread buffer, even if not
2731 * multi-threaded. This is in part to simplify this code, and partly
2732 * because we need a buffer anyway for strftime(), and partly because a
2733 * call of localeconv() could otherwise wipe out the buffer, and the
2734 * programmer would not be expecting this, as this is a nl_langinfo()
2735 * substitute after all, so s/he might be thinking their localeconv()
2736 * is safe until another localeconv() call. */
f7416781 2737
43dd6b15
KW		 2738 switch (item) {
2739 Size_t len;
f7416781 2740
8d72e74e 2741 /* This is unimplemented */
4e6826bf 2742 case ERA: /* For use with strftime() %E modifier */
f7416781 2743
43dd6b15
KW		 2744 default:
2745 return "";
f7416781 2746
43dd6b15 2747 /* We use only an English set, since we don't know any more */
4e6826bf
KW		 2748 case YESEXPR: return "^[+1yY]";
2749 case YESSTR: return "yes";
2750 case NOEXPR: return "^[-0nN]";
2751 case NOSTR: return "no";
2752
8d72e74e
KW		 2753 case CODESET:
2754
2755# ifndef WIN32
2756
2757 /* On non-windows, this is unimplemented, in part because of
2758 * inconsistencies between vendors. The Darwin native
2759 * nl_langinfo() implementation simply looks at everything past
2760 * any dot in the name, but that doesn't work for other
2761 * vendors. Many Linux locales that don't have UTF-8 in their
2762 * names really are UTF-8, for example; z/OS locales that do
2763 * have UTF-8 in their names, aren't really UTF-8 */
2764 return "";
2765
2766# else
2767
2768 { /* But on Windows, the name does seem to be consistent, so
2769 use that. */
2770 const char * p;
2771 const char * first;
2772 Size_t offset = 0;
2773 const char * name = my_setlocale(LC_CTYPE, NULL);
2774
2775 if (isNAME_C_OR_POSIX(name)) {
2776 return "ANSI_X3.4-1968";
2777 }
2778
2779 /* Find the dot in the locale name */
2780 first = (const char *) strchr(name, '.');
2781 if (! first) {
2782 first = name;
2783 goto has_nondigit;
2784 }
2785
2786 /* Look at everything past the dot */
2787 first++;
2788 p = first;
2789
2790 while (*p) {
2791 if (! isDIGIT(*p)) {
2792 goto has_nondigit;
2793 }
2794
2795 p++;
2796 }
2797
2798 /* Here everything past the dot is a digit. Treat it as a
2799 * code page */
18503cbd 2800 retval = save_to_buffer("CP", &PL_langinfo_buf,
32a62865 2801 &PL_langinfo_bufsize, 0);
8d72e74e 2802 offset = STRLENs("CP");
f7416781 2803
8d72e74e
KW		 2804 has_nondigit:
2805
2806 retval = save_to_buffer(first, &PL_langinfo_buf,
2807 &PL_langinfo_bufsize, offset);
2808 }
2809
2810 break;
2811
2812# endif
f7416781
KW		 2813# ifdef HAS_LOCALECONV
2814
4e6826bf 2815 case CRNCYSTR:
f7416781 2816
43dd6b15
KW		 2817 /* We don't bother with localeconv_l() because any system that
2818 * has it is likely to also have nl_langinfo() */
291a84fb 2819
8609fe00
KW		 2820 LOCALECONV_LOCK; /* Prevent interference with other threads
2821 using localeconv() */
69c5e0db
KW		 2822
2823# ifdef TS_W32_BROKEN_LOCALECONV
2824
2825 /* This is a workaround for a Windows bug prior to VS 15.
2826 * What we do here is, while locked, switch to the global
2827 * locale so localeconv() works; then switch back just before
2828 * the unlock. This can screw things up if some thread is
2829 * already using the global locale while assuming no other is.
2830 * A different workaround would be to call GetCurrencyFormat on
2831 * a known value, and parse it; patches welcome
2832 *
2833 * We have to use LC_ALL instead of LC_MONETARY because of
2834 * another bug in Windows */
2835
2836 save_thread = savepv(my_setlocale(LC_ALL, NULL));
2837 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
2838 save_global= savepv(my_setlocale(LC_ALL, NULL));
2839 my_setlocale(LC_ALL, save_thread);
2840
2841# endif
5acc4454 2842
43dd6b15
KW		 2843 lc = localeconv();
2844 if ( ! lc
2845 || ! lc->currency_symbol
2846 || strEQ("", lc->currency_symbol))
2847 {
8609fe00 2848 LOCALECONV_UNLOCK;
43dd6b15
KW		 2849 return "";
2850 }
f7416781 2851
43dd6b15 2852 /* Leave the first spot empty to be filled in below */
0b6697c5
KW		 2853 retval = save_to_buffer(lc->currency_symbol, &PL_langinfo_buf,
2854 &PL_langinfo_bufsize, 1);
43dd6b15
KW		 2855 if (lc->mon_decimal_point && strEQ(lc->mon_decimal_point, ""))
2856 { /* khw couldn't figure out how the localedef specifications
2857 would show that the $ should replace the radix; this is
2858 just a guess as to how it might work.*/
a34edee3 2859 PL_langinfo_buf[0] = '.';
43dd6b15
KW		 2860 }
2861 else if (lc->p_cs_precedes) {
a34edee3 2862 PL_langinfo_buf[0] = '-';
43dd6b15
KW		 2863 }
2864 else {
a34edee3 2865 PL_langinfo_buf[0] = '+';
43dd6b15 2866 }
f7416781 2867
69c5e0db
KW		 2868# ifdef TS_W32_BROKEN_LOCALECONV
2869
2870 my_setlocale(LC_ALL, save_global);
2871 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
2872 my_setlocale(LC_ALL, save_thread);
2873 Safefree(save_global);
2874 Safefree(save_thread);
2875
2876# endif
2877
8609fe00 2878 LOCALECONV_UNLOCK;
43dd6b15 2879 break;
f7416781 2880
69c5e0db
KW		 2881# ifdef TS_W32_BROKEN_LOCALECONV
2882
4e6826bf 2883 case RADIXCHAR:
69c5e0db
KW		 2884
2885 /* For this, we output a known simple floating point number to
2886 * a buffer, and parse it, looking for the radix */
2887
2888 if (toggle) {
2889 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
2890 }
2891
2892 if (PL_langinfo_bufsize < 10) {
2893 PL_langinfo_bufsize = 10;
2894 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2895 }
2896
2897 needed_size = my_snprintf(PL_langinfo_buf, PL_langinfo_bufsize,
2898 "%.1f", 1.5);
2899 if (needed_size >= (int) PL_langinfo_bufsize) {
2900 PL_langinfo_bufsize = needed_size + 1;
2901 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
2902 needed_size = my_snprintf(PL_langinfo_buf, PL_langinfo_bufsize,
2903 "%.1f", 1.5);
2904 assert(needed_size < (int) PL_langinfo_bufsize);
2905 }
2906
2907 ptr = PL_langinfo_buf;
2908 e = PL_langinfo_buf + PL_langinfo_bufsize;
2909
2910 /* Find the '1' */
2911 while (ptr < e && *ptr != '1') {
2912 ptr++;
2913 }
2914 ptr++;
2915
2916 /* Find the '5' */
2917 item_start = ptr;
2918 while (ptr < e && *ptr != '5') {
2919 ptr++;
2920 }
2921
2922 /* Everything in between is the radix string */
2923 if (ptr >= e) {
2924 PL_langinfo_buf[0] = '?';
2925 PL_langinfo_buf[1] = '\0';
2926 }
2927 else {
2928 *ptr = '\0';
2929 Move(item_start, PL_langinfo_buf, ptr - PL_langinfo_buf, char);
2930 }
2931
2932 if (toggle) {
2933 RESTORE_LC_NUMERIC();
2934 }
2935
2936 retval = PL_langinfo_buf;
2937 break;
2938
2939# else
2940
2941 case RADIXCHAR: /* No special handling needed */
2942
2943# endif
2944
4e6826bf 2945 case THOUSEP:
f7416781 2946
43dd6b15 2947 if (toggle) {
038d3702 2948 STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
c0d737a8 2949 }
f7416781 2950
8609fe00
KW		 2951 LOCALECONV_LOCK; /* Prevent interference with other threads
2952 using localeconv() */
69c5e0db
KW		 2953
2954# ifdef TS_W32_BROKEN_LOCALECONV
2955
2956 /* This should only be for the thousands separator. A
2957 * different work around would be to use GetNumberFormat on a
2958 * known value and parse the result to find the separator */
2959 save_thread = savepv(my_setlocale(LC_ALL, NULL));
2960 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
2961 save_global = savepv(my_setlocale(LC_ALL, NULL));
2962 my_setlocale(LC_ALL, save_thread);
2963# if 0
2964 /* This is the start of code that for broken Windows replaces
2965 * the above and below code, and instead calls
2966 * GetNumberFormat() and then would parse that to find the
2967 * thousands separator. It needs to handle UTF-16 vs -8
2968 * issues. */
2969
2970 needed_size = GetNumberFormatEx(PL_numeric_name, 0, "1234.5", NULL, PL_langinfo_buf, PL_langinfo_bufsize);
2971 DEBUG_L(PerlIO_printf(Perl_debug_log,
2972 "%s: %d: return from GetNumber, count=%d, val=%s\n",
2973 __FILE__, __LINE__, needed_size, PL_langinfo_buf));
2974
2975# endif
2976# endif
5acc4454 2977
43dd6b15
KW		 2978 lc = localeconv();
2979 if (! lc) {
628ff75a 2980 temp = "";
33394adc 2981 }
43dd6b15 2982 else {
4e6826bf 2983 temp = (item == RADIXCHAR)
43dd6b15
KW		 2984 ? lc->decimal_point
2985 : lc->thousands_sep;
628ff75a
KW		 2986 if (! temp) {
2987 temp = "";
43dd6b15
KW		 2988 }
2989 }
f7416781 2990
0b6697c5
KW		 2991 retval = save_to_buffer(temp, &PL_langinfo_buf,
2992 &PL_langinfo_bufsize, 0);
f7416781 2993
69c5e0db
KW		 2994# ifdef TS_W32_BROKEN_LOCALECONV
2995
2996 my_setlocale(LC_ALL, save_global);
2997 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
2998 my_setlocale(LC_ALL, save_thread);
2999 Safefree(save_global);
3000 Safefree(save_thread);
3001
3002# endif
3003
8609fe00 3004 LOCALECONV_UNLOCK;
5acc4454 3005
43dd6b15 3006 if (toggle) {
038d3702 3007 RESTORE_LC_NUMERIC();
43dd6b15 3008 }
f7416781 3009
43dd6b15 3010 break;
f7416781
KW		 3011
3012# endif
3013# ifdef HAS_STRFTIME
3014
43dd6b15
KW		 3015 /* These are defined by C89, so we assume that strftime supports
3016 * them, and so are returned unconditionally; they may not be what
3017 * the locale actually says, but should give good enough results
3018 * for someone using them as formats (as opposed to trying to parse
3019 * them to figure out what the locale says). The other format
3020 * items are actually tested to verify they work on the platform */
4e6826bf
KW		 3021 case D_FMT: return "%x";
3022 case T_FMT: return "%X";
3023 case D_T_FMT: return "%c";
43dd6b15
KW		 3024
3025 /* These formats are only available in later strfmtime's */
4e6826bf 3026 case ERA_D_FMT: case ERA_T_FMT: case ERA_D_T_FMT: case T_FMT_AMPM:
43dd6b15
KW		 3027
3028 /* The rest can be gotten from most versions of strftime(). */
4e6826bf
KW		 3029 case ABDAY_1: case ABDAY_2: case ABDAY_3:
3030 case ABDAY_4: case ABDAY_5: case ABDAY_6: case ABDAY_7:
3031 case ALT_DIGITS:
3032 case AM_STR: case PM_STR:
3033 case ABMON_1: case ABMON_2: case ABMON_3: case ABMON_4:
3034 case ABMON_5: case ABMON_6: case ABMON_7: case ABMON_8:
3035 case ABMON_9: case ABMON_10: case ABMON_11: case ABMON_12:
3036 case DAY_1: case DAY_2: case DAY_3: case DAY_4:
3037 case DAY_5: case DAY_6: case DAY_7:
3038 case MON_1: case MON_2: case MON_3: case MON_4:
3039 case MON_5: case MON_6: case MON_7: case MON_8:
3040 case MON_9: case MON_10: case MON_11: case MON_12:
43dd6b15 3041
43dd6b15
KW		 3042 init_tm(&tm); /* Precaution against core dumps */
3043 tm.tm_sec = 30;
3044 tm.tm_min = 30;
3045 tm.tm_hour = 6;
3046 tm.tm_year = 2017 - 1900;
3047 tm.tm_wday = 0;
3048 tm.tm_mon = 0;
3049 switch (item) {
3050 default:
43dd6b15
KW		 3051 Perl_croak(aTHX_
3052 "panic: %s: %d: switch case: %d problem",
3053 __FILE__, __LINE__, item);
3054 NOT_REACHED; /* NOTREACHED */
3055
4e6826bf
KW		 3056 case PM_STR: tm.tm_hour = 18;
3057 case AM_STR:
43dd6b15
KW		 3058 format = "%p";
3059 break;
3060
4e6826bf
KW		 3061 case ABDAY_7: tm.tm_wday++;
3062 case ABDAY_6: tm.tm_wday++;
3063 case ABDAY_5: tm.tm_wday++;
3064 case ABDAY_4: tm.tm_wday++;
3065 case ABDAY_3: tm.tm_wday++;
3066 case ABDAY_2: tm.tm_wday++;
3067 case ABDAY_1:
43dd6b15
KW		 3068 format = "%a";
3069 break;
3070
4e6826bf
KW		 3071 case DAY_7: tm.tm_wday++;
3072 case DAY_6: tm.tm_wday++;
3073 case DAY_5: tm.tm_wday++;
3074 case DAY_4: tm.tm_wday++;
3075 case DAY_3: tm.tm_wday++;
3076 case DAY_2: tm.tm_wday++;
3077 case DAY_1:
43dd6b15
KW		 3078 format = "%A";
3079 break;
3080
4e6826bf
KW		 3081 case ABMON_12: tm.tm_mon++;
3082 case ABMON_11: tm.tm_mon++;
3083 case ABMON_10: tm.tm_mon++;
3084 case ABMON_9: tm.tm_mon++;
3085 case ABMON_8: tm.tm_mon++;
3086 case ABMON_7: tm.tm_mon++;
3087 case ABMON_6: tm.tm_mon++;
3088 case ABMON_5: tm.tm_mon++;
3089 case ABMON_4: tm.tm_mon++;
3090 case ABMON_3: tm.tm_mon++;
3091 case ABMON_2: tm.tm_mon++;
3092 case ABMON_1:
43dd6b15
KW		 3093 format = "%b";
3094 break;
3095
4e6826bf
KW		 3096 case MON_12: tm.tm_mon++;
3097 case MON_11: tm.tm_mon++;
3098 case MON_10: tm.tm_mon++;
3099 case MON_9: tm.tm_mon++;
3100 case MON_8: tm.tm_mon++;
3101 case MON_7: tm.tm_mon++;
3102 case MON_6: tm.tm_mon++;
3103 case MON_5: tm.tm_mon++;
3104 case MON_4: tm.tm_mon++;
3105 case MON_3: tm.tm_mon++;
3106 case MON_2: tm.tm_mon++;
3107 case MON_1:
43dd6b15
KW		 3108 format = "%B";
3109 break;
3110
4e6826bf 3111 case T_FMT_AMPM:
43dd6b15
KW		 3112 format = "%r";
3113 return_format = TRUE;
3114 break;
3115
4e6826bf 3116 case ERA_D_FMT:
43dd6b15
KW		 3117 format = "%Ex";
3118 return_format = TRUE;
3119 break;
3120
4e6826bf 3121 case ERA_T_FMT:
43dd6b15
KW		 3122 format = "%EX";
3123 return_format = TRUE;
3124 break;
3125
4e6826bf 3126 case ERA_D_T_FMT:
43dd6b15
KW		 3127 format = "%Ec";
3128 return_format = TRUE;
3129 break;
3130
4e6826bf 3131 case ALT_DIGITS:
43dd6b15
KW		 3132 tm.tm_wday = 0;
3133 format = "%Ow"; /* Find the alternate digit for 0 */
3134 break;
3135 }
f7416781 3136
43dd6b15
KW		 3137 /* We can't use my_strftime() because it doesn't look at
3138 * tm_wday */
3139 while (0 == strftime(PL_langinfo_buf, PL_langinfo_bufsize,
3140 format, &tm))
3141 {
3142 /* A zero return means one of:
3143 * a) there wasn't enough space in PL_langinfo_buf
3144 * b) the format, like a plain %p, returns empty
3145 * c) it was an illegal format, though some
3146 * implementations of strftime will just return the
3147 * illegal format as a plain character sequence.
3148 *
3149 * To quickly test for case 'b)', try again but precede
3150 * the format with a plain character. If that result is
3151 * still empty, the problem is either 'a)' or 'c)' */
3152
3153 Size_t format_size = strlen(format) + 1;
3154 Size_t mod_size = format_size + 1;
3155 char * mod_format;
3156 char * temp_result;
3157
3158 Newx(mod_format, mod_size, char);
3159 Newx(temp_result, PL_langinfo_bufsize, char);
6873aa47 3160 *mod_format = ' ';
43dd6b15
KW		 3161 my_strlcpy(mod_format + 1, format, mod_size);
3162 len = strftime(temp_result,
3163 PL_langinfo_bufsize,
3164 mod_format, &tm);
3165 Safefree(mod_format);
3166 Safefree(temp_result);
3167
3168 /* If 'len' is non-zero, it means that we had a case like
3169 * %p which means the current locale doesn't use a.m. or
3170 * p.m., and that is valid */
3171 if (len == 0) {
3172
3173 /* Here, still didn't work. If we get well beyond a
3174 * reasonable size, bail out to prevent an infinite
3175 * loop. */
3176
3177 if (PL_langinfo_bufsize > 100 * format_size) {
3178 *PL_langinfo_buf = '\0';
3179 }
3180 else {
3181 /* Double the buffer size to retry; Add 1 in case
3182 * original was 0, so we aren't stuck at 0. */
3183 PL_langinfo_bufsize *= 2;
3184 PL_langinfo_bufsize++;
3185 Renew(PL_langinfo_buf, PL_langinfo_bufsize, char);
3186 continue;
3187 }
3188 }
f7416781 3189
f7416781 3190 break;
43dd6b15 3191 }
f7416781 3192
43dd6b15
KW		 3193 /* Here, we got a result.
3194 *
3195 * If the item is 'ALT_DIGITS', PL_langinfo_buf contains the
3196 * alternate format for wday 0. If the value is the same as
3197 * the normal 0, there isn't an alternate, so clear the buffer.
3198 * */
4e6826bf 3199 if ( item == ALT_DIGITS
43dd6b15
KW		 3200 && strEQ(PL_langinfo_buf, "0"))
3201 {
3202 *PL_langinfo_buf = '\0';
3203 }
f7416781 3204
43dd6b15
KW		 3205 /* ALT_DIGITS is problematic. Experiments on it showed that
3206 * strftime() did not always work properly when going from
3207 * alt-9 to alt-10. Only a few locales have this item defined,
3208 * and in all of them on Linux that khw was able to find,
3209 * nl_langinfo() merely returned the alt-0 character, possibly
3210 * doubled. Most Unicode digits are in blocks of 10
3211 * consecutive code points, so that is sufficient information
3212 * for those scripts, as we can infer alt-1, alt-2, .... But
3213 * for a Japanese locale, a CJK ideographic 0 is returned, and
3214 * the CJK digits are not in code point order, so you can't
3215 * really infer anything. The localedef for this locale did
3216 * specify the succeeding digits, so that strftime() works
3217 * properly on them, without needing to infer anything. But
3218 * the nl_langinfo() return did not give sufficient information
3219 * for the caller to understand what's going on. So until
3220 * there is evidence that it should work differently, this
3221 * returns the alt-0 string for ALT_DIGITS.
3222 *
3223 * wday was chosen because its range is all a single digit.
3224 * Things like tm_sec have two digits as the minimum: '00' */
f7416781 3225
d1b150d9
KW		 3226 retval = PL_langinfo_buf;
3227
43dd6b15
KW		 3228 /* If to return the format, not the value, overwrite the buffer
3229 * with it. But some strftime()s will keep the original format
3230 * if illegal, so change those to "" */
3231 if (return_format) {
3232 if (strEQ(PL_langinfo_buf, format)) {
f7416781
KW		 3233 *PL_langinfo_buf = '\0';
3234 }
43dd6b15 3235 else {
0b6697c5
KW		 3236 retval = save_to_buffer(format, &PL_langinfo_buf,
3237 &PL_langinfo_bufsize, 0);
f7416781
KW		 3238 }
3239 }
3240
3241 break;
f7416781
KW		 3242
3243# endif
3244
43dd6b15 3245 }
f7416781
KW		 3246 }
3247
0b6697c5 3248 return retval;
f7416781
KW		 3249
3250#endif
3251
a4f00dcc 3252}
b385bb4d 3253
98994639
HS		 3254/*
3255 * Initialize locale awareness.
3256 */
3257int
3258Perl_init_i18nl10n(pTHX_ int printwarn)
3259{
0e92a118
KW		 3260 /* printwarn is
3261 *
3262 * 0 if not to output warning when setup locale is bad
3263 * 1 if to output warning based on value of PERL_BADLANG
3264 * >1 if to output regardless of PERL_BADLANG
3265 *
3266 * returns
98994639 3267 * 1 = set ok or not applicable,
0e92a118
KW		 3268 * 0 = fallback to a locale of lower priority
3269 * -1 = fallback to all locales failed, not even to the C locale
6b058d42
KW		 3270 *
3271 * Under -DDEBUGGING, if the environment variable PERL_DEBUG_LOCALE_INIT is
3272 * set, debugging information is output.
3273 *
3274 * This looks more complicated than it is, mainly due to the #ifdefs.
3275 *
3276 * We try to set LC_ALL to the value determined by the environment. If
3277 * there is no LC_ALL on this platform, we try the individual categories we
3278 * know about. If this works, we are done.
3279 *
3280 * But if it doesn't work, we have to do something else. We search the
3281 * environment variables ourselves instead of relying on the system to do
3282 * it. We look at, in order, LC_ALL, LANG, a system default locale (if we
3283 * think there is one), and the ultimate fallback "C". This is all done in
3284 * the same loop as above to avoid duplicating code, but it makes things
7d4bcc4a
KW		 3285 * more complex. The 'trial_locales' array is initialized with just one
3286 * element; it causes the behavior described in the paragraph above this to
3287 * happen. If that fails, we add elements to 'trial_locales', and do extra
3288 * loop iterations to cause the behavior described in this paragraph.
6b058d42
KW		 3289 *
3290 * On Ultrix, the locale MUST come from the environment, so there is
3291 * preliminary code to set it. I (khw) am not sure that it is necessary,
3292 * and that this couldn't be folded into the loop, but barring any real
3293 * platforms to test on, it's staying as-is
3294 *
3295 * A slight complication is that in embedded Perls, the locale may already
3296 * be set-up, and we don't want to get it from the normal environment
3297 * variables. This is handled by having a special environment variable
3298 * indicate we're in this situation. We simply set setlocale's 2nd
3299 * parameter to be a NULL instead of "". That indicates to setlocale that
3300 * it is not to change anything, but to return the current value,
3301 * effectively initializing perl's db to what the locale already is.
3302 *
3303 * We play the same trick with NULL if a LC_ALL succeeds. We call
3304 * setlocale() on the individual categores with NULL to get their existing
3305 * values for our db, instead of trying to change them.
3306 * */
98994639 3307
1565c085 3308
0e92a118
KW		 3309 int ok = 1;
3310
7d4bcc4a
KW		 3311#ifndef USE_LOCALE
3312
3313 PERL_UNUSED_ARG(printwarn);
3314
3315#else /* USE_LOCALE */
7d4bcc4a
KW		 3316# ifdef __GLIBC__
3317
24f3e849 3318 const char * const language = PerlEnv_getenv("LANGUAGE");
7d4bcc4a
KW		 3319
3320# endif
65ebb059 3321
ccd65d51
KW		 3322 /* NULL uses the existing already set up locale */
3323 const char * const setlocale_init = (PerlEnv_getenv("PERL_SKIP_LOCALE_INIT"))
3324 ? NULL
3325 : "";
c3fcd832
KW		 3326 const char* trial_locales[5]; /* 5 = 1 each for "", LC_ALL, LANG, "", C */
3327 unsigned int trial_locales_count;
24f3e849
KW		 3328 const char * const lc_all = PerlEnv_getenv("LC_ALL");
3329 const char * const lang = PerlEnv_getenv("LANG");
98994639 3330 bool setlocale_failure = FALSE;
65ebb059 3331 unsigned int i;
175c4cf9
KW		 3332
3333 /* A later getenv() could zap this, so only use here */
3334 const char * const bad_lang_use_once = PerlEnv_getenv("PERL_BADLANG");
3335
3336 const bool locwarn = (printwarn > 1
e5f10d49
KW		 3337 || ( printwarn
3338 && ( ! bad_lang_use_once
22ff3130 3339 || (
e5f10d49
KW		 3340 /* disallow with "" or "0" */
3341 *bad_lang_use_once
3342 && strNE("0", bad_lang_use_once)))));
ea92aad8 3343
291a84fb 3344 /* setlocale() return vals; not copied so must be looked at immediately */
8de4332b 3345 const char * sl_result[NOMINAL_LC_ALL_INDEX + 1];
291a84fb
KW		 3346
3347 /* current locale for given category; should have been copied so aren't
3348 * volatile */
8de4332b 3349 const char * curlocales[NOMINAL_LC_ALL_INDEX + 1];
291a84fb 3350
7d4bcc4a
KW		 3351# ifdef WIN32
3352
6bce99ee
JH		 3353 /* In some systems you can find out the system default locale
3354 * and use that as the fallback locale. */
7d4bcc4a
KW		 3355# define SYSTEM_DEFAULT_LOCALE
3356# endif
3357# ifdef SYSTEM_DEFAULT_LOCALE
3358
65ebb059 3359 const char *system_default_locale = NULL;
98994639 3360
7d4bcc4a 3361# endif
948523db
KW		 3362
3363# ifndef DEBUGGING
3364# define DEBUG_LOCALE_INIT(a,b,c)
3365# else
7d4bcc4a 3366
8298454c 3367 DEBUG_INITIALIZATION_set(cBOOL(PerlEnv_getenv("PERL_DEBUG_LOCALE_INIT")));
7d4bcc4a
KW		 3368
3369# define DEBUG_LOCALE_INIT(category, locale, result) \
2fcc0ca9
KW		 3370 STMT_START { \
3371 if (debug_initialization) { \
3372 PerlIO_printf(Perl_debug_log, \
3373 "%s:%d: %s\n", \
3374 __FILE__, __LINE__, \
a4f00dcc 3375 setlocale_debug_string(category, \
2fcc0ca9
KW		 3376 locale, \
3377 result)); \
3378 } \
3379 } STMT_END
2fcc0ca9 3380
948523db
KW		 3381/* Make sure the parallel arrays are properly set up */
3382# ifdef USE_LOCALE_NUMERIC
3383 assert(categories[LC_NUMERIC_INDEX] == LC_NUMERIC);
3384 assert(strEQ(category_names[LC_NUMERIC_INDEX], "LC_NUMERIC"));
e9bc6d6b
KW		 3385# ifdef USE_POSIX_2008_LOCALE
3386 assert(category_masks[LC_NUMERIC_INDEX] == LC_NUMERIC_MASK);
3387# endif
948523db
KW		 3388# endif
3389# ifdef USE_LOCALE_CTYPE
3390 assert(categories[LC_CTYPE_INDEX] == LC_CTYPE);
3391 assert(strEQ(category_names[LC_CTYPE_INDEX], "LC_CTYPE"));
e9bc6d6b
KW		 3392# ifdef USE_POSIX_2008_LOCALE
3393 assert(category_masks[LC_CTYPE_INDEX] == LC_CTYPE_MASK);
3394# endif
948523db
KW		 3395# endif
3396# ifdef USE_LOCALE_COLLATE
3397 assert(categories[LC_COLLATE_INDEX] == LC_COLLATE);
3398 assert(strEQ(category_names[LC_COLLATE_INDEX], "LC_COLLATE"));
e9bc6d6b
KW		 3399# ifdef USE_POSIX_2008_LOCALE
3400 assert(category_masks[LC_COLLATE_INDEX] == LC_COLLATE_MASK);
3401# endif
948523db
KW		 3402# endif
3403# ifdef USE_LOCALE_TIME
3404 assert(categories[LC_TIME_INDEX] == LC_TIME);
3405 assert(strEQ(category_names[LC_TIME_INDEX], "LC_TIME"));
e9bc6d6b
KW		 3406# ifdef USE_POSIX_2008_LOCALE
3407 assert(category_masks[LC_TIME_INDEX] == LC_TIME_MASK);
3408# endif
948523db
KW		 3409# endif
3410# ifdef USE_LOCALE_MESSAGES
3411 assert(categories[LC_MESSAGES_INDEX] == LC_MESSAGES);
3412 assert(strEQ(category_names[LC_MESSAGES_INDEX], "LC_MESSAGES"));
e9bc6d6b
KW		 3413# ifdef USE_POSIX_2008_LOCALE
3414 assert(category_masks[LC_MESSAGES_INDEX] == LC_MESSAGES_MASK);
3415# endif
948523db
KW		 3416# endif
3417# ifdef USE_LOCALE_MONETARY
3418 assert(categories[LC_MONETARY_INDEX] == LC_MONETARY);
3419 assert(strEQ(category_names[LC_MONETARY_INDEX], "LC_MONETARY"));
e9bc6d6b
KW		 3420# ifdef USE_POSIX_2008_LOCALE
3421 assert(category_masks[LC_MONETARY_INDEX] == LC_MONETARY_MASK);
3422# endif
948523db 3423# endif
9821811f
KW		 3424# ifdef USE_LOCALE_ADDRESS
3425 assert(categories[LC_ADDRESS_INDEX] == LC_ADDRESS);
3426 assert(strEQ(category_names[LC_ADDRESS_INDEX], "LC_ADDRESS"));
e9bc6d6b
KW		 3427# ifdef USE_POSIX_2008_LOCALE
3428 assert(category_masks[LC_ADDRESS_INDEX] == LC_ADDRESS_MASK);
3429# endif
9821811f
KW		 3430# endif
3431# ifdef USE_LOCALE_IDENTIFICATION
3432 assert(categories[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION);
3433 assert(strEQ(category_names[LC_IDENTIFICATION_INDEX], "LC_IDENTIFICATION"));
e9bc6d6b
KW		 3434# ifdef USE_POSIX_2008_LOCALE
3435 assert(category_masks[LC_IDENTIFICATION_INDEX] == LC_IDENTIFICATION_MASK);
3436# endif
9821811f
KW		 3437# endif
3438# ifdef USE_LOCALE_MEASUREMENT
3439 assert(categories[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT);
3440 assert(strEQ(category_names[LC_MEASUREMENT_INDEX], "LC_MEASUREMENT"));
e9bc6d6b
KW		 3441# ifdef USE_POSIX_2008_LOCALE
3442 assert(category_masks[LC_MEASUREMENT_INDEX] == LC_MEASUREMENT_MASK);
3443# endif
9821811f
KW		 3444# endif
3445# ifdef USE_LOCALE_PAPER
3446 assert(categories[LC_PAPER_INDEX] == LC_PAPER);
3447 assert(strEQ(category_names[LC_PAPER_INDEX], "LC_PAPER"));
e9bc6d6b
KW		 3448# ifdef USE_POSIX_2008_LOCALE
3449 assert(category_masks[LC_PAPER_INDEX] == LC_PAPER_MASK);
3450# endif
9821811f
KW		 3451# endif
3452# ifdef USE_LOCALE_TELEPHONE
3453 assert(categories[LC_TELEPHONE_INDEX] == LC_TELEPHONE);
3454 assert(strEQ(category_names[LC_TELEPHONE_INDEX], "LC_TELEPHONE"));
e9bc6d6b
KW		 3455# ifdef USE_POSIX_2008_LOCALE
3456 assert(category_masks[LC_TELEPHONE_INDEX] == LC_TELEPHONE_MASK);
3457# endif
9821811f 3458# endif
36dbc955
KW		 3459# ifdef USE_LOCALE_SYNTAX
3460 assert(categories[LC_SYNTAX_INDEX] == LC_SYNTAX);
3461 assert(strEQ(category_names[LC_SYNTAX_INDEX], "LC_SYNTAX"));
3462# ifdef USE_POSIX_2008_LOCALE
3463 assert(category_masks[LC_SYNTAX_INDEX] == LC_SYNTAX_MASK);
3464# endif
3465# endif
3466# ifdef USE_LOCALE_TOD
3467 assert(categories[LC_TOD_INDEX] == LC_TOD);
3468 assert(strEQ(category_names[LC_TOD_INDEX], "LC_TOD"));
3469# ifdef USE_POSIX_2008_LOCALE
3470 assert(category_masks[LC_TOD_INDEX] == LC_TOD_MASK);
3471# endif
3472# endif
948523db
KW		 3473# ifdef LC_ALL
3474 assert(categories[LC_ALL_INDEX] == LC_ALL);
3475 assert(strEQ(category_names[LC_ALL_INDEX], "LC_ALL"));
3476 assert(NOMINAL_LC_ALL_INDEX == LC_ALL_INDEX);
e9bc6d6b
KW		 3477# ifdef USE_POSIX_2008_LOCALE
3478 assert(category_masks[LC_ALL_INDEX] == LC_ALL_MASK);
3479# endif
948523db
KW		 3480# endif
3481# endif /* DEBUGGING */
47280b20 3482
5a6637f0
KW		 3483 /* Initialize the per-thread mbrFOO() state variables. See POSIX.xs for
3484 * why these particular incantations are used. */
d2c9cb53
KW		 3485#ifdef HAS_MBRLEN
3486 memzero(&PL_mbrlen_ps, sizeof(PL_mbrlen_ps));
3487#endif
5a6637f0
KW		 3488#ifdef HAS_MBRTOWC
3489 memzero(&PL_mbrtowc_ps, sizeof(PL_mbrtowc_ps));
3490#endif
3491#ifdef HAS_WCTOMBR
3492 wcrtomb(NULL, L'\0', &PL_wcrtomb_ps);
3493#endif
d2c9cb53 3494
47280b20
KW		 3495 /* Initialize the cache of the program's UTF-8ness for the always known
3496 * locales C and POSIX */
3497 my_strlcpy(PL_locale_utf8ness, C_and_POSIX_utf8ness,
3498 sizeof(PL_locale_utf8ness));
3499
e9bc6d6b
KW		 3500# ifdef USE_THREAD_SAFE_LOCALE
3501# ifdef WIN32
3502
3503 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
3504
3505# endif
3506# endif
39e69e77 3507# ifdef USE_POSIX_2008_LOCALE
e9bc6d6b
KW		 3508
3509 PL_C_locale_obj = newlocale(LC_ALL_MASK, "C", (locale_t) 0);
3510 if (! PL_C_locale_obj) {
3511 Perl_croak_nocontext(
3512 "panic: Cannot create POSIX 2008 C locale object; errno=%d", errno);
3513 }
3514 if (DEBUG_Lv_TEST || debug_initialization) {
3515 PerlIO_printf(Perl_debug_log, "%s:%d: created C object %p\n", __FILE__, __LINE__, PL_C_locale_obj);
3516 }
3517
3518# endif
3519
78f7c09f
KW		 3520# ifdef USE_LOCALE_NUMERIC
3521
3ca88433
KW		 3522 PL_numeric_radix_sv = newSVpvs(".");
3523
78f7c09f
KW		 3524# endif
3525
e9bc6d6b
KW		 3526# if defined(USE_POSIX_2008_LOCALE) && ! defined(HAS_QUERYLOCALE)
3527
3528 /* Initialize our records. If we have POSIX 2008, we have LC_ALL */
3529 do_setlocale_c(LC_ALL, my_setlocale(LC_ALL, NULL));
3530
3531# endif
b56c4436 3532# ifdef LOCALE_ENVIRON_REQUIRED
98994639
HS		 3533
3534 /*
3535 * Ultrix setlocale(..., "") fails if there are no environment
3536 * variables from which to get a locale name.
3537 */
3538
b56c4436
KW		 3539# ifndef LC_ALL
3540# error Ultrix without LC_ALL not implemented
3541# else
7d4bcc4a 3542
b56c4436
KW		 3543 {
3544 bool done = FALSE;
ea92aad8
KW		 3545 if (lang) {
3546 sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, setlocale_init);
3547 DEBUG_LOCALE_INIT(LC_ALL, setlocale_init, sl_result[LC_ALL_INDEX]);
3548 if (sl_result[LC_ALL_INDEX])
3549 done = TRUE;
3550 else
e5f10d49 3551 setlocale_failure = TRUE;
ea92aad8
KW		 3552 }
3553 if (! setlocale_failure) {
3554 const char * locale_param;
3555 for (i = 0; i < LC_ALL_INDEX; i++) {
3556 locale_param = (! done && (lang || PerlEnv_getenv(category_names[i])))
3557 ? setlocale_init
3558 : NULL;
3559 sl_result[i] = do_setlocale_r(categories[i], locale_param);
3560 if (! sl_result[i]) {
3561 setlocale_failure = TRUE;
3562 }
3563 DEBUG_LOCALE_INIT(categories[i], locale_param, sl_result[i]);
e5f10d49 3564 }
c835d6be 3565 }
7d4bcc4a
KW		 3566 }
3567
3568# endif /* LC_ALL */
e5f10d49 3569# endif /* LOCALE_ENVIRON_REQUIRED */
98994639 3570
65ebb059 3571 /* We try each locale in the list until we get one that works, or exhaust
20a240df
KW		 3572 * the list. Normally the loop is executed just once. But if setting the
3573 * locale fails, inside the loop we add fallback trials to the array and so
3574 * will execute the loop multiple times */
c3fcd832
KW		 3575 trial_locales[0] = setlocale_init;
3576 trial_locales_count = 1;
7d4bcc4a 3577
65ebb059
KW		 3578 for (i= 0; i < trial_locales_count; i++) {
3579 const char * trial_locale = trial_locales[i];
3580
3581 if (i > 0) {
3582
3583 /* XXX This is to preserve old behavior for LOCALE_ENVIRON_REQUIRED
3584 * when i==0, but I (khw) don't think that behavior makes much
3585 * sense */
3586 setlocale_failure = FALSE;
3587
7d4bcc4a 3588# ifdef SYSTEM_DEFAULT_LOCALE
291a84fb 3589# ifdef WIN32 /* Note that assumes Win32 has LC_ALL */
7d4bcc4a 3590
65ebb059
KW		 3591 /* On Windows machines, an entry of "" after the 0th means to use
3592 * the system default locale, which we now proceed to get. */
3593 if (strEQ(trial_locale, "")) {
3594 unsigned int j;
3595
3596 /* Note that this may change the locale, but we are going to do
3597 * that anyway just below */
837ce802 3598 system_default_locale = do_setlocale_c(LC_ALL, "");
5d1187d1 3599 DEBUG_LOCALE_INIT(LC_ALL, "", system_default_locale);
65ebb059 3600
7d4bcc4a 3601 /* Skip if invalid or if it's already on the list of locales to
65ebb059
KW		 3602 * try */
3603 if (! system_default_locale) {
3604 goto next_iteration;
3605 }
3606 for (j = 0; j < trial_locales_count; j++) {
3607 if (strEQ(system_default_locale, trial_locales[j])) {
3608 goto next_iteration;
3609 }
3610 }
3611
3612 trial_locale = system_default_locale;
3613 }
ec0202b5
KW		 3614# else
3615# error SYSTEM_DEFAULT_LOCALE only implemented for Win32
3616# endif
7d4bcc4a 3617# endif /* SYSTEM_DEFAULT_LOCALE */
291a84fb
KW		 3618
3619 } /* For i > 0 */
65ebb059 3620
7d4bcc4a
KW		 3621# ifdef LC_ALL
3622
948523db
KW		 3623 sl_result[LC_ALL_INDEX] = do_setlocale_c(LC_ALL, trial_locale);
3624 DEBUG_LOCALE_INIT(LC_ALL, trial_locale, sl_result[LC_ALL_INDEX]);
3625 if (! sl_result[LC_ALL_INDEX]) {
49c85077 3626 setlocale_failure = TRUE;
7cd8b568
KW		 3627 }
3628 else {
3629 /* Since LC_ALL succeeded, it should have changed all the other
3630 * categories it can to its value; so we massage things so that the
3631 * setlocales below just return their category's current values.
3632 * This adequately handles the case in NetBSD where LC_COLLATE may
3633 * not be defined for a locale, and setting it individually will
7d4bcc4a 3634 * fail, whereas setting LC_ALL succeeds, leaving LC_COLLATE set to
7cd8b568
KW		 3635 * the POSIX locale. */
3636 trial_locale = NULL;
3637 }
7d4bcc4a
KW		 3638
3639# endif /* LC_ALL */
98994639 3640
e5f10d49
KW		 3641 if (! setlocale_failure) {
3642 unsigned int j;
3643 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3644 curlocales[j]
3645 = savepv(do_setlocale_r(categories[j], trial_locale));
3646 if (! curlocales[j]) {
3647 setlocale_failure = TRUE;
3648 }
3649 DEBUG_LOCALE_INIT(categories[j], trial_locale, curlocales[j]);
3650 }
c835d6be 3651
e5f10d49
KW		 3652 if (! setlocale_failure) { /* All succeeded */
3653 break; /* Exit trial_locales loop */
49c85077 3654 }
65ebb059 3655 }
98994639 3656
49c85077
KW		 3657 /* Here, something failed; will need to try a fallback. */
3658 ok = 0;
65ebb059 3659
49c85077
KW		 3660 if (i == 0) {
3661 unsigned int j;
98994639 3662
65ebb059 3663 if (locwarn) { /* Output failure info only on the first one */
7d4bcc4a
KW		 3664
3665# ifdef LC_ALL
98994639 3666
49c85077
KW		 3667 PerlIO_printf(Perl_error_log,
3668 "perl: warning: Setting locale failed.\n");
98994639 3669
7d4bcc4a 3670# else /* !LC_ALL */
98994639 3671
49c85077
KW		 3672 PerlIO_printf(Perl_error_log,
3673 "perl: warning: Setting locale failed for the categories:\n\t");
7d4bcc4a 3674
e5f10d49
KW		 3675 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3676 if (! curlocales[j]) {
3677 PerlIO_printf(Perl_error_log, category_names[j]);
3678 }
3679 else {
3680 Safefree(curlocales[j]);
3681 }
3682 }
7d4bcc4a 3683
7d4bcc4a 3684# endif /* LC_ALL */
98994639 3685
49c85077
KW		 3686 PerlIO_printf(Perl_error_log,
3687 "perl: warning: Please check that your locale settings:\n");
98994639 3688
7d4bcc4a
KW		 3689# ifdef __GLIBC__
3690
49c85077
KW		 3691 PerlIO_printf(Perl_error_log,
3692 "\tLANGUAGE = %c%s%c,\n",
3693 language ? '"' : '(',
3694 language ? language : "unset",
3695 language ? '"' : ')');
7d4bcc4a 3696# endif
98994639 3697
49c85077
KW		 3698 PerlIO_printf(Perl_error_log,
3699 "\tLC_ALL = %c%s%c,\n",
3700 lc_all ? '"' : '(',
3701 lc_all ? lc_all : "unset",
3702 lc_all ? '"' : ')');
98994639 3703
7d4bcc4a
KW		 3704# if defined(USE_ENVIRON_ARRAY)
3705
49c85077 3706 {
cd999af9 3707 char **e;
d5e32b93
KW		 3708
3709 /* Look through the environment for any variables of the
3710 * form qr/ ^ LC_ [A-Z]+ = /x, except LC_ALL which was
3711 * already handled above. These are assumed to be locale
3712 * settings. Output them and their values. */
cd999af9 3713 for (e = environ; *e; e++) {
d5e32b93
KW		 3714 const STRLEN prefix_len = sizeof("LC_") - 1;
3715 STRLEN uppers_len;
3716
cd999af9 3717 if ( strBEGINs(*e, "LC_")
c8b388b0 3718 && ! strBEGINs(*e, "LC_ALL=")
d5e32b93
KW		 3719 && (uppers_len = strspn(*e + prefix_len,
3720 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"))
3721 && ((*e)[prefix_len + uppers_len] == '='))
cd999af9
KW		 3722 {
3723 PerlIO_printf(Perl_error_log, "\t%.*s = \"%s\",\n",
d5e32b93
KW		 3724 (int) (prefix_len + uppers_len), *e,
3725 *e + prefix_len + uppers_len + 1);
cd999af9
KW		 3726 }
3727 }
49c85077 3728 }
7d4bcc4a
KW		 3729
3730# else
3731
49c85077
KW		 3732 PerlIO_printf(Perl_error_log,
3733 "\t(possibly more locale environment variables)\n");
7d4bcc4a
KW		 3734
3735# endif
98994639 3736
49c85077
KW		 3737 PerlIO_printf(Perl_error_log,
3738 "\tLANG = %c%s%c\n",
3739 lang ? '"' : '(',
3740 lang ? lang : "unset",
3741 lang ? '"' : ')');
98994639 3742
49c85077
KW		 3743 PerlIO_printf(Perl_error_log,
3744 " are supported and installed on your system.\n");
3745 }
98994639 3746
65ebb059 3747 /* Calculate what fallback locales to try. We have avoided this
f6bab5f6 3748 * until we have to, because failure is quite unlikely. This will
65ebb059
KW		 3749 * usually change the upper bound of the loop we are in.
3750 *
3751 * Since the system's default way of setting the locale has not
3752 * found one that works, We use Perl's defined ordering: LC_ALL,
3753 * LANG, and the C locale. We don't try the same locale twice, so
3754 * don't add to the list if already there. (On POSIX systems, the
3755 * LC_ALL element will likely be a repeat of the 0th element "",
6b058d42
KW		 3756 * but there's no harm done by doing it explicitly.
3757 *
3758 * Note that this tries the LC_ALL environment variable even on
3759 * systems which have no LC_ALL locale setting. This may or may
3760 * not have been originally intentional, but there's no real need
3761 * to change the behavior. */
65ebb059
KW		 3762 if (lc_all) {
3763 for (j = 0; j < trial_locales_count; j++) {
3764 if (strEQ(lc_all, trial_locales[j])) {
3765 goto done_lc_all;
3766 }
3767 }
3768 trial_locales[trial_locales_count++] = lc_all;
3769 }
3770 done_lc_all:
98994639 3771
65ebb059
KW		 3772 if (lang) {
3773 for (j = 0; j < trial_locales_count; j++) {
3774 if (strEQ(lang, trial_locales[j])) {
3775 goto done_lang;
3776 }
3777 }
3778 trial_locales[trial_locales_count++] = lang;
3779 }
3780 done_lang:
3781
7d4bcc4a
KW		 3782# if defined(WIN32) && defined(LC_ALL)
3783
65ebb059
KW		 3784 /* For Windows, we also try the system default locale before "C".
3785 * (If there exists a Windows without LC_ALL we skip this because
3786 * it gets too complicated. For those, the "C" is the next
3787 * fallback possibility). The "" is the same as the 0th element of
3788 * the array, but the code at the loop above knows to treat it
3789 * differently when not the 0th */
3790 trial_locales[trial_locales_count++] = "";
7d4bcc4a
KW		 3791
3792# endif
65ebb059
KW		 3793
3794 for (j = 0; j < trial_locales_count; j++) {
3795 if (strEQ("C", trial_locales[j])) {
3796 goto done_C;
3797 }
3798 }
3799 trial_locales[trial_locales_count++] = "C";
98994639 3800
65ebb059
KW		 3801 done_C: ;
3802 } /* end of first time through the loop */
98994639 3803
7d4bcc4a
KW		 3804# ifdef WIN32
3805
65ebb059 3806 next_iteration: ;
7d4bcc4a
KW		 3807
3808# endif
65ebb059
KW		 3809
3810 } /* end of looping through the trial locales */
3811
3812 if (ok < 1) { /* If we tried to fallback */
3813 const char* msg;
3814 if (! setlocale_failure) { /* fallback succeeded */
3815 msg = "Falling back to";
3816 }
3817 else { /* fallback failed */
e5f10d49 3818 unsigned int j;
98994639 3819
65ebb059
KW		 3820 /* We dropped off the end of the loop, so have to decrement i to
3821 * get back to the value the last time through */
3822 i--;
98994639 3823
65ebb059
KW		 3824 ok = -1;
3825 msg = "Failed to fall back to";
3826
3827 /* To continue, we should use whatever values we've got */
7d4bcc4a 3828
e5f10d49
KW		 3829 for (j = 0; j < NOMINAL_LC_ALL_INDEX; j++) {
3830 Safefree(curlocales[j]);
3831 curlocales[j] = savepv(do_setlocale_r(categories[j], NULL));
3832 DEBUG_LOCALE_INIT(categories[j], NULL, curlocales[j]);
3833 }
65ebb059
KW		 3834 }
3835
3836 if (locwarn) {
3837 const char * description;
3838 const char * name = "";
3839 if (strEQ(trial_locales[i], "C")) {
3840 description = "the standard locale";
3841 name = "C";
3842 }
7d4bcc4a
KW		 3843
3844# ifdef SYSTEM_DEFAULT_LOCALE
3845
65ebb059
KW		 3846 else if (strEQ(trial_locales[i], "")) {
3847 description = "the system default locale";
3848 if (system_default_locale) {
3849 name = system_default_locale;
3850 }
3851 }
7d4bcc4a
KW		 3852
3853# endif /* SYSTEM_DEFAULT_LOCALE */
3854
65ebb059
KW		 3855 else {
3856 description = "a fallback locale";
3857 name = trial_locales[i];
3858 }
3859 if (name && strNE(name, "")) {
3860 PerlIO_printf(Perl_error_log,
3861 "perl: warning: %s %s (\"%s\").\n", msg, description, name);
3862 }
3863 else {
3864 PerlIO_printf(Perl_error_log,
3865 "perl: warning: %s %s.\n", msg, description);
3866 }
3867 }
3868 } /* End of tried to fallback */
98994639 3869
e5f10d49
KW		 3870 /* Done with finding the locales; update our records */
3871
7d4bcc4a
KW		 3872# ifdef USE_LOCALE_CTYPE
3873
948523db 3874 new_ctype(curlocales[LC_CTYPE_INDEX]);
98994639 3875
e5f10d49 3876# endif
7d4bcc4a
KW		 3877# ifdef USE_LOCALE_COLLATE
3878
948523db 3879 new_collate(curlocales[LC_COLLATE_INDEX]);
98994639 3880
e5f10d49 3881# endif
7d4bcc4a
KW		 3882# ifdef USE_LOCALE_NUMERIC
3883
948523db 3884 new_numeric(curlocales[LC_NUMERIC_INDEX]);
e5f10d49
KW		 3885
3886# endif
3887
948523db 3888 for (i = 0; i < NOMINAL_LC_ALL_INDEX; i++) {
47280b20 3889
e9bc6d6b 3890# if defined(USE_ITHREADS) && ! defined(USE_THREAD_SAFE_LOCALE)
47280b20
KW		 3891
3892 /* This caches whether each category's locale is UTF-8 or not. This
3893 * may involve changing the locale. It is ok to do this at
e9bc6d6b
KW		 3894 * initialization time before any threads have started, but not later
3895 * unless thread-safe operations are used.
47280b20
KW		 3896 * Caching means that if the program heeds our dictate not to change
3897 * locales in threaded applications, this data will remain valid, and
9de6fe47
KW		 3898 * it may get queried without having to change locales. If the
3899 * environment is such that all categories have the same locale, this
3900 * isn't needed, as the code will not change the locale; but this
3901 * handles the uncommon case where the environment has disparate
3902 * locales for the categories */
47280b20
KW		 3903 (void) _is_cur_LC_category_utf8(categories[i]);
3904
3905# endif
3906
e5f10d49
KW		 3907 Safefree(curlocales[i]);
3908 }
b310b053 3909
7d4bcc4a
KW		 3910# if defined(USE_PERLIO) && defined(USE_LOCALE_CTYPE)
3911
49c85077 3912 /* Set PL_utf8locale to TRUE if using PerlIO _and_ the current LC_CTYPE
50bf02bd
KW		 3913 * locale is UTF-8. The call to new_ctype() just above has already
3914 * calculated the latter value and saved it in PL_in_utf8_CTYPE_locale. If
3915 * both PL_utf8locale and PL_unicode (set by -C or by $ENV{PERL_UNICODE})
3916 * are true, perl.c:S_parse_body() will turn on the PerlIO :utf8 layer on
3917 * STDIN, STDOUT, STDERR, _and_ the default open discipline. */
3918 PL_utf8locale = PL_in_utf8_CTYPE_locale;
49c85077 3919
a05d7ebb 3920 /* Set PL_unicode to $ENV{PERL_UNICODE} if using PerlIO.
fde18df1
JH		 3921 This is an alternative to using the -C command line switch
3922 (the -C if present will override this). */
3923 {
dd374669 3924 const char *p = PerlEnv_getenv("PERL_UNICODE");
a05d7ebb 3925 PL_unicode = p ? parse_unicode_opts(&p) : 0;
5a22a2bb
NC		 3926 if (PL_unicode & PERL_UNICODE_UTF8CACHEASSERT_FLAG)
3927 PL_utf8cache = -1;
b310b053
JH		 3928 }
3929
7d4bcc4a 3930# endif
e3305790 3931#endif /* USE_LOCALE */
2fcc0ca9 3932#ifdef DEBUGGING
7d4bcc4a 3933
2fcc0ca9 3934 /* So won't continue to output stuff */
27cdc72e 3935 DEBUG_INITIALIZATION_set(FALSE);
7d4bcc4a 3936
2fcc0ca9
KW		 3937#endif
3938
98994639
HS		 3939 return ok;
3940}
3941
98994639
HS		 3942#ifdef USE_LOCALE_COLLATE
3943
a4a439fb 3944char *
a4a439fb
KW		 3945Perl__mem_collxfrm(pTHX_ const char *input_string,
3946 STRLEN len, /* Length of 'input_string' */
3947 STRLEN *xlen, /* Set to length of returned string
3948 (not including the collation index
3949 prefix) */
3950 bool utf8 /* Is the input in UTF-8? */
6696cfa7 3951 )
98994639 3952{
a4a439fb
KW		 3953
3954 /* _mem_collxfrm() is a bit like strxfrm() but with two important
3955 * differences. First, it handles embedded NULs. Second, it allocates a bit
3956 * more memory than needed for the transformed data itself. The real
55e5378d 3957 * transformed data begins at offset COLLXFRM_HDR_LEN. *xlen is set to
a4a439fb
KW		 3958 * the length of that, and doesn't include the collation index size.
3959 * Please see sv_collxfrm() to see how this is used. */
3960
55e5378d
KW		 3961#define COLLXFRM_HDR_LEN sizeof(PL_collation_ix)
3962
6696cfa7
KW		 3963 char * s = (char *) input_string;
3964 STRLEN s_strlen = strlen(input_string);
79f120c8 3965 char *xbuf = NULL;
55e5378d 3966 STRLEN xAlloc; /* xalloc is a reserved word in VC */
17f41037 3967 STRLEN length_in_chars;
c664130f 3968 bool first_time = TRUE; /* Cleared after first loop iteration */
98994639 3969
a4a439fb
KW		 3970 PERL_ARGS_ASSERT__MEM_COLLXFRM;
3971
3972 /* Must be NUL-terminated */
3973 assert(*(input_string + len) == '\0');
7918f24d 3974
79f120c8
KW		 3975 /* If this locale has defective collation, skip */
3976 if (PL_collxfrm_base == 0 && PL_collxfrm_mult == 0) {
c7202dee
KW		 3977 DEBUG_L(PerlIO_printf(Perl_debug_log,
3978 "_mem_collxfrm: locale's collation is defective\n"));
79f120c8
KW		 3979 goto bad;
3980 }
3981
6696cfa7
KW		 3982 /* Replace any embedded NULs with the control that sorts before any others.
3983 * This will give as good as possible results on strings that don't
3984 * otherwise contain that character, but otherwise there may be
3985 * less-than-perfect results with that character and NUL. This is
fdc080f3 3986 * unavoidable unless we replace strxfrm with our own implementation. */
fd43f63c
KW		 3987 if (UNLIKELY(s_strlen < len)) { /* Only execute if there is an embedded
3988 NUL */
6696cfa7
KW		 3989 char * e = s + len;
3990 char * sans_nuls;
fdc080f3 3991 STRLEN sans_nuls_len;
94762aa0 3992 int try_non_controls;
afc4976f
KW		 3993 char this_replacement_char[] = "?\0"; /* Room for a two-byte string,
3994 making sure 2nd byte is NUL.
3995 */
3996 STRLEN this_replacement_len;
3997
1e4c9676
KW		 3998 /* If we don't know what non-NUL control character sorts lowest for
3999 * this locale, find it */
f28f4d2a 4000 if (PL_strxfrm_NUL_replacement == '\0') {
6696cfa7 4001 int j;
afc4976f 4002 char * cur_min_x = NULL; /* The min_char's xfrm, (except it also
6696cfa7
KW		 4003 includes the collation index
4004 prefixed. */
4005
91c0e2e0 4006 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "Looking to replace NUL\n"));
94762aa0
KW		 4007
4008 /* Unlikely, but it may be that no control will work to replace
1e4c9676
KW		 4009 * NUL, in which case we instead look for any character. Controls
4010 * are preferred because collation order is, in general, context
4011 * sensitive, with adjoining characters affecting the order, and
4012 * controls are less likely to have such interactions, allowing the
4013 * NUL-replacement to stand on its own. (Another way to look at it
4014 * is to imagine what would happen if the NUL were replaced by a
4015 * combining character; it wouldn't work out all that well.) */
94762aa0
KW		 4016 for (try_non_controls = 0;
4017 try_non_controls < 2;
4018 try_non_controls++)
4019 {
d4ff9586
KW		 4020 /* Look through all legal code points (NUL isn't) */
4021 for (j = 1; j < 256; j++) {
4022 char * x; /* j's xfrm plus collation index */
4023 STRLEN x_len; /* length of 'x' */
4024 STRLEN trial_len = 1;
736a4fed 4025 char cur_source[] = { '\0', '\0' };
d4ff9586 4026
736a4fed
KW		 4027 /* Skip non-controls the first time through the loop. The
4028 * controls in a UTF-8 locale are the L1 ones */
afc4976f
KW		 4029 if (! try_non_controls && (PL_in_utf8_COLLATE_locale)
4030 ? ! isCNTRL_L1(j)
4031 : ! isCNTRL_LC(j))
4032 {
d4ff9586 4033 continue;
6696cfa7 4034 }
6696cfa7 4035
736a4fed
KW		 4036 /* Create a 1-char string of the current code point */
4037 cur_source[0] = (char) j;
4038
d4ff9586
KW		 4039 /* Then transform it */
4040 x = _mem_collxfrm(cur_source, trial_len, &x_len,
afc4976f 4041 0 /* The string is not in UTF-8 */);
6696cfa7 4042
1e4c9676 4043 /* Ignore any character that didn't successfully transform.
d4ff9586
KW		 4044 * */
4045 if (! x) {
4046 continue;
4047 }
6696cfa7 4048
d4ff9586
KW		 4049 /* If this character's transformation is lower than
4050 * the current lowest, this one becomes the lowest */
4051 if ( cur_min_x == NULL
4052 || strLT(x + COLLXFRM_HDR_LEN,
4053 cur_min_x + COLLXFRM_HDR_LEN))
4054 {
f28f4d2a 4055 PL_strxfrm_NUL_replacement = j;
62d66863 4056 Safefree(cur_min_x);
d4ff9586 4057 cur_min_x = x;
d4ff9586
KW		 4058 }
4059 else {
4060 Safefree(x);
4061 }
1e4c9676 4062 } /* end of loop through all 255 characters */
6696cfa7 4063
1e4c9676 4064 /* Stop looking if found */
94762aa0
KW		 4065 if (cur_min_x) {
4066 break;
4067 }
4068
4069 /* Unlikely, but possible, if there aren't any controls that
4070 * work in the locale, repeat the loop, looking for any
4071 * character that works */
4072 DEBUG_L(PerlIO_printf(Perl_debug_log,
4073 "_mem_collxfrm: No control worked. Trying non-controls\n"));
1e4c9676 4074 } /* End of loop to try first the controls, then any char */
6696cfa7 4075
94762aa0
KW		 4076 if (! cur_min_x) {
4077 DEBUG_L(PerlIO_printf(Perl_debug_log,
4078 "_mem_collxfrm: Couldn't find any character to replace"
4079 " embedded NULs in locale %s with", PL_collation_name));
4080 goto bad;
58eebef2
KW		 4081 }
4082
94762aa0
KW		 4083 DEBUG_L(PerlIO_printf(Perl_debug_log,
4084 "_mem_collxfrm: Replacing embedded NULs in locale %s with "
f28f4d2a 4085 "0x%02X\n", PL_collation_name, PL_strxfrm_NUL_replacement));
94762aa0 4086
6696cfa7 4087 Safefree(cur_min_x);
1e4c9676 4088 } /* End of determining the character that is to replace NULs */
afc4976f
KW		 4089
4090 /* If the replacement is variant under UTF-8, it must match the
291a84fb 4091 * UTF8-ness of the original */
f28f4d2a
KW		 4092 if ( ! UVCHR_IS_INVARIANT(PL_strxfrm_NUL_replacement) && utf8) {
4093 this_replacement_char[0] =
4094 UTF8_EIGHT_BIT_HI(PL_strxfrm_NUL_replacement);
4095 this_replacement_char[1] =
4096 UTF8_EIGHT_BIT_LO(PL_strxfrm_NUL_replacement);
afc4976f
KW		 4097 this_replacement_len = 2;
4098 }
4099 else {
f28f4d2a 4100 this_replacement_char[0] = PL_strxfrm_NUL_replacement;
afc4976f
KW		 4101 /* this_replacement_char[1] = '\0' was done at initialization */
4102 this_replacement_len = 1;
6696cfa7
KW		 4103 }
4104
4105 /* The worst case length for the replaced string would be if every
4106 * character in it is NUL. Multiply that by the length of each
4107 * replacement, and allow for a trailing NUL */
afc4976f 4108 sans_nuls_len = (len * this_replacement_len) + 1;
fdc080f3 4109 Newx(sans_nuls, sans_nuls_len, char);
6696cfa7
KW		 4110 *sans_nuls = '\0';
4111
6696cfa7
KW		 4112 /* Replace each NUL with the lowest collating control. Loop until have
4113 * exhausted all the NULs */
4114 while (s + s_strlen < e) {
6069d6c5 4115 my_strlcat(sans_nuls, s, sans_nuls_len);
6696cfa7
KW		 4116
4117 /* Do the actual replacement */
6069d6c5 4118 my_strlcat(sans_nuls, this_replacement_char, sans_nuls_len);
6696cfa7
KW		 4119
4120 /* Move past the input NUL */
4121 s += s_strlen + 1;
4122 s_strlen = strlen(s);
4123 }
4124
4125 /* And add anything that trails the final NUL */
6069d6c5 4126 my_strlcat(sans_nuls, s, sans_nuls_len);
6696cfa7
KW		 4127
4128 /* Switch so below we transform this modified string */
4129 s = sans_nuls;
4130 len = strlen(s);
1e4c9676 4131 } /* End of replacing NULs */
6696cfa7 4132
a4a439fb
KW		 4133 /* Make sure the UTF8ness of the string and locale match */
4134 if (utf8 != PL_in_utf8_COLLATE_locale) {
9de6fe47 4135 /* XXX convert above Unicode to 10FFFF? */
a4a439fb
KW		 4136 const char * const t = s; /* Temporary so we can later find where the
4137 input was */
4138
4139 /* Here they don't match. Change the string's to be what the locale is
4140 * expecting */
4141
4142 if (! utf8) { /* locale is UTF-8, but input isn't; upgrade the input */
4143 s = (char *) bytes_to_utf8((const U8 *) s, &len);
4144 utf8 = TRUE;
4145 }
4146 else { /* locale is not UTF-8; but input is; downgrade the input */
4147
4148 s = (char *) bytes_from_utf8((const U8 *) s, &len, &utf8);
4149
4150 /* If the downgrade was successful we are done, but if the input
4151 * contains things that require UTF-8 to represent, have to do
4152 * damage control ... */
4153 if (UNLIKELY(utf8)) {
4154
4155 /* What we do is construct a non-UTF-8 string with
4156 * 1) the characters representable by a single byte converted
4157 * to be so (if necessary);
4158 * 2) and the rest converted to collate the same as the
4159 * highest collating representable character. That makes
4160 * them collate at the end. This is similar to how we
4161 * handle embedded NULs, but we use the highest collating
4162 * code point instead of the smallest. Like the NUL case,
4163 * this isn't perfect, but is the best we can reasonably
4164 * do. Every above-255 code point will sort the same as
4165 * the highest-sorting 0-255 code point. If that code
4166 * point can combine in a sequence with some other code
4167 * points for weight calculations, us changing something to
4168 * be it can adversely affect the results. But in most
4169 * cases, it should work reasonably. And note that this is
4170 * really an illegal situation: using code points above 255
4171 * on a locale where only 0-255 are valid. If two strings
4172 * sort entirely equal, then the sort order for the
4173 * above-255 code points will be in code point order. */
4174
4175 utf8 = FALSE;
4176
4177 /* If we haven't calculated the code point with the maximum
4178 * collating order for this locale, do so now */
4179 if (! PL_strxfrm_max_cp) {
4180 int j;
4181
4182 /* The current transformed string that collates the
4183 * highest (except it also includes the prefixed collation
4184 * index. */
4185 char * cur_max_x = NULL;
4186
4187 /* Look through all legal code points (NUL isn't) */
4188 for (j = 1; j < 256; j++) {
4189 char * x;
4190 STRLEN x_len;
736a4fed 4191 char cur_source[] = { '\0', '\0' };
a4a439fb 4192
736a4fed
KW		 4193 /* Create a 1-char string of the current code point */
4194 cur_source[0] = (char) j;
a4a439fb
KW		 4195
4196 /* Then transform it */
4197 x = _mem_collxfrm(cur_source, 1, &x_len, FALSE);
4198
4199 /* If something went wrong (which it shouldn't), just
4200 * ignore this code point */
94762aa0 4201 if (! x) {
a4a439fb
KW		 4202 continue;
4203 }
4204
4205 /* If this character's transformation is higher than
4206 * the current highest, this one becomes the highest */
4207 if ( cur_max_x == NULL
55e5378d
KW		 4208 || strGT(x + COLLXFRM_HDR_LEN,
4209 cur_max_x + COLLXFRM_HDR_LEN))
a4a439fb
KW		 4210 {
4211 PL_strxfrm_max_cp = j;
62d66863 4212 Safefree(cur_max_x);
a4a439fb
KW		 4213 cur_max_x = x;
4214 }
4215 else {
4216 Safefree(x);
4217 }
4218 }
4219
94762aa0
KW		 4220 if (! cur_max_x) {
4221 DEBUG_L(PerlIO_printf(Perl_debug_log,
4222 "_mem_collxfrm: Couldn't find any character to"
4223 " replace above-Latin1 chars in locale %s with",
4224 PL_collation_name));
4225 goto bad;
4226 }
4227
58eebef2
KW		 4228 DEBUG_L(PerlIO_printf(Perl_debug_log,
4229 "_mem_collxfrm: highest 1-byte collating character"
4230 " in locale %s is 0x%02X\n",
4231 PL_collation_name,
4232 PL_strxfrm_max_cp));
58eebef2 4233
a4a439fb
KW		 4234 Safefree(cur_max_x);
4235 }
4236
4237 /* Here we know which legal code point collates the highest.
4238 * We are ready to construct the non-UTF-8 string. The length
4239 * will be at least 1 byte smaller than the input string
4240 * (because we changed at least one 2-byte character into a
4241 * single byte), but that is eaten up by the trailing NUL */
4242 Newx(s, len, char);
4243
4244 {
4245 STRLEN i;
4246 STRLEN d= 0;
042d9e50 4247 char * e = (char *) t + len;
a4a439fb
KW		 4248
4249 for (i = 0; i < len; i+= UTF8SKIP(t + i)) {
4250 U8 cur_char = t[i];
4251 if (UTF8_IS_INVARIANT(cur_char)) {
4252 s[d++] = cur_char;
4253 }
042d9e50 4254 else if (UTF8_IS_NEXT_CHAR_DOWNGRADEABLE(t + i, e)) {
a4a439fb
KW		 4255 s[d++] = EIGHT_BIT_UTF8_TO_NATIVE(cur_char, t[i+1]);
4256 }
4257 else { /* Replace illegal cp with highest collating
4258 one */
4259 s[d++] = PL_strxfrm_max_cp;
4260 }
4261 }
4262 s[d++] = '\0';
4263 Renew(s, d, char); /* Free up unused space */
4264 }
4265 }
4266 }
4267
4268 /* Here, we have constructed a modified version of the input. It could
4269 * be that we already had a modified copy before we did this version.
4270 * If so, that copy is no longer needed */
4271 if (t != input_string) {
4272 Safefree(t);
4273 }
4274 }
4275
17f41037
KW		 4276 length_in_chars = (utf8)
4277 ? utf8_length((U8 *) s, (U8 *) s + len)
4278 : len;
4279
59c018b9
KW		 4280 /* The first element in the output is the collation id, used by
4281 * sv_collxfrm(); then comes the space for the transformed string. The
4282 * equation should give us a good estimate as to how much is needed */
55e5378d 4283 xAlloc = COLLXFRM_HDR_LEN
a4a439fb 4284 + PL_collxfrm_base
17f41037 4285 + (PL_collxfrm_mult * length_in_chars);
a02a5408 4286 Newx(xbuf, xAlloc, char);
c7202dee
KW		 4287 if (UNLIKELY(! xbuf)) {
4288 DEBUG_L(PerlIO_printf(Perl_debug_log,
4289 "_mem_collxfrm: Couldn't malloc %zu bytes\n", xAlloc));
98994639 4290 goto bad;
c7202dee 4291 }
98994639 4292
d35fca5f 4293 /* Store the collation id */
98994639 4294 *(U32*)xbuf = PL_collation_ix;
d35fca5f
KW		 4295
4296 /* Then the transformation of the input. We loop until successful, or we
4297 * give up */
4ebeff16 4298 for (;;) {
1adab0a7 4299
55e5378d 4300 *xlen = strxfrm(xbuf + COLLXFRM_HDR_LEN, s, xAlloc - COLLXFRM_HDR_LEN);
4ebeff16
KW		 4301
4302 /* If the transformed string occupies less space than we told strxfrm()
4303 * was available, it means it successfully transformed the whole
4304 * string. */
55e5378d 4305 if (*xlen < xAlloc - COLLXFRM_HDR_LEN) {
17f41037 4306
1adab0a7
KW		 4307 /* Some systems include a trailing NUL in the returned length.
4308 * Ignore it, using a loop in case multiple trailing NULs are
4309 * returned. */
4310 while ( (*xlen) > 0
4311 && *(xbuf + COLLXFRM_HDR_LEN + (*xlen) - 1) == '\0')
4312 {
4313 (*xlen)--;
4314 }
4315
17f41037
KW		 4316 /* If the first try didn't get it, it means our prediction was low.
4317 * Modify the coefficients so that we predict a larger value in any
4318 * future transformations */
4319 if (! first_time) {
4320 STRLEN needed = *xlen + 1; /* +1 For trailing NUL */
4321 STRLEN computed_guess = PL_collxfrm_base
4322 + (PL_collxfrm_mult * length_in_chars);
e1c30f0c
KW		 4323
4324 /* On zero-length input, just keep current slope instead of
4325 * dividing by 0 */
4326 const STRLEN new_m = (length_in_chars != 0)
4327 ? needed / length_in_chars
4328 : PL_collxfrm_mult;
17f41037
KW		 4329
4330 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
b07929e4
KW		 4331 "%s: %d: initial size of %zu bytes for a length "
4332 "%zu string was insufficient, %zu needed\n",
17f41037 4333 __FILE__, __LINE__,
b07929e4 4334 computed_guess, length_in_chars, needed));
17f41037
KW		 4335
4336 /* If slope increased, use it, but discard this result for
4337 * length 1 strings, as we can't be sure that it's a real slope
4338 * change */
4339 if (length_in_chars > 1 && new_m > PL_collxfrm_mult) {
7d4bcc4a
KW		 4340
4341# ifdef DEBUGGING
4342
17f41037
KW		 4343 STRLEN old_m = PL_collxfrm_mult;
4344 STRLEN old_b = PL_collxfrm_base;
7d4bcc4a
KW		 4345
4346# endif
4347
17f41037
KW		 4348 PL_collxfrm_mult = new_m;
4349 PL_collxfrm_base = 1; /* +1 For trailing NUL */
4350 computed_guess = PL_collxfrm_base
4351 + (PL_collxfrm_mult * length_in_chars);
4352 if (computed_guess < needed) {
4353 PL_collxfrm_base += needed - computed_guess;
4354 }
4355
4356 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
b07929e4
KW		 4357 "%s: %d: slope is now %zu; was %zu, base "
4358 "is now %zu; was %zu\n",
17f41037 4359 __FILE__, __LINE__,
b07929e4
KW		 4360 PL_collxfrm_mult, old_m,
4361 PL_collxfrm_base, old_b));
17f41037
KW		 4362 }
4363 else { /* Slope didn't change, but 'b' did */
4364 const STRLEN new_b = needed
4365 - computed_guess
4366 + PL_collxfrm_base;
4367 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
b07929e4 4368 "%s: %d: base is now %zu; was %zu\n",
17f41037 4369 __FILE__, __LINE__,
b07929e4 4370 new_b, PL_collxfrm_base));
17f41037
KW		 4371 PL_collxfrm_base = new_b;
4372 }
4373 }
4374
4ebeff16
KW		 4375 break;
4376 }
bb0f664e 4377
c7202dee
KW		 4378 if (UNLIKELY(*xlen >= PERL_INT_MAX)) {
4379 DEBUG_L(PerlIO_printf(Perl_debug_log,
4380 "_mem_collxfrm: Needed %zu bytes, max permissible is %u\n",
4381 *xlen, PERL_INT_MAX));
4ebeff16 4382 goto bad;
c7202dee 4383 }
d35fca5f 4384
c664130f 4385 /* A well-behaved strxfrm() returns exactly how much space it needs
1adab0a7
KW		 4386 * (usually not including the trailing NUL) when it fails due to not
4387 * enough space being provided. Assume that this is the case unless
4388 * it's been proven otherwise */
c664130f 4389 if (LIKELY(PL_strxfrm_is_behaved) && first_time) {
55e5378d 4390 xAlloc = *xlen + COLLXFRM_HDR_LEN + 1;
c664130f
KW		 4391 }
4392 else { /* Here, either:
4393 * 1) The strxfrm() has previously shown bad behavior; or
4394 * 2) It isn't the first time through the loop, which means
4395 * that the strxfrm() is now showing bad behavior, because
4396 * we gave it what it said was needed in the previous
4397 * iteration, and it came back saying it needed still more.
4398 * (Many versions of cygwin fit this. When the buffer size
4399 * isn't sufficient, they return the input size instead of
4400 * how much is needed.)
d4ff9586
KW		 4401 * Increase the buffer size by a fixed percentage and try again.
4402 * */
6ddd902c 4403 xAlloc += (xAlloc / 4) + 1;
c664130f 4404 PL_strxfrm_is_behaved = FALSE;
c664130f 4405
7d4bcc4a
KW		 4406# ifdef DEBUGGING
4407
58eebef2
KW		 4408 if (DEBUG_Lv_TEST || debug_initialization) {
4409 PerlIO_printf(Perl_debug_log,
4410 "_mem_collxfrm required more space than previously calculated"
b07929e4 4411 " for locale %s, trying again with new guess=%d+%zu\n",
58eebef2 4412 PL_collation_name, (int) COLLXFRM_HDR_LEN,
b07929e4 4413 xAlloc - COLLXFRM_HDR_LEN);
58eebef2 4414 }
7d4bcc4a
KW		 4415
4416# endif
4417
58eebef2 4418 }
c664130f 4419
4ebeff16 4420 Renew(xbuf, xAlloc, char);
c7202dee
KW		 4421 if (UNLIKELY(! xbuf)) {
4422 DEBUG_L(PerlIO_printf(Perl_debug_log,
4423 "_mem_collxfrm: Couldn't realloc %zu bytes\n", xAlloc));
4ebeff16 4424 goto bad;
c7202dee 4425 }
c664130f
KW		 4426
4427 first_time = FALSE;
4ebeff16 4428 }
98994639 4429
6696cfa7 4430
7d4bcc4a
KW		 4431# ifdef DEBUGGING
4432
58eebef2 4433 if (DEBUG_Lv_TEST || debug_initialization) {
c7202dee
KW		 4434
4435 print_collxfrm_input_and_return(s, s + len, xlen, utf8);
4436 PerlIO_printf(Perl_debug_log, "Its xfrm is:");
7e2f38b2
KW		 4437 PerlIO_printf(Perl_debug_log, "%s\n",
4438 _byte_dump_string((U8 *) xbuf + COLLXFRM_HDR_LEN,
4439 *xlen, 1));
58eebef2 4440 }
7d4bcc4a
KW		 4441
4442# endif
58eebef2 4443
3c5f993e 4444 /* Free up unneeded space; retain ehough for trailing NUL */
55e5378d 4445 Renew(xbuf, COLLXFRM_HDR_LEN + *xlen + 1, char);
98994639 4446
6696cfa7
KW		 4447 if (s != input_string) {
4448 Safefree(s);
98994639
HS		 4449 }
4450
98994639
HS		 4451 return xbuf;
4452
4453 bad:
7d4bcc4a
KW		 4454
4455# ifdef DEBUGGING
4456
58eebef2 4457 if (DEBUG_Lv_TEST || debug_initialization) {
c7202dee 4458 print_collxfrm_input_and_return(s, s + len, NULL, utf8);
58eebef2 4459 }
7d4bcc4a
KW		 4460
4461# endif
4462
21dce8f4
KW		 4463 Safefree(xbuf);
4464 if (s != input_string) {
4465 Safefree(s);
4466 }
4467 *xlen = 0;
4468
98994639
HS		 4469 return NULL;
4470}
4471
7d4bcc4a 4472# ifdef DEBUGGING
c7202dee 4473
4cbaac56 4474STATIC void
c7202dee
KW		 4475S_print_collxfrm_input_and_return(pTHX_
4476 const char * const s,
4477 const char * const e,
4478 const STRLEN * const xlen,
4479 const bool is_utf8)
4480{
c7202dee
KW		 4481
4482 PERL_ARGS_ASSERT_PRINT_COLLXFRM_INPUT_AND_RETURN;
4483
511e4ff7
DM		 4484 PerlIO_printf(Perl_debug_log, "_mem_collxfrm[%" UVuf "]: returning ",
4485 (UV)PL_collation_ix);
c7202dee 4486 if (xlen) {
08b6dc1d 4487 PerlIO_printf(Perl_debug_log, "%zu", *xlen);
c7202dee
KW		 4488 }
4489 else {
4490 PerlIO_printf(Perl_debug_log, "NULL");
4491 }
4492 PerlIO_printf(Perl_debug_log, " for locale '%s', string='",
4493 PL_collation_name);
9c8a6dc2
KW		 4494 print_bytes_for_locale(s, e, is_utf8);
4495
4496 PerlIO_printf(Perl_debug_log, "'\n");
4497}
4498
4d9252fd
KW		 4499# endif /* DEBUGGING */
4500#endif /* USE_LOCALE_COLLATE */
1c0e67b5
KW		 4501#ifdef USE_LOCALE
4502# ifdef DEBUGGING
4d9252fd 4503
9c8a6dc2
KW		 4504STATIC void
4505S_print_bytes_for_locale(pTHX_
4506 const char * const s,
4507 const char * const e,
4508 const bool is_utf8)
4509{
4510 const char * t = s;
4511 bool prev_was_printable = TRUE;
4512 bool first_time = TRUE;
4513
4514 PERL_ARGS_ASSERT_PRINT_BYTES_FOR_LOCALE;
c7202dee
KW		 4515
4516 while (t < e) {
4517 UV cp = (is_utf8)
4518 ? utf8_to_uvchr_buf((U8 *) t, e, NULL)
4519 : * (U8 *) t;
4520 if (isPRINT(cp)) {
4521 if (! prev_was_printable) {
4522 PerlIO_printf(Perl_debug_log, " ");
4523 }
4524 PerlIO_printf(Perl_debug_log, "%c", (U8) cp);
4525 prev_was_printable = TRUE;
4526 }
4527 else {
4528 if (! first_time) {
4529 PerlIO_printf(Perl_debug_log, " ");
4530 }
147e3846 4531 PerlIO_printf(Perl_debug_log, "%02" UVXf, cp);
c7202dee
KW		 4532 prev_was_printable = FALSE;
4533 }
4534 t += (is_utf8) ? UTF8SKIP(t) : 1;
4535 first_time = FALSE;
4536 }
c7202dee
KW		 4537}
4538
1c0e67b5 4539# endif /* #ifdef DEBUGGING */
8ef6e574 4540
962aa53f
KW		 4541STATIC const char *
4542S_switch_category_locale_to_template(pTHX_ const int switch_category, const int template_category, const char * template_locale)
4543{
4544 /* Changes the locale for LC_'switch_category" to that of
4545 * LC_'template_category', if they aren't already the same. If not NULL,
4546 * 'template_locale' is the locale that 'template_category' is in.
4547 *
9de6fe47
KW		 4548 * Returns a copy of the name of the original locale for 'switch_category'
4549 * so can be switched back to with the companion function
4550 * restore_switched_locale(), (NULL if no restoral is necessary.) */
962aa53f
KW		 4551
4552 char * restore_to_locale = NULL;
4553
4554 if (switch_category == template_category) { /* No changes needed */
4555 return NULL;
4556 }
4557
4558 /* Find the original locale of the category we may need to change, so that
4559 * it can be restored to later */
d6189047
KW		 4560 restore_to_locale = stdize_locale(savepv(do_setlocale_r(switch_category,
4561 NULL)));
962aa53f
KW		 4562 if (! restore_to_locale) {
4563 Perl_croak(aTHX_
4564 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4565 __FILE__, __LINE__, category_name(switch_category), errno);
4566 }
962aa53f
KW		 4567
4568 /* If the locale of the template category wasn't passed in, find it now */
4569 if (template_locale == NULL) {
4570 template_locale = do_setlocale_r(template_category, NULL);
4571 if (! template_locale) {
4572 Perl_croak(aTHX_
4573 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4574 __FILE__, __LINE__, category_name(template_category), errno);
4575 }
4576 }
4577
4578 /* It the locales are the same, there's nothing to do */
4579 if (strEQ(restore_to_locale, template_locale)) {
4580 Safefree(restore_to_locale);
4581
4582 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale unchanged as %s\n",
e1c8059f 4583 category_name(switch_category), template_locale));
962aa53f
KW		 4584
4585 return NULL;
4586 }
4587
4588 /* Finally, change the locale to the template one */
4589 if (! do_setlocale_r(switch_category, template_locale)) {
4590 Perl_croak(aTHX_
4591 "panic: %s: %d: Could not change %s locale to %s, errno=%d\n",
4592 __FILE__, __LINE__, category_name(switch_category),
4593 template_locale, errno);
4594 }
4595
4596 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s locale switched to %s\n",
4597 category_name(switch_category), template_locale));
4598
4599 return restore_to_locale;
4600}
4601
4602STATIC void
4603S_restore_switched_locale(pTHX_ const int category, const char * const original_locale)
4604{
9de6fe47
KW		 4605 /* Restores the locale for LC_'category' to 'original_locale' (which is a
4606 * copy that will be freed by this function), or do nothing if the latter
4607 * parameter is NULL */
962aa53f
KW		 4608
4609 if (original_locale == NULL) {
4610 return;
4611 }
4612
4613 if (! do_setlocale_r(category, original_locale)) {
4614 Perl_croak(aTHX_
4615 "panic: %s: %d: setlocale %s restore to %s failed, errno=%d\n",
4616 __FILE__, __LINE__,
4617 category_name(category), original_locale, errno);
4618 }
4619
4620 Safefree(original_locale);
4621}
4622
51332242
N		 4623/* is_cur_LC_category_utf8 uses a small char buffer to avoid malloc/free */
4624#define CUR_LC_BUFFER_SIZE 64
4625
c1284011
KW		 4626bool
4627Perl__is_cur_LC_category_utf8(pTHX_ int category)
7d74bb61
KW		 4628{
4629 /* Returns TRUE if the current locale for 'category' is UTF-8; FALSE
4630 * otherwise. 'category' may not be LC_ALL. If the platform doesn't have
119ee68b 4631 * nl_langinfo(), nor MB_CUR_MAX, this employs a heuristic, which hence
609548d2
KW		 4632 * could give the wrong result. The result will very likely be correct for
4633 * languages that have commonly used non-ASCII characters, but for notably
4634 * English, it comes down to if the locale's name ends in something like
9de6fe47
KW		 4635 * "UTF-8". It errs on the side of not being a UTF-8 locale.
4636 *
4637 * If the platform is early C89, not containing mbtowc(), or we are
4638 * compiled to not pay attention to LC_CTYPE, this employs heuristics.
4639 * These work very well for non-Latin locales or those whose currency
4640 * symbol isn't a '$' nor plain ASCII text. But without LC_CTYPE and at
4641 * least MB_CUR_MAX, English locales with an ASCII currency symbol depend
4642 * on the name containing UTF-8 or not. */
7d74bb61 4643
47280b20 4644 /* Name of current locale corresponding to the input category */
8de4332b 4645 const char *save_input_locale = NULL;
47280b20
KW		 4646
4647 bool is_utf8 = FALSE; /* The return value */
7d74bb61 4648
47280b20
KW		 4649 /* The variables below are for the cache of previous lookups using this
4650 * function. The cache is a C string, described at the definition for
4651 * 'C_and_POSIX_utf8ness'.
4652 *
4653 * The first part of the cache is fixed, for the C and POSIX locales. The
4654 * varying part starts just after them. */
4655 char * utf8ness_cache = PL_locale_utf8ness + STRLENs(C_and_POSIX_utf8ness);
4656
4657 Size_t utf8ness_cache_size; /* Size of the varying portion */
4658 Size_t input_name_len; /* Length in bytes of save_input_locale */
4659 Size_t input_name_len_with_overhead; /* plus extra chars used to store
4660 the name in the cache */
4661 char * delimited; /* The name plus the delimiters used to store
4662 it in the cache */
51332242 4663 char buffer[CUR_LC_BUFFER_SIZE]; /* small buffer */
47280b20
KW		 4664 char * name_pos; /* position of 'delimited' in the cache, or 0
4665 if not there */
4666
4667
7d4bcc4a
KW		 4668# ifdef LC_ALL
4669
7d74bb61 4670 assert(category != LC_ALL);
7d4bcc4a
KW		 4671
4672# endif
7d74bb61 4673
47280b20 4674 /* Get the desired category's locale */
d6189047 4675 save_input_locale = stdize_locale(savepv(do_setlocale_r(category, NULL)));
7d74bb61 4676 if (! save_input_locale) {
47280b20 4677 Perl_croak(aTHX_
d707d779
KW		 4678 "panic: %s: %d: Could not find current %s locale, errno=%d\n",
4679 __FILE__, __LINE__, category_name(category), errno);
7d74bb61 4680 }
47280b20 4681
47280b20
KW		 4682 DEBUG_L(PerlIO_printf(Perl_debug_log,
4683 "Current locale for %s is %s\n",
4684 category_name(category), save_input_locale));
4685
4686 input_name_len = strlen(save_input_locale);
4687
4688 /* In our cache, each name is accompanied by two delimiters and a single
4689 * utf8ness digit */
4690 input_name_len_with_overhead = input_name_len + 3;
4691
51332242
N		 4692 if ( input_name_len_with_overhead <= CUR_LC_BUFFER_SIZE ) {
4693 /* we can use the buffer, avoid a malloc */
4694 delimited = buffer;
4695 } else { /* need a malloc */
4696 /* Allocate and populate space for a copy of the name surrounded by the
4697 * delimiters */
4698 Newx(delimited, input_name_len_with_overhead, char);
4699 }
4700
47280b20
KW		 4701 delimited[0] = UTF8NESS_SEP[0];
4702 Copy(save_input_locale, delimited + 1, input_name_len, char);
4703 delimited[input_name_len+1] = UTF8NESS_PREFIX[0];
4704 delimited[input_name_len+2] = '\0';
4705
4706 /* And see if that is in the cache */
4707 name_pos = instr(PL_locale_utf8ness, delimited);
4708 if (name_pos) {
4709 is_utf8 = *(name_pos + input_name_len_with_overhead - 1) - '0';
4710
4711# ifdef DEBUGGING
4712
4713 if (DEBUG_Lv_TEST || debug_initialization) {
4714 PerlIO_printf(Perl_debug_log, "UTF8ness for locale %s=%d, \n",
4715 save_input_locale, is_utf8);
4716 }
4717
4718# endif
4719
4720 /* And, if not already in that position, move it to the beginning of
4721 * the non-constant portion of the list, since it is the most recently
4722 * used. (We don't have to worry about overflow, since just moving
4723 * existing names around) */
4724 if (name_pos > utf8ness_cache) {
4725 Move(utf8ness_cache,
4726 utf8ness_cache + input_name_len_with_overhead,
4727 name_pos - utf8ness_cache, char);
4728 Copy(delimited,
4729 utf8ness_cache,
4730 input_name_len_with_overhead - 1, char);
4731 utf8ness_cache[input_name_len_with_overhead - 1] = is_utf8 + '0';
4732 }
4733
51332242
N		 4734 /* free only when not using the buffer */
4735 if ( delimited != buffer ) Safefree(delimited);
b07fffd1 4736 Safefree(save_input_locale);
47280b20 4737 return is_utf8;
7d74bb61
KW		 4738 }
4739
47280b20
KW		 4740 /* Here we don't have stored the utf8ness for the input locale. We have to
4741 * calculate it */
4742
94646a69 4743# if defined(USE_LOCALE_CTYPE) \
6201c220 4744 && ( defined(HAS_NL_LANGINFO) \
94646a69 4745 || (defined(HAS_MBTOWC) || defined(HAS_MBRTOWC)))
7d74bb61 4746
0dec74cd 4747 {
962aa53f
KW		 4748 const char *original_ctype_locale
4749 = switch_category_locale_to_template(LC_CTYPE,
4750 category,
4751 save_input_locale);
69014004 4752
7d74bb61 4753 /* Here the current LC_CTYPE is set to the locale of the category whose
0dec74cd 4754 * information is desired. This means that nl_langinfo() and mbtowc()
1d958db2 4755 * should give the correct results */
119ee68b 4756
0dec74cd
KW		 4757# ifdef MB_CUR_MAX /* But we can potentially rule out UTF-8ness, avoiding
4758 calling the functions if we have this */
4759
4760 /* Standard UTF-8 needs at least 4 bytes to represent the maximum
4761 * Unicode code point. */
4762
de3a3072
KW		 4763 DEBUG_L(PerlIO_printf(Perl_debug_log, "%s: %d: MB_CUR_MAX=%d\n",
4764 __FILE__, __LINE__, (int) MB_CUR_MAX));
0dec74cd
KW		 4765 if ((unsigned) MB_CUR_MAX < STRLENs(MAX_UNICODE_UTF8)) {
4766 is_utf8 = FALSE;
b5b2847c
KW		 4767 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4768 goto finish_and_return;
0dec74cd
KW		 4769 }
4770
4771# endif
6201c220 4772# if defined(HAS_NL_LANGINFO)
7d4bcc4a 4773
0dec74cd
KW		 4774 { /* The task is easiest if the platform has this POSIX 2001 function.
4775 Except on some platforms it can wrongly return "", so have to have
4776 a fallback. And it can return that it's UTF-8, even if there are
4777 variances from that. For example, Turkish locales may use the
4778 alternate dotted I rules, and sometimes it appears to be a
4779 defective locale definition. XXX We should probably check for
9de6fe47
KW		 4780 these in the Latin1 range and warn (but on glibc, requires
4781 iswalnum() etc. due to their not handling 80-FF correctly */
4e6826bf 4782 const char *codeset = my_nl_langinfo(CODESET, FALSE);
c70a3e68 4783 /* FALSE => already in dest locale */
119ee68b 4784
af84e886 4785 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
c70a3e68
KW		 4786 "\tnllanginfo returned CODESET '%s'\n", codeset));
4787
4788 if (codeset && strNE(codeset, "")) {
1d958db2 4789
1d075173
KW		 4790 /* If the implementation of foldEQ() somehow were
4791 * to change to not go byte-by-byte, this could
4792 * read past end of string, as only one length is
4793 * checked. But currently, a premature NUL will
4794 * compare false, and it will stop there */
4795 is_utf8 = cBOOL( foldEQ(codeset, STR_WITH_LEN("UTF-8"))
4796 || foldEQ(codeset, STR_WITH_LEN("UTF8")));
1d958db2 4797
69014004
KW		 4798 DEBUG_L(PerlIO_printf(Perl_debug_log,
4799 "\tnllanginfo returned CODESET '%s'; ?UTF8 locale=%d\n",
4800 codeset, is_utf8));
b5b2847c
KW		 4801 restore_switched_locale(LC_CTYPE, original_ctype_locale);
4802 goto finish_and_return;
1d958db2 4803 }
119ee68b
KW		 4804 }
4805
7d4bcc4a 4806# endif
94646a69 4807# if defined(HAS_MBTOWC) || defined(HAS_MBRTOWC)
0dec74cd
KW		 4808 /* We can see if this is a UTF-8-like locale if have mbtowc(). It was a
4809 * late adder to C89, so very likely to have it. However, testing has
4810 * shown that, like nl_langinfo() above, there are locales that are not
4811 * strictly UTF-8 that this will return that they are */
69014004 4812
0dec74cd 4813 {
119ee68b 4814 wchar_t wc;
51fc4b19 4815 int len;
48015184 4816 dSAVEDERRNO;
51fc4b19 4817
94646a69
KW		 4818# if defined(HAS_MBRTOWC) && defined(USE_ITHREADS)
4819
4820 mbstate_t ps;
4821
4822# endif
4823
4824 /* mbrtowc() and mbtowc() convert a byte string to a wide
4825 * character. Feed a byte string to one of them and check that the
4826 * result is the expected Unicode code point */
4827
4828# if defined(HAS_MBRTOWC) && defined(USE_ITHREADS)
4829 /* Prefer this function if available, as it's reentrant */
4830
4831 memset(&ps, 0, sizeof(ps));;
4832 PERL_UNUSED_RESULT(mbrtowc(&wc, NULL, 0, &ps)); /* Reset any shift
4833 state */
48015184 4834 SETERRNO(0, 0);
94646a69 4835 len = mbrtowc(&wc, STR_WITH_LEN(REPLACEMENT_CHARACTER_UTF8), &ps);
48015184 4836 SAVE_ERRNO;
94646a69
KW		 4837
4838# else
0dec74cd 4839
7953f73f 4840 MBTOWC_LOCK;
856b881c 4841 PERL_UNUSED_RESULT(mbtowc(&wc, NULL, 0));/* Reset any shift state */
48015184 4842 SETERRNO(0, 0);
b1d4925c 4843 len = mbtowc(&wc, STR_WITH_LEN(REPLACEMENT_CHARACTER_UTF8));
48015184 4844 SAVE_ERRNO;
7953f73f 4845 MBTOWC_UNLOCK;
51fc4b19 4846
94646a69
KW		 4847# endif
4848
48015184 4849 RESTORE_ERRNO;
af84e886 4850 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
0dec74cd 4851 "\treturn from mbtowc; len=%d; code_point=%x; errno=%d\n",
48015184 4852 len, (unsigned int) wc, GET_ERRNO));
b1d4925c 4853
0dec74cd
KW		 4854 is_utf8 = cBOOL( len == STRLENs(REPLACEMENT_CHARACTER_UTF8)
4855 && wc == (wchar_t) UNICODE_REPLACEMENT);
119ee68b 4856 }
7d4bcc4a 4857
17dd77cd
FP		 4858# endif
4859
962aa53f 4860 restore_switched_locale(LC_CTYPE, original_ctype_locale);
47280b20 4861 goto finish_and_return;
7d74bb61 4862 }
119ee68b 4863
0dec74cd 4864# else
7d74bb61 4865
0dec74cd
KW		 4866 /* Here, we must have a C89 compiler that doesn't have mbtowc(). Next
4867 * try looking at the currency symbol to see if it disambiguates
4868 * things. Often that will be in the native script, and if the symbol
4869 * isn't in UTF-8, we know that the locale isn't. If it is non-ASCII
4870 * UTF-8, we infer that the locale is too, as the odds of a non-UTF8
4871 * string being valid UTF-8 are quite small */
fa9b773e 4872
660ee27b
KW		 4873# ifdef USE_LOCALE_MONETARY
4874
4875 /* If have LC_MONETARY, we can look at the currency symbol. Often that
4876 * will be in the native script. We do this one first because there is
4877 * just one string to examine, so potentially avoids work */
7d4bcc4a 4878
9db16864
KW		 4879 {
4880 const char *original_monetary_locale
660ee27b
KW		 4881 = switch_category_locale_to_template(LC_MONETARY,
4882 category,
4883 save_input_locale);
9db16864 4884 bool only_ascii = FALSE;
660ee27b 4885 const U8 * currency_string
4e6826bf 4886 = (const U8 *) my_nl_langinfo(CRNCYSTR, FALSE);
660ee27b
KW		 4887 /* 2nd param not relevant for this item */
4888 const U8 * first_variant;
fa9b773e 4889
660ee27b
KW		 4890 assert( *currency_string == '-'
4891 || *currency_string == '+'
4892 || *currency_string == '.');
97f4de96 4893
660ee27b 4894 currency_string++;
fa9b773e 4895
660ee27b 4896 if (is_utf8_invariant_string_loc(currency_string, 0, &first_variant))
9db16864
KW		 4897 {
4898 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));
4899 only_ascii = TRUE;
4900 }
4901 else {
660ee27b 4902 is_utf8 = is_strict_utf8_string(first_variant, 0);
9db16864 4903 }
fa9b773e 4904
9db16864 4905 restore_switched_locale(LC_MONETARY, original_monetary_locale);
fa9b773e 4906
9db16864 4907 if (! only_ascii) {
fa9b773e 4908
9db16864
KW		 4909 /* It isn't a UTF-8 locale if the symbol is not legal UTF-8;
4910 * otherwise assume the locale is UTF-8 if and only if the symbol
4911 * is non-ascii UTF-8. */
af84e886 4912 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?Currency symbol for %s is UTF-8=%d\n",
9db16864
KW		 4913 save_input_locale, is_utf8));
4914 goto finish_and_return;
4915 }
13542a67 4916 }
fa9b773e 4917
660ee27b 4918# endif /* USE_LOCALE_MONETARY */
7d4bcc4a 4919# if defined(HAS_STRFTIME) && defined(USE_LOCALE_TIME)
15f7e74e 4920
9db16864
KW		 4921 /* Still haven't found a non-ASCII string to disambiguate UTF-8 or not. Try
4922 * the names of the months and weekdays, timezone, and am/pm indicator */
4923 {
4924 const char *original_time_locale
4925 = switch_category_locale_to_template(LC_TIME,
4926 category,
4927 save_input_locale);
4928 int hour = 10;
4929 bool is_dst = FALSE;
4930 int dom = 1;
4931 int month = 0;
4932 int i;
4933 char * formatted_time;
4934
4935 /* Here the current LC_TIME is set to the locale of the category
4936 * whose information is desired. Look at all the days of the week and
4937 * month names, and the timezone and am/pm indicator for UTF-8 variant
4938 * characters. The first such a one found will tell us if the locale
4939 * is UTF-8 or not */
4940
4941 for (i = 0; i < 7 + 12; i++) { /* 7 days; 12 months */
4942 formatted_time = my_strftime("%A %B %Z %p",
4943 0, 0, hour, dom, month, 2012 - 1900, 0, 0, is_dst);
4944 if ( ! formatted_time
4945 || is_utf8_invariant_string((U8 *) formatted_time, 0))
4946 {
15f7e74e 4947
9db16864
KW		 4948 /* Here, we didn't find a non-ASCII. Try the next time through
4949 * with the complemented dst and am/pm, and try with the next
4950 * weekday. After we have gotten all weekdays, try the next
4951 * month */
4952 is_dst = ! is_dst;
4953 hour = (hour + 12) % 24;
4954 dom++;
4955 if (i > 6) {
4956 month++;
4957 }
4958 continue;
15f7e74e 4959 }
9db16864
KW		 4960
4961 /* Here, we have a non-ASCII. Return TRUE is it is valid UTF8;
4962 * false otherwise. But first, restore LC_TIME to its original
4963 * locale if we changed it */
4964 restore_switched_locale(LC_TIME, original_time_locale);
4965
af84e886 4966 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?time-related strings for %s are UTF-8=%d\n",
9db16864
KW		 4967 save_input_locale,
4968 is_utf8_string((U8 *) formatted_time, 0)));
4969 is_utf8 = is_utf8_string((U8 *) formatted_time, 0);
4970 goto finish_and_return;
15f7e74e
KW		 4971 }
4972
9db16864
KW		 4973 /* Falling off the end of the loop indicates all the names were just
4974 * ASCII. Go on to the next test. If we changed it, restore LC_TIME
4975 * to its original locale */
962aa53f 4976 restore_switched_locale(LC_TIME, original_time_locale);
af84e886 4977 DEBUG_Lv(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));
15f7e74e
KW		 4978 }
4979
7d4bcc4a 4980# endif
15f7e74e 4981
7d4bcc4a 4982# if 0 && defined(USE_LOCALE_MESSAGES) && defined(HAS_SYS_ERRLIST)
855aeb93 4983
9db16864
KW		 4984 /* This code is ifdefd out because it was found to not be necessary in testing
4985 * on our dromedary test machine, which has over 700 locales. There, this
4986 * added no value to looking at the currency symbol and the time strings. I
4987 * left it in so as to avoid rewriting it if real-world experience indicates
4988 * that dromedary is an outlier. Essentially, instead of returning abpve if we
4989 * haven't found illegal utf8, we continue on and examine all the strerror()
4990 * messages on the platform for utf8ness. If all are ASCII, we still don't
4991 * know the answer; but otherwise we have a pretty good indication of the
4992 * utf8ness. The reason this doesn't help much is that the messages may not
4993 * have been translated into the locale. The currency symbol and time strings
4994 * are much more likely to have been translated. */
4995 {
4996 int e;
4997 bool non_ascii = FALSE;
4998 const char *original_messages_locale
4999 = switch_category_locale_to_template(LC_MESSAGES,
5000 category,
5001 save_input_locale);
5002 const char * errmsg = NULL;
5003
5004 /* Here the current LC_MESSAGES is set to the locale of the category
5005 * whose information is desired. Look through all the messages. We
5006 * can't use Strerror() here because it may expand to code that
5007 * segfaults in miniperl */
5008
5009 for (e = 0; e <= sys_nerr; e++) {
5010 errno = 0;
5011 errmsg = sys_errlist[e];
5012 if (errno || !errmsg) {
5013 break;
5014 }
5015 errmsg = savepv(errmsg);
5016 if (! is_utf8_invariant_string((U8 *) errmsg, 0)) {
5017 non_ascii = TRUE;
5018 is_utf8 = is_utf8_string((U8 *) errmsg, 0);
5019 break;
5020 }
855aeb93 5021 }
9db16864 5022 Safefree(errmsg);
855aeb93 5023
9db16864 5024 restore_switched_locale(LC_MESSAGES, original_messages_locale);
855aeb93 5025
9db16864 5026 if (non_ascii) {
5857e934 5027
9db16864
KW		 5028 /* Any non-UTF-8 message means not a UTF-8 locale; if all are valid,
5029 * any non-ascii means it is one; otherwise we assume it isn't */
af84e886 5030 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "\t?error messages for %s are UTF-8=%d\n",
9db16864
KW		 5031 save_input_locale,
5032 is_utf8));
5033 goto finish_and_return;
5034 }
855aeb93 5035
9db16864
KW		 5036 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));
5037 }
855aeb93 5038
7d4bcc4a 5039# endif
0dec74cd 5040# ifndef EBCDIC /* On os390, even if the name ends with "UTF-8', it isn't a
92c0a900 5041 UTF-8 locale */
7d4bcc4a 5042
97f4de96
KW		 5043 /* As a last resort, look at the locale name to see if it matches
5044 * qr/UTF -? * 8 /ix, or some other common locale names. This "name", the
5045 * return of setlocale(), is actually defined to be opaque, so we can't
5046 * really rely on the absence of various substrings in the name to indicate
5047 * its UTF-8ness, but if it has UTF8 in the name, it is extremely likely to
5048 * be a UTF-8 locale. Similarly for the other common names */
5049
0dec74cd 5050 {
c36d8df8 5051 const Size_t final_pos = strlen(save_input_locale) - 1;
0dec74cd 5052
c36d8df8
KW		 5053 if (final_pos >= 3) {
5054 const char *name = save_input_locale;
97f4de96 5055
c36d8df8
KW		 5056 /* Find next 'U' or 'u' and look from there */
5057 while ((name += strcspn(name, "Uu") + 1)
5058 <= save_input_locale + final_pos - 2)
97f4de96 5059 {
c36d8df8
KW		 5060 if ( isALPHA_FOLD_NE(*name, 't')
5061 || isALPHA_FOLD_NE(*(name + 1), 'f'))
5062 {
5063 continue;
5064 }
5065 name += 2;
5066 if (*(name) == '-') {
5067 if ((name > save_input_locale + final_pos - 1)) {
5068 break;
5069 }
5070 name++;
5071 }
5072 if (*(name) == '8') {
5073 DEBUG_L(PerlIO_printf(Perl_debug_log,
5074 "Locale %s ends with UTF-8 in name\n",
5075 save_input_locale));
5076 is_utf8 = TRUE;
5077 goto finish_and_return;
97f4de96 5078 }
97f4de96 5079 }
c36d8df8
KW		 5080 DEBUG_L(PerlIO_printf(Perl_debug_log,
5081 "Locale %s doesn't end with UTF-8 in name\n",
5082 save_input_locale));
97f4de96 5083 }
97f4de96 5084
4d8d465a 5085# ifdef WIN32
7d4bcc4a 5086
c36d8df8
KW		 5087 /* http://msdn.microsoft.com/en-us/library/windows/desktop/dd317756.aspx */
5088 if (memENDs(save_input_locale, final_pos, "65001")) {
5089 DEBUG_L(PerlIO_printf(Perl_debug_log,
8a0832a1 5090 "Locale %s ends with 65001 in name, is UTF-8 locale\n",
97f4de96 5091 save_input_locale));
c36d8df8
KW		 5092 is_utf8 = TRUE;
5093 goto finish_and_return;
5094 }
7d4bcc4a 5095
4d8d465a 5096# endif
17dd77cd 5097 }
4d8d465a 5098# endif
97f4de96
KW		 5099
5100 /* Other common encodings are the ISO 8859 series, which aren't UTF-8. But
5101 * since we are about to return FALSE anyway, there is no point in doing
5102 * this extra work */
7d4bcc4a 5103
0dec74cd 5104# if 0
97f4de96
KW		 5105 if (instr(save_input_locale, "8859")) {
5106 DEBUG_L(PerlIO_printf(Perl_debug_log,
5107 "Locale %s has 8859 in name, not UTF-8 locale\n",
5108 save_input_locale));
47280b20
KW		 5109 is_utf8 = FALSE;
5110 goto finish_and_return;
97f4de96 5111 }
0dec74cd 5112# endif
97f4de96 5113
69014004
KW		 5114 DEBUG_L(PerlIO_printf(Perl_debug_log,
5115 "Assuming locale %s is not a UTF-8 locale\n",
5116 save_input_locale));
47280b20
KW		 5117 is_utf8 = FALSE;
5118
0dec74cd
KW		 5119# endif /* the code that is compiled when no modern LC_CTYPE */
5120
47280b20
KW		 5121 finish_and_return:
5122
5123 /* Cache this result so we don't have to go through all this next time. */
5124 utf8ness_cache_size = sizeof(PL_locale_utf8ness)
5125 - (utf8ness_cache - PL_locale_utf8ness);
5126
5127 /* But we can't save it if it is too large for the total space available */
5128 if (LIKELY(input_name_len_with_overhead < utf8ness_cache_size)) {
5129 Size_t utf8ness_cache_len = strlen(utf8ness_cache);
5130
5131 /* Here it can fit, but we may need to clear out the oldest cached
5132 * result(s) to do so. Check */
5133 if (utf8ness_cache_len + input_name_len_with_overhead
5134 >= utf8ness_cache_size)
5135 {
5136 /* Here we have to clear something out to make room for this.
5137 * Start looking at the rightmost place where it could fit and find
5138 * the beginning of the entry that extends past that. */
5139 char * cutoff = (char *) my_memrchr(utf8ness_cache,
5140 UTF8NESS_SEP[0],
5141 utf8ness_cache_size
5142 - input_name_len_with_overhead);
5143
5144 assert(cutoff);
5145 assert(cutoff >= utf8ness_cache);
5146
5147 /* This and all subsequent entries must be removed */
5148 *cutoff = '\0';
5149 utf8ness_cache_len = strlen(utf8ness_cache);
5150 }
5151
5152 /* Make space for the new entry */
5153 Move(utf8ness_cache,
5154 utf8ness_cache + input_name_len_with_overhead,
5155 utf8ness_cache_len + 1 /* Incl. trailing NUL */, char);
5156
5157 /* And insert it */
5158 Copy(delimited, utf8ness_cache, input_name_len_with_overhead - 1, char);
5159 utf8ness_cache[input_name_len_with_overhead - 1] = is_utf8 + '0';
5160
72299e00 5161 if ((PL_locale_utf8ness[strlen(PL_locale_utf8ness)-1] & ~1) != '0') {
47280b20 5162 Perl_croak(aTHX_
7fcf9272
KW		 5163 "panic: %s: %d: Corrupt utf8ness_cache=%s\nlen=%zu,"
5164 " inserted_name=%s, its_len=%zu\n",
47280b20
KW		 5165 __FILE__, __LINE__,
5166 PL_locale_utf8ness, strlen(PL_locale_utf8ness),
5167 delimited, input_name_len_with_overhead);
5168 }
5169 }
5170
5171# ifdef DEBUGGING
5172
de3a3072
KW		 5173 if (DEBUG_Lv_TEST) {
5174 const char * s = PL_locale_utf8ness;
5175
5176 /* Audit the structure */
5177 while (s < PL_locale_utf8ness + strlen(PL_locale_utf8ness)) {
5178 const char *e;
5179
5180 if (*s != UTF8NESS_SEP[0]) {
5181 Perl_croak(aTHX_
5182 "panic: %s: %d: Corrupt utf8ness_cache: missing"
5183 " separator %.*s<-- HERE %s\n",
5184 __FILE__, __LINE__,
fe301c93 5185 (int) (s - PL_locale_utf8ness), PL_locale_utf8ness,
de3a3072
KW		 5186 s);
5187 }
5188 s++;
5189 e = strchr(s, UTF8NESS_PREFIX[0]);
5190 if (! e) {
01b91050 5191 e = PL_locale_utf8ness + strlen(PL_locale_utf8ness);
de3a3072
KW		 5192 Perl_croak(aTHX_
5193 "panic: %s: %d: Corrupt utf8ness_cache: missing"
5194 " separator %.*s<-- HERE %s\n",
5195 __FILE__, __LINE__,
fe301c93 5196 (int) (e - PL_locale_utf8ness), PL_locale_utf8ness,
de3a3072
KW		 5197 e);
5198 }
5199 e++;
5200 if (*e != '0' && *e != '1') {
5201 Perl_croak(aTHX_
5202 "panic: %s: %d: Corrupt utf8ness_cache: utf8ness"
5203 " must be [01] %.*s<-- HERE %s\n",
5204 __FILE__, __LINE__,
fe301c93
KW		 5205 (int) (e + 1 - PL_locale_utf8ness),
5206 PL_locale_utf8ness, e + 1);
de3a3072
KW		 5207 }
5208 if (ninstr(PL_locale_utf8ness, s, s-1, e)) {
5209 Perl_croak(aTHX_
5210 "panic: %s: %d: Corrupt utf8ness_cache: entry"
5211 " has duplicate %.*s<-- HERE %s\n",
5212 __FILE__, __LINE__,
fe301c93 5213 (int) (e - PL_locale_utf8ness), PL_locale_utf8ness,
de3a3072
KW		 5214 e);
5215 }
5216 s = e + 1;
5217 }
5218 }
5219
47280b20 5220 if (DEBUG_Lv_TEST || debug_initialization) {
de3a3072 5221
47280b20
KW		 5222 PerlIO_printf(Perl_debug_log,
5223 "PL_locale_utf8ness is now %s; returning %d\n",
5224 PL_locale_utf8ness, is_utf8);
5225 }
5226
5227# endif
5228
51332242
N		 5229 /* free only when not using the buffer */
5230 if ( delimited != buffer ) Safefree(delimited);
fa9b773e 5231 Safefree(save_input_locale);
47280b20 5232 return is_utf8;
7d74bb61
KW		 5233}
5234
8ef6e574 5235#endif
7d74bb61 5236
d6ded950
KW		 5237bool
5238Perl__is_in_locale_category(pTHX_ const bool compiling, const int category)
5239{
5240 /* Internal function which returns if we are in the scope of a pragma that
5241 * enables the locale category 'category'. 'compiling' should indicate if
5242 * this is during the compilation phase (TRUE) or not (FALSE). */
5243
5244 const COP * const cop = (compiling) ? &PL_compiling : PL_curcop;
5245
363d7d4a
JK		 5246 SV *these_categories = cop_hints_fetch_pvs(cop, "locale", 0);
5247 if (! these_categories || these_categories == &PL_sv_placeholder) {
d6ded950
KW		 5248 return FALSE;
5249 }
5250
5251 /* The pseudo-category 'not_characters' is -1, so just add 1 to each to get
5252 * a valid unsigned */
5253 assert(category >= -1);
363d7d4a 5254 return cBOOL(SvUV(these_categories) & (1U << (category + 1)));
d6ded950
KW		 5255}
5256
2c6ee1a7 5257char *
6ebbc862
KW		 5258Perl_my_strerror(pTHX_ const int errnum)
5259{
5260 /* Returns a mortalized copy of the text of the error message associated
5261 * with 'errnum'. It uses the current locale's text unless the platform
5262 * doesn't have the LC_MESSAGES category or we are not being called from
5263 * within the scope of 'use locale'. In the former case, it uses whatever
5264 * strerror returns; in the latter case it uses the text from the C locale.
5265 *
5266 * The function just calls strerror(), but temporarily switches, if needed,
5267 * to the C locale */
5268
5269 char *errstr;
5270
52770946 5271#ifndef USE_LOCALE_MESSAGES
6ebbc862 5272
52770946
KW		 5273 /* If platform doesn't have messages category, we don't do any switching to
5274 * the C locale; we just use whatever strerror() returns */
5275
5276 errstr = savepv(Strerror(errnum));
5277
5278#else /* Has locale messages */
5279
5280 const bool within_locale_scope = IN_LC(LC_MESSAGES);
2c6ee1a7 5281
39e69e77 5282# ifndef USE_ITHREADS
7aaa36b1 5283
39e69e77
KW		 5284 /* This function is trivial without threads. */
5285 if (within_locale_scope) {
5286 errstr = savepv(strerror(errnum));
5287 }
5288 else {
b0bde642 5289 const char * save_locale = savepv(do_setlocale_c(LC_MESSAGES, NULL));
39e69e77
KW		 5290
5291 do_setlocale_c(LC_MESSAGES, "C");
5292 errstr = savepv(strerror(errnum));
5293 do_setlocale_c(LC_MESSAGES, save_locale);
b0bde642 5294 Safefree(save_locale);
39e69e77
KW		 5295 }
5296
fd639d5f 5297# elif defined(USE_POSIX_2008_LOCALE) \
8fdf38a3 5298 && defined(HAS_STRERROR_L)
39e69e77
KW		 5299
5300 /* This function is also trivial if we don't have to worry about thread
5301 * safety and have strerror_l(), as it handles the switch of locales so we
5302 * don't have to deal with that. We don't have to worry about thread
5303 * safety if strerror_r() is also available. Both it and strerror_l() are
5304 * thread-safe. Plain strerror() isn't thread safe. But on threaded
5305 * builds when strerror_r() is available, the apparent call to strerror()
5306 * below is actually a macro that behind-the-scenes calls strerror_r(). */
43cb6651 5307
39e69e77 5308# ifdef HAS_STRERROR_R
7aaa36b1
KW		 5309
5310 if (within_locale_scope) {
4eb27fc5 5311 errstr = savepv(strerror(errnum));
7aaa36b1
KW		 5312 }
5313 else {
4eb27fc5 5314 errstr = savepv(strerror_l(errnum, PL_C_locale_obj));
7aaa36b1
KW		 5315 }
5316
43cb6651
KW		 5317# else
5318
5319 /* Here we have strerror_l(), but not strerror_r() and we are on a
5320 * threaded-build. We use strerror_l() for everything, constructing a
5321 * locale to pass to it if necessary */
5322
5323 bool do_free = FALSE;
5324 locale_t locale_to_use;
5325
5326 if (within_locale_scope) {
5327 locale_to_use = uselocale((locale_t) 0);
5328 if (locale_to_use == LC_GLOBAL_LOCALE) {
5329 locale_to_use = duplocale(LC_GLOBAL_LOCALE);
5330 do_free = TRUE;
5331 }
5332 }
5333 else { /* Use C locale if not within 'use locale' scope */
5334 locale_to_use = PL_C_locale_obj;
5335 }
5336
5337 errstr = savepv(strerror_l(errnum, locale_to_use));
5338
5339 if (do_free) {
5340 freelocale(locale_to_use);
5341 }
5342
5343# endif
5344# else /* Doesn't have strerror_l() */
7aaa36b1 5345
8de4332b 5346 const char * save_locale = NULL;
c9dda6da 5347 bool locale_is_C = FALSE;
2c6ee1a7 5348
9de6fe47 5349 /* We have a critical section to prevent another thread from executing this
e9bc6d6b 5350 * same code at the same time. (On thread-safe perls, the LOCK is a
9de6fe47
KW		 5351 * no-op.) Since this is the only place in core that changes LC_MESSAGES
5352 * (unless the user has called setlocale(), this works to prevent races. */
7953f73f 5353 SETLOCALE_LOCK;
6ebbc862 5354
9c8a6dc2
KW		 5355 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5356 "my_strerror called with errnum %d\n", errnum));
6ebbc862 5357 if (! within_locale_scope) {
837ce802 5358 save_locale = do_setlocale_c(LC_MESSAGES, NULL);
c9dda6da 5359 if (! save_locale) {
d523eeeb 5360 SETLOCALE_UNLOCK;
d707d779
KW		 5361 Perl_croak(aTHX_
5362 "panic: %s: %d: Could not find current LC_MESSAGES locale,"
5363 " errno=%d\n", __FILE__, __LINE__, errno);
c9dda6da
KW		 5364 }
5365 else {
5366 locale_is_C = isNAME_C_OR_POSIX(save_locale);
2c6ee1a7 5367
c9dda6da
KW		 5368 /* Switch to the C locale if not already in it */
5369 if (! locale_is_C) {
2c6ee1a7 5370
c9dda6da
KW		 5371 /* The setlocale() just below likely will zap 'save_locale', so
5372 * create a copy. */
5373 save_locale = savepv(save_locale);
837ce802 5374 do_setlocale_c(LC_MESSAGES, "C");
c9dda6da 5375 }
6ebbc862 5376 }
6ebbc862 5377 } /* end of ! within_locale_scope */
9c8a6dc2
KW		 5378 else {
5379 DEBUG_Lv(PerlIO_printf(Perl_debug_log, "%s: %d: WITHIN locale scope\n",
5380 __FILE__, __LINE__));
5381 }
a0b53297 5382
9c8a6dc2
KW		 5383 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5384 "Any locale change has been done; about to call Strerror\n"));
52770946 5385 errstr = savepv(Strerror(errnum));
6ebbc862
KW		 5386
5387 if (! within_locale_scope) {
c9dda6da 5388 if (save_locale && ! locale_is_C) {
837ce802 5389 if (! do_setlocale_c(LC_MESSAGES, save_locale)) {
d523eeeb 5390 SETLOCALE_UNLOCK;
d707d779 5391 Perl_croak(aTHX_
cfaae47f
KW		 5392 "panic: %s: %d: setlocale restore to '%s' failed, errno=%d\n",
5393 __FILE__, __LINE__, save_locale, errno);
c9dda6da 5394 }
6ebbc862
KW		 5395 Safefree(save_locale);
5396 }
5397 }
5398
7953f73f 5399 SETLOCALE_UNLOCK;
6ebbc862 5400
7aaa36b1 5401# endif /* End of doesn't have strerror_l */
d36adde0 5402# ifdef DEBUGGING
6affbbf0
KW		 5403
5404 if (DEBUG_Lv_TEST) {
5405 PerlIO_printf(Perl_debug_log, "Strerror returned; saving a copy: '");
5406 print_bytes_for_locale(errstr, errstr + strlen(errstr), 0);
5407 PerlIO_printf(Perl_debug_log, "'\n");
5408 }
5409
d36adde0
KW		 5410# endif
5411#endif /* End of does have locale messages */
2c6ee1a7 5412
52770946 5413 SAVEFREEPV(errstr);
6ebbc862 5414 return errstr;
2c6ee1a7
KW		 5415}
5416
66610fdd 5417/*
747c467a 5418
58e641fb
KW		 5419=for apidoc switch_to_global_locale
5420
75920755 5421On systems without locale support, or on typical single-threaded builds, or on
58e641fb
KW		 5422platforms that do not support per-thread locale operations, this function does
5423nothing. On such systems that do have locale support, only a locale global to
5424the whole program is available.
5425
5426On multi-threaded builds on systems that do have per-thread locale operations,
5427this function converts the thread it is running in to use the global locale.
5428This is for code that has not yet or cannot be updated to handle multi-threaded
5429locale operation. As long as only a single thread is so-converted, everything
5430works fine, as all the other threads continue to ignore the global one, so only
5431this thread looks at it.
5432
69c5e0db
KW		 5433However, on Windows systems this isn't quite true prior to Visual Studio 15,
5434at which point Microsoft fixed a bug. A race can occur if you use the
5435following operations on earlier Windows platforms:
5436
5437=over
5438
5439=item L<POSIX::localeconv|POSIX/localeconv>
5440
5441=item L<I18N::Langinfo>, items C<CRNCYSTR> and C<THOUSEP>
5442
5443=item L<perlapi/Perl_langinfo>, items C<CRNCYSTR> and C<THOUSEP>
5444
5445=back
5446
5447The first item is not fixable (except by upgrading to a later Visual Studio
5448release), but it would be possible to work around the latter two items by using
5449the Windows API functions C<GetNumberFormat> and C<GetCurrencyFormat>; patches
5450welcome.
5451
58e641fb
KW		 5452Without this function call, threads that use the L<C<setlocale(3)>> system
5453function will not work properly, as all the locale-sensitive functions will
5454look at the per-thread locale, and C<setlocale> will have no effect on this
5455thread.
5456
5457Perl code should convert to either call
5458L<C<Perl_setlocale>|perlapi/Perl_setlocale> (which is a drop-in for the system
5459C<setlocale>) or use the methods given in L<perlcall> to call
5460L<C<POSIX::setlocale>|POSIX/setlocale>. Either one will transparently properly
5461handle all cases of single- vs multi-thread, POSIX 2008-supported or not.
5462
5463Non-Perl libraries, such as C<gtk>, that call the system C<setlocale> can
5464continue to work if this function is called before transferring control to the
5465library.
5466
5467Upon return from the code that needs to use the global locale,
5468L<C<sync_locale()>|perlapi/sync_locale> should be called to restore the safe
5469multi-thread operation.
5470
5471=cut
5472*/
5473
5474void
5475Perl_switch_to_global_locale()
5476{
5477
5478#ifdef USE_THREAD_SAFE_LOCALE
5479# ifdef WIN32
5480
5481 _configthreadlocale(_DISABLE_PER_THREAD_LOCALE);
5482
5483# else
5484# ifdef HAS_QUERYLOCALE
5485
5486 setlocale(LC_ALL, querylocale(LC_ALL_MASK, uselocale((locale_t) 0)));
5487
5488# else
5489
5490 {
5491 unsigned int i;
5492
5493 for (i = 0; i < LC_ALL_INDEX; i++) {
5494 setlocale(categories[i], do_setlocale_r(categories[i], NULL));
5495 }
5496 }
5497
5498# endif
5499
5500 uselocale(LC_GLOBAL_LOCALE);
5501
5502# endif
5503#endif
5504
5505}
5506
5507/*
5508
747c467a
KW		 5509=for apidoc sync_locale
5510
b2e9ba0c
KW		 5511L<C<Perl_setlocale>|perlapi/Perl_setlocale> can be used at any time to query or
5512change the locale (though changing the locale is antisocial and dangerous on
5513multi-threaded systems that don't have multi-thread safe locale operations.
5514(See L<perllocale/Multi-threaded operation>). Using the system
5515L<C<setlocale(3)>> should be avoided. Nevertheless, certain non-Perl libraries
5516called from XS, such as C<Gtk> do so, and this can't be changed. When the
5517locale is changed by XS code that didn't use
5518L<C<Perl_setlocale>|perlapi/Perl_setlocale>, Perl needs to be told that the
5519locale has changed. Use this function to do so, before returning to Perl.
5520
5521The return value is a boolean: TRUE if the global locale at the time of call
5522was in effect; and FALSE if a per-thread locale was in effect. This can be
5523used by the caller that needs to restore things as-they-were to decide whether
5524or not to call
5525L<C<Perl_switch_to_global_locale>|perlapi/switch_to_global_locale>.
747c467a
KW		 5526
5527=cut
5528*/
5529
b2e9ba0c
KW		 5530bool
5531Perl_sync_locale()
747c467a 5532{
d36adde0
KW		 5533
5534#ifndef USE_LOCALE
5535
5536 return TRUE;
5537
5538#else
5539
e9bc6d6b 5540 const char * newlocale;
b2e9ba0c
KW		 5541 dTHX;
5542
d36adde0 5543# ifdef USE_POSIX_2008_LOCALE
b2e9ba0c
KW		 5544
5545 bool was_in_global_locale = FALSE;
5546 locale_t cur_obj = uselocale((locale_t) 0);
5547
5548 /* On Windows, unless the foreign code has turned off the thread-safe
5549 * locale setting, any plain setlocale() will have affected what we see, so
5550 * no need to worry. Otherwise, If the foreign code has done a plain
5551 * setlocale(), it will only affect the global locale on POSIX systems, but
5552 * will affect the */
5553 if (cur_obj == LC_GLOBAL_LOCALE) {
5554
d36adde0 5555# ifdef HAS_QUERY_LOCALE
b2e9ba0c
KW		 5556
5557 do_setlocale_c(LC_ALL, setlocale(LC_ALL, NULL));
5558
d36adde0 5559# else
b2e9ba0c
KW		 5560
5561 unsigned int i;
5562
5563 /* We can't trust that we can read the LC_ALL format on the
5564 * platform, so do them individually */
5565 for (i = 0; i < LC_ALL_INDEX; i++) {
5566 do_setlocale_r(categories[i], setlocale(categories[i], NULL));
5567 }
747c467a 5568
d36adde0 5569# endif
b2e9ba0c
KW		 5570
5571 was_in_global_locale = TRUE;
5572 }
5573
d36adde0 5574# else
b2e9ba0c
KW		 5575
5576 bool was_in_global_locale = TRUE;
5577
d36adde0
KW		 5578# endif
5579# ifdef USE_LOCALE_CTYPE
7d4bcc4a 5580
b0bde642 5581 newlocale = savepv(do_setlocale_c(LC_CTYPE, NULL));
9f82ea3e
KW		 5582 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5583 "%s:%d: %s\n", __FILE__, __LINE__,
5584 setlocale_debug_string(LC_CTYPE, NULL, newlocale)));
5585 new_ctype(newlocale);
b0bde642 5586 Safefree(newlocale);
747c467a 5587
d36adde0
KW		 5588# endif /* USE_LOCALE_CTYPE */
5589# ifdef USE_LOCALE_COLLATE
7d4bcc4a 5590
b0bde642 5591 newlocale = savepv(do_setlocale_c(LC_COLLATE, NULL));
9f82ea3e
KW		 5592 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5593 "%s:%d: %s\n", __FILE__, __LINE__,
5594 setlocale_debug_string(LC_COLLATE, NULL, newlocale)));
5595 new_collate(newlocale);
b0bde642 5596 Safefree(newlocale);
747c467a 5597
d36adde0
KW		 5598# endif
5599# ifdef USE_LOCALE_NUMERIC
7d4bcc4a 5600
b0bde642 5601 newlocale = savepv(do_setlocale_c(LC_NUMERIC, NULL));
9f82ea3e
KW		 5602 DEBUG_Lv(PerlIO_printf(Perl_debug_log,
5603 "%s:%d: %s\n", __FILE__, __LINE__,
5604 setlocale_debug_string(LC_NUMERIC, NULL, newlocale)));
5605 new_numeric(newlocale);
b0bde642 5606 Safefree(newlocale);
7d4bcc4a 5607
d36adde0 5608# endif /* USE_LOCALE_NUMERIC */
747c467a 5609
b2e9ba0c 5610 return was_in_global_locale;
d36adde0
KW		 5611
5612#endif
5613
747c467a
KW		 5614}
5615
5d1187d1
KW		 5616#if defined(DEBUGGING) && defined(USE_LOCALE)
5617
a4f00dcc
KW		 5618STATIC char *
5619S_setlocale_debug_string(const int category, /* category number,
5d1187d1
KW		 5620 like LC_ALL */
5621 const char* const locale, /* locale name */
5622
5623 /* return value from setlocale() when attempting to
5624 * set 'category' to 'locale' */
5625 const char* const retval)
5626{
5627 /* Returns a pointer to a NUL-terminated string in static storage with
5628 * added text about the info passed in. This is not thread safe and will
5629 * be overwritten by the next call, so this should be used just to
fa07b8e5 5630 * formulate a string to immediately print or savepv() on. */
5d1187d1 5631
8c3a0f6c 5632 static char ret[256];
7d4bcc4a 5633
e5f10d49 5634 my_strlcpy(ret, "setlocale(", sizeof(ret));
b09aaf40 5635 my_strlcat(ret, category_name(category), sizeof(ret));
fa07b8e5 5636 my_strlcat(ret, ", ", sizeof(ret));
5d1187d1
KW		 5637
5638 if (locale) {
fa07b8e5
KW		 5639 my_strlcat(ret, "\"", sizeof(ret));
5640 my_strlcat(ret, locale, sizeof(ret));
5641 my_strlcat(ret, "\"", sizeof(ret));
5d1187d1
KW		 5642 }
5643 else {
fa07b8e5 5644 my_strlcat(ret, "NULL", sizeof(ret));
5d1187d1
KW		 5645 }
5646
fa07b8e5 5647 my_strlcat(ret, ") returned ", sizeof(ret));
5d1187d1
KW		 5648
5649 if (retval) {
fa07b8e5
KW		 5650 my_strlcat(ret, "\"", sizeof(ret));
5651 my_strlcat(ret, retval, sizeof(ret));
5652 my_strlcat(ret, "\"", sizeof(ret));
5d1187d1
KW		 5653 }
5654 else {
fa07b8e5 5655 my_strlcat(ret, "NULL", sizeof(ret));
5d1187d1
KW		 5656 }
5657
5658 assert(strlen(ret) < sizeof(ret));
5659
5660 return ret;
5661}
5662
5663#endif
747c467a 5664
e9bc6d6b
KW		 5665void
5666Perl_thread_locale_init()
5667{
5668 /* Called from a thread on startup*/
5669
5670#ifdef USE_THREAD_SAFE_LOCALE
5671
5672 dTHX_DEBUGGING;
5673
5674 /* C starts the new thread in the global C locale. If we are thread-safe,
5675 * we want to not be in the global locale */
5676
5677 DEBUG_L(PerlIO_printf(Perl_debug_log,
5678 "%s:%d: new thread, initial locale is %s; calling setlocale\n",
5679 __FILE__, __LINE__, setlocale(LC_ALL, NULL)));
5680
5681# ifdef WIN32
5682
5683 _configthreadlocale(_ENABLE_PER_THREAD_LOCALE);
5684
5685# else
5686
5687 Perl_setlocale(LC_ALL, "C");
5688
5689# endif
5690#endif
5691
5692}
5693
5694void
5695Perl_thread_locale_term()
5696{
5697 /* Called from a thread as it gets ready to terminate */
5698
5699#ifdef USE_THREAD_SAFE_LOCALE
5700
5701 /* C starts the new thread in the global C locale. If we are thread-safe,
5702 * we want to not be in the global locale */
5703
5704# ifndef WIN32
5705
5706 { /* Free up */
5707 locale_t cur_obj = uselocale(LC_GLOBAL_LOCALE);
e72200e7 5708 if (cur_obj != LC_GLOBAL_LOCALE && cur_obj != PL_C_locale_obj) {
e9bc6d6b
KW		 5709 freelocale(cur_obj);
5710 }
5711 }
5712
5713# endif
5714#endif
5715
5716}
747c467a
KW		 5717
5718/*
14d04a33 5719 * ex: set ts=8 sts=4 sw=4 et:
37442d52 5720 */
Unnamed repository; edit this file 'description' to name the repository.