This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
For now, remove the 'cannot remove [dir] when cwd is [dir]' message,
[perl5.git] / lib / base.pm
index f1644a8..574925f 100644 (file)
@@ -2,7 +2,8 @@ package base;
 
 use strict 'vars';
 use vars qw($VERSION);
-$VERSION = '2.10';
+$VERSION = '2.14';
+$VERSION = eval $VERSION;
 
 # constant.pm is slow
 sub SUCCESS () { 1 }
@@ -40,23 +41,23 @@ sub get_attr {
 
 if ($] < 5.009) {
     *get_fields = sub {
-       # Shut up a possible typo warning.
-       () = \%{$_[0].'::FIELDS'};
-       my $f = \%{$_[0].'::FIELDS'};
+        # Shut up a possible typo warning.
+        () = \%{$_[0].'::FIELDS'};
+        my $f = \%{$_[0].'::FIELDS'};
 
-       # should be centralized in fields? perhaps
-       # fields::mk_FIELDS_be_OK. Peh. As long as %{ $package . '::FIELDS' }
-       # is used here anyway, it doesn't matter.
-       bless $f, 'pseudohash' if (ref($f) ne 'pseudohash');
+        # should be centralized in fields? perhaps
+        # fields::mk_FIELDS_be_OK. Peh. As long as %{ $package . '::FIELDS' }
+        # is used here anyway, it doesn't matter.
+        bless $f, 'pseudohash' if (ref($f) ne 'pseudohash');
 
-       return $f;
+        return $f;
     }
 }
 else {
     *get_fields = sub {
-       # Shut up a possible typo warning.
-       () = \%{$_[0].'::FIELDS'};
-       return \%{$_[0].'::FIELDS'};
+        # Shut up a possible typo warning.
+        () = \%{$_[0].'::FIELDS'};
+        return \%{$_[0].'::FIELDS'};
     }
 }
 
