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
tcidbiternext
tcidbsync
);

=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( $idb );

=head2 tcidbiternext

  my $id = tcidbiternext( $idb );

=head2 tcidbsync

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