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<ftp.gnu.org>, but you are strongly urged to use one of the many
  27 mirrors.  You can obtain a list of mirror sites from
  28 http://www.gnu.org/order/ftp.html.
  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)>, L<perldbmfilter>.
  37
  38 =cut
  39
  40 package GDBM_File;
  41
  42 use strict;
  43 use warnings;
  44 our($VERSION, @ISA, @EXPORT, $AUTOLOAD);
  45
  46 require Carp;
  47 require Tie::Hash;
  48 require Exporter;
  49 use XSLoader ();
  50 @ISA = qw(Tie::Hash Exporter);
  51 @EXPORT = qw(
  52         GDBM_CACHESIZE
  53         GDBM_FAST
  54         GDBM_INSERT
  55         GDBM_NEWDB
  56         GDBM_NOLOCK
  57         GDBM_READER
  58         GDBM_REPLACE
  59         GDBM_WRCREAT
  60         GDBM_WRITER
  61 );
  62
  63 $VERSION = "1.06";
  64
  65 sub AUTOLOAD {
  66     my($constname);
  67     ($constname = $AUTOLOAD) =~ s/.*:://;
  68     my ($error, $val) = constant($constname);
  69     Carp::croak $error if $error;
  70     no strict 'refs';
  71     *{$AUTOLOAD} = sub { $val };
  72     goto &{$AUTOLOAD};
  73 }
  74
  75 XSLoader::load 'GDBM_File', $VERSION;
  76
  77 1;