/[Search-TokyoDystopia]/lib/Search/TokyoDystopia.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Contents of /lib/Search/TokyoDystopia.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 26 - (show annotations)
Mon Aug 18 19:04:10 2008 UTC (15 years, 7 months ago) by dpavlin
File size: 2809 byte(s)
tcidbpath
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 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 tcidbclose
33 tcidbput
34 tcidbout
35 tcidbget
36 tcidbsearch
37 tcidbsearch2
38 IDBSSUBSTR
39 IDBSPREFIX
40 IDBSSUFFIX
41 IDBSFULL
42 IDBSTOKEN
43 IDBSTOKPRE
44 IDBSTOKSUF
45 tcidbiterinit
46 tcidbiternext
47 tcidbsync
48 tcidboptimize
49 tcidbvanish
50 tcidbcopy
51 tcidbpath
52 );
53
54 =head1 NAME
55
56 Search::TokyoDystopia - XS bindings for Tokyo Dystopia
57
58 =head1 EXPORTS
59
60 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 my $message = tcidberrmsg( $ecode );
65
66 =head2 tcidbnew
67
68 my $idb = tcidbnew;
69
70 =head2 tcidbdel
71
72 tcidbdel( $idb );
73
74 =head2 tcidbecode
75
76 my $ecode = tcidbecode( $idb );
77
78 =head2 tcidbtune
79
80 my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE | IDBTDEFLATE );
81
82 =cut
83
84 use constant {
85 IDBTLARGE => 1 << 0,
86 IDBTDEFLATE => 1 << 1,
87 IDBTTCBS => 1 << 2,
88 };
89
90 =head2 tcidbsetcache
91
92 my $success = tcidbsetcache( $idb, $icsiz, $lcnum );
93
94 =head2 tcidbsetfwmmax
95
96 my $success = tcidbsetfwmmax( $idb, $fwnum );
97
98 =head2 tcidbopen
99
100 my $success = tcidbopen( $idb, 'casket', IDBOWRITER | IDBOCREAT );
101
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 =head2 tcidbclose
114
115 my $success = tcidbclose( $idb );
116
117 =head2 tcidbput
118
119 my $success = tcidbput( $idb, $id, $text );
120
121 =head2 tcidbout
122
123 my $success = tcidbout( $idb, $id );
124
125 =head2 tcidbget
126
127 my $text = tcidbget( $idb, $id );
128
129 =head2 tcidbsearch
130
131 my $ids = tcidbsearch( $idb, $word, IDBSSUBSTR );
132
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 =head2 tcidbsearch2
146
147 my $ids = tcidbsearch2( $idb, $expr );
148
149 =head2 tcidbiterinit
150
151 my $success = tcidbiterinit( $idb );
152
153 =head2 tcidbiternext
154
155 my $id = tcidbiternext( $idb );
156
157 =head2 tcidbsync
158
159 my $success = tcidbsync( $idb );
160
161 =head2 tcidboptimize
162
163 my $success = tcidboptimize( $idb );
164
165 =head2 tcidbvanish
166
167 my $success = tcidbvanish( $idb );
168
169 =head2 tcidbcopy
170
171 my $success = tcidbcopy( $idb, '/path/of/copy' );
172
173 =head2 tcidbpath
174
175 my $path = tcidbpath( $idb );
176
177 =cut
178
179 =head1 KNOWN BUGS
180
181 Low-level functions often just die when called on invalid (or deleted) database
182
183 =cut
184
185 1;

  ViewVC Help
Powered by ViewVC 1.1.26