This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Move Module::Build from ext/ to cpan/
[perl5.git] / lib / utf8_heavy.pl
index e82c06b..41a0662 100644 (file)
@@ -6,169 +6,168 @@ sub DEBUG () { 0 }
 
 sub DESTROY {}
 
+my %Cache;
+
+our (%PropertyAlias, %PA_reverse, %PropValueAlias, %PVA_reverse, %PVA_abbr_map);
+
 sub croak { require Carp; Carp::croak(@_) }
 
+##
+## "SWASH" == "SWATCH HASH". A "swatch" is a swatch of the Unicode landscape.
+## It's a data structure that encodes a set of Unicode characters.
+##
+
 sub SWASHNEW {
     my ($class, $type, $list, $minbits, $none) = @_;
     local $^D = 0 if $^D;
 
     print STDERR "SWASHNEW @_\n" if DEBUG;
 
-    ## check to see if we've already got it.
-    {
-        no strict 'refs';
-        if ($type and ref ${"${class}::{$type}"} eq $class) {
-            warn qq/Found \${"${class}::{$type}"}\n/ if DEBUG;
-            return ${"${class}::{$type}"};
-        }
-    }
-
     ##
     ## Get the list of codepoints for the type.
-    ## Called from utf8.c
+    ## Called from swash_init (see utf8.c) or SWASHNEW itself.
+    ##
+    ## Callers of swash_init:
+    ##     op.c:pmtrans             -- for tr/// and y///
+    ##     regexec.c:regclass_swash -- for /[]/, \p, and \P
+    ##     utf8.c:is_utf8_common    -- for common Unicode properties
+    ##     utf8.c:to_utf8_case      -- for lc, uc, ucfirst, etc. and //i
     ##
     ## Given a $type, our goal is to fill $list with the set of codepoint
-    ## ranges. As we try various interpretations of $type, sometimes we'll
-    ## end up with the $list directly, and sometimes we'll end up with a
-    ## $file name that holds the list data.
+    ## ranges. If $type is false, $list passed is used.
+    ##
+    ## $minbits:
+    ##     For binary properties, $minbits must be 1.
+    ##     For character mappings (case and transliteration), $minbits must
+    ##     be a number except 1.
+    ##
+    ## $list (or that filled according to $type):
+    ##     Refer to perlunicode.pod, "User-Defined Character Properties."
+    ##     
+    ##     For binary properties, only characters with the property value
+    ##     of True should be listed. The 3rd column, if any, will be ignored.
     ##
     ## To make the parsing of $type clear, this code takes the a rather
-    ## unorthadox approach of last'ing out of the block once we have the
+    ## unorthodox approach of last'ing out of the block once we have the
     ## info we need. Were this to be a subroutine, the 'last' would just
     ## be a 'return'.
     ##
+    my $file; ## file to load data from, and also part of the %Cache key.
+    my $ListSorted = 0;
+
     if ($type)
     {
         $type =~ s/^\s+//;
         $type =~ s/\s+$//;
 
-        print "type = $type\n" if DEBUG;
+        print STDERR "type = $type\n" if DEBUG;
 
-        my $file;
-        ## Figure out what file to load to get the data....
       GETFILE:
         {
+           ##
+           ## It could be a user-defined property.
+           ##
+
+           my $caller1 = $type =~ s/(.+)::// ? $1 : caller(1);
+
+           if (defined $caller1 && $type =~ /^(?:\w+)$/) {
+               my $prop = "${caller1}::$type";
+               if (exists &{$prop}) {
+                   no strict 'refs';
+                   
+                   $list = &{$prop};
+                   last GETFILE;
+               }
+           }
+
+            my $wasIs;
+
+            ($wasIs = $type =~ s/^Is(?:\s+|[-_])?//i)
+              or
+            $type =~ s/^(?:(?:General(?:\s+|_)?)?Category|gc)\s*[:=]\s*//i
+              or
+            $type =~ s/^(?:Script|sc)\s*[:=]\s*//i
+              or
+            $type =~ s/^Block\s*[:=]\s*/In/i;
+
+
+           ##
+           ## See if it's in some enumeration.
+           ##
+           require "unicore/PVA.pl";
+           if ($type =~ /^([\w\s]+)[:=]\s*(.*)/) {
+               my ($enum, $val) = (lc $1, lc $2);
+               $enum =~ tr/ _-//d;
+               $val =~ tr/ _-//d;
+
+               my $pa = $PropertyAlias{$enum} ? $enum : $PA_reverse{$enum};
+               my $f = $PropValueAlias{$pa}{$val} ? $val : $PVA_reverse{$pa}{lc $val};
+
+               if ($pa and $f) {
+                   $pa = "gc_sc" if $pa eq "gc" or $pa eq "sc";
+                   $file = "unicore/lib/$pa/$PVA_abbr_map{$pa}{lc $f}.pl";
+                   last GETFILE;
+               }
+           }
+           else {
+               my $t = lc $type;
+               $t =~ tr/ _-//d;
+
+               if ($PropValueAlias{gc}{$t} or $PropValueAlias{sc}{$t}) {
+                   $file = "unicore/lib/gc_sc/$PVA_abbr_map{gc_sc}{$t}.pl";
+                   last GETFILE;
+               }
+           }
+
             ##
-            ## First, see if it's an "Is" name (the 'Is' is optional)
-            ##
-            ## Because we check "Is" names first, they have precidence over
-            ## "In" names. For example, "Greek" is both a script and a
-            ## block. "IsGreek" always gets the script, while "InGreek"
-            ## always gets the block. "Greek" gets the script because we
-            ## check "Is" names first.
+            ## See if it's in the direct mapping table.
             ##
-            if ($type =~ m{^
-                           ## "Is" prefix, or "Script=" or "Category="
-                           (?: Is [- _]? | (?:Script|Category)\s*=\s* )?
-                           ## name to check in the "Is" symbol table.
-                           ([A-Z].*)
-                           $
-                          }ix)
-            {
-                my $istype = $1;
-                ##
-                ## Input ($type)     Name To Check ($istype)
-                ## -------------     -----------------------
-                ## IsLu                 Lu
-                ## Lu                   Lu
-                ## Category = Lu        Lu
-                ## Foo                  Foo
-                ## Script = Greek       Greek
-                ##
-
-                print "istype = $istype\n" if DEBUG;
-
-                ## Load "Is" mapping data, if not yet loaded.
-                do "unicore/Is.pl" if not defined %utf8::Is;
-
-                ##
-                ## If the "Is" mapping data has an exact match, it points
-                ## to the file we need.
-                ##
-                if (exists $utf8::Is{$istype})
-                {
-                    $file = "unicore/Is/$utf8::Is{$istype}.pl";
-                    last GETFILE;
-                }
-
-                ##
-                ## Need to look at %utf8::IsPat (loaded from "unicore/Is.pl")
-                ## to see if there's a regex that matches this $istype.
-                ## If so, the associated name is the file we need.
-                ##
-                my $prefix = substr(lc($istype), 0, 2);
-                if (exists $utf8::IsPat{$prefix})
-                {
-                    while (my ($pat, $name) = each %{$utf8::IsPat{$prefix}})
-                    {
-                        print "isprefix = $prefix, Is = $istype, pat = $pat\n" if DEBUG;
-                        ##
-                        ## The following regex probably need not be cached,
-                        ## since every time there's a match, the results of
-                        ## the entire call to SWASHNEW() is cached, so there's
-                        ## a very limited number of times any one $pat will
-                        ## be evaluated as a regex, at least with "reasonable"
-                        ## code that doesn't try a baziilion \p{Random} names.
-                        ##
-                        if ($istype =~ /^$pat$/i)
-                        {
-                            $file = "unicore/Is/$name.pl";
-                            last GETFILE;
-                        }
-                    }
-                }
+            require "unicore/Exact.pl";
+            if (my $base = $utf8::Exact{$type}) {
+                $file = "unicore/lib/gc_sc/$base.pl";
+                last GETFILE;
             }
 
             ##
-            ## Couldn't find via "Is" -- let's try via "In".....
+            ## If not there exactly, try the canonical form. The canonical
+            ## form is lowercased, with any separators (\s+|[-_]) removed.
             ##
-            if ($type =~ m{^
-                           ( In(?!herited$)[- _]? | Block\s*=\s*)?
-                           ([A-Z].*)
-                           $
-                          }xi)
-            {
-                my $intype = $2;
-                print "intype = $intype\n" if DEBUG;
-
-                ##
-                ## Input ($type)      Name To Check ($intype)
-                ## -------------      -----------------------
-                ## Inherited             Inherited
-                ## InGreek               Greek
-                ## Block = Greek         Greek
-                ##
-
-                ## Load "In" mapping data, if not yet loaded.
-                do "unicore/In.pl" if not defined %utf8::In;
-
-                ## If there's a direct match, it points to the file we need
-                if (exists $utf8::In{$intype}) {
-                    $file = "unicore/In/$utf8::In{$intype}.pl";
-                    last GETFILE;
-                }
-
-                my $prefix = substr(lc($intype), 0, 2);
-                if (exists $utf8::InPat{$prefix})
-                {
-                    print "inprefix = $prefix, In = $intype\n" if DEBUG;
-                    while (my ($pat, $name) = each %{$utf8::InPat{$prefix}})
-                    {
-                        print "inprefix = $prefix, In = $intype, k = $pat\n" if DEBUG;
-                        if ($intype =~ /^$pat$/i) {
-                            $file = "unicore/In/$name.pl";
-                            print "inprefix = $prefix, In = $intype, k = $pat, file = $file\n" if DEBUG;
-                            last GETFILE;
-                        }
-                    }
-                }
+            my $canonical = lc $type;
+            $canonical =~ s/(?<=[a-z\d])(?:\s+|[-_])(?=[a-z\d])//g;
+            print STDERR "canonical = $canonical\n" if DEBUG;
+
+            require "unicore/Canonical.pl";
+           { no warnings "uninitialized";
+            if (my $base = ($utf8::Canonical{$canonical} || $utf8::Canonical{ lc $utf8::PropertyAlias{$canonical} })) {
+                $file = "unicore/lib/gc_sc/$base.pl";
+                last GETFILE;
+            }
             }
 
+           ##
+           ## See if it's a user-level "To".
+           ##
+
+           my $caller0 = caller(0);
+
+           if (defined $caller0 && $type =~ /^To(?:\w+)$/) {
+               my $map = $caller0 . "::" . $type;
+
+               if (exists &{$map}) {
+                   no strict 'refs';
+                   
+                   $list = &{$map};
+                   last GETFILE;
+               }
+           }
+
             ##
-            ## Last attempt -- see if it's a "To" name (e.g. "ToLower")
+            ## Last attempt -- see if it's a standard "To" name
+           ## (e.g. "ToLower")  ToTitle is used by ucfirst().
+           ## The user-level way to access ToDigit() and ToFold()
+           ## is to use Unicode::UCD.
             ##
-            if ($type =~ /^To([A-Z][A-Za-z]+)$/)
-            {
+            if ($type =~ /^To(Digit|Fold|Lower|Title|Upper)$/) {
                 $file = "unicore/To/$1.pl";
                 ## would like to test to see if $file actually exists....
                 last GETFILE;
@@ -178,27 +177,48 @@ sub SWASHNEW {
             ## If we reach this line, it's because we couldn't figure
             ## out what to do with $type. Ouch.
             ##
-            croak("Can't find Unicode character property \"$type\"");
+
+            return $type;
         }
 
-        ##
-        ## If we reach here, it was due to a 'last GETFILE' above, so we
-        ## have a filename, so now we load it.
-        ##
-        $list = do $file;
+       if (defined $file) {
+           print STDERR "found it (file='$file')\n" if DEBUG;
+
+           ##
+           ## If we reach here, it was due to a 'last GETFILE' above
+           ## (exception: user-defined properties and mappings), so we
+           ## have a filename, so now we load it if we haven't already.
+           ## If we have, return the cached results. The cache key is the
+           ## class and file to load.
+           ##
+           my $found = $Cache{$class, $file};
+           if ($found and ref($found) eq $class) {
+               print STDERR "Returning cached '$file' for \\p{$type}\n" if DEBUG;
+               return $found;
+           }
+
+           local $@;
+           local $!;
+           $list = do $file; die $@ if $@;
+       }
+
+        $ListSorted = 1; ## we know that these lists are sorted
     }
 
     my $extras;
-    my $bits;
+    my $bits = $minbits;
 
+    my $ORIG = $list;
     if ($list) {
        my @tmp = split(/^/m, $list);
        my %seen;
        no warnings;
        $extras = join '', grep /^[^0-9a-fA-F]/, @tmp;
        $list = join '',
-           sort { hex $a <=> hex $b }
-           grep {/^([0-9a-fA-F]+)/ and not $seen{$1}++} @tmp; # XXX doesn't do ranges right
+           map  { $_->[1] }
+           sort { $a->[0] <=> $b->[0] }
+           map  { /^([0-9a-fA-F]+)/; [ CORE::hex($1), $_ ] }
+           grep { /^([0-9a-fA-F]+)/ and not $seen{$1}++ } @tmp; # XXX doesn't do ranges right
     }
 
     if ($none) {
@@ -206,21 +226,20 @@ sub SWASHNEW {
        $list =~ s/\tXXXX$/\t$hextra/mg;
     }
 
-    if ($minbits < 32) {
+    if ($minbits != 1 && $minbits < 32) { # not binary property
        my $top = 0;
-       while ($list =~ /^([0-9a-fA-F]+)(?:\t([0-9a-fA-F]+)?)(?:\t([0-9a-fA-F]+))?/mg) {
-           my $min = hex $1;
-           my $max = hex(defined $2 ? $2 : $1);
-           my $val = hex(defined $3 ? $3 : "");
+       while ($list =~ /^([0-9a-fA-F]+)(?:[\t]([0-9a-fA-F]+)?)(?:[ \t]([0-9a-fA-F]+))?/mg) {
+           my $min = CORE::hex $1;
+           my $max = defined $2 ? CORE::hex $2 : $min;
+           my $val = defined $3 ? CORE::hex $3 : 0;
            $val += $max - $min if defined $3;
            $top = $val if $val > $top;
        }
-       $bits =
+       my $topbits =
            $top > 0xffff ? 32 :
-           $top > 0xff ? 16 :
-           $top > 1 ? 8 : 1
+           $top > 0xff ? 16 : 8;
+       $bits = $topbits if $bits < $topbits;
     }
-    $bits = $minbits if $bits < $minbits;
 
     my @extras;
     for my $x ($extras) {
@@ -229,9 +248,19 @@ sub SWASHNEW {
            my $char = $1;
            my $name = $2;
            print STDERR "$1 => $2\n" if DEBUG;
-           if ($char =~ /[-+!]/) {
+           if ($char =~ /[-+!&]/) {
                my ($c,$t) = split(/::/, $name, 2);     # bogus use of ::, really
-               my $subobj = $c->SWASHNEW($t, "", 0, 0, 0);
+               my $subobj;
+               if ($c eq 'utf8') {
+                   $subobj = utf8->SWASHNEW($t, "", $minbits, 0);
+               }
+               elsif (exists &$name) {
+                   $subobj = utf8->SWASHNEW($name, "", $minbits, 0);
+               }
+               elsif ($c =~ /^([0-9a-fA-F]+)/) {
+                   $subobj = utf8->SWASHNEW("", $c, $minbits, 0);
+               }
+               return $subobj unless ref $subobj;
                push @extras, $name => $subobj;
                $bits = $subobj->{BITS} if $bits < $subobj->{BITS};
            }
@@ -240,8 +269,7 @@ sub SWASHNEW {
 
     print STDERR "CLASS = $class, TYPE => $type, BITS => $bits, NONE => $none\nEXTRAS =>\n$extras\nLIST =>\n$list\n" if DEBUG;
 
-    no strict 'refs';
-    ${"${class}::{$type}"} = bless {
+    my $SWASH = bless {
        TYPE => $type,
        BITS => $bits,
        EXTRAS => $extras,
@@ -249,131 +277,14 @@ sub SWASHNEW {
        NONE => $none,
        @extras,
     } => $class;
-}
 
-# NOTE: utf8.c:swash_init() assumes entries are never modified once generated.
-
-sub SWASHGET {
-    # See utf8.c:Perl_swash_fetch for problems with this interface.
-    my ($self, $start, $len) = @_;
-    local $^D = 0 if $^D;
-    my $type = $self->{TYPE};
-    my $bits = $self->{BITS};
-    my $none = $self->{NONE};
-    print STDERR "SWASHGET @_ [$type/$bits/$none]\n" if DEBUG;
-    my $end = $start + $len;
-    my $swatch = "";
-    my $key;
-    vec($swatch, $len - 1, $bits) = 0; # Extend to correct length.
-    if ($none) {
-       for $key (0 .. $len - 1) { vec($swatch, $key, $bits) = $none }
+    if ($file) {
+        $Cache{$class, $file} = $SWASH;
     }
 
-    for ($self->{LIST}) {
-       pos $_ = 0;
-       if ($bits > 1) {
-         LINE:
-           while (/^([0-9a-fA-F]+)(?:\t([0-9a-fA-F]+)?)(?:\t([0-9a-fA-F]+))?/mg) {
-               my $min = hex $1;
-               my $max = (defined $2 ? hex $2 : $min);
-               my $val = hex $3;
-               next if $max < $start;
-               print "$min $max $val\n" if DEBUG;
-               if ($none) {
-                   if ($min < $start) {
-                       $val += $start - $min if $val < $none;
-                       $min = $start;
-                   }
-                   for ($key = $min; $key <= $max; $key++) {
-                       last LINE if $key >= $end;
-                       print STDERR "$key => $val\n" if DEBUG;
-                       vec($swatch, $key - $start, $bits) = $val;
-                       ++$val if $val < $none;
-                   }
-               }
-               else {
-                   if ($min < $start) {
-                       $val += $start - $min;
-                       $min = $start;
-                   }
-                   for ($key = $min; $key <= $max; $key++, $val++) {
-                       last LINE if $key >= $end;
-                       print STDERR "$key => $val\n" if DEBUG;
-                       vec($swatch, $key - $start, $bits) = $val;
-                   }
-               }
-           }
-       }
-       else {
-         LINE:
-           while (/^([0-9a-fA-F]+)(?:\t([0-9a-fA-F]+))?/mg) {
-               my $min = hex $1;
-               my $max = (defined $2 ? hex $2 : $min);
-               next if $max < $start;
-               if ($min < $start) {
-                   $min = $start;
-               }
-               for ($key = $min; $key <= $max; $key++) {
-                   last LINE if $key >= $end;
-                   print STDERR "$key => 1\n" if DEBUG;
-                   vec($swatch, $key - $start, 1) = 1;
-               }
-           }
-       }
-    }
-    for my $x ($self->{EXTRAS}) {
-       pos $x = 0;
-       while ($x =~ /^([-+!])(.*)/mg) {
-           my $char = $1;
-           my $name = $2;
-           print STDERR "INDIRECT $1 $2\n" if DEBUG;
-           my $otherbits = $self->{$name}->{BITS};
-           croak("SWASHGET size mismatch") if $bits < $otherbits;
-           my $other = $self->{$name}->SWASHGET($start, $len);
-           if ($char eq '+') {
-               if ($bits == 1 and $otherbits == 1) {
-                   $swatch |= $other;
-               }
-               else {
-                   for ($key = 0; $key < $len; $key++) {
-                       vec($swatch, $key, $bits) = vec($other, $key, $otherbits);
-                   }
-               }
-           }
-           elsif ($char eq '!') {
-               if ($bits == 1 and $otherbits == 1) {
-                   $swatch |= ~$other;
-               }
-               else {
-                   for ($key = 0; $key < $len; $key++) {
-                       if (!vec($other, $key, $otherbits)) {
-                           vec($swatch, $key, $bits) = 1;
-                       }
-                   }
-               }
-           }
-           elsif ($char eq '-') {
-               if ($bits == 1 and $otherbits == 1) {
-                   $swatch &= ~$other;
-               }
-               else {
-                   for ($key = 0; $key < $len; $key++) {
-                       if (vec($other, $key, $otherbits)) {
-                           vec($swatch, $key, $bits) = 0;
-                       }
-                   }
-               }
-           }
-       }
-    }
-    if (DEBUG) {
-       print STDERR "CELLS ";
-       for ($key = 0; $key < $len; $key++) {
-           print STDERR vec($swatch, $key, $bits), " ";
-       }
-       print STDERR "\n";
-    }
-    $swatch;
+    return $SWASH;
 }
 
+# Now SWASHGET is recasted into a C function S_swash_get (see utf8.c).
+
 1;