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
tcidbout
tcidbget
tcidbsearch
IDBSSUBSTR
IDBSPREFIX
IDBSSUFFIX
IDBSFULL
IDBSTOKEN
IDBSTOKPRE
IDBSTOKSUF
tcidbiterinit
);

=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, $text );

=head2 tcidbout
  
  my $success = tcidbout( $idb, $id );

=head2 tcidbget
  
  my $text = tcidbget( $idb, $id );

=head2 tcidbsearch

  my @ids = tcidbsearch( $idb, $word, IDBSSUBSTR )

=cut

use constant {
        IDBSSUBSTR => 0,                # substring matching
        IDBSPREFIX => 1,                # prefix matching
        IDBSSUFFIX => 2,                # suffix matching
        IDBSFULL => 3,          # full matching
        IDBSTOKEN => 4,         # token matching
        IDBSTOKPRE => 5,                # token prefix matching
        IDBSTOKSUF => 6,                # token suffix matching
};

=head2 tcidbiterinit

  my $success = tcidbiterinit;

=cut

=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	15	tcidbout
35	dpavlin	17	tcidbget
36	dpavlin	18	tcidbsearch
37			IDBSSUBSTR
38			IDBSPREFIX
39			IDBSSUFFIX
40			IDBSFULL
41			IDBSTOKEN
42			IDBSTOKPRE
43			IDBSTOKSUF
44	dpavlin	19	tcidbiterinit
45	dpavlin	10	);
46
47	dpavlin	1	=head1 NAME
48
49			Search::TokyoDystopia - XS bindings for Tokyo Dystopia
50
51	dpavlin	10	=head1 EXPORTS
52	dpavlin	1
53	dpavlin	10	If you don't prevent it, it will export all kind of stuff into your namespace to cut down on typing.
54
55			=head2 tcidberrmsg
56
57	dpavlin	12	my $message = tcidberrmsg( $ecode );
58	dpavlin	10
59			=head2 tcidbnew
60
61	dpavlin	12	my $idb = tcidbnew;
62	dpavlin	10
63			=head2 tcidbdel
64
65	dpavlin	12	tcidbdel( $idb );
66	dpavlin	10
67			=head2 tcidbecode
68
69	dpavlin	12	my $ecode = tcidbecode( $idb );
70	dpavlin	10
71			=head2 tcidbtune
72
73	dpavlin	13	my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE \| IDBTDEFLATE );
74	dpavlin	10
75	dpavlin	1	=cut
76
77	dpavlin	10	use constant {
78			IDBTLARGE => 1 << 0,
79			IDBTDEFLATE => 1 << 1,
80			IDBTTCBS => 1 << 2,
81			};
82
83			=head2 tcidbsetcache
84
85	dpavlin	12	my $success = tcidbsetcache( $idb, $icsiz, $lcnum );
86	dpavlin	10
87			=head2 tcidbsetfwmmax
88
89	dpavlin	12	my $success = tcidbsetfwmmax( $idb, $fwnum );
90	dpavlin	10
91			=head2 tcidbopen
92
93	dpavlin	13	my $success = tcidbopen( $idb, 'casket', IDBOWRITER \| IDBOCREAT );
94	dpavlin	10
95			=cut
96
97			use constant {
98			IDBOREADER => 1 << 0,
99			IDBOWRITER => 1 << 1,
100			IDBOCREAT => 1 << 2,
101			IDBOTRUNC => 1 << 3,
102			IDBONOLCK => 1 << 4,
103			IDBOLCKNB => 1 << 5,
104			};
105
106	dpavlin	12	=head2 tcidbclose
107
108			my $success = tcidbclose( $idb );
109
110	dpavlin	14	=head2 tcidbput
111
112	dpavlin	17	my $success = tcidbput( $idb, $id, $text );
113	dpavlin	14
114	dpavlin	16	=head2 tcidbout
115
116			my $success = tcidbout( $idb, $id );
117
118	dpavlin	17	=head2 tcidbget
119
120			my $text = tcidbget( $idb, $id );
121
122	dpavlin	18	=head2 tcidbsearch
123
124			my @ids = tcidbsearch( $idb, $word, IDBSSUBSTR )
125
126			=cut
127
128			use constant {
129			IDBSSUBSTR => 0, # substring matching
130			IDBSPREFIX => 1, # prefix matching
131			IDBSSUFFIX => 2, # suffix matching
132			IDBSFULL => 3, # full matching
133			IDBSTOKEN => 4, # token matching
134			IDBSTOKPRE => 5, # token prefix matching
135			IDBSTOKSUF => 6, # token suffix matching
136			};
137
138	dpavlin	19	=head2 tcidbiterinit
139
140			my $success = tcidbiterinit;
141
142			=cut
143
144	dpavlin	5	=head1 KNOWN BUGS
145	dpavlin	1
146	dpavlin	5	Low-level functions often just die when called on invalid (or deleted) database
147
148			=cut
149
150	dpavlin	1	1;