Commit | Line | Data |
---|---|---|
a0ed51b3 LW |
1 | package utf8; |
2 | ||
d5448623 GS |
3 | $utf8::hint_bits = 0x00800000; |
4 | ||
b75c8c73 MS |
5 | our $VERSION = '1.00'; |
6 | ||
a0ed51b3 | 7 | sub import { |
d5448623 | 8 | $^H |= $utf8::hint_bits; |
a0ed51b3 LW |
9 | $enc{caller()} = $_[1] if $_[1]; |
10 | } | |
11 | ||
12 | sub unimport { | |
d5448623 | 13 | $^H &= ~$utf8::hint_bits; |
a0ed51b3 LW |
14 | } |
15 | ||
16 | sub AUTOLOAD { | |
17 | require "utf8_heavy.pl"; | |
daf4d4ea SC |
18 | goto &$AUTOLOAD if defined &$AUTOLOAD; |
19 | Carp::croak("Undefined subroutine $AUTOLOAD called"); | |
a0ed51b3 LW |
20 | } |
21 | ||
22 | 1; | |
23 | __END__ | |
24 | ||
25 | =head1 NAME | |
26 | ||
b3419ed8 | 27 | utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code |
a0ed51b3 LW |
28 | |
29 | =head1 SYNOPSIS | |
30 | ||
31 | use utf8; | |
32 | no utf8; | |
33 | ||
34 | =head1 DESCRIPTION | |
35 | ||
393fec97 | 36 | The C<use utf8> pragma tells the Perl parser to allow UTF-8 in the |
b3419ed8 PK |
37 | program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based |
38 | platforms). The C<no utf8> pragma tells Perl to switch back to treating | |
39 | the source text as literal bytes in the current lexical scope. | |
a0ed51b3 | 40 | |
393fec97 GS |
41 | This pragma is primarily a compatibility device. Perl versions |
42 | earlier than 5.6 allowed arbitrary bytes in source code, whereas | |
43 | in future we would like to standardize on the UTF-8 encoding for | |
44 | source text. Until UTF-8 becomes the default format for source | |
45 | text, this pragma should be used to recognize UTF-8 in the source. | |
46 | When UTF-8 becomes the standard source format, this pragma will | |
b3419ed8 | 47 | effectively become a no-op. For convenience in what follows the |
ad0029c4 | 48 | term I<UTF-X> is used to refer to UTF-8 on ASCII and ISO Latin based |
b3419ed8 | 49 | platforms and UTF-EBCDIC on EBCDIC based platforms. |
a0ed51b3 | 50 | |
ad0029c4 | 51 | Enabling the C<utf8> pragma has the following effect: |
a0ed51b3 | 52 | |
4ac9195f | 53 | =over 4 |
a0ed51b3 LW |
54 | |
55 | =item * | |
56 | ||
393fec97 | 57 | Bytes in the source text that have their high-bit set will be treated |
ad0029c4 JH |
58 | as being part of a literal UTF-8 character. This includes most |
59 | literals such as identifiers, string constants, constant regular | |
60 | expression patterns and package names. On EBCDIC platforms characters | |
61 | in the Latin 1 character set are treated as being part of a literal | |
62 | UTF-EBCDIC character. | |
a0ed51b3 | 63 | |
4ac9195f MS |
64 | =back |
65 | ||
1b026014 NIS |
66 | =head2 Utility functions |
67 | ||
68 | The following functions are defined in the C<utf8::> package by the perl core. | |
69 | ||
70 | =over 4 | |
71 | ||
72 | =item * $num_octets = utf8::upgrade($string); | |
73 | ||
ad0029c4 JH |
74 | Converts internal representation of string to the Perl's internal |
75 | I<UTF-X> form. Returns the number of octets necessary to represent | |
76 | the string as I<UTF-X>. | |
1b026014 NIS |
77 | |
78 | =item * utf8::downgrade($string[, CHECK]) | |
79 | ||
80 | Converts internal representation of string to be un-encoded bytes. | |
81 | ||
82 | =item * utf8::encode($string) | |
83 | ||
84 | Converts (in-place) I<$string> from logical characters to octet sequence | |
ad0029c4 | 85 | representing it in Perl's I<UTF-X> encoding. |
1b026014 NIS |
86 | |
87 | =item * $flag = utf8::decode($string) | |
88 | ||
ad0029c4 JH |
89 | Attempts to convert I<$string> in-place from Perl's I<UTF-X> encoding |
90 | into logical characters. | |
1b026014 NIS |
91 | |
92 | =back | |
93 | ||
393fec97 | 94 | =head1 SEE ALSO |
a0ed51b3 | 95 | |
8058d7ab | 96 | L<perlunicode>, L<bytes> |
a0ed51b3 LW |
97 | |
98 | =cut |