This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
t/loc_tools.pl: find_locales() Don't destroy callers ENV
[perl5.git] / t / loc_tools.pl
1 # Common tools for test files files to find the locales which exist on the
2 # system.  Caller should have defined ok() for the unlikely event that setup
3 # here fails, and should have verified that this isn't miniperl before calling
4 # the functions.
5
6 # Note that it's okay that some languages have their native names
7 # capitalized here even though that's not "right".  They are lowercased
8 # anyway later during the scanning process (and besides, some clueless
9 # vendor might have them capitalized erroneously anyway).
10
11 sub _trylocale {    # Adds the locale given by the first parameter to the list
12                     # given by the 2nd iff the platform supports the locale,
13                     # and it is not already on the list
14     my $locale = shift;
15     my $list = shift;
16     return if grep { $locale eq $_ } @$list;
17     return unless setlocale(&POSIX::LC_ALL, $locale);
18     my $badutf8;
19     {
20         local $SIG{__WARN__} = sub {
21             $badutf8 = $_[0] =~ /Malformed UTF-8/;
22         };
23     }
24
25     if ($badutf8) {
26         ok(0, "Verify locale name doesn't contain malformed utf8");
27         return;
28     }
29     push @$list, $locale;
30 }
31
32 sub _decode_encodings {
33     my @enc;
34
35     foreach (split(/ /, shift)) {
36         if (/^(\d+)$/) {
37             push @enc, "ISO8859-$1";
38             push @enc, "iso8859$1";     # HP
39             if ($1 eq '1') {
40                  push @enc, "roman8";   # HP
41             }
42             push @enc, $_;
43             push @enc, "$_.UTF-8";
44             push @enc, "$_.65001"; # Windows UTF-8
45             push @enc, "$_.ACP"; # Windows ANSI code page
46             push @enc, "$_.OCP"; # Windows OEM code page
47         }
48     }
49     if ($^O eq 'os390') {
50         push @enc, qw(IBM-037 IBM-819 IBM-1047);
51     }
52     push @enc, "UTF-8";
53     push @enc, "65001"; # Windows UTF-8
54
55     return @enc;
56 }
57
58 sub find_locales {  # Returns an array of all the locales we found on the
59                     # system
60
61     use Config;;
62     my $have_setlocale = $Config{d_setlocale};
63
64     # Visual C's CRT goes silly on strings of the form "en_US.ISO8859-1"
65     # and mingw32 uses said silly CRT
66     # This doesn't seem to be an issue any more, at least on Windows XP,
67     # so re-enable the tests for Windows XP onwards.
68     my $winxp = ($^O eq 'MSWin32' && defined &Win32::GetOSVersion &&
69                     join('.', (Win32::GetOSVersion())[1..2]) >= 5.1);
70     $have_setlocale = 0 if ((($^O eq 'MSWin32' && !$winxp) || $^O eq 'NetWare') &&
71                     $Config{cc} =~ /^(cl|gcc|g\+\+|ici)/i);
72
73     # UWIN seems to loop after taint tests, just skip for now
74     $have_setlocale = 0 if ($^O =~ /^uwin/);
75
76     return unless $have_setlocale;
77
78     # Done this way in case this is 'required' in the caller before seeing if
79     # this is miniperl.
80     require POSIX; import POSIX 'locale_h';
81
82     _trylocale("C", \@Locale);
83     _trylocale("POSIX", \@Locale);
84     foreach (0..15) {
85         _trylocale("ISO8859-$_", \@Locale);
86         _trylocale("iso8859$_", \@Locale);
87         _trylocale("iso8859-$_", \@Locale);
88         _trylocale("iso_8859_$_", \@Locale);
89         _trylocale("isolatin$_", \@Locale);
90         _trylocale("isolatin-$_", \@Locale);
91         _trylocale("iso_latin_$_", \@Locale);
92     }
93
94     # Sanitize the environment so that we can run the external 'locale'
95     # program without the taint mode getting grumpy.
96
97     # $ENV{PATH} is special in VMS.
98     delete local $ENV{PATH} if $^O ne 'VMS' or $Config{d_setenv};
99
100     # Other subversive stuff.
101     delete local @ENV{qw(IFS CDPATH ENV BASH_ENV)};
102
103     if (-x "/usr/bin/locale"
104         && open(LOCALES, "/usr/bin/locale -a 2>/dev/null|"))
105     {
106         while (<LOCALES>) {
107             # It seems that /usr/bin/locale steadfastly outputs 8 bit data, which
108             # ain't great when we're running this testPERL_UNICODE= so that utf8
109             # locales will cause all IO hadles to default to (assume) utf8
110             next unless utf8::valid($_);
111             chomp;
112             _trylocale($_, \@Locale);
113         }
114         close(LOCALES);
115     } elsif ($^O eq 'VMS'
116              && defined($ENV{'SYS$I18N_LOCALE'})
117              && -d 'SYS$I18N_LOCALE')
118     {
119     # The SYS$I18N_LOCALE logical name search list was not present on
120     # VAX VMS V5.5-12, but was on AXP && VAX VMS V6.2 as well as later versions.
121         opendir(LOCALES, "SYS\$I18N_LOCALE:");
122         while ($_ = readdir(LOCALES)) {
123             chomp;
124             _trylocale($_, \@Locale);
125         }
126         close(LOCALES);
127     } elsif (($^O eq 'openbsd' || $^O eq 'bitrig' ) && -e '/usr/share/locale') {
128
129     # OpenBSD doesn't have a locale executable, so reading /usr/share/locale
130     # is much easier and faster than the last resort method.
131
132         opendir(LOCALES, '/usr/share/locale');
133         while ($_ = readdir(LOCALES)) {
134             chomp;
135             _trylocale($_, \@Locale);
136         }
137         close(LOCALES);
138     } else { # Final fallback.  Try our list of locales hard-coded here
139
140         # This is going to be slow.
141         my @Data;
142
143
144         # Locales whose name differs if the utf8 bit is on are stored in these two
145         # files with appropriate encodings.
146         if ($^H & 0x08 || (${^OPEN} || "") =~ /:utf8/) {
147             @Data = do "lib/locale/utf8";
148         } else {
149             @Data = do "lib/locale/latin1";
150         }
151
152         # The rest of the locales are in this file.
153         push @Data, <DATA>;
154
155         foreach my $line (@Data) {
156             my ($locale_name, $language_codes, $country_codes, $encodings) =
157                 split /:/, $line;
158             my @enc = _decode_encodings($encodings);
159             foreach my $loc (split(/ /, $locale_name)) {
160                 _trylocale($loc, \@Locale);
161                 foreach my $enc (@enc) {
162                     _trylocale("$loc.$enc", \@Locale);
163                 }
164                 $loc = lc $loc;
165                 foreach my $enc (@enc) {
166                     _trylocale("$loc.$enc", \@Locale);
167                 }
168             }
169             foreach my $lang (split(/ /, $language_codes)) {
170                 _trylocale($lang, \@Locale);
171                 foreach my $country (split(/ /, $country_codes)) {
172                     my $lc = "${lang}_${country}";
173                     _trylocale($lc, \@Locale);
174                     foreach my $enc (@enc) {
175                         _trylocale("$lc.$enc", \@Locale);
176                     }
177                     my $lC = "${lang}_\U${country}";
178                     _trylocale($lC, \@Locale);
179                     foreach my $enc (@enc) {
180                         _trylocale("$lC.$enc", \@Locale);
181                     }
182                 }
183             }
184         }
185     }
186
187     @Locale = sort @Locale;
188
189     return @Locale;
190
191
192 }
193
194 sub is_locale_utf8 ($) { # Return a boolean as to if core Perl thinks the input
195                         # is a UTF-8 locale
196     my $locale = shift;
197
198     use locale;
199
200     my $save_locale = setlocale(&POSIX::LC_CTYPE());
201     if (! $save_locale) {
202         ok(0, "Verify could save previous locale");
203         return 0;
204     }
205
206     if (! setlocale(&POSIX::LC_CTYPE(), $locale)) {
207         ok(0, "Verify could setlocale to $locale");
208         return 0;
209     }
210
211     my $ret = 0;
212
213     # Use an op that gives different results for UTF-8 than any other locale.
214     # If a platform has UTF-8 locales, there should be at least one locale on
215     # most platforms with UTF-8 in its name, so if there is a bug in the op
216     # giving a false negative, we should get a failure for those locales as we
217     # go through testing all the locales on the platform.
218     if (CORE::fc(chr utf8::unicode_to_native(0xdf)) ne "ss") {
219         if ($locale =~ /UTF-?8/i) {
220             ok (0, "Verify $locale with UTF-8 in name is a UTF-8 locale");
221         }
222     }
223     else {
224         $ret = 1;
225     }
226
227     die "Couldn't restore locale '$save_locale'"
228         unless setlocale(&POSIX::LC_CTYPE(), $save_locale);
229
230     return $ret;
231 }
232
233 sub find_utf8_locale (;$) { # Return the name of locale that core Perl thinks
234                             # is a UTF-8 locale.  Optional second parameter is
235                             # a reference to a list of locales to try; if
236                             # omitted, this tries all locales it can find on
237                             # the platform
238     my $locales_ref = shift;
239     if (! defined $locales_ref) {
240         my @locales = find_locales();
241         $locales_ref = \@locales;
242     }
243
244     foreach my $locale (@$locales_ref) {
245         return $locale if is_locale_utf8($locale);
246     }
247
248     return;
249 }
250
251 1
252
253 # Format of data is: locale_name, language_codes, country_codes, encodings
254 __DATA__
255 Afrikaans:af:za:1 15
256 Arabic:ar:dz eg sa:6 arabic8
257 Brezhoneg Breton:br:fr:1 15
258 Bulgarski Bulgarian:bg:bg:5
259 Chinese:zh:cn tw:cn.EUC eucCN eucTW euc.CN euc.TW Big5 GB2312 tw.EUC
260 Hrvatski Croatian:hr:hr:2
261 Cymraeg Welsh:cy:cy:1 14 15
262 Czech:cs:cz:2
263 Dansk Danish:da:dk:1 15
264 Nederlands Dutch:nl:be nl:1 15
265 English American British:en:au ca gb ie nz us uk zw:1 15 cp850
266 Esperanto:eo:eo:3
267 Eesti Estonian:et:ee:4 6 13
268 Suomi Finnish:fi:fi:1 15
269 Flamish::fl:1 15
270 Deutsch German:de:at be ch de lu:1 15
271 Euskaraz Basque:eu:es fr:1 15
272 Galego Galician:gl:es:1 15
273 Ellada Greek:el:gr:7 g8
274 Frysk:fy:nl:1 15
275 Greenlandic:kl:gl:4 6
276 Hebrew:iw:il:8 hebrew8
277 Hungarian:hu:hu:2
278 Indonesian:id:id:1 15
279 Gaeilge Irish:ga:IE:1 14 15
280 Italiano Italian:it:ch it:1 15
281 Nihongo Japanese:ja:jp:euc eucJP jp.EUC sjis
282 Korean:ko:kr:
283 Latine Latin:la:va:1 15
284 Latvian:lv:lv:4 6 13
285 Lithuanian:lt:lt:4 6 13
286 Macedonian:mk:mk:1 15
287 Maltese:mt:mt:3
288 Moldovan:mo:mo:2
289 Norsk Norwegian:no no\@nynorsk nb nn:no:1 15
290 Occitan:oc:es:1 15
291 Polski Polish:pl:pl:2
292 Rumanian:ro:ro:2
293 Russki Russian:ru:ru su ua:5 koi8 koi8r KOI8-R koi8u cp1251 cp866
294 Serbski Serbian:sr:yu:5
295 Slovak:sk:sk:2
296 Slovene Slovenian:sl:si:2
297 Sqhip Albanian:sq:sq:1 15
298 Svenska Swedish:sv:fi se:1 15
299 Thai:th:th:11 tis620
300 Turkish:tr:tr:9 turkish8
301 Yiddish:yi::1 15