lib/utf8.pm

   1 package utf8;
   2
   3 $utf8::hint_bits = 0x00800000;
   4
   5 our $VERSION = '1.02';
   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     $num_octets = utf8::upgrade($string);
  35     $success    = utf8::downgrade($string[, FAIL_OK]);
  36
  37     utf8::encode($string);
  38     utf8::decode($string);
  39
  40     $flag = utf8::is_utf8(STRING); # since Perl 5.8.1
  41     $flag = utf8::valid(STRING);
  42
  43 =head1 DESCRIPTION
  44
  45 The C<use utf8> pragma tells the Perl parser to allow UTF-8 in the
  46 program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based
  47 platforms).  The C<no utf8> pragma tells Perl to switch back to treating
  48 the source text as literal bytes in the current lexical scope.
  49
  50 This pragma is primarily a compatibility device.  Perl versions
  51 earlier than 5.6 allowed arbitrary bytes in source code, whereas
  52 in future we would like to standardize on the UTF-8 encoding for
  53 source text.
  54
  55 B<Do not use this pragma for anything else than telling Perl that your
  56 script is written in UTF-8.> The utility functions described below are
  57 useful for their own purposes, but they are not really part of the
  58 "pragmatic" effect.
  59
  60 Until UTF-8 becomes the default format for source text, either this
  61 pragma or the L</encoding> pragma should be used to recognize UTF-8
  62 in the source.  When UTF-8 becomes the standard source format, this
  63 pragma will effectively become a no-op.  For convenience in what
  64 follows the term I<UTF-X> is used to refer to UTF-8 on ASCII and ISO
  65 Latin based platforms and UTF-EBCDIC on EBCDIC based platforms.
  66
  67 Enabling the C<utf8> pragma has the following effect:
  68
  69 =over 4
  70
  71 =item *
  72
  73 Bytes in the source text that have their high-bit set will be treated
  74 as being part of a literal UTF-8 character.  This includes most
  75 literals such as identifier names, string constants, and constant
  76 regular expression patterns.
  77
  78 On EBCDIC platforms characters in the Latin 1 character set are
  79 treated as being part of a literal UTF-EBCDIC character.
  80
  81 =back
  82
  83 Note that if you have bytes with the eighth bit on in your script
  84 (for example embedded Latin-1 in your string literals), C<use utf8>
  85 will be unhappy since the bytes are most probably not well-formed
  86 UTF-8.  If you want to have such bytes and use utf8, you can disable
  87 utf8 until the end the block (or file, if at top level) by C<no utf8;>.
  88
  89 If you want to automatically upgrade your 8-bit legacy bytes to UTF-8,
  90 use the L</encoding> pragma instead of this pragma.  For example, if
  91 you want to implicitly upgrade your ISO 8859-1 (Latin-1) bytes to UTF-8
  92 as used in e.g. C<chr()> and C<\x{...}>, try this:
  93
  94     use encoding "latin-1";
  95     my $c = chr(0xc4);
  96     my $x = "\x{c5}";
  97
  98 In case you are wondering: yes, C<use encoding 'utf8';> works much
  99 the same as C<use utf8;>.
 100
 101 =head2 Utility functions
 102
 103 The following functions are defined in the C<utf8::> package by the
 104 Perl core.  You do not need to say C<use utf8> to use these and in fact
 105 you should not say that  unless you really want to have UTF-8 source code.
 106
 107 =over 4
 108
 109 =item * $num_octets = utf8::upgrade($string)
 110
 111 Converts (in-place) internal representation of string to Perl's
 112 internal I<UTF-X> form.  Returns the number of octets necessary to
 113 represent the string as I<UTF-X>.  Can be used to make sure that the
 114 UTF-8 flag is on, so that C<\w> or C<lc()> work as expected on strings
 115 containing characters in the range 0x80-0xFF (oon ASCII and
 116 derivatives).  Note that this should not be used to convert a legacy
 117 byte encoding to Unicode: use Encode for that.  Affected by the
 118 encoding pragma.
 119
 120 =item * $success = utf8::downgrade($string[, FAIL_OK])
 121
 122 Converts (in-place) internal representation of string to be un-encoded
 123 bytes.  Returns true on success. On failure dies or, if the value of
 124 FAIL_OK is true, returns false.  Can be used to make sure that the
 125 UTF-8 flag is off, e.g. when you want to make sure that the substr()
 126 or length() function works with the usually faster byte algorithm.
 127 Note that this should not be used to convert Unicode back to a legacy
 128 byte encoding: use Encode for that.  B<Not> affected by the encoding
 129 pragma.
 130
 131 =item * utf8::encode($string)
 132
 133 Converts (in-place) I<$string> from logical characters to octet
 134 sequence representing it in Perl's I<UTF-X> encoding.  Returns
 135 nothing.  Same as Encode::encode_utf8(). Note that this should not be
 136 used to convert a legacy byte encoding to Unicode: use Encode for
 137 that.
 138
 139 =item * utf8::decode($string)
 140
 141 Attempts to convert I<$string> in-place from Perl's I<UTF-X> encoding
 142 into logical characters. Returns nothing.  Same as Encode::decode_utf8().
 143 Note that this should not be used to convert Unicode back to a legacy
 144 byte encoding: use Encode for that.
 145
 146 =item * $flag = utf8::is_utf8(STRING)
 147
 148 (Since Perl 5.8.1)  Test whether STRING is in UTF-8.  Functionally
 149 the same as Encode::is_utf8().
 150
 151 =item * $flag = utf8::valid(STRING)
 152
 153 [INTERNAL] Test whether STRING is in a consistent state regarding
 154 UTF-8.  Will return true is well-formed UTF-8 and has the UTF-8 flag
 155 on B<or> if string is held as bytes (both these states are 'consistent').
 156 Main reason for this routine is to allow Perl's testsuite to check
 157 that operations have left strings in a consistent state.  You most
 158 probably want to use utf8::is_utf8() instead.
 159
 160 =back
 161
 162 C<utf8::encode> is like C<utf8::upgrade>, but the UTF8 flag is
 163 cleared.  See L<perlunicode> for more on the UTF8 flag and the C API
 164 functions C<sv_utf8_upgrade>, C<sv_utf8_downgrade>, C<sv_utf8_encode>,
 165 and C<sv_utf8_decode>, which are wrapped by the Perl functions
 166 C<utf8::upgrade>, C<utf8::downgrade>, C<utf8::encode> and
 167 C<utf8::decode>.  Note that in the Perl 5.8.0 and 5.8.1 implementation
 168 the functions utf8::is_utf8, utf8::valid, utf8::encode, utf8::decode,
 169 utf8::upgrade, and utf8::downgrade are always available, without a
 170 C<require utf8> statement-- this may change in future releases.
 171
 172 =head1 BUGS
 173
 174 One can have Unicode in identifier names, but not in package/class or
 175 subroutine names.  While some limited functionality towards this does
 176 exist as of Perl 5.8.0, that is more accidental than designed; use of
 177 Unicode for the said purposes is unsupported.
 178
 179 One reason of this unfinishedness is its (currently) inherent
 180 unportability: since both package names and subroutine names may need
 181 to be mapped to file and directory names, the Unicode capability of
 182 the filesystem becomes important-- and there unfortunately aren't
 183 portable answers.
 184
 185 =head1 SEE ALSO
 186
 187 L<perluniintro>, L<encoding>, L<perlunicode>, L<bytes>
 188
 189 =cut