$utf8::hint_bits = 0x00800000;
-our $VERSION = '1.12';
+our $VERSION = '1.14';
sub import {
$^H |= $utf8::hint_bits;
utf8::encode($string); # "\x{100}" becomes "\xc4\x80"
utf8::decode($string); # "\xc4\x80" becomes "\x{100}"
- $flag = utf8::is_utf8(STRING); # since Perl 5.8.1
- $flag = utf8::valid(STRING);
+ # 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
=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<UTF-X>. The
Therefore Encode is recommended for the general purposes; see also
L<Encode>.
-=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<UTF-X> to the equivalent octet sequence in the native encoding (Latin-1
byte algorithm.
Fails if the original I<UTF-X> sequence cannot be represented in the
-native 8 bit encoding. On failure dies or, if the value of C<$fail_ok> is
+native 8 bit encoding. On failure dies or, if the value of I<$fail_ok> is
true, returns false.
Returns true on success.
Therefore Encode is recommended for the general purposes; see also
L<Encode>.
-=item * utf8::encode($string)
+=item * C<utf8::encode($string)>
Converts in-place the character sequence to the corresponding octet
sequence in I<UTF-X>. That is, every (possibly wide) character gets
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<Note that this function does not handle arbitrary encodings.>
Therefore Encode is recommended for the general purposes; see also
L<Encode>.
-=item * $success = utf8::decode($string)
+=item * C<$success = utf8::decode($string)>
-Attempts to convert in-place the octet sequence in I<UTF-X> to the
+Attempts to convert in-place the octet sequence encoded as I<UTF-X> to the
corresponding character sequence. That is, it replaces each sequence of
characters in the string whose ords represent a valid UTF-X byte
sequence, with the corresponding single character. The UTF-8 flag is
characters. If I<$string> is invalid as I<UTF-X>, 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<Note that this function does not handle arbitrary encodings.>
Therefore Encode is recommended for the general purposes; see also
L<Encode>.
-=item * $flag = utf8::is_utf8(STRING)
+=item * C<$unicode = utf8::native_to_unicode($code_point)>
+
+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 EBCIDC to Unicode.
+
+A meaningless value will currently be returned if the input is not an unsigned
+integer.
+
+=item * C<$native = utf8::unicode_to_native($code_point)>
+
+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.
+
+=item * C<$flag = utf8::is_utf8($string)>
-(Since Perl 5.8.1) Test whether STRING is marked internally as encoded in
+(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 STRING is in a consistent state regarding
+[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
-on B<or> if STRING is held as bytes (both these states are 'consistent').
+on B<or> if I<$string> is held as bytes (both these states are 'consistent').
Main reason for this routine is to allow Perl's test suite to check
that operations have left strings in a consistent state. You most
probably want to use utf8::is_utf8() instead.
https://perl5.git.perl.org / perl5.git / blobdiff