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