/[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

Annotation of /lib/Search/TokyoDystopia.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 28 - (hide annotations)
Mon Aug 18 19:18:53 2008 UTC (15 years, 7 months ago) by dpavlin
File size: 2949 byte(s)
tcidbfsiz
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 27 tcidbrnum
53 dpavlin 28 tcidbfsiz
54 dpavlin 10 );
55    
56 dpavlin 1 =head1 NAME
57    
58     Search::TokyoDystopia - XS bindings for Tokyo Dystopia
59    
60 dpavlin 10 =head1 EXPORTS
61 dpavlin 1
62 dpavlin 10 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 dpavlin 12 my $message = tcidberrmsg( $ecode );
67 dpavlin 10
68     =head2 tcidbnew
69    
70 dpavlin 12 my $idb = tcidbnew;
71 dpavlin 10
72     =head2 tcidbdel
73    
74 dpavlin 12 tcidbdel( $idb );
75 dpavlin 10
76     =head2 tcidbecode
77    
78 dpavlin 12 my $ecode = tcidbecode( $idb );
79 dpavlin 10
80     =head2 tcidbtune
81    
82 dpavlin 13 my $success = tcidbtune( $idb, $ernum, $etnum, $iusiz, IDBTLARGE | IDBTDEFLATE );
83 dpavlin 10
84 dpavlin 1 =cut
85    
86 dpavlin 10 use constant {
87     IDBTLARGE => 1 << 0,
88     IDBTDEFLATE => 1 << 1,
89     IDBTTCBS => 1 << 2,
90     };
91    
92     =head2 tcidbsetcache
93    
94 dpavlin 12 my $success = tcidbsetcache( $idb, $icsiz, $lcnum );
95 dpavlin 10
96     =head2 tcidbsetfwmmax
97    
98 dpavlin 12 my $success = tcidbsetfwmmax( $idb, $fwnum );
99 dpavlin 10
100     =head2 tcidbopen
101    
102 dpavlin 13 my $success = tcidbopen( $idb, 'casket', IDBOWRITER | IDBOCREAT );
103 dpavlin 10
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 dpavlin 12 =head2 tcidbclose
116    
117     my $success = tcidbclose( $idb );
118    
119 dpavlin 14 =head2 tcidbput
120    
121 dpavlin 17 my $success = tcidbput( $idb, $id, $text );
122 dpavlin 14
123 dpavlin 16 =head2 tcidbout
124    
125     my $success = tcidbout( $idb, $id );
126    
127 dpavlin 17 =head2 tcidbget
128    
129     my $text = tcidbget( $idb, $id );
130    
131 dpavlin 18 =head2 tcidbsearch
132    
133 dpavlin 22 my $ids = tcidbsearch( $idb, $word, IDBSSUBSTR );
134 dpavlin 18
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 dpavlin 22 =head2 tcidbsearch2
148    
149     my $ids = tcidbsearch2( $idb, $expr );
150    
151 dpavlin 19 =head2 tcidbiterinit
152    
153 dpavlin 20 my $success = tcidbiterinit( $idb );
154 dpavlin 19
155 dpavlin 20 =head2 tcidbiternext
156    
157     my $id = tcidbiternext( $idb );
158    
159 dpavlin 21 =head2 tcidbsync
160    
161     my $success = tcidbsync( $idb );
162    
163 dpavlin 23 =head2 tcidboptimize
164    
165     my $success = tcidboptimize( $idb );
166    
167 dpavlin 24 =head2 tcidbvanish
168    
169     my $success = tcidbvanish( $idb );
170    
171 dpavlin 25 =head2 tcidbcopy
172    
173     my $success = tcidbcopy( $idb, '/path/of/copy' );
174    
175 dpavlin 26 =head2 tcidbpath
176    
177     my $path = tcidbpath( $idb );
178    
179 dpavlin 27 =head2 tcidbrnum
180    
181     my $number_of_records = tcidbrnum( $idb );
182    
183 dpavlin 28 =head2 tcidbfsiz
184    
185     my $file_size = tcidbfsiz( $idb );
186    
187 dpavlin 19 =cut
188    
189 dpavlin 5 =head1 KNOWN BUGS
190 dpavlin 1
191 dpavlin 5 Low-level functions often just die when called on invalid (or deleted) database
192    
193     =cut
194    
195 dpavlin 1 1;

  ViewVC Help
Powered by ViewVC 1.1.26