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

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

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