This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Deprecate isFOO_utf8() macros
[perl5.git] / ext / XS-APItest / t / handy.t
CommitLineData
bdd8600f
KW
1#!perl -w
2
31f05a37 3BEGIN {
629eeaee
KW
4 require 'loc_tools.pl'; # Contains locales_enabled() and
5 # find_utf8_ctype_locale()
31f05a37
KW
6}
7
bdd8600f
KW
8use strict;
9use Test::More;
569f7fc5 10use Config;
bdd8600f
KW
11
12use XS::APItest;
13
01a11ab9
KW
14my $tab = " " x 4; # Indent subsidiary tests this much
15
4acecd39
KW
16use Unicode::UCD qw(search_invlist prop_invmap prop_invlist);
17my ($charname_list, $charname_map, $format, $default) = prop_invmap("Name Alias");
18
19sub get_charname($) {
20 my $cp = shift;
21
22 # If there is a an abbreviation for the code point name, use it
23 my $name_index = search_invlist(\@{$charname_list}, $cp);
24 if (defined $name_index) {
25 my $synonyms = $charname_map->[$name_index];
26 if (ref $synonyms) {
27 my $pat = qr/: abbreviation/;
28 my @abbreviations = grep { $_ =~ $pat } @$synonyms;
29 if (@abbreviations) {
30 return $abbreviations[0] =~ s/$pat//r;
31 }
32 }
33 }
34
35 # Otherwise, use the full name
36 use charnames ();
37 return charnames::viacode($cp) // "No name";
38}
39
5073ffbd 40sub truth($) { # Converts values so is() works
e2efe419 41 return (shift) ? 1 : 0;
c9c05358
KW
42}
43
01a11ab9 44my $base_locale;
31f05a37 45my $utf8_locale;
629eeaee 46if(locales_enabled('LC_ALL')) {
569f7fc5 47 require POSIX;
01a11ab9
KW
48 $base_locale = POSIX::setlocale( &POSIX::LC_ALL, "C");
49 if (defined $base_locale && $base_locale eq 'C') {
5f1269ab 50 use locale; # make \w work right in non-ASCII lands
569f7fc5
JR
51
52 # Some locale implementations don't have the 128-255 characters all
53 # mean nothing. Skip the locale tests in that situation
54 for my $i (128 .. 255) {
b5c3a14a 55 if (chr(utf8::unicode_to_native($i)) =~ /[[:print:]]/) {
01a11ab9 56 undef $base_locale;
569f7fc5
JR
57 last;
58 }
981746b9 59 }
31f05a37 60
01a11ab9 61 $utf8_locale = find_utf8_ctype_locale() if $base_locale;
981746b9
KW
62 }
63}
64
01a11ab9
KW
65sub get_display_locale_or_skip($$) {
66
67 # Helper function intimately tied to its callers. It knows the loop
68 # iterates with a locale of "", meaning don't use locale; $base_locale
69 # meaning to use a non-UTF-8 locale; and $utf8_locale.
70 #
71 # It checks to see if the current test should be skipped or executed,
72 # returning an empty list for the former, and for the latter:
73 # ( 'locale display name',
74 # bool of is this a UTF-8 locale )
75 #
76 # The display name is the empty string if not using locale. Functions
77 # with _LC in their name are skipped unless in locale, and functions
78 # without _LC are executed only outside locale. However, if no locales at
79 # all are on the system, the _LC functions are executed outside locale.
80
81 my ($locale, $suffix) = @_;
82
83 # The test should be skipped if the input is for a non-existent locale
84 return unless defined $locale;
85
86 # Here the input is defined, either a locale name or "". If the test is
87 # for not using locales, we want to do the test for non-LC functions,
88 # and skip it for LC ones (except if there are no locales on the system,
89 # we do it for LC ones as if they weren't LC).
90 if ($locale eq "") {
91 return ("", 0) if $suffix !~ /LC/ || ! defined $base_locale;
92 return;
93 }
94
95 # Here the input is for a real locale. We don't test the non-LC functions
96 # for locales.
97 return if $suffix !~ /LC/;
98
99 # Here is for a LC function and a real locale. The base locale is not
100 # UTF-8.
101 return (" ($locale locale)", 0) if $locale eq $base_locale;
102
103 # The only other possibility is that we have a UTF-8 locale
104 return (" ($locale)", 1);
105}
106
da8c1a98
KW
107sub try_malforming($$$)
108{
109 # Determines if the tests for malformed UTF-8 should be done. When done,
110 # the .xs code creates malformations by pretending the length is shorter
111 # than it actually is. Some things can't be malformed, and sometimes this
112 # test knows that the current code doesn't look for a malformation under
113 # various circumstances.
114
115 my ($i, $function, $using_locale) = @_;
116
117 # Single bytes can't be malformed
118 return 0 if $i < ((ord "A" == 65) ? 128 : 160);
119
120 # ASCII doesn't need to ever look beyond the first byte.
121 return 0 if $function eq "ASCII";
122
123 # No controls above 255, so the code doesn't look at those
124 return 0 if $i > 255 && $function eq "CNTRL";
125
126 # No non-ASCII digits below 256, except if using locales.
127 return 0 if $i < 256 && ! $using_locale && $function =~ /X?DIGIT/;
128
129 return 1;
130}
131
e2efe419
KW
132my %properties = (
133 # name => Lookup-property name
134 alnum => 'Word',
981746b9 135 wordchar => 'Word',
15861f94 136 alphanumeric => 'Alnum',
ebdbc726 137 alpha => 'XPosixAlpha',
e2efe419
KW
138 ascii => 'ASCII',
139 blank => 'Blank',
140 cntrl => 'Control',
141 digit => 'Digit',
142 graph => 'Graph',
143 idfirst => '_Perl_IDStart',
eba68aa0 144 idcont => '_Perl_IDCont',
ebdbc726 145 lower => 'XPosixLower',
e2efe419
KW
146 print => 'Print',
147 psxspc => 'XPosixSpace',
148 punct => 'XPosixPunct',
149 quotemeta => '_Perl_Quotemeta',
150 space => 'XPerlSpace',
840f8e92 151 vertws => 'VertSpace',
ebdbc726 152 upper => 'XPosixUpper',
e2efe419
KW
153 xdigit => 'XDigit',
154 );
155
34aeb2e9 156my %seen;
5073ffbd
KW
157my @warnings;
158local $SIG{__WARN__} = sub { push @warnings, @_ };
159
da8c1a98
KW
160my %utf8_param_code = (
161 "_safe" => 0,
162 "_safe, malformed" => 1,
34aeb2e9 163 "deprecated unsafe" => -1,
da8c1a98 164 );
4acecd39 165
8dc91396
KW
166foreach my $name (sort keys %properties, 'octal') {
167 my @invlist;
168 if ($name eq 'octal') {
169 # Hand-roll an inversion list with 0-7 in it and nothing else.
170 push @invlist, ord "0", ord "8";
171 }
172 else {
9a009363
KW
173 my $property = $properties{$name};
174 @invlist = prop_invlist($property, '_perl_core_internal_ok');
175 if (! @invlist) {
176
177 # An empty return could mean an unknown property, or merely that
178 # it is empty. Call in scalar context to differentiate
179 if (! prop_invlist($property, '_perl_core_internal_ok')) {
180 fail("No inversion list found for $property");
181 next;
182 }
ebdbc726 183 }
e2efe419
KW
184 }
185
186 # Include all the Latin1 code points, plus 0x100.
187 my @code_points = (0 .. 256);
188
189 # Then include the next few boundaries above those from this property
190 my $above_latins = 0;
191 foreach my $range_start (@invlist) {
192 next if $range_start < 257;
193 push @code_points, $range_start - 1, $range_start;
194 $above_latins++;
195 last if $above_latins > 5;
196 }
197
eba68aa0
KW
198 # This makes sure we are using the Perl definition of idfirst and idcont,
199 # and not the Unicode. There are a few differences.
200 push @code_points, ord "\N{ESTIMATED SYMBOL}" if $name =~ /^id(first|cont)/;
2f4622f0
KW
201 if ($name eq "idcont") { # And some that are continuation but not start
202 push @code_points, ord("\N{GREEK ANO TELEIA}"),
203 ord("\N{COMBINING GRAVE ACCENT}");
204 }
f91dcd13 205
e2efe419
KW
206 # And finally one non-Unicode code point.
207 push @code_points, 0x110000; # Above Unicode, no prop should match
4f6ef7cc 208 no warnings 'non_unicode';
e2efe419 209
2e1414ce
KW
210 for my $j (@code_points) {
211 my $i = utf8::native_to_unicode($j);
c9c05358 212 my $function = uc($name);
c9c05358 213
01a11ab9
KW
214 is (@warnings, 0, "Got no unexpected warnings in previous iteration")
215 or diag("@warnings");
216 undef @warnings;
217
4acecd39 218 my $matches = search_invlist(\@invlist, $i);
e2efe419
KW
219 if (! defined $matches) {
220 $matches = 0;
221 }
222 else {
223 $matches = truth(! ($matches % 2));
224 }
5073ffbd 225
e2efe419 226 my $ret;
4acecd39 227 my $char_name = get_charname($j);
94a62bdc 228 my $display_name = sprintf "\\x{%02X, %s}", $i, $char_name;
01a11ab9 229 my $display_call = "is${function}( $display_name )";
e2efe419 230
a7fe8528
KW
231 foreach my $suffix ("", "_A", "_L1", "_LC", "_uni", "_uvchr",
232 "_LC_uvchr", "_utf8", "_LC_utf8")
ee9e5f10 233 {
31f05a37 234
01a11ab9
KW
235 # Not all possible macros have been defined
236 if ($name eq 'vertws') {
31f05a37 237
01a11ab9 238 # vertws is always all of Unicode
a7fe8528 239 next if $suffix !~ / ^ _ ( uni | uvchr | utf8 ) $ /x;
981746b9 240 }
01a11ab9 241 elsif ($name eq 'alnum') {
981746b9 242
a7fe8528
KW
243 # ALNUM_A, ALNUM_L1, and ALNUM_uvchr are not defined as these
244 # suffixes were added later, after WORDCHAR was created to be
245 # a clearer synonym for ALNUM
246 next if $suffix eq '_A'
247 || $suffix eq '_L1'
248 || $suffix eq '_uvchr';
31a09021 249 }
8dc91396 250 elsif ($name eq 'octal') {
ee9e5f10 251 next if $suffix ne "" && $suffix ne '_A' && $suffix ne '_L1';
8dc91396 252 }
42c03a9a
KW
253 elsif ($name eq 'quotemeta') {
254 # There is only one macro for this, and is defined only for
255 # Latin1 range
256 next if $suffix ne ""
257 }
a9aff56e 258
01a11ab9
KW
259 foreach my $locale ("", $base_locale, $utf8_locale) {
260
261 my ($display_locale, $locale_is_utf8)
262 = get_display_locale_or_skip($locale, $suffix);
263 next unless defined $display_locale;
264
265 use if $locale, "locale";
266 POSIX::setlocale( &POSIX::LC_ALL, $locale) if $locale;
267
268 if ($suffix !~ /utf8/) { # _utf8 has to handled specially
269 my $display_call
270 = "is${function}$suffix( $display_name )$display_locale";
271 $ret = truth eval "test_is${function}$suffix($i)";
272 if (is ($@, "", "$display_call didn't give error")) {
273 my $truth = $matches;
274 if ($truth) {
275
276 # The single byte functions are false for
277 # above-Latin1
278 if ($i >= 256) {
ee9e5f10
KW
279 $truth = 0
280 if $suffix=~ / ^ ( _A | _L [1C] )? $ /x;
01a11ab9 281 }
42c03a9a
KW
282 elsif ( utf8::native_to_unicode($i) >= 128
283 && $name ne 'quotemeta')
284 {
01a11ab9 285
ee9e5f10 286 # The no-suffix and _A functions are false
01a11ab9
KW
287 # for non-ASCII. So are _LC functions on a
288 # non-UTF-8 locale
289 $truth = 0 if $suffix eq "_A"
ee9e5f10 290 || $suffix eq ""
01a11ab9
KW
291 || ( $suffix =~ /LC/
292 && ! $locale_is_utf8);
293 }
294 }
295
296 is ($ret, $truth, "${tab}And correctly returns $truth");
297 }
298 }
299 else { # _utf8 suffix
300 my $char = chr($i);
301 utf8::upgrade($char);
302 $char = quotemeta $char if $char eq '\\' || $char eq "'";
303 my $truth;
304 if ( $suffix =~ /LC/
305 && ! $locale_is_utf8
306 && $i < 256
307 && utf8::native_to_unicode($i) >= 128)
308 { # The C-locale _LC function returns FALSE for Latin1
309 # above ASCII
310 $truth = 0;
311 }
312 else {
313 $truth = $matches;
314 }
31f05a37 315
da8c1a98
KW
316 foreach my $utf8_param("_safe",
317 "_safe, malformed",
34aeb2e9 318 "deprecated unsafe"
da8c1a98
KW
319 )
320 {
321 my $utf8_param_code = $utf8_param_code{$utf8_param};
322 my $expect_error = $utf8_param_code > 0;
323 next if $expect_error
34aeb2e9
KW
324 && ! try_malforming($i, $function,
325 $suffix =~ /LC/);
da8c1a98
KW
326
327 my $display_call = "is${function}$suffix( $display_name"
328 . ", $utf8_param )$display_locale";
329 $ret = truth eval "test_is${function}$suffix('$char',"
330 . " $utf8_param_code)";
331 if ($expect_error) {
332 isnt ($@, "",
333 "expected and got error in $display_call");
334 like($@, qr/Malformed UTF-8 character/,
335 "${tab}And got expected message");
336 if (is (@warnings, 1,
337 "${tab}Got a single warning besides"))
338 {
339 like($warnings[0],
340 qr/Malformed UTF-8 character.*short/,
341 "${tab}Got expected warning");
342 }
343 else {
344 diag("@warnings");
345 }
346 undef @warnings;
347 }
348 elsif (is ($@, "", "$display_call didn't give error")) {
01a11ab9
KW
349 is ($ret, $truth,
350 "${tab}And correctly returned $truth");
34aeb2e9
KW
351 if ($utf8_param_code < 0) {
352 my $warnings_ok;
353 my $unique_function = "is" . $function . $suffix;
354 if (! $seen{$unique_function}++) {
355 $warnings_ok = is(@warnings, 1,
356 "${tab}This is first call to"
357 . " $unique_function; Got a single"
358 . " warning");
359 if ($warnings_ok) {
360 $warnings_ok = like($warnings[0],
361 qr/starting in Perl .* will require an additional parameter/,
362 "${tab}The warning was the expected"
363 . " deprecation one");
364 }
365 }
366 else {
367 $warnings_ok = is(@warnings, 0,
368 "${tab}This subsequent call to"
369 . " $unique_function did not warn");
370 }
371 $warnings_ok or diag("@warnings");
372 undef @warnings;
373 }
01a11ab9 374 }
da8c1a98 375 }
01a11ab9 376 }
31a09021 377 }
8ff203a1 378 }
c9c05358
KW
379 }
380}
381
2e1414ce 382my %to_properties = (
01a11ab9 383 FOLD => 'Case_Folding',
2e1414ce
KW
384 LOWER => 'Lowercase_Mapping',
385 TITLE => 'Titlecase_Mapping',
386 UPPER => 'Uppercase_Mapping',
387 );
388
389
390foreach my $name (sort keys %to_properties) {
391 my $property = $to_properties{$name};
392 my ($list_ref, $map_ref, $format, $missing)
393 = prop_invmap($property, );
394 if (! $list_ref || ! $map_ref) {
395 fail("No inversion map found for $property");
396 next;
397 }
ebdbc726 398 if ($format !~ / ^ a l? $ /x) {
2e1414ce
KW
399 fail("Unexpected inversion map format ('$format') found for $property");
400 next;
401 }
402
403 # Include all the Latin1 code points, plus 0x100.
404 my @code_points = (0 .. 256);
405
406 # Then include the next few multi-char folds above those from this
407 # property, and include the next few single folds as well
408 my $above_latins = 0;
409 my $multi_char = 0;
410 for my $i (0 .. @{$list_ref} - 1) {
411 my $range_start = $list_ref->[$i];
412 next if $range_start < 257;
413 if (ref $map_ref->[$i] && $multi_char < 5) {
01a11ab9
KW
414 push @code_points, $range_start - 1
415 if $code_points[-1] != $range_start - 1;
2e1414ce
KW
416 push @code_points, $range_start;
417 $multi_char++;
418 }
419 elsif ($above_latins < 5) {
01a11ab9
KW
420 push @code_points, $range_start - 1
421 if $code_points[-1] != $range_start - 1;
2e1414ce
KW
422 push @code_points, $range_start;
423 $above_latins++;
424 }
425 last if $above_latins >= 5 && $multi_char >= 5;
426 }
427
428 # And finally one non-Unicode code point.
429 push @code_points, 0x110000; # Above Unicode, no prop should match
430 no warnings 'non_unicode';
431
432 # $j is native; $i unicode.
433 for my $j (@code_points) {
434 my $i = utf8::native_to_unicode($j);
435 my $function = $name;
436
4acecd39 437 my $index = search_invlist(\@{$list_ref}, $j);
2e1414ce
KW
438
439 my $ret;
4acecd39 440 my $char_name = get_charname($j);
2e1414ce
KW
441 my $display_name = sprintf "\\N{U+%02X, %s}", $i, $char_name;
442
01a11ab9 443 foreach my $suffix ("", "_L1", "_LC") {
2e1414ce 444
01a11ab9
KW
445 # This is the only macro defined for L1
446 next if $suffix eq "_L1" && $function ne "LOWER";
2e1414ce 447
01a11ab9
KW
448 SKIP:
449 foreach my $locale ("", $base_locale, $utf8_locale) {
31f05a37 450
01a11ab9
KW
451 # titlecase is not defined in locales.
452 next if $name eq 'TITLE' && $suffix eq "_LC";
31f05a37 453
01a11ab9
KW
454 my ($display_locale, $locale_is_utf8)
455 = get_display_locale_or_skip($locale, $suffix);
456 next unless defined $display_locale;
31f05a37 457
01a11ab9
KW
458 skip("to${name}_LC does not work for LATIN SMALL LETTER SHARP S"
459 . "$display_locale", 1)
460 if $i == 0xDF && $name =~ / FOLD | UPPER /x
461 && $suffix eq "_LC" && $locale_is_utf8;
462
463 use if $locale, "locale";
464 POSIX::setlocale( &POSIX::LC_ALL, $locale) if $locale;
465
466 my $display_call = "to${function}$suffix("
467 . " $display_name )$display_locale";
468 $ret = eval "test_to${function}$suffix($j)";
469 if (is ($@, "", "$display_call didn't give error")) {
470 my $should_be;
471 if ($i > 255) {
472 $should_be = $j;
473 }
474 elsif ( $i > 127
475 && ( $suffix eq ""
476 || ($suffix eq "_LC" && ! $locale_is_utf8)))
477 {
478 $should_be = $j;
479 }
480 elsif ($map_ref->[$index] != $missing) {
481 $should_be = $map_ref->[$index] + $j - $list_ref->[$index]
31f05a37
KW
482 }
483 else {
01a11ab9 484 $should_be = $j;
31f05a37 485 }
01a11ab9
KW
486
487 is ($ret, $should_be,
488 sprintf("${tab}And correctly returned 0x%02X",
489 $should_be));
31f05a37 490 }
2e1414ce
KW
491 }
492 }
493
a7fe8528
KW
494 # The _uni, uvchr, and _utf8 functions return both the ordinal of the
495 # first code point of the result, and the result in utf8. The .xs
496 # tests return these in an array, in [0] and [1] respectively, with
497 # [2] the length of the utf8 in bytes.
2e1414ce
KW
498 my $utf8_should_be = "";
499 my $first_ord_should_be;
500 if (ref $map_ref->[$index]) { # A multi-char result
501 for my $j (0 .. @{$map_ref->[$index]} - 1) {
502 $utf8_should_be .= chr $map_ref->[$index][$j];
503 }
504
505 $first_ord_should_be = $map_ref->[$index][0];
506 }
507 else { # A single-char result
508 $first_ord_should_be = ($map_ref->[$index] != $missing)
01a11ab9
KW
509 ? $map_ref->[$index] + $j
510 - $list_ref->[$index]
2e1414ce
KW
511 : $j;
512 $utf8_should_be = chr $first_ord_should_be;
513 }
514 utf8::upgrade($utf8_should_be);
515
a7fe8528
KW
516 # Test _uni, uvchr
517 foreach my $suffix ('_uni', '_uvchr') {
c5546fac
KW
518 my $s;
519 my $len;
520 my $display_call = "to${function}$suffix( $display_name )";
521 $ret = eval "test_to${function}$suffix($j)";
522 if (is ($@, "", "$display_call didn't give error")) {
523 is ($ret->[0], $first_ord_should_be,
524 sprintf("${tab}And correctly returned 0x%02X",
525 $first_ord_should_be));
526 is ($ret->[1], $utf8_should_be, "${tab}Got correct utf8");
527 use bytes;
528 is ($ret->[2], length $utf8_should_be,
529 "${tab}Got correct number of bytes for utf8 length");
530 }
a7fe8528 531 }
2e1414ce
KW
532
533 # Test _utf8
534 my $char = chr($j);
535 utf8::upgrade($char);
536 $char = quotemeta $char if $char eq '\\' || $char eq "'";
01a11ab9
KW
537 {
538 my $display_call = "to${function}_utf8($display_name )";
539 $ret = eval "test_to${function}_utf8('$char')";
540 if (is ($@, "", "$display_call didn't give error")) {
541 is ($ret->[0], $first_ord_should_be,
542 sprintf("${tab}And correctly returned 0x%02X",
543 $first_ord_should_be));
544 is ($ret->[1], $utf8_should_be, "${tab}Got correct utf8");
545 use bytes;
546 is ($ret->[2], length $utf8_should_be,
547 "${tab}Got correct number of bytes for utf8 length");
548 }
2e1414ce 549 }
2e1414ce
KW
550 }
551}
552
5073ffbd 553# This is primarily to make sure that no non-Unicode warnings get generated
01a11ab9
KW
554is(scalar @warnings, 0, "No unexpected warnings were generated in the tests")
555 or diag @warnings;
5073ffbd 556
bdd8600f 557done_testing;