lib/Search/TokyoDystopia.pm

package Search::TokyoDystopia;

use strict;
use warnings;

require Exporter;
require XSLoader;
use base qw(Exporter);
our $VERSION = '0.00';
our $debug = 0;
XSLoader::load('Search::TokyoDystopia', $VERSION);

our @EXPORT = qw(
tcidberrmsg
tcidbnew
tcidbdel
tcidbnew
tcidbecode
tcidbtune
IDBTLARGE
IDBTDEFLATE
IDBTTCBS
tcidbsetcache
tcidbsetfwmmax
tcidbopen
IDBOREADER
IDBOWRITER
IDBOCREAT
IDBOTRUNC
IDBONOLCK
IDBOLCKNB
tcidbclose
);

=head1 NAME

Search::TokyoDystopia - XS bindings for Tokyo Dystopia

=head1 EXPORTS

If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing.

=head2 tcidberrmsg

  my $message = tcidberrmsg( $ecode );

=head2 tcidbnew

  my $idb = tcidbnew;

=head2 tcidbdel

  tcidbdel( $idb );

=head2 tcidbecode

  my $ecode = tcidbecode( $idb );

=head2 tcidbtune

  my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE || IDBTDEFLATE );

=cut

use constant {
        IDBTLARGE => 1 << 0,
        IDBTDEFLATE => 1 << 1,
        IDBTTCBS => 1 << 2,
};

=head2 tcidbsetcache

  my $success = tcidbsetcache( $idb, $icsiz, $lcnum );

=head2 tcidbsetfwmmax

  my $success = tcidbsetfwmmax( $idb, $fwnum );

=head2 tcidbopen

  my $success = tcidbopen( $idb, 'casket', IDBOWRITER || IDBOCREAT );

=cut

use constant {
        IDBOREADER => 1 << 0,
        IDBOWRITER => 1 << 1,
        IDBOCREAT => 1 << 2,
        IDBOTRUNC => 1 << 3,
        IDBONOLCK => 1 << 4,
        IDBOLCKNB => 1 << 5,
};

=head2 tcidbclose

  my $success = tcidbclose( $idb );

=head1 KNOWN BUGS

Low-level functions often just die when called on invalid (or deleted) database

=cut

1;
1	dpavlin	1	package Search::TokyoDystopia;
2
3			use strict;
4			use warnings;
5
6			require Exporter;
7			require XSLoader;
8			use base qw(Exporter);
9			our $VERSION = '0.00';
10			our $debug = 0;
11			XSLoader::load('Search::TokyoDystopia', $VERSION);
12
13	dpavlin	10	our @EXPORT = qw(
14			tcidberrmsg
15			tcidbnew
16			tcidbdel
17			tcidbnew
18			tcidbecode
19			tcidbtune
20			IDBTLARGE
21			IDBTDEFLATE
22			IDBTTCBS
23			tcidbsetcache
24			tcidbsetfwmmax
25			tcidbopen
26			IDBOREADER
27			IDBOWRITER
28			IDBOCREAT
29			IDBOTRUNC
30			IDBONOLCK
31			IDBOLCKNB
32	dpavlin	11	tcidbclose
33	dpavlin	10	);
34
35	dpavlin	1	=head1 NAME
36
37			Search::TokyoDystopia - XS bindings for Tokyo Dystopia
38
39	dpavlin	10	=head1 EXPORTS
40	dpavlin	1
41	dpavlin	10	If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing.
42
43			=head2 tcidberrmsg
44
45	dpavlin	12	my $message = tcidberrmsg( $ecode );
46	dpavlin	10
47			=head2 tcidbnew
48
49	dpavlin	12	my $idb = tcidbnew;
50	dpavlin	10
51			=head2 tcidbdel
52
53	dpavlin	12	tcidbdel( $idb );
54	dpavlin	10
55			=head2 tcidbecode
56
57	dpavlin	12	my $ecode = tcidbecode( $idb );
58	dpavlin	10
59			=head2 tcidbtune
60
61	dpavlin	12	my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE \|\| IDBTDEFLATE );
62	dpavlin	10
63	dpavlin	1	=cut
64
65	dpavlin	10	use constant {
66			IDBTLARGE => 1 << 0,
67			IDBTDEFLATE => 1 << 1,
68			IDBTTCBS => 1 << 2,
69			};
70
71			=head2 tcidbsetcache
72
73	dpavlin	12	my $success = tcidbsetcache( $idb, $icsiz, $lcnum );
74	dpavlin	10
75			=head2 tcidbsetfwmmax
76
77	dpavlin	12	my $success = tcidbsetfwmmax( $idb, $fwnum );
78	dpavlin	10
79			=head2 tcidbopen
80
81	dpavlin	12	my $success = tcidbopen( $idb, 'casket', IDBOWRITER \|\| IDBOCREAT );
82	dpavlin	10
83			=cut
84
85			use constant {
86			IDBOREADER => 1 << 0,
87			IDBOWRITER => 1 << 1,
88			IDBOCREAT => 1 << 2,
89			IDBOTRUNC => 1 << 3,
90			IDBONOLCK => 1 << 4,
91			IDBOLCKNB => 1 << 5,
92			};
93
94	dpavlin	12	=head2 tcidbclose
95
96			my $success = tcidbclose( $idb );
97
98	dpavlin	5	=head1 KNOWN BUGS
99	dpavlin	1
100	dpavlin	5	Low-level functions often just die when called on invalid (or deleted) database
101
102			=cut
103
104	dpavlin	1	1;