package utf8;
+$utf8::hint_bits = 0x00800000;
+
+our $VERSION = '1.22';
+
sub import {
- $^H |= 0x00000008;
- $enc{caller()} = $_[1] if $_[1];
+ $^H |= $utf8::hint_bits;
}
sub unimport {
- $^H &= ~0x00000008;
+ $^H &= ~$utf8::hint_bits;
}
sub AUTOLOAD {
- require "utf8_heavy.pl";
- goto &$AUTOLOAD;
+ goto &$AUTOLOAD if defined &$AUTOLOAD;
+ require Carp;
+ Carp::croak("Undefined subroutine $AUTOLOAD called");
}
1;
=head1 NAME
-utf8 - Perl pragma to turn on UTF-8 and Unicode support
+utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code
=head1 SYNOPSIS
- use utf8;
- no utf8;
+ use utf8;
+ no utf8;
+
+ # Convert the internal representation of a Perl scalar to/from UTF-8.
+
+ $num_octets = utf8::upgrade($string);
+ $success = utf8::downgrade($string[, $fail_ok]);
+
+ # Change each character of a Perl scalar to/from a series of
+ # characters that represent the UTF-8 bytes of each original character.
+
+ utf8::encode($string); # "\x{100}" becomes "\xc4\x80"
+ utf8::decode($string); # "\xc4\x80" becomes "\x{100}"
+
+ # Convert a code point from the platform native character set to
+ # Unicode, and vice-versa.
+ $unicode = utf8::native_to_unicode(ord('A')); # returns 65 on both
+ # ASCII and EBCDIC
+ # platforms
+ $native = utf8::unicode_to_native(65); # returns 65 on ASCII
+ # platforms; 193 on
+ # EBCDIC
+
+ $flag = utf8::is_utf8($string); # since Perl 5.8.1
+ $flag = utf8::valid($string);
=head1 DESCRIPTION
-The utf8 pragma tells Perl to use UTF-8 as its internal string
-representation for the rest of the enclosing block. (The "no utf8"
-pragma tells Perl to switch back to ordinary byte-oriented processing
-for the rest of the enclosing block.) Under utf8, many operations that
-formerly operated on bytes change to operating on characters. For
-ASCII data this makes no difference, because UTF-8 stores ASCII in
-single bytes, but for any character greater than C<chr(127)>, the
-character is stored in a sequence of two or more bytes, all of which
-have the high bit set. But by and large, the user need not worry about
-this, because the utf8 pragma hides it from the user. A character
-under utf8 is logically just a number ranging from 0 to 2**32 or so.
-Larger characters encode to longer sequences of bytes, but again, this
-is hidden.
-
-Use of the utf8 pragma has the following effects:
+The C<use utf8> pragma tells the Perl parser to allow UTF-8 in the
+program text in the current lexical scope. The C<no utf8> pragma tells Perl
+to switch back to treating the source text as literal bytes in the current
+lexical scope. (On EBCDIC platforms, technically it is allowing UTF-EBCDIC,
+and not UTF-8, but this distinction is academic, so in this document the term
+UTF-8 is used to mean both).
+
+B<Do not use this pragma for anything else than telling Perl that your
+script is written in UTF-8.> The utility functions described below are
+directly usable without C<use utf8;>.
+
+Because it is not possible to reliably tell UTF-8 from native 8 bit
+encodings, you need either a Byte Order Mark at the beginning of your
+source code, or C<use utf8;>, to instruct perl.
+
+When UTF-8 becomes the standard source format, this pragma will
+effectively become a no-op.
+
+See also the effects of the C<-C> switch and its cousin, the
+C<PERL_UNICODE> environment variable, in L<perlrun>.
+
+Enabling the C<utf8> pragma has the following effect:
=over 4
=item *
-Strings and patterns may contain characters that have an ordinal value
-larger than 255. Presuming you use a Unicode editor to edit your
-program, these will typically occur directly within the literal strings
-as UTF-8 characters, but you can also specify a particular character
-with an extension of the C<\x> notation. UTF-8 characters are
-specified by putting the hexidecimal code within curlies after the
-C<\x>. For instance, a Unicode smiley face is C<\x{263A}>. A
-character in the Latin-1 range (128..255) should be written C<\x{ab}>
-rather than C<\xab>, since the former will turn into a two-byte UTF-8
-code, while the latter will continue to be interpreted as generating a
-8-bit byte rather than a character. In fact, if -w is turned on, it will
-produce a warning that you might be generating invalid UTF-8.
+Bytes in the source text that are not in the ASCII character set will be
+treated as being part of a literal UTF-8 sequence. This includes most
+literals such as identifier names, string constants, and constant
+regular expression patterns.
-=item *
+=back
-Identifiers within the Perl script may contain Unicode alphanumeric
-characters, including ideographs. (You are currently on your own when
-it comes to using the canonical forms of characters--Perl doesn't (yet)
-attempt to canonicalize variable names for you.)
+Note that if you have non-ASCII, non-UTF-8 bytes in your script (for example
+embedded Latin-1 in your string literals), C<use utf8> will be unhappy. If
+you want to have such bytes under C<use utf8>, you can disable this pragma
+until the end the block (or file, if at top level) by C<no utf8;>.
-=item *
+=head2 Utility functions
-Regular expressions match characters instead of bytes. For instance,
-"." matches a character instead of a byte. (However, the C<\C> pattern
-is provided to force a match a single byte ("C<char>" in C, hence
-C<\C>).)
+The following functions are defined in the C<utf8::> package by the
+Perl core. You do not need to say C<use utf8> to use these and in fact
+you should not say that unless you really want to have UTF-8 source code.
-=item *
+=over 4
-Character classes in regular expressions match characters instead of
-bytes, and match against the character properties specified in the
-Unicode properties database. So C<\w> can be used to match an ideograph,
-for instance.
+=item * C<$num_octets = utf8::upgrade($string)>
-=item *
+(Since Perl v5.8.0)
+Converts in-place the internal representation of the string from an octet
+sequence in the native encoding (Latin-1 or EBCDIC) to UTF-8. The
+logical character sequence itself is unchanged. If I<$string> is already
+upgraded, then this is a no-op. Returns the
+number of octets necessary to represent the string as UTF-8.
-Named Unicode properties and block ranges make be used as character
-classes via the new C<\p{}> (matches property) and C<\P{}> (doesn't
-match property) constructs. For instance, C<\p{Lu}> matches any
-character with the Unicode uppercase property, while C<\p{M}> matches
-any mark character. Single letter properties may omit the brackets, so
-that can be written C<\pM> also. Many predefined character classes are
-available, such as C<\p{IsMirrored}> and C<\p{InTibetan}>.
+If your code needs to be compatible with versions of perl without
+C<use feature 'unicode_strings';>, you can force Unicode semantics on
+a given string:
-=item *
+ # force unicode semantics for $string without the
+ # "unicode_strings" feature
+ utf8::upgrade($string);
-The special pattern C<\X> match matches any extended Unicode sequence
-(a "combining character sequence" in Standardese), where the first
-character is a base character and subsequent characters are mark
-characters that apply to the base character. It is equivalent to
-C<(?:\pM\PM*)>.
+For example:
-=item *
+ # without explicit or implicit use feature 'unicode_strings'
+ my $x = "\xDF"; # LATIN SMALL LETTER SHARP S
+ $x =~ /ss/i; # won't match
+ my $y = uc($x); # won't convert
+ utf8::upgrade($x);
+ $x =~ /ss/i; # matches
+ my $z = uc($x); # converts to "SS"
-The C<tr///> operator translates characters instead of bytes. It can also
-be forced to translate between 8-bit codes and UTF-8 regardless of the
-surrounding utf8 state. For instance, if you know your input in Latin-1,
-you can say:
+B<Note that this function does not handle arbitrary encodings>;
+use L<Encode> instead.
- use utf8;
- while (<>) {
- tr/\0-\xff//CU; # latin1 char to utf8
- ...
- }
+=item * C<$success = utf8::downgrade($string[, $fail_ok])>
-Similarly you could translate your output with
+(Since Perl v5.8.0)
+Converts in-place the internal representation of the string from UTF-8 to the
+equivalent octet sequence in the native encoding (Latin-1 or EBCDIC). The
+logical character sequence itself is unchanged. If I<$string> is already
+stored as native 8 bit, then this is a no-op. Can be used to make sure that
+the UTF-8 flag is off, e.g. when you want to make sure that the substr() or
+length() function works with the usually faster byte algorithm.
- tr/\0-\x{ff}//UC; # utf8 to latin1 char
+Fails if the original UTF-8 sequence cannot be represented in the
+native 8 bit encoding. On failure dies or, if the value of I<$fail_ok> is
+true, returns false.
-No, C<s///> doesn't take /U or /C (yet?).
+Returns true on success.
-=item *
+If your code expects an octet sequence this can be used to validate
+that you've received one:
-Case translation operators use the Unicode case translation tables.
-Note that C<uc()> translates to uppercase, while C<ucfirst> translates
-to titlecase (for languages that make the distinction). Naturally
-the corresponding backslash sequences have the same semantics.
+ # throw an exception if not representable as octets
+ utf8::downgrade($string)
-=item *
+ # or do your own error handling
+ utf8::downgrade($string, 1) or die "string must be octets";
-Most operators that deal with positions or lengths in the string will
-automatically switch to using character positions, including C<chop()>,
-C<substr()>, C<pos()>, C<index()>, C<rindex()>, C<sprintf()>,
-C<write()>, and C<length()>. Operators that specifically don't switch
-include C<vec()>, C<pack()>, and C<unpack()>. Operators that really
-don't care include C<chomp()>, as well as any other operator that
-treats a string as a bucket of bits, such as C<sort()>, and the
-operators dealing with filenames.
+B<Note that this function does not handle arbitrary encodings>;
+use L<Encode> instead.
-=item *
+=item * C<utf8::encode($string)>
-The C<pack()>/C<unpack()> letters "C<c>" and "C<C>" do I<not> change,
-since they're often used for byte-oriented formats. (Again, think
-"C<char>" in the C language.) However, there is a new "C<U>" specifier
-that will convert between UTF-8 characters and integers. (It works
-outside of the utf8 pragma too.)
+(Since Perl v5.8.0)
+Converts in-place the character sequence to the corresponding octet
+sequence in Perl's extended UTF-8. That is, every (possibly wide) character
+gets replaced with a sequence of one or more characters that represent the
+individual UTF-8 bytes of the character. The UTF8 flag is turned off.
+Returns nothing.
-=item *
+ my $x = "\x{100}"; # $x contains one character, with ord 0x100
+ utf8::encode($x); # $x contains two characters, with ords (on
+ # ASCII platforms) 0xc4 and 0x80. On EBCDIC
+ # 1047, this would instead be 0x8C and 0x41.
-The C<chr()> and C<ord()> functions work on characters. This is like
-C<pack("U")> and C<unpack("U")>, not like C<pack("C")> and
-C<unpack("C")>. In fact, the latter are how you now emulate
-byte-oriented C<chr()> and C<ord()> under utf8.
+Similar to:
-=item *
+ use Encode;
+ $x = Encode::encode("utf8", $x);
+
+B<Note that this function does not handle arbitrary encodings>;
+use L<Encode> instead.
+
+=item * C<$success = utf8::decode($string)>
+
+(Since Perl v5.8.0)
+Attempts to convert in-place the octet sequence encoded in Perl's extended
+UTF-8 to the corresponding character sequence. That is, it replaces each
+sequence of characters in the string whose ords represent a valid (extended)
+UTF-8 byte sequence, with the corresponding single character. The UTF-8 flag
+is turned on only if the source string contains multiple-byte UTF-8
+characters. If I<$string> is invalid as extended UTF-8, returns false;
+otherwise returns true.
+
+ my $x = "\xc4\x80"; # $x contains two characters, with ords
+ # 0xc4 and 0x80
+ utf8::decode($x); # On ASCII platforms, $x contains one char,
+ # with ord 0x100. Since these bytes aren't
+ # legal UTF-EBCDIC, on EBCDIC platforms, $x is
+ # unchanged and the function returns FALSE.
+
+B<Note that this function does not handle arbitrary encodings>;
+use L<Encode> instead.
+
+=item * C<$unicode = utf8::native_to_unicode($code_point)>
+
+(Since Perl v5.8.0)
+This takes an unsigned integer (which represents the ordinal number of a
+character (or a code point) on the platform the program is being run on) and
+returns its Unicode equivalent value. Since ASCII platforms natively use the
+Unicode code points, this function returns its input on them. On EBCDIC
+platforms it converts from EBCDIC to Unicode.
+
+A meaningless value will currently be returned if the input is not an unsigned
+integer.
+
+Since Perl v5.22.0, calls to this function are optimized out on ASCII
+platforms, so there is no performance hit in using it there.
+
+=item * C<$native = utf8::unicode_to_native($code_point)>
+
+(Since Perl v5.8.0)
+This is the inverse of C<utf8::native_to_unicode()>, converting the other
+direction. Again, on ASCII platforms, this returns its input, but on EBCDIC
+platforms it will find the native platform code point, given any Unicode one.
+
+A meaningless value will currently be returned if the input is not an unsigned
+integer.
-And finally, C<scalar reverse()> reverses by character rather than by byte.
+Since Perl v5.22.0, calls to this function are optimized out on ASCII
+platforms, so there is no performance hit in using it there.
+
+=item * C<$flag = utf8::is_utf8($string)>
+
+(Since Perl 5.8.1) Test whether I<$string> is marked internally as encoded in
+UTF-8. Functionally the same as C<Encode::is_utf8($string)>.
+
+Typically only necessary for debugging and testing, if you need to
+dump the internals of an SV, L<Devel::Peek's|Devel::Peek> Dump()
+provides more detail in a compact form.
+
+If you still think you need this outside of debugging, testing or
+dealing with filenames, you should probably read L<perlunitut> and
+L<perlunifaq/What is "the UTF8 flag"?>.
+
+Don't use this flag as a marker to distinguish character and binary
+data: that should be decided for each variable when you write your
+code.
+
+To force unicode semantics in code portable to perl 5.8 and 5.10, call
+C<utf8::upgrade($string)> unconditionally.
+
+=item * C<$flag = utf8::valid($string)>
+
+[INTERNAL] Test whether I<$string> is in a consistent state regarding
+UTF-8. Will return true if it is well-formed Perl extended UTF-8 and has the
+UTF-8 flag
+on B<or> if I<$string> is held as bytes (both these states are 'consistent').
+The main reason for this routine is to allow Perl's test suite to check
+that operations have left strings in a consistent state.
=back
-=head1 CAVEATS
-
-As of yet, there is no method for automatically coercing input and
-output to some encoding other than UTF-8. This is planned in the near
-future, however.
-
-In any event, you'll need to keep track of whether interfaces to other
-modules expect UTF-8 data or something else. The utf8 pragma does not
-magically mark strings for you in order to remember their encoding, nor
-will any automatic coercion happen (other than that eventually planned
-for I/O). If you want such automatic coercion, you can build yourself
-a set of pretty object-oriented modules. Expect it to run considerably
-slower than than this low-level support.
-
-Use of locales with utf8 may lead to odd results. Currently there is
-some attempt to apply 8-bit locale info to characters in the range
-0..255, but this is demonstrably incorrect for locales that use
-characters above that range (when mapped into Unicode). It will also
-tend to run slower. Avoidance of locales is strongly encouraged.
+C<utf8::encode> is like C<utf8::upgrade>, but the UTF8 flag is
+cleared. See L<perlunicode>, and the C API
+functions C<L<sv_utf8_upgrade|perlapi/sv_utf8_upgrade>>,
+C<L<perlapi/sv_utf8_downgrade>>, C<L<perlapi/sv_utf8_encode>>,
+and C<L<perlapi/sv_utf8_decode>>, which are wrapped by the Perl functions
+C<utf8::upgrade>, C<utf8::downgrade>, C<utf8::encode> and
+C<utf8::decode>. Also, the functions C<utf8::is_utf8>, C<utf8::valid>,
+C<utf8::encode>, C<utf8::decode>, C<utf8::upgrade>, and C<utf8::downgrade> are
+actually internal, and thus always available, without a C<require utf8>
+statement.
+
+=head1 BUGS
+
+Some filesystems may not support UTF-8 file names, or they may be supported
+incompatibly with Perl. Therefore UTF-8 names that are visible to the
+filesystem, such as module names may not work.
+
+=head1 SEE ALSO
+
+L<perlunitut>, L<perluniintro>, L<perlrun>, L<bytes>, L<perlunicode>
=cut
https://perl5.git.perl.org / perl5.git / blobdiff