This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
t/charset_tools.pl: Avoid some work on ASCII platforms
[perl5.git] / t / charset_tools.pl
CommitLineData
173ee337
KW
1# Tools to aid testing across platforms with different character sets.
2
3$::IS_ASCII = ord 'A' == 65;
4$::IS_EBCDIC = ord 'A' == 193;
5
6# The following functions allow tests to work on both EBCDIC and ASCII-ish
7# platforms. They convert string scalars between the native character set and
8# the set of 256 characters which is usually called Latin1. However, they
9# will work properly with any character input, not just Latin1.
10
84d8fb58
KW
11*native_to_uni = ($::IS_ASCII)
12 ? sub { return shift }
13 : sub {
173ee337
KW
14 my $string = shift;
15
173ee337
KW
16 my $output = "";
17 for my $i (0 .. length($string) - 1) {
18 $output .= chr(utf8::native_to_unicode(ord(substr($string, $i, 1))));
19 }
20 # Preserve utf8ness of input onto the output, even if it didn't need to be
21 # utf8
22 utf8::upgrade($output) if utf8::is_utf8($string);
23
24 return $output;
84d8fb58 25};
173ee337 26
84d8fb58
KW
27*uni_to_native = ($::IS_ASCII)
28 ? sub { return shift }
29 : sub {
173ee337
KW
30 my $string = shift;
31
173ee337
KW
32 my $output = "";
33 for my $i (0 .. length($string) - 1) {
98c62be8 34 $output .= chr(utf8::unicode_to_native(ord(substr($string, $i, 1))));
173ee337
KW
35 }
36 # Preserve utf8ness of input onto the output, even if it didn't need to be
37 # utf8
38 utf8::upgrade($output) if utf8::is_utf8($string);
39
40 return $output;
84d8fb58 41};
173ee337 42
84d8fb58 43my @utf8_skip;
173ee337 44
84d8fb58
KW
45if ($::IS_EBCDIC) {
46 @utf8_skip = (
47 # This translates a utf-8-encoded byte into how many bytes the full utf8
48 # character occupies.
173ee337 49
84d8fb58 50 # 0 1 2 3 4 5 6 7 8 9 A B C D E F
173ee337
KW
51 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 0
52 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 1
53 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 2
54 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 3
55 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 4
56 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 5
57 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 6
58 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, # 7
59 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, # 8
60 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, # 9
61 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, # A
62 -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, # B
63 -1,-1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, # C
64 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, # D
65 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, # E
66 4, 4, 4, 4, 4, 4, 4, 4, 5, 5, 5, 5, 6, 6, 7,13, # F
67 );
84d8fb58
KW
68}
69
70*byte_utf8a_to_utf8n = ($::IS_ASCII)
71 ? sub { return shift }
72 : sub {
73 # Convert a UTF-8 byte sequence into the platform's native UTF-8
74 # equivalent, currently only UTF-8 and UTF-EBCDIC.
173ee337
KW
75
76 my $string = shift;
77 die "Input to byte_utf8a-to_utf8n() must not be flagged UTF-8"
78 if utf8::is_utf8($string);
173ee337
KW
79 die "Expecting ASCII or EBCDIC" unless $::IS_EBCDIC;
80
81 my $length = length($string);
82 #diag($string);
83 #diag($length);
84 my $out = "";
85 for ($i = 0; $i < $length; $i++) {
86 my $byte = ord substr($string, $i, 1);
87 my $byte_count = $utf8_skip[$byte];
88 #diag($byte);
89 #diag($byte_count);
90
91 die "Illegal start byte" if $byte_count < 0;
92 if ($i + $byte_count > $length) {
93 die "Attempt to read " . $i + $byte_count - $length . " beyond end-of-string";
94 }
95
96 # Just translate UTF-8 invariants directly.
97 if ($byte_count == 1) {
98 $out .= chr utf8::unicode_to_native($byte);
99 next;
100 }
101
102 # Otherwise calculate the code point ordinal represented by the
103 # sequence beginning with this byte, using the algorithm adapted from
104 # utf8.c. We absorb each byte in the sequence as we go along
105 my $ord = $byte & (0x1F >> ($byte_count - 2));
106 my $bytes_remaining = $byte_count - 1;
107 while ($bytes_remaining > 0) {
108 $byte = ord substr($string, ++$i, 1);
109 unless (($byte & 0xC0) == 0x80) {
110 die sprintf "byte '%X' is not a valid continuation", $byte;
111 }
112 $ord = $ord << 6 | ($byte & 0x3f);
113 $bytes_remaining--;
114 }
115 #diag($byte);
116 #diag($ord);
117
118 my $expected_bytes = $ord < 0x80
119 ? 1
120 : $ord < 0x800
121 ? 2
122 : $ord < 0x10000
123 ? 3
124 : $ord < 0x200000
125 ? 4
126 : $ord < 0x4000000
127 ? 5
128 : $ord < 0x80000000
129 ? 6
130 : 7;
131 #: (uv) < UTF8_QUAD_MAX ? 7 : 13 )
132
133 # Make sure is not an overlong sequence
134 if ($byte_count != $expected_bytes) {
135 die sprintf "character U+%X should occupy %d bytes, not %d",
136 $ord, $expected_bytes, $byte_count;
137 }
138
139 # Now that we have found the code point the original UTF-8 meant, we
140 # use the native chr function to get its native string equivalent.
141 $out .= chr utf8::unicode_to_native($ord);
142 }
143
144 utf8::encode($out); # Turn off utf8 flag.
145 #diag($out);
146 return $out;
84d8fb58 147};
173ee337 148
5d4414ef
KW
149my @i8_to_native = ( # Only code page 1047 so far.
150# _0 _1 _2 _3 _4 _5 _6 _7 _8 _9 _A _B _C _D _E _F
1510x00,0x01,0x02,0x03,0x37,0x2D,0x2E,0x2F,0x16,0x05,0x15,0x0B,0x0C,0x0D,0x0E,0x0F,
1520x10,0x11,0x12,0x13,0x3C,0x3D,0x32,0x26,0x18,0x19,0x3F,0x27,0x1C,0x1D,0x1E,0x1F,
1530x40,0x5A,0x7F,0x7B,0x5B,0x6C,0x50,0x7D,0x4D,0x5D,0x5C,0x4E,0x6B,0x60,0x4B,0x61,
1540xF0,0xF1,0xF2,0xF3,0xF4,0xF5,0xF6,0xF7,0xF8,0xF9,0x7A,0x5E,0x4C,0x7E,0x6E,0x6F,
1550x7C,0xC1,0xC2,0xC3,0xC4,0xC5,0xC6,0xC7,0xC8,0xC9,0xD1,0xD2,0xD3,0xD4,0xD5,0xD6,
1560xD7,0xD8,0xD9,0xE2,0xE3,0xE4,0xE5,0xE6,0xE7,0xE8,0xE9,0xAD,0xE0,0xBD,0x5F,0x6D,
1570x79,0x81,0x82,0x83,0x84,0x85,0x86,0x87,0x88,0x89,0x91,0x92,0x93,0x94,0x95,0x96,
1580x97,0x98,0x99,0xA2,0xA3,0xA4,0xA5,0xA6,0xA7,0xA8,0xA9,0xC0,0x4F,0xD0,0xA1,0x07,
1590x20,0x21,0x22,0x23,0x24,0x25,0x06,0x17,0x28,0x29,0x2A,0x2B,0x2C,0x09,0x0A,0x1B,
1600x30,0x31,0x1A,0x33,0x34,0x35,0x36,0x08,0x38,0x39,0x3A,0x3B,0x04,0x14,0x3E,0xFF,
1610x41,0x42,0x43,0x44,0x45,0x46,0x47,0x48,0x49,0x4A,0x51,0x52,0x53,0x54,0x55,0x56,
1620x57,0x58,0x59,0x62,0x63,0x64,0x65,0x66,0x67,0x68,0x69,0x6A,0x70,0x71,0x72,0x73,
1630x74,0x75,0x76,0x77,0x78,0x80,0x8A,0x8B,0x8C,0x8D,0x8E,0x8F,0x90,0x9A,0x9B,0x9C,
1640x9D,0x9E,0x9F,0xA0,0xAA,0xAB,0xAC,0xAE,0xAF,0xB0,0xB1,0xB2,0xB3,0xB4,0xB5,0xB6,
1650xB7,0xB8,0xB9,0xBA,0xBB,0xBC,0xBE,0xBF,0xCA,0xCB,0xCC,0xCD,0xCE,0xCF,0xDA,0xDB,
1660xDC,0xDD,0xDE,0xDF,0xE1,0xEA,0xEB,0xEC,0xED,0xEE,0xEF,0xFA,0xFB,0xFC,0xFD,0xFE,
167);
168
169my @native_to_i8;
170for (my $i = 0; $i < 256; $i++) {
171 $native_to_i8[$i8_to_native[$i]] = $i;
172}
173
05d49a9a
KW
174# Use these to convert to/from UTF-8 bytes. I8 is the encoding that
175# corresponds to UTF-8 with start bytes, continuation bytes, and invariant
176# bytes. UTF-EBCDIC is derived from this by a mapping which causes things
177# like the start byte C5 to map to something else, as C5 is actually an 'E' in
178# EBCDIC so can't be a real start byte, as it must be an invariant; and it
179# maps 0x45 (an ASCII 'E') to C5.
5d4414ef
KW
180*I8_to_native = ($::IS_ASCII)
181 ? sub { return shift }
182 : sub { return join "", map { chr $i8_to_native[ord $_] }
183 split "", shift };
184*native_to_I8 = ($::IS_ASCII)
185 ? sub { return shift }
186 : sub { return join "", map { chr $native_to_i8[ord $_] }
187 split "", shift };
188
173ee337 1891