lib/UNIVERSAL.pm

   1 package UNIVERSAL;
   2
   3 our $VERSION = '1.00';
   4
   5 # UNIVERSAL should not contain any extra subs/methods beyond those
   6 # that it exists to define. The use of Exporter below is a historical
   7 # accident that can't be fixed without breaking code.  Note that we
   8 # *don't* set @ISA here, don't want all classes/objects inheriting from
   9 # Exporter.  It's bad enough that all classes have a import() method
  10 # whenever UNIVERSAL.pm is loaded.
  11 require Exporter;
  12 *import = \&Exporter::import;
  13 @EXPORT_OK = qw(isa can VERSION);
  14
  15 1;
  16 __END__
  17
  18 =head1 NAME
  19
  20 UNIVERSAL - base class for ALL classes (blessed references)
  21
  22 =head1 SYNOPSIS
  23
  24     $is_io = $fd->isa("IO::Handle");
  25     $is_io = Class->isa("IO::Handle");
  26
  27     $sub = $obj->can("print");
  28     $sub = Class->can("print");
  29
  30     use UNIVERSAL qw( isa can VERSION );
  31     $yes = isa $ref, "HASH" ;
  32     $sub = can $ref, "fandango" ;
  33     $ver = VERSION $obj ;
  34
  35 =head1 DESCRIPTION
  36
  37 C<UNIVERSAL> is the base class which all bless references will inherit from,
  38 see L<perlobj>.
  39
  40 C<UNIVERSAL> provides the following methods and functions:
  41
  42 =over 4
  43
  44 =item $obj->isa( TYPE ), CLASS->isa( TYPE ), isa( VAL, TYPE )
  45
  46     C<TYPE> is a package name
  47     $obj is a blessed reference or a string containing a package name
  48     C<CLASS> is a package name
  49     C<VAL> is any of the above or an unblessed reference
  50
  51 When used as an instance or class method (C<$obj->isa( TYPE )>), C<isa>
  52 returns I<true> if $obj is blessed into package C<TYPE> or inherits from
  53 package C<TYPE>.
  54
  55 When used as a class method (C<CLASS->isa( TYPE )>; sometimes referred to as a
  56 static method), C<isa> returns I<true> if C<CLASS> inherits from (or is itself)
  57 the name of the package C<TYPE> or inherits from package C<TYPE>.
  58
  59 When used as a function, like
  60
  61    use UNIVERSAL qw( isa ) ;
  62    $yes = isa $h, "HASH";
  63    $yes = isa "Foo", "Bar";
  64
  65 or
  66
  67    require UNIVERSAL ;
  68    $yes = UNIVERSAL::isa $a, "ARRAY";
  69
  70 , C<isa> returns I<true> in the same cases as above and also if C<VAL> is an
  71 unblessed reference to a perl variable of type C<TYPE>, such as "HASH",
  72 "ARRAY", or "Regexp".
  73
  74 =item $obj->can( METHOD ), CLASS->can( METHOD ), can( VAL, METHOD )
  75
  76 C<can> checks if the object or class has a method called C<METHOD>. If it does
  77 then a reference to the sub is returned. If it does not then I<undef> is
  78 returned.  This includes methods inherited or imported by C<$obj>, C<CLASS>, or
  79 C<VAL>.
  80
  81 C<can> cannot know whether an object will be able to provide a method
  82 through AUTOLOAD, so a return value of I<undef> does not necessarily mean
  83 the object will not be able to handle the method call. To get around
  84 this some module authors use a forward declaration (see L<perlsub>)
  85 for methods they will handle via AUTOLOAD. For such 'dummy' subs, C<can>
  86 will still return a code reference, which, when called, will fall through
  87 to the AUTOLOAD. If no suitable AUTOLOAD is provided, calling the coderef
  88 will cause an error.
  89
  90 C<can> can be called as a class (static) method, an object method, or a
  91 function.
  92
  93 When used as a function, if C<VAL> is a blessed reference or package name which
  94 has a method called C<METHOD>, C<can> returns a reference to the subroutine.
  95 If C<VAL> is not a blessed reference, or if it does not have a method
  96 C<METHOD>, I<undef> is returned.
  97
  98 =item VERSION ( [ REQUIRE ] )
  99
 100 C<VERSION> will return the value of the variable C<$VERSION> in the
 101 package the object is blessed into. If C<REQUIRE> is given then
 102 it will do a comparison and die if the package version is not
 103 greater than or equal to C<REQUIRE>.
 104
 105 C<VERSION> can be called as either a class (static) method, an object method or
 106 or a function.
 107
 108
 109 =back
 110
 111 These subroutines should I<not> be imported via S<C<use UNIVERSAL qw(...)>>.
 112 If you want simple local access to them you can do
 113
 114   *isa = \&UNIVERSAL::isa;
 115
 116 to import isa into your package.
 117
 118 =cut