ext/GDBM_File/GDBM_File.pm

   1 # GDBM_File.pm -- Perl 5 interface to GNU gdbm library.
   2
   3 =head1 NAME
   4
   5 GDBM_File - Perl5 access to the gdbm library.
   6
   7 =head1 SYNOPSIS
   8
   9     use GDBM_File ;
  10     tie %hash, GDBM_File, $filename, &GDBM_WRCREAT, 0640);
  11     # Use the %hash array.
  12     untie %hash ;
  13
  14 =head1 DESCRIPTION
  15
  16 B<GDBM_File> is a module which allows Perl programs to make use of the
  17 facilities provided by the GNU gdbm library.  If you intend to use this
  18 module you should really have a copy of the gdbm manualpage at hand.
  19
  20 Most of the libgdbm.a functions are available through the GDBM_File
  21 interface.
  22
  23 =head1 AVAILABILITY
  24
  25 Gdbm is available from any GNU archive.  The master site is
  26 C<prep.ai.mit.edu>, but your are strongly urged to use one of the many
  27 mirrors.   You can obtain a list of mirror sites by issuing the
  28 command C<finger fsf@prep.ai.mit.edu>.
  29
  30 =head1 BUGS
  31
  32 The available functions and the gdbm/perl interface need to be documented.
  33
  34 =head1 SEE ALSO
  35
  36 L<perl(1)>, L<DB_File(3)>.
  37
  38 =cut
  39
  40 package GDBM_File;
  41
  42 require Carp;
  43 require TieHash;
  44 require Exporter;
  45 use AutoLoader;
  46 require DynaLoader;
  47 @ISA = qw(TieHash Exporter DynaLoader);
  48 @EXPORT = qw(
  49         GDBM_CACHESIZE
  50         GDBM_FAST
  51         GDBM_INSERT
  52         GDBM_NEWDB
  53         GDBM_READER
  54         GDBM_REPLACE
  55         GDBM_WRCREAT
  56         GDBM_WRITER
  57 );
  58
  59 sub AUTOLOAD {
  60     local($constname);
  61     ($constname = $AUTOLOAD) =~ s/.*:://;
  62     $val = constant($constname, @_ ? $_[0] : 0);
  63     if ($! != 0) {
  64         if ($! =~ /Invalid/) {
  65             $AutoLoader::AUTOLOAD = $AUTOLOAD;
  66             goto &AutoLoader::AUTOLOAD;
  67         }
  68         else {
  69             Carp::croak("Your vendor has not defined GDBM_File macro $constname, used");
  70         }
  71     }
  72     eval "sub $AUTOLOAD { $val }";
  73     goto &$AUTOLOAD;
  74 }
  75
  76 bootstrap GDBM_File;
  77
  78 # Preloaded methods go here.  Autoload methods go after __END__, and are
  79 # processed by the autosplit program.
  80
  81 1;
  82 __END__