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

  ViewVC Help
Powered by ViewVC 1.1.26