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
tcidbput
);

=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 );

=head2 tcidbput

  my $success = tcidbput( $idb, $id, $utf8_text );

=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	14	tcidbput
34	dpavlin	10	);
35
36	dpavlin	1	=head1 NAME
37
38			Search::TokyoDystopia - XS bindings for Tokyo Dystopia
39
40	dpavlin	10	=head1 EXPORTS
41	dpavlin	1
42	dpavlin	10	If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing.
43
44			=head2 tcidberrmsg
45
46	dpavlin	12	my $message = tcidberrmsg( $ecode );
47	dpavlin	10
48			=head2 tcidbnew
49
50	dpavlin	12	my $idb = tcidbnew;
51	dpavlin	10
52			=head2 tcidbdel
53
54	dpavlin	12	tcidbdel( $idb );
55	dpavlin	10
56			=head2 tcidbecode
57
58	dpavlin	12	my $ecode = tcidbecode( $idb );
59	dpavlin	10
60			=head2 tcidbtune
61
62	dpavlin	13	my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE \| IDBTDEFLATE );
63	dpavlin	10
64	dpavlin	1	=cut
65
66	dpavlin	10	use constant {
67			IDBTLARGE => 1 << 0,
68			IDBTDEFLATE => 1 << 1,
69			IDBTTCBS => 1 << 2,
70			};
71
72			=head2 tcidbsetcache
73
74	dpavlin	12	my $success = tcidbsetcache( $idb, $icsiz, $lcnum );
75	dpavlin	10
76			=head2 tcidbsetfwmmax
77
78	dpavlin	12	my $success = tcidbsetfwmmax( $idb, $fwnum );
79	dpavlin	10
80			=head2 tcidbopen
81
82	dpavlin	13	my $success = tcidbopen( $idb, 'casket', IDBOWRITER \| IDBOCREAT );
83	dpavlin	10
84			=cut
85
86			use constant {
87			IDBOREADER => 1 << 0,
88			IDBOWRITER => 1 << 1,
89			IDBOCREAT => 1 << 2,
90			IDBOTRUNC => 1 << 3,
91			IDBONOLCK => 1 << 4,
92			IDBOLCKNB => 1 << 5,
93			};
94
95	dpavlin	12	=head2 tcidbclose
96
97			my $success = tcidbclose( $idb );
98
99	dpavlin	14	=head2 tcidbput
100
101			my $success = tcidbput( $idb, $id, $utf8_text );
102
103	dpavlin	5	=head1 KNOWN BUGS
104	dpavlin	1
105	dpavlin	5	Low-level functions often just die when called on invalid (or deleted) database
106
107			=cut
108
109	dpavlin	1	1;