Upgrade to Encode 2.00.
[p5sagit/p5-mst-13.2.git] / ext / Encode / lib / Encode / Guess.pm
index fc8d267..5692cee 100644 (file)
@@ -2,10 +2,10 @@ package Encode::Guess;
 use strict;
 
 use Encode qw(:fallbacks find_encoding);
-our $VERSION = do { my @r = (q$Revision: 1.8 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
+our $VERSION = do { my @r = (q$Revision: 2.0 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
 
 my $Canon = 'Guess';
-our $DEBUG = 0;
+sub DEBUG () { 0 }
 our %DEF_SUSPECTS = map { $_ => find_encoding($_) } qw(ascii utf8);
 $Encode::Encoding{$Canon} = 
     bless { 
@@ -18,6 +18,8 @@ sub needs_lines { 1 }
 sub perlio_ok { 0 }
 
 our @EXPORT = qw(guess_encoding);
+our $NoUTFAutoGuess = 0;
+our $UTF8_BOM = pack("C3", 0xef, 0xbb, 0xbf);
 
 sub import { # Exporter not used so we do it on our own
     my $callpkg = caller;
@@ -41,7 +43,7 @@ sub add_suspects{
     for my $c (@_){
        my $e = find_encoding($c) or die "Unknown encoding: $c";
        $self->{Suspects}{$e->name} = $e;
-       $DEBUG and warn "Added: ", $e->name;
+       DEBUG and warn "Added: ", $e->name;
     }
 }
 
@@ -70,75 +72,83 @@ sub guess {
     return unless defined $octet and length $octet;
 
     # cheat 0: utf8 flag;
-    Encode::is_utf8($octet) and return find_encoding('utf8');
+    if ( Encode::is_utf8($octet) ) {
+       return find_encoding('utf8') unless $NoUTFAutoGuess;
+       Encode::_utf8_off($octet);
+    }
     # cheat 1: BOM
     use Encode::Unicode;
-    my $BOM = unpack('n', $octet);
-    return find_encoding('UTF-16') 
-       if (defined $BOM and ($BOM == 0xFeFF or $BOM == 0xFFFe));
-    $BOM = unpack('N', $octet);
-    return find_encoding('UTF-32') 
-       if (defined $BOM and ($BOM == 0xFeFF or $BOM == 0xFFFe0000));
+    unless ($NoUTFAutoGuess) {
+       my $BOM = pack('C3', unpack("C3", $octet));
+       return find_encoding('utf8')
+           if (defined $BOM and $BOM eq $UTF8_BOM);
+       $BOM = unpack('N', $octet);
+       return find_encoding('UTF-32')
+           if (defined $BOM and ($BOM == 0xFeFF or $BOM == 0xFFFe0000));
+       $BOM = unpack('n', $octet);
+       return find_encoding('UTF-16')
+           if (defined $BOM and ($BOM == 0xFeFF or $BOM == 0xFFFe));
+       if ($octet =~ /\x00/o){ # if \x00 found, we assume UTF-(16|32)(BE|LE)
+           my $utf;
+           my ($be, $le) = (0, 0);
+           if ($octet =~ /\x00\x00/o){ # UTF-32(BE|LE) assumed
+               $utf = "UTF-32";
+               for my $char (unpack('N*', $octet)){
+                   $char & 0x0000ffff and $be++;
+                   $char & 0xffff0000 and $le++;
+               }
+           }else{ # UTF-16(BE|LE) assumed
+               $utf = "UTF-16";
+               for my $char (unpack('n*', $octet)){
+                   $char & 0x00ff and $be++;
+                   $char & 0xff00 and $le++;
+               }
+           }
+           DEBUG and warn "$utf, be == $be, le == $le";
+           $be == $le 
+               and return
+                   "Encodings ambiguous between $utf BE and LE ($be, $le)";
+           $utf .= ($be > $le) ? 'BE' : 'LE';
+           return find_encoding($utf);
+       }
+    }
     my %try =  %{$obj->{Suspects}};
     for my $c (@_){
        my $e = find_encoding($c) or die "Unknown encoding: $c";
        $try{$e->name} = $e;
-       $DEBUG and warn "Added: ", $e->name;
+       DEBUG and warn "Added: ", $e->name;
     }
-    if ($octet =~ /\x00/o){ # if \x00 found, we assume UTF-(16|32)(BE|LE)
-       my $utf;
-       my ($be, $le) = (0, 0);
-       if ($octet =~ /\x00\x00/o){ # UTF-32(BE|LE) assumed
-           $utf = "UTF-32";
-           for my $char (unpack('N*', $octet)){
-               $char & 0x0000ffff and $be++;
-               $char & 0xffff0000 and $le++;
-           }
-       }else{ # UTF-16(BE|LE) assumed
-           $utf = "UTF-16";
-           for my $char (unpack('n*', $octet)){
-               $char & 0x00ff and $be++;
-               $char & 0xff00 and $le++;
+    my $nline = 1;
+    for my $line (split /\r\n?|\n/, $octet){
+       # cheat 2 -- \e in the string
+       if ($line =~ /\e/o){
+           my @keys = keys %try;
+           delete @try{qw/utf8 ascii/};
+           for my $k (@keys){
+               ref($try{$k}) eq 'Encode::XS' and delete $try{$k};
            }
        }
-       $DEBUG and warn "$utf, be == $be, le == $le";
-       $be == $le 
-           and return "Encodings ambiguous between $utf BE and LE ($be, $le)";
-       $utf .= ($be > $le) ? 'BE' : 'LE';
-       return find_encoding($utf);
-    }else{
-       my $nline = 1;
-       for my $line (split /\r\n?|\n/, $octet){
-           # cheat 2 -- \e in the string
-           if ($line =~ /\e/o){
-               my @keys = keys %try;
-               delete @try{qw/utf8 ascii/};
-               for my $k (@keys){
-                   ref($try{$k}) eq 'Encode::XS' and delete $try{$k};
-               }
-           }
-           my %ok = %try;
-           # warn join(",", keys %try);
-           for my $k (keys %try){
-               my $scratch = $line;
-               $try{$k}->decode($scratch, FB_QUIET);
-               if ($scratch eq ''){
-                   $DEBUG and warn sprintf("%4d:%-24s ok\n", $nline, $k);
-               }else{
-                   use bytes ();
-                   $DEBUG and 
-                       warn sprintf("%4d:%-24s not ok; %d bytes left\n", 
-                                    $nline, $k, bytes::length($scratch));
-                   delete $ok{$k};
-               }
-           }
-           %ok or return "No appropriate encodings found!";
-           if (scalar(keys(%ok)) == 1){
-               my ($retval) = values(%ok);
-               return $retval;
+       my %ok = %try;
+       # warn join(",", keys %try);
+       for my $k (keys %try){
+           my $scratch = $line;
+           $try{$k}->decode($scratch, FB_QUIET);
+           if ($scratch eq ''){
+               DEBUG and warn sprintf("%4d:%-24s ok\n", $nline, $k);
+           }else{
+               use bytes ();
+               DEBUG and 
+                   warn sprintf("%4d:%-24s not ok; %d bytes left\n", 
+                                $nline, $k, bytes::length($scratch));
+               delete $ok{$k};
            }
-           %try = %ok; $nline++;
        }
+       %ok or return "No appropriate encodings found!";
+       if (scalar(keys(%ok)) == 1){
+           my ($retval) = values(%ok);
+           return $retval;
+       }
+       %try = %ok; $nline++;
     }
     $try{ascii} or 
        return  "Encodings too ambiguous: ", join(" or ", keys %try);
@@ -186,9 +196,15 @@ To use it more practically, you have to give the names of encodings to
 check (I<suspects> as follows).  The name of suspects can either be
 canonical names or aliases.
 
+CAVEAT: Unlike UTF-(16|32), BOM in utf8 is NOT AUTOMATICALLY STRIPPED.
+
  # tries all major Japanese Encodings as well
   use Encode::Guess qw/euc-jp shiftjis 7bit-jis/;
 
+If the C<$Encode::Guess::NoUTFAutoGuess> variable is set to a true
+value, no heuristics will be applied to UTF8/16/32, and the result
+will be limited to the suspects and C<ascii>.
+
 =over 4
 
 =item Encode::Guess->set_suspects