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

  ViewVC Help
Powered by ViewVC 1.1.26