lib/utf8.pm

   1 package utf8;
   2
   3 $utf8::hint_bits = 0x00800000;
   4
   5 our $VERSION = '1.00';
   6
   7 sub import {
   8     $^H |= $utf8::hint_bits;
   9     $enc{caller()} = $_[1] if $_[1];
  10 }
  11
  12 sub unimport {
  13     $^H &= ~$utf8::hint_bits;
  14 }
  15
  16 sub AUTOLOAD {
  17     require "utf8_heavy.pl";
  18     goto &$AUTOLOAD if defined &$AUTOLOAD;
  19     Carp::croak("Undefined subroutine $AUTOLOAD called");
  20 }
  21
  22 1;
  23 __END__
  24
  25 =head1 NAME
  26
  27 utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code
  28
  29 =head1 SYNOPSIS
  30
  31     use utf8;
  32     no utf8;
  33
  34 =head1 DESCRIPTION
  35
  36 The C<use utf8> pragma tells the Perl parser to allow UTF-8 in the
  37 program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based
  38 platforms).  The C<no utf8> pragma tells Perl to switch back to treating
  39 the source text as literal bytes in the current lexical scope.
  40
  41 This pragma is primarily a compatibility device.  Perl versions
  42 earlier than 5.6 allowed arbitrary bytes in source code, whereas
  43 in future we would like to standardize on the UTF-8 encoding for
  44 source text.  Until UTF-8 becomes the default format for source
  45 text, this pragma should be used to recognize UTF-8 in the source.
  46 When UTF-8 becomes the standard source format, this pragma will
  47 effectively become a no-op.  For convenience in what follows the
  48 term I<UTF-X> is used to refer to UTF-8 on ASCII and ISO Latin based
  49 platforms and UTF-EBCDIC on EBCDIC based platforms.
  50
  51 Enabling the C<utf8> pragma has the following effect:
  52
  53 =over 4
  54
  55 =item *
  56
  57 Bytes in the source text that have their high-bit set will be treated
  58 as being part of a literal UTF-8 character.  This includes most
  59 literals such as identifiers, string constants, constant regular
  60 expression patterns and package names.  On EBCDIC platforms characters
  61 in the Latin 1 character set are treated as being part of a literal
  62 UTF-EBCDIC character.
  63
  64 =back
  65
  66 Note that if you have bytes with the eighth bit on in your script
  67 (for example embedded Latin-1 in your string literals), C<use utf8>
  68 will be unhappy since the bytes are most probably not well-formed
  69 UTF-8.  If you want to have such bytes and use utf8, you can disable
  70 utf8 until the end the block (or file, if at top level) by C<no utf8;>.
  71
  72 =head2 Utility functions
  73
  74 The following functions are defined in the C<utf8::> package by the perl core.
  75
  76 =over 4
  77
  78 =item * $num_octets = utf8::upgrade($string);
  79
  80 Converts internal representation of string to the Perl's internal
  81 I<UTF-X> form.  Returns the number of octets necessary to represent
  82 the string as I<UTF-X>.  Note that this should not be used to convert
  83 a legacy byte encoding to Unicode: use Encode for that.  Affected
  84 by the encoding pragma.
  85
  86 =item * utf8::downgrade($string[, CHECK])
  87
  88 Converts internal representation of string to be un-encoded bytes.
  89 Note that this should not be used to convert Unicode back to a legacy
  90 byte encoding: use Encode for that.  B<Not> affected by the encoding
  91 pragma.
  92
  93 =item * utf8::encode($string)
  94
  95 Converts (in-place) I<$string> from logical characters to octet
  96 sequence representing it in Perl's I<UTF-X> encoding.  Note that this
  97 should not be used to convert a legacy byte encoding to Unicode: use
  98 Encode for that.
  99
 100 =item * $flag = utf8::decode($string)
 101
 102 Attempts to convert I<$string> in-place from Perl's I<UTF-X> encoding
 103 into logical characters.  Note that this should not be used to convert
 104 Unicode back to a legacy byte encoding: use Encode for that.
 105
 106 =back
 107
 108 C<utf8::encode> is like C<utf8::upgrade>, but the UTF8 flag is cleared.
 109 See L<perlunicode> for more on the UTF8 flag and the C API functions
 110 C<sv_utf8_upgrade>, C<sv_utf8_downgrade>, C<sv_utf8_encode>,
 111 and C<sv_utf8_decode>, which are wrapped by the Perl functions
 112 C<utf8::upgrade>, C<utf8::downgrade>, C<utf8::encode> and
 113 C<utf8::decode>.
 114
 115 =head1 SEE ALSO
 116
 117 L<perlunicode>, L<bytes>
 118
 119 =cut