X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/2af1ab88da52f38a7450a6455bc28aa93c8e4e57..ebf06983127fdec6e5f31c7ecc2d3a3ac991cfa2:/lib/utf8.pm diff --git a/lib/utf8.pm b/lib/utf8.pm index 986d577..607c59d 100644 --- a/lib/utf8.pm +++ b/lib/utf8.pm @@ -2,11 +2,10 @@ package utf8; $utf8::hint_bits = 0x00800000; -our $VERSION = '1.01'; +our $VERSION = '1.22'; sub import { $^H |= $utf8::hint_bits; - $enc{caller()} = $_[1] if $_[1]; } sub unimport { @@ -14,8 +13,8 @@ sub unimport { } sub AUTOLOAD { - require "utf8_heavy.pl"; goto &$AUTOLOAD if defined &$AUTOLOAD; + require Carp; Carp::croak("Undefined subroutine $AUTOLOAD called"); } @@ -28,25 +27,54 @@ 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 C pragma tells the Perl parser to allow UTF-8 in the -program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based -platforms). The C pragma tells Perl to switch back to treating -the source text as literal bytes in the current lexical scope. - -This pragma is primarily a compatibility device. Perl versions -earlier than 5.6 allowed arbitrary bytes in source code, whereas -in future we would like to standardize on the UTF-8 encoding for -source text. Until UTF-8 becomes the default format for source -text, this pragma should be used to recognize UTF-8 in the source. +program text in the current lexical scope. The C 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 The utility functions described below are +directly usable without C. + +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, to instruct perl. + When UTF-8 becomes the standard source format, this pragma will -effectively become a no-op. For convenience in what follows the -term I is used to refer to UTF-8 on ASCII and ISO Latin based -platforms and UTF-EBCDIC on EBCDIC based platforms. +effectively become a no-op. + +See also the effects of the C<-C> switch and its cousin, the +C environment variable, in L. Enabling the C pragma has the following effect: @@ -54,107 +82,205 @@ Enabling the C pragma has the following effect: =item * -Bytes in the source text that have their high-bit set will be treated -as being part of a literal UTF-8 character. This includes most +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. -On EBCDIC platforms characters in the Latin 1 character set are -treated as being part of a literal UTF-EBCDIC character. - =back -Note that if you have bytes with the eighth bit on in your script -(for example embedded Latin-1 in your string literals), C -will be unhappy since the bytes are most probably not well-formed -UTF-8. If you want to have such bytes and use utf8, you can disable -utf8 until the end the block (or file, if at top level) by C. +Note that if you have non-ASCII, non-UTF-8 bytes in your script (for example +embedded Latin-1 in your string literals), C will be unhappy. If +you want to have such bytes under C, you can disable this pragma +until the end the block (or file, if at top level) by C. =head2 Utility functions The following functions are defined in the C package by the Perl core. You do not need to say C to use these and in fact -you should not unless you really want to have UTF-8 source code. +you should not say that unless you really want to have UTF-8 source code. =over 4 -=item * $num_octets = utf8::upgrade($string); +=item * C<$num_octets = utf8::upgrade($string)> + +(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. + +If your code needs to be compatible with versions of perl without +C, you can force Unicode semantics on +a given string: + + # force unicode semantics for $string without the + # "unicode_strings" feature + utf8::upgrade($string); + +For example: + + # 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" + +B; +use L instead. + +=item * C<$success = utf8::downgrade($string[, $fail_ok])> + +(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. + +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. + +Returns true on success. -Converts (in-place) internal representation of string to Perl's -internal I form. Returns the number of octets necessary to -represent the string as I. Can be used to make sure that the -UTF-8 flag is on, so that C<\w> or C work as expected on strings -containing characters in the range 0x80-0xFF (oon ASCII and -derivatives). Note that this should not be used to convert a legacy -byte encoding to Unicode: use Encode for that. Affected by the -encoding pragma. +If your code expects an octet sequence this can be used to validate +that you've received one: -=item * utf8::downgrade($string[, FAIL_OK]) + # throw an exception if not representable as octets + utf8::downgrade($string) -Converts (in-place) internal representation of string to be un-encoded -bytes. Returns true on success. On failure dies or, if the value of -FAIL_OK is true, returns false. 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. -Note that this should not be used to convert Unicode back to a legacy -byte encoding: use Encode for that. B affected by the encoding -pragma. + # or do your own error handling + utf8::downgrade($string, 1) or die "string must be octets"; -=item * utf8::encode($string) +B; +use L instead. -Converts (in-place) I<$string> from logical characters to octet -sequence representing it in Perl's I encoding. Returns -nothing. Same as Encode::encode_utf8(). Note that this should not be -used to convert a legacy byte encoding to Unicode: use Encode for -that. +=item * C -=item * $flag = utf8::decode($string) +(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. -Attempts to convert I<$string> in-place from Perl's I encoding -into logical characters. Returns nothing. Same as Encode::decode_utf8(). -Note that this should not be used to convert Unicode back to a legacy -byte encoding: use Encode for that. + 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. -=item * $flag = utf8::is_utf8(STRING) +Similar to: -Test whether STRING is in UTF-8. Same as Encode::is_utf8(). + use Encode; + $x = Encode::encode("utf8", $x); -=item * $flag = utf8::valid(STRING) +B; +use L instead. -[INTERNAL] Test whether STRING is in a consistent state regarding -UTF-8. Will return true is well-formed UTF-8 and has the UTF-8 flag -on B if string is held as bytes (both these states are 'consistent'). -Main reason for this routine is to allow Perl's testsuite to check -that operations have left strings in a consistent state. You most -probably want to use utf8::is_utf8() 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; +use L 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, 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. + +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. + +Typically only necessary for debugging and testing, if you need to +dump the internals of an SV, L 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 and +L. + +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 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 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 C is like C, but the UTF8 flag is -cleared. See L for more on the UTF8 flag and the C API -functions C, C, C, -and C, which are wrapped by the Perl functions +cleared. See L, and the C API +functions C>, +C>, C>, +and C>, which are wrapped by the Perl functions C, C, C and -C. Note that in the Perl 5.8.0 implementation the -functions utf8::is_utf8, utf8::valid, utf8::encode, utf8::decode, -utf8::upgrade, and utf8::downgrade are always available, without a -C statement-- this may change in future releases. +C. Also, the functions C, C, +C, C, C, and C are +actually internal, and thus always available, without a C +statement. =head1 BUGS -One can have Unicode in identifier names, but not in package/class or -subroutine names. While some limited functionality towards this does -exist as of Perl 5.8.0, that is more accidental than designed; use of -Unicode for the said purposes is unsupported. - -One reason of this unfinishedness is its (currently) inherent -unportability: since both package names and subroutine names may need -to be mapped to file and directory names, the Unicode capability of -the filesystem becomes important-- and there unfortunately aren't -portable answers. +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, L +L, L, L, L, L =cut