This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
In utf8decode.t, test that we get the expected Unicode character(s)
[perl5.git] / t / op / utf8decode.t
1 #!./perl
2
3 BEGIN {
4     chdir 't' if -d 't';
5     @INC = '../lib';
6     require './test.pl';
7 }
8
9 {
10     my $wide = v256;
11     use bytes;
12     my $ordwide = ord($wide);
13     printf "# under use bytes ord(v256) = 0x%02x\n", $ordwide;
14     skip_all('UTF-EBCDIC (not UTF-8) used here') if $ordwide == 140;
15
16     if ($ordwide != 196) {
17         printf "# v256 starts with 0x%02x\n", $ordwide;
18     }
19 }
20
21 no utf8;
22
23 foreach (<DATA>) {
24     if (/^(?:\d+(?:\.\d+)?)\s/ || /^#/) {
25         # print "# $_\n";
26     } elsif (/^(\d+\.\d+\.\d+[bu]?)\s+(y|n|N-?\d+)\s+([0-9a-f]{1,8}(?:,[0-9a-f]{1,8})*|-)\s+(\d+)\s+([0-9a-f]{2}(?::[0-9a-f]{2})*)\s+(\d+|-)(?:\s+(.+))?$/) {
27         my ($id, $okay, $Unicode, $byteslen, $hex, $charslen, $experr) =
28             ($1, $2, $3, $4, $5, $6, $7);
29         my @hex = split(/:/, $hex);
30         is(scalar @hex, $byteslen, 'Amount of hex tallies with byteslen');
31         my $octets = join '', map {chr hex $_} @hex;
32         is(length $octets, $byteslen, 'Number of octets tallies with byteslen');
33         if ($okay eq 'y') {
34             my @chars = map {hex $_} split ',', $Unicode;
35             is(scalar @chars, $charslen, 'Amount of hex tallies with charslen');
36             my @got;
37             warning_is(sub {@got = unpack 'C0U*', $octets}, undef,
38                        "No warnings expected for $id");
39             is("@got", "@chars", 'Got expected Unicode characters');
40         } elsif ($okay eq 'n') {
41             isnt($experr, '', "Expected warning for $id provided");
42             warnings_like(sub {unpack 'C0U*', $octets}, [qr/$experr/],
43                          "Only expected warning for $id");
44         } elsif ($okay !~ /^N(-?\d+)/) {
45             is($okay, 'n', "Confused test description for $id");
46         } else {
47             my $expect = $1;
48             my @warnings;
49
50             {
51                 local $SIG{__WARN__} = sub {
52                     print "# $id: @_";
53                     push @warnings, "@_";
54                 };
55                 unpack 'C0U*', $octets;
56             }
57
58             isnt($experr, '', "Expected first warning for $id provided");
59             like($warnings[0], qr/$experr/, "Expected first warning for $id seen");
60             local $::TODO;
61             if ($expect < 0) {
62                 $expect = -$expect;
63                 $::TODO = "Markus Kuhn states that $expect invalid sequences should be signalled";
64             }
65             is(scalar @warnings, $expect, "Expected number of warnings for $id seen");
66         }
67     } else {
68         fail("unknown format '$_'");
69     }
70 }
71
72 done_testing();
73
74 # This table is based on Markus Kuhn's UTF-8 Decode Stress Tester,
75 # http://www.cl.cam.ac.uk/~mgk25/ucs/examples/UTF-8-test.txt,
76 # version dated 2000-09-02.
77
78 __DATA__
79 1       Correct UTF-8
80 1.1.1 y 3ba,1f79,3c3,3bc,3b5    11      ce:ba:e1:bd:b9:cf:83:ce:bc:ce:b5        5
81 2       Boundary conditions
82 2.1     First possible sequence of certain length
83 2.1.1 y 0               1       00      1
84 2.1.2 y 80              2       c2:80   1
85 2.1.3 y 800             3       e0:a0:80        1
86 2.1.4 y 10000           4       f0:90:80:80     1
87 2.1.5 y 200000          5       f8:88:80:80:80  1
88 2.1.6 y 4000000         6       fc:84:80:80:80:80       1
89 2.2     Last possible sequence of certain length
90 2.2.1 y 7f              1       7f      1
91 2.2.2 y 7ff             2       df:bf   1
92 # The ffff is legal by default since 872c91ae155f6880
93 2.2.3 y ffff            3       ef:bf:bf        1       character 0xffff
94 2.2.4 y 1fffff          4       f7:bf:bf:bf     1
95 2.2.5 y 3ffffff         5       fb:bf:bf:bf:bf  1
96 2.2.6 y 7fffffff        6       fd:bf:bf:bf:bf:bf       1
97 2.3     Other boundary conditions
98 2.3.1 y d7ff            3       ed:9f:bf        1
99 2.3.2 y e000            3       ee:80:80        1
100 2.3.3 y fffd            3       ef:bf:bd        1
101 2.3.4 y 10ffff          4       f4:8f:bf:bf     1
102 2.3.5 y 110000          4       f4:90:80:80     1
103 3       Malformed sequences
104 3.1     Unexpected continuation bytes
105 3.1.1 n -               1       80      -       unexpected continuation byte 0x80
106 3.1.2 n -               1       bf      -       unexpected continuation byte 0xbf
107 3.1.3 N2 -              2       80:bf   -       unexpected continuation byte 0x80
108 3.1.4 N3 -              3       80:bf:80        -       unexpected continuation byte 0x80
109 3.1.5 N4 -              4       80:bf:80:bf     -       unexpected continuation byte 0x80
110 3.1.6 N5 -              5       80:bf:80:bf:80  -       unexpected continuation byte 0x80
111 3.1.7 N6 -              6       80:bf:80:bf:80:bf       -       unexpected continuation byte 0x80
112 3.1.8 N7 -              7       80:bf:80:bf:80:bf:80    -       unexpected continuation byte 0x80
113 3.1.9 N64 -     64      80:81:82:83:84:85:86:87:88:89:8a:8b:8c:8d:8e:8f:90:91:92:93:94:95:96:97:98:99:9a:9b:9c:9d:9e:9f:a0:a1:a2:a3:a4:a5:a6:a7:a8:a9:aa:ab:ac:ad:ae:af:b0:b1:b2:b3:b4:b5:b6:b7:b8:b9:ba:bb:bc:bd:be:bf -       unexpected continuation byte 0x80
114 3.2     Lonely start characters
115 3.2.1 N32 -     64      c0:20:c1:20:c2:20:c3:20:c4:20:c5:20:c6:20:c7:20:c8:20:c9:20:ca:20:cb:20:cc:20:cd:20:ce:20:cf:20:d0:20:d1:20:d2:20:d3:20:d4:20:d5:20:d6:20:d7:20:d8:20:d9:20:da:20:db:20:dc:20:dd:20:de:20:df:20 -       unexpected non-continuation byte 0x20, immediately after start byte 0xc0
116 3.2.2 N16 -     32      e0:20:e1:20:e2:20:e3:20:e4:20:e5:20:e6:20:e7:20:e8:20:e9:20:ea:20:eb:20:ec:20:ed:20:ee:20:ef:20 -       unexpected non-continuation byte 0x20, immediately after start byte 0xe0
117 3.2.3 N8 -      16      f0:20:f1:20:f2:20:f3:20:f4:20:f5:20:f6:20:f7:20 -       unexpected non-continuation byte 0x20, immediately after start byte 0xf0
118 3.2.4 N4 -      8       f8:20:f9:20:fa:20:fb:20 -       unexpected non-continuation byte 0x20, immediately after start byte 0xf8
119 3.2.5 N2 -      4       fc:20:fd:20     -       unexpected non-continuation byte 0x20, immediately after start byte 0xfc
120 3.3     Sequences with last continuation byte missing
121 3.3.1 n -       1       c0      -       1 byte, need 2
122 3.3.2 n -       2       e0:80   -       2 bytes, need 3
123 3.3.3 n -       3       f0:80:80        -       3 bytes, need 4
124 3.3.4 n -       4       f8:80:80:80     -       4 bytes, need 5
125 3.3.5 n -       5       fc:80:80:80:80  -       5 bytes, need 6
126 3.3.6 n -       1       df      -       1 byte, need 2
127 3.3.7 n -       2       ef:bf   -       2 bytes, need 3
128 3.3.8 n -       3       f7:bf:bf        -       3 bytes, need 4
129 3.3.9 n -       4       fb:bf:bf:bf     -       4 bytes, need 5
130 3.3.10 n -      5       fd:bf:bf:bf:bf  -       5 bytes, need 6
131 3.4     Concatenation of incomplete sequences
132 3.4.1 N-10 -    30      c0:e0:80:f0:80:80:f8:80:80:80:fc:80:80:80:80:df:ef:bf:f7:bf:bf:fb:bf:bf:bf:fd:bf:bf:bf:bf       -       unexpected non-continuation byte 0xe0, immediately after start byte 0xc0
133 3.5     Impossible bytes
134 3.5.1 n -       1       fe      -       byte 0xfe
135 3.5.2 n -       1       ff      -       byte 0xff
136 3.5.3 N4 -      4       fe:fe:ff:ff     -       byte 0xfe
137 4       Overlong sequences
138 4.1     Examples of an overlong ASCII character
139 4.1.1 n -       2       c0:af   -       2 bytes, need 1
140 4.1.2 n -       3       e0:80:af        -       3 bytes, need 1
141 4.1.3 n -       4       f0:80:80:af     -       4 bytes, need 1
142 4.1.4 n -       5       f8:80:80:80:af  -       5 bytes, need 1
143 4.1.5 n -       6       fc:80:80:80:80:af       -       6 bytes, need 1
144 4.2     Maximum overlong sequences
145 4.2.1 n -       2       c1:bf   -       2 bytes, need 1
146 4.2.2 n -       3       e0:9f:bf        -       3 bytes, need 2
147 4.2.3 n -       4       f0:8f:bf:bf     -       4 bytes, need 3
148 4.2.4 n -       5       f8:87:bf:bf:bf  -       5 bytes, need 4
149 4.2.5 n -       6       fc:83:bf:bf:bf:bf       -       6 bytes, need 5
150 4.3     Overlong representation of the NUL character
151 4.3.1 n -       2       c0:80   -       2 bytes, need 1
152 4.3.2 n -       3       e0:80:80        -       3 bytes, need 1
153 4.3.3 n -       4       f0:80:80:80     -       4 bytes, need 1
154 4.3.4 n -       5       f8:80:80:80:80  -       5 bytes, need 1
155 4.3.5 n -       6       fc:80:80:80:80:80       -       6 bytes, need 1
156 5       Illegal code positions
157 5.1     Single UTF-16 surrogates
158 5.1.1 y d800    3       ed:a0:80        1       UTF-16 surrogate 0xd800
159 5.1.2 y db7f    3       ed:ad:bf        1       UTF-16 surrogate 0xdb7f
160 5.1.3 y db80    3       ed:ae:80        1       UTF-16 surrogate 0xdb80
161 5.1.4 y dbff    3       ed:af:bf        1       UTF-16 surrogate 0xdbff
162 5.1.5 y dc00    3       ed:b0:80        1       UTF-16 surrogate 0xdc00
163 5.1.6 y df80    3       ed:be:80        1       UTF-16 surrogate 0xdf80
164 5.1.7 y dfff    3       ed:bf:bf        1       UTF-16 surrogate 0xdfff
165 5.2     Paired UTF-16 surrogates
166 5.2.1 y d800,dc00       6       ed:a0:80:ed:b0:80       2       UTF-16 surrogates 0xd800, dc00
167 5.2.2 y d800,dfff       6       ed:a0:80:ed:bf:bf       2       UTF-16 surrogates 0xd800, dfff
168 5.2.3 y db7f,dc00       6       ed:ad:bf:ed:b0:80       2       UTF-16 surrogates 0xdb7f, dc00
169 5.2.4 y db7f,dfff       6       ed:ad:bf:ed:bf:bf       2       UTF-16 surrogates 0xdb7f, dfff
170 5.2.5 y db80,dc00       6       ed:ae:80:ed:b0:80       2       UTF-16 surrogates 0xdb80, dc00
171 5.2.6 y db80,dfff       6       ed:ae:80:ed:bf:bf       2       UTF-16 surrogates 0xdb80, dfff
172 5.2.7 y dbff,dc00       6       ed:af:bf:ed:b0:80       2       UTF-16 surrogates 0xdbff, dc00
173 5.2.8 y dbff,dfff       6       ed:af:bf:ed:bf:bf       2       UTF-16 surrogates 0xdbff, dfff
174 5.3     Other illegal code positions
175 5.3.1 y fffe    3       ef:bf:be        1       byte order mark 0xfffe
176 # The ffff is legal by default since 872c91ae155f6880
177 5.3.2 y ffff    3       ef:bf:bf        1       character 0xffff