X-Git-Url: https://perl5.git.perl.org/perl5.git/blobdiff_plain/c8ed25e60b6d0e4fd15d63363ea2c1c0e3e129d1..f240c685c914970dc8ffec926f02d6048831bc09:/lib/utf8.pm diff --git a/lib/utf8.pm b/lib/utf8.pm index 43c7277..23fbfac 100644 --- a/lib/utf8.pm +++ b/lib/utf8.pm @@ -2,7 +2,7 @@ package utf8; $utf8::hint_bits = 0x00800000; -our $VERSION = '1.13'; +our $VERSION = '1.17'; sub import { $^H |= $utf8::hint_bits; @@ -42,6 +42,14 @@ utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code 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); @@ -66,7 +74,7 @@ I is used to refer to UTF-8 on ASCII and ISO Latin based platforms and UTF-EBCDIC on EBCDIC based platforms. See also the effects of the C<-C> switch and its cousin, the -C<$ENV{PERL_UNICODE}>, in L. +C environment variable, in L. Enabling the C pragma has the following effect: @@ -99,7 +107,7 @@ 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)> Converts in-place the internal representation of the string from an octet sequence in the native encoding (Latin-1 or EBCDIC) to I. The @@ -114,7 +122,7 @@ B Therefore Encode is recommended for the general purposes; see also L. -=item * $success = utf8::downgrade($string[, $fail_ok]) +=item * C<$success = utf8::downgrade($string[, $fail_ok])> Converts in-place the internal representation of the string from I to the equivalent octet sequence in the native encoding (Latin-1 @@ -135,7 +143,7 @@ B Therefore Encode is recommended for the general purposes; see also L. -=item * utf8::encode($string) +=item * C Converts in-place the character sequence to the corresponding octet sequence in I. That is, every (possibly wide) character gets @@ -144,14 +152,14 @@ individual I bytes of the character. The UTF8 flag is turned off. Returns nothing. my $a = "\x{100}"; # $a contains one character, with ord 0x100 - utf8::encode($a); # $a contains two characters, with ords 0xc4 and - # 0x80 + utf8::encode($a); # $a contains two characters, with ords (on + # ASCII platforms) 0xc4 and 0x80 B Therefore Encode is recommended for the general purposes; see also L. -=item * $success = utf8::decode($string) +=item * C<$success = utf8::decode($string)> Attempts to convert in-place the octet sequence encoded as I to the corresponding character sequence. That is, it replaces each sequence of @@ -161,20 +169,55 @@ turned on only if the source string contains multiple-byte I characters. If I<$string> is invalid as I, returns false; otherwise returns true. - my $a = "\xc4\x80"; # $a contains two characters, with ords - # 0xc4 and 0x80 - utf8::decode($a); # $a contains one character, with ord 0x100 + my $a = "\xc4\x80"; # $a contains two characters, with ords + # 0xc4 and 0x80 + utf8::decode($a); # On ASCII platforms, $a contains one char, + # with ord 0x100. On EBCDIC platforms, $a + # is unchanged and the function returns FALSE. + +(C<"\xc4\x80"> is not a valid sequence of bytes in any UTF-8-encoded +character(s) in the EBCDIC code pages that Perl supports, which is why the +above example returns failure on them. What does decode into C<\x{100}> +depends on the platform. It is C<"\x8C\x41"> in IBM-1047.) B Therefore Encode is recommended for the general purposes; see also L. -=item * $flag = utf8::is_utf8($string) +=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 Encode::is_utf8(). -=item * $flag = utf8::valid($string) +=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 UTF-8 and has the UTF-8 flag