Make the UTF-8 decoding stricter and more verbose when
[p5sagit/p5-mst-13.2.git] / pod / perlunicode.pod
1 =head1 NAME
2
3 perlunicode - Unicode support in Perl
4
5 =head1 DESCRIPTION
6
7 =head2 Important Caveat
8
9 WARNING: The implementation of Unicode support in Perl is incomplete.
10
11 The following areas need further work.
12
13 =over
14
15 =item Input and Output Disciplines
16
17 There is currently no easy way to mark data read from a file or other
18 external source as being utf8.  This will be one of the major areas of
19 focus in the near future.
20
21 =item Regular Expressions
22
23 The existing regular expression compiler does not produce polymorphic
24 opcodes.  This means that the determination on whether to match Unicode
25 characters is made when the pattern is compiled, based on whether the
26 pattern contains Unicode characters, and not when the matching happens
27 at run time.  This needs to be changed to adaptively match Unicode if
28 the string to be matched is Unicode.
29
30 =item C<use utf8> still needed to enable a few features
31
32 The C<utf8> pragma implements the tables used for Unicode support.  These
33 tables are automatically loaded on demand, so the C<utf8> pragma need not
34 normally be used.
35
36 However, as a compatibility measure, this pragma must be explicitly used
37 to enable recognition of UTF-8 encoded literals and identifiers in the
38 source text.
39
40 =back
41
42 =head2 Byte and Character semantics
43
44 Beginning with version 5.6, Perl uses logically wide characters to
45 represent strings internally.  This internal representation of strings
46 uses the UTF-8 encoding.
47
48 In future, Perl-level operations can be expected to work with characters
49 rather than bytes, in general.
50
51 However, as strictly an interim compatibility measure, Perl v5.6 aims to
52 provide a safe migration path from byte semantics to character semantics
53 for programs.  For operations where Perl can unambiguously decide that the
54 input data is characters, Perl now switches to character semantics.
55 For operations where this determination cannot be made without additional
56 information from the user, Perl decides in favor of compatibility, and
57 chooses to use byte semantics.
58
59 This behavior preserves compatibility with earlier versions of Perl,
60 which allowed byte semantics in Perl operations, but only as long as
61 none of the program's inputs are marked as being as source of Unicode
62 character data.  Such data may come from filehandles, from calls to
63 external programs, from information provided by the system (such as %ENV),
64 or from literals and constants in the source text.
65
66 If the C<-C> command line switch is used, (or the ${^WIDE_SYSTEM_CALLS}
67 global flag is set to C<1>), all system calls will use the
68 corresponding wide character APIs.  This is currently only implemented
69 on Windows.
70
71 Regardless of the above, the C<bytes> pragma can always be used to force
72 byte semantics in a particular lexical scope.  See L<bytes>.
73
74 One effect of the C<utf8> pragma is that the internal UTF-8 decoding
75 becomes stricter so that the character 0xFFFF (UTF-8 bytes 0xEF 0xBF
76 0xBF), and the bytes 0xFE and 0xFF, start to cause warnings if they
77 appear in the data.
78
79 The C<utf8> pragma is primarily a compatibility device that enables
80 recognition of UTF-8 in literals encountered by the parser.  It may also
81 be used for enabling some of the more experimental Unicode support features.
82 Note that this pragma is only required until a future version of Perl
83 in which character semantics will become the default.  This pragma may
84 then become a no-op.  See L<utf8>.
85
86 Unless mentioned otherwise, Perl operators will use character semantics
87 when they are dealing with Unicode data, and byte semantics otherwise.
88 Thus, character semantics for these operations apply transparently; if
89 the input data came from a Unicode source (for example, by adding a
90 character encoding discipline to the filehandle whence it came, or a
91 literal UTF-8 string constant in the program), character semantics
92 apply; otherwise, byte semantics are in effect.  To force byte semantics
93 on Unicode data, the C<bytes> pragma should be used.
94
95 Under character semantics, many operations that formerly operated on
96 bytes change to operating on characters.  For ASCII data this makes
97 no difference, because UTF-8 stores ASCII in single bytes, but for
98 any character greater than C<chr(127)>, the character may be stored in
99 a sequence of two or more bytes, all of which have the high bit set.
100 But by and large, the user need not worry about this, because Perl
101 hides it from the user.  A character in Perl is logically just a number
102 ranging from 0 to 2**32 or so.  Larger characters encode to longer
103 sequences of bytes internally, but again, this is just an internal
104 detail which is hidden at the Perl level.
105
106 =head2 Effects of character semantics
107
108 Character semantics have the following effects:
109
110 =over 4
111
112 =item *
113
114 Strings and patterns may contain characters that have an ordinal value
115 larger than 255.
116
117 Presuming you use a Unicode editor to edit your program, such characters
118 will typically occur directly within the literal strings as UTF-8
119 characters, but you can also specify a particular character with an
120 extension of the C<\x> notation.  UTF-8 characters are specified by
121 putting the hexadecimal code within curlies after the C<\x>.  For instance,
122 a Unicode smiley face is C<\x{263A}>.
123
124 =item *
125
126 Identifiers within the Perl script may contain Unicode alphanumeric
127 characters, including ideographs.  (You are currently on your own when
128 it comes to using the canonical forms of characters--Perl doesn't (yet)
129 attempt to canonicalize variable names for you.)
130
131 =item *
132
133 Regular expressions match characters instead of bytes.  For instance,
134 "." matches a character instead of a byte.  (However, the C<\C> pattern
135 is provided to force a match a single byte ("C<char>" in C, hence
136 C<\C>).)
137
138 =item *
139
140 Character classes in regular expressions match characters instead of
141 bytes, and match against the character properties specified in the
142 Unicode properties database.  So C<\w> can be used to match an ideograph,
143 for instance.
144
145 =item *
146
147 Named Unicode properties and block ranges make be used as character
148 classes via the new C<\p{}> (matches property) and C<\P{}> (doesn't
149 match property) constructs.  For instance, C<\p{Lu}> matches any
150 character with the Unicode uppercase property, while C<\p{M}> matches
151 any mark character.  Single letter properties may omit the brackets, so
152 that can be written C<\pM> also.  Many predefined character classes are
153 available, such as C<\p{IsMirrored}> and  C<\p{InTibetan}>.
154
155 =item *
156
157 The special pattern C<\X> match matches any extended Unicode sequence
158 (a "combining character sequence" in Standardese), where the first
159 character is a base character and subsequent characters are mark
160 characters that apply to the base character.  It is equivalent to
161 C<(?:\PM\pM*)>.
162
163 =item *
164
165 The C<tr///> operator translates characters instead of bytes.  Note
166 that the C<tr///CU> functionality has been removed, as the interface
167 was a mistake.  For similar functionality see pack('U0', ...) and
168 pack('C0', ...).
169
170 =item *
171
172 Case translation operators use the Unicode case translation tables
173 when provided character input.  Note that C<uc()> translates to
174 uppercase, while C<ucfirst> translates to titlecase (for languages
175 that make the distinction).  Naturally the corresponding backslash
176 sequences have the same semantics.
177
178 =item *
179
180 Most operators that deal with positions or lengths in the string will
181 automatically switch to using character positions, including C<chop()>,
182 C<substr()>, C<pos()>, C<index()>, C<rindex()>, C<sprintf()>,
183 C<write()>, and C<length()>.  Operators that specifically don't switch
184 include C<vec()>, C<pack()>, and C<unpack()>.  Operators that really
185 don't care include C<chomp()>, as well as any other operator that
186 treats a string as a bucket of bits, such as C<sort()>, and the
187 operators dealing with filenames.
188
189 =item *
190
191 The C<pack()>/C<unpack()> letters "C<c>" and "C<C>" do I<not> change,
192 since they're often used for byte-oriented formats.  (Again, think
193 "C<char>" in the C language.)  However, there is a new "C<U>" specifier
194 that will convert between UTF-8 characters and integers.  (It works
195 outside of the utf8 pragma too.)
196
197 =item *
198
199 The C<chr()> and C<ord()> functions work on characters.  This is like
200 C<pack("U")> and C<unpack("U")>, not like C<pack("C")> and
201 C<unpack("C")>.  In fact, the latter are how you now emulate
202 byte-oriented C<chr()> and C<ord()> under utf8.
203
204 =item *
205
206 And finally, C<scalar reverse()> reverses by character rather than by byte.
207
208 =back
209
210 =head2 Character encodings for input and output
211
212 [XXX: This feature is not yet implemented.]
213
214 =head1 CAVEATS
215
216 As of yet, there is no method for automatically coercing input and
217 output to some encoding other than UTF-8.  This is planned in the near
218 future, however.
219
220 Whether an arbitrary piece of data will be treated as "characters" or
221 "bytes" by internal operations cannot be divined at the current time.
222
223 Use of locales with utf8 may lead to odd results.  Currently there is
224 some attempt to apply 8-bit locale info to characters in the range
225 0..255, but this is demonstrably incorrect for locales that use
226 characters above that range (when mapped into Unicode).  It will also
227 tend to run slower.  Avoidance of locales is strongly encouraged.
228
229 =head1 SEE ALSO
230
231 L<bytes>, L<utf8>, L<perlvar/"${^WIDE_SYSTEM_CALLS}">
232
233 =cut