@@ -69,52 +70,60 @@ sub import {
     my $fields_base;
 
     my $inheritor = caller(0);
+    my @isa_classes;
 
+    my @bases;
     foreach my $base (@_) {
         if ( $inheritor eq $base ) {
             warn "Class '$inheritor' tried to inherit from itself\n";
         }
 
-        next if $inheritor->isa($base);
+        next if grep $_->isa($base), ($inheritor, @bases);
 
         if (has_version($base)) {
-           ${$base.'::VERSION'} = '-1, set by base.pm' 
-             unless defined ${$base.'::VERSION'};
+            ${$base.'::VERSION'} = '-1, set by base.pm' 
+              unless defined ${$base.'::VERSION'};
         }
         else {
-           my $sigdie;
-           {
-               local $SIG{__DIE__};
-               eval "require $base";
-               # Only ignore "Can't locate" errors from our eval require.
-               # Other fatal errors (syntax etc) must be reported.
-               die if $@ && $@ !~ /^Can't locate .*? at \(eval /;
-               unless (%{"$base\::"}) {
-                   require Carp;
-                   Carp::croak(<<ERROR);
+            my $sigdie;
+            {
+                local $SIG{__DIE__};
+                eval "require $base";
+                # Only ignore "Can't locate" errors from our eval require.
+                # Other fatal errors (syntax etc) must be reported.
+                die if $@ && $@ !~ /^Can't locate .*? at \(eval /;
+                unless (%{"$base\::"}) {
+                    require Carp;
+                    local $" = " ";
+                    Carp::croak(<<ERROR);
 Base class package "$base" is empty.
-    (Perhaps you need to 'use' the module which defines that package first.)
+    (Perhaps you need to 'use' the module which defines that package first,
+    or make that module available in \@INC (\@INC contains: @INC).
 ERROR
-               }
-               $sigdie = $SIG{__DIE__};
-           }
-           # Make sure a global $SIG{__DIE__} makes it out of the localization.
-           $SIG{__DIE__} = $sigdie if defined $sigdie;
+                }
+                $sigdie = $SIG{__DIE__} || undef;
+            }
+            # Make sure a global $SIG{__DIE__} makes it out of the localization.
+            $SIG{__DIE__} = $sigdie if defined $sigdie;
             ${$base.'::VERSION'} = "-1, set by base.pm"
               unless defined ${$base.'::VERSION'};
         }
-        push @{"$inheritor\::ISA"}, $base;
+        push @bases, $base;
 
         if ( has_fields($base) || has_attr($base) ) {
-           # No multiple fields inheritance *suck*
-           if ($fields_base) {
-               require Carp;
-               Carp::croak("Can't multiply inherit %FIELDS");
-           } else {
-               $fields_base = $base;
-           }
+            # No multiple fields inheritance *suck*
+            if ($fields_base) {
+                require Carp;
+                Carp::croak("Can't multiply inherit fields");
+            } else {
+                $fields_base = $base;
+            }
         }
     }
+    # Save this until the end so it's all or nothing if the above loop croaks.
+    push @{"$inheritor\::ISA"}, @isa_classes;
+
+    push @{"$inheritor\::ISA"}, @bases;
 
     if( defined $fields_base ) {
         inherit_fields($inheritor, $fields_base);
@@ -135,10 +144,11 @@ sub inherit_fields {
     $dattr->[0] = @$battr;
 
     if( keys %$dfields ) {
-        warn "$derived is inheriting from $base but already has its own ".
-             "fields!\n".
-             "This will cause problems.\n".
-             "Be sure you use base BEFORE declaring fields\n";
+        warn <<"END";
+$derived is inheriting from $base but already has its own fields!
+This will cause problems.  Be sure you use base BEFORE declaring fields.
+END
+
     }
 
     # Iterate through the base's fields adding all the non-private
@@ -147,10 +157,10 @@ sub inherit_fields {
     # This is all too complicated to do efficiently with add_fields().
     while (my($k,$v) = each %$bfields) {
         my $fno;
-       if ($fno = $dfields->{$k} and $fno != $v) {
-           require Carp;
-           Carp::croak ("Inherited %FIELDS can't override existing %FIELDS");
-       }
+        if ($fno = $dfields->{$k} and $fno != $v) {
+            require Carp;
+            Carp::croak ("Inherited fields can't override existing fields");
+        }
 
         if( $battr->[$v] & PRIVATE ) {
             $dattr->[$v] = PRIVATE | INHERITED;
@@ -162,8 +172,8 @@ sub inherit_fields {
     }
 
     foreach my $idx (1..$#{$battr}) {
-       next if defined $dattr->[$idx];
-       $dattr->[$idx] = $battr->[$idx] & INHERITED;
+        next if defined $dattr->[$idx];
+        $dattr->[$idx] = $battr->[$idx] & INHERITED;
     }
 }
 
@@ -174,7 +184,7 @@ __END__
 
 =head1 NAME
 
-base - Establish IS-A relationship with base classes at compile time
+base - Establish an ISA relationship with base classes at compile time
 
 =head1 SYNOPSIS
 
@@ -183,6 +193,9 @@ base - Establish IS-A relationship with base classes at compile time
 
 =head1 DESCRIPTION
 
+Unless you are using the C<fields> pragma, consider this module discouraged
+in favor of the lighter-weight C<parent>.
+
 Allows you to both load one or more modules, while setting up inheritance from
 those modules at the same time.  Roughly similar in effect to
 
@@ -193,18 +206,29 @@ those modules at the same time.  Roughly similar in effect to
         push @ISA, qw(Foo Bar);
     }
 
-If any of the listed modules are not loaded yet, I<base> silently attempts to
-C<require> them (and silently continues if the C<require> failed).  Whether to
-C<require> a base class module is determined by the absence of a global variable
-$VERSION in the base package.  If $VERSION is not detected even after loading
-it, <base> will define $VERSION in the base package, setting it to the string
-C<-1, set by base.pm>.
+C<base> employs some heuristics to determine if a module has already been
+loaded, if it has it doesn't try again. If C<base> tries to C<require> the
+module it will not die if it cannot find the module's file, but will die on any
+other error. After all this, should your base class be empty, containing no
+symbols, it will die. This is useful for inheriting from classes in the same
+file as yourself, like so:
+
+        package Foo;
+        sub exclaim { "I can have such a thing?!" }
+        
+        package Bar;
+        use base "Foo";
+
+If $VERSION is not detected even after loading it, <base> will define $VERSION
+in the base package, setting it to the string C<-1, set by base.pm>.
+
+C<base> will also initialize the fields if one of the base classes has it.
+Multiple inheritance of fields is B<NOT> supported, if two or more base classes
+each have inheritable fields the 'base' pragma will croak. See L<fields>,
+L<public> and L<protected> for a description of this feature.
+
+The base class' C<import> method is B<not> called.
 
-Will also initialize the fields if one of the base classes has it.
-Multiple inheritance of fields is B<NOT> supported, if two or more
-base classes each have inheritable fields the 'base' pragma will
-croak.  See L<fields>, L<public> and L<protected> for a description of
-this feature.
 
 =head1 DIAGNOSTICS
 
@@ -215,18 +239,18 @@ this feature.
 base.pm was unable to require the base package, because it was not
 found in your path.
 
-=back
+=item Class 'Foo' tried to inherit from itself
 
-=head1 HISTORY
+Attempting to inherit from yourself generates a warning.
 
-This module was introduced with Perl 5.004_04.
+    use Foo;
+    use base 'Foo';
 
-Attempting to inherit from yourself generates a warning:
+=back
 
- use Foo;
- use base 'Foo';
+=head1 HISTORY
 
- # Class 'Foo' tried to inherit from itself
+This module was introduced with Perl 5.004_04.
 
 =head1 CAVEATS