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

  ViewVC Help
Powered by ViewVC 1.1.26