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
tcidbsearch2
IDBSSUBSTR
IDBSPREFIX
IDBSSUFFIX
IDBSFULL
IDBSTOKEN
IDBSTOKPRE
IDBSTOKSUF
tcidbiterinit
tcidbiternext
tcidbsync
tcidboptimize
tcidbvanish
tcidbcopy
tcidbpath
);

=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 tcidbsearch2

  my $ids = tcidbsearch2( $idb, $expr );

=head2 tcidbiterinit

  my $success = tcidbiterinit( $idb );

=head2 tcidbiternext

  my $id = tcidbiternext( $idb );

=head2 tcidbsync

  my $success = tcidbsync( $idb );

=head2 tcidboptimize

  my $success = tcidboptimize( $idb );

=head2 tcidbvanish

  my $success = tcidbvanish( $idb );

=head2 tcidbcopy

  my $success = tcidbcopy( $idb, '/path/of/copy' );

=head2 tcidbpath

  my $path = tcidbpath( $idb );

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