aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/zstr_8h-source.html
blob: 47bf10b9a9816f443d9ac6a248bb761d618ee3d6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>zstr.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.15 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>zstr.h</h1><div class="fragment"><pre>00001 <font class="comment">/*****************************************************************************</font>
00002 <font class="comment"> * zstr.h   - code for class 'zStr'- a module that reads compressed text</font>
00003 <font class="comment"> *                      files.</font>
00004 <font class="comment"> *                      and provides lookup and parsing functions based on</font>
00005 <font class="comment"> *                      class StrKey</font>
00006 <font class="comment"> *</font>
00007 <font class="comment"> * $Id: zstr_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $</font>
00008 <font class="comment"> *</font>
00009 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font>
00010 <font class="comment"> *      CrossWire Bible Society</font>
00011 <font class="comment"> *      P. O. Box 2528</font>
00012 <font class="comment"> *      Tempe, AZ  85280-2528</font>
00013 <font class="comment"> *</font>
00014 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font>
00015 <font class="comment"> * under the terms of the GNU General Public License as published by the</font>
00016 <font class="comment"> * Free Software Foundation version 2.</font>
00017 <font class="comment"> *</font>
00018 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font>
00019 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00020 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</font>
00021 <font class="comment"> * General Public License for more details.</font>
00022 <font class="comment"> *</font>
00023 <font class="comment"> */</font>
00024 
00025 <font class="preprocessor">#ifndef ZSTR_H</font>
00026 <font class="preprocessor"></font><font class="preprocessor">#define ZSTR_H</font>
00027 <font class="preprocessor"></font>
00028 <font class="preprocessor">#include &lt;filemgr.h&gt;</font>
00029 
00030 <font class="preprocessor">#include &lt;defs.h&gt;</font>
00031 
00032 <font class="keyword">class </font>SWCompress;
00033 <font class="keyword">class </font>EntriesBlock;
00034 
00035 <font class="keyword">class </font>SWDLLEXPORT zStr {
00036 
00037 <font class="keyword">private</font>:
00038         <font class="keyword">static</font> <font class="keywordtype">int</font> instance;            <font class="comment">// number of instantiated zStr objects or derivitives</font>
00039         EntriesBlock *cacheBlock;
00040         <font class="keywordtype">long</font> cacheBlockIndex;
00041         <font class="keywordtype">bool</font> cacheDirty;
00042         <font class="keywordtype">char</font> *path;
00043         <font class="keywordtype">long</font> lastoff;
00044         <font class="keywordtype">long</font> blockCount;
00045         SWCompress *compressor;
00046 
00047 <font class="keyword">protected</font>:
00048         FileDesc *idxfd;
00049         FileDesc *datfd;
00050         FileDesc *zdxfd;
00051         FileDesc *zdtfd;
00052         <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">int</font> IDXENTRYSIZE;
00053         <font class="keyword">static</font> <font class="keyword">const</font> <font class="keywordtype">int</font> ZDXENTRYSIZE;
00054 
00055         <font class="keywordtype">void</font> getCompressedText(<font class="keywordtype">long</font> block, <font class="keywordtype">long</font> entry, <font class="keywordtype">char</font> **buf);
00056         <font class="keywordtype">void</font> flushCache();
00057         <font class="keywordtype">void</font> prepText(<font class="keywordtype">char</font> *buf);
00058         <font class="keywordtype">void</font> getKeyFromDatOffset(<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf);
00059         <font class="keywordtype">void</font> getKeyFromIdxOffset(<font class="keywordtype">long</font> ioffset, <font class="keywordtype">char</font> **buf);
00060 
00061 <font class="keyword">public</font>:
00062         <font class="keywordtype">char</font> nl;
00063         zStr(<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keywordtype">int</font> fileMode = -1, <font class="keywordtype">long</font> blockCount = 100, SWCompress *icomp = 0);
00064         <font class="keyword">virtual</font> ~zStr();
00065         <font class="keywordtype">signed</font> <font class="keywordtype">char</font> findKeyIndex(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey, <font class="keywordtype">long</font> *idxoff, <font class="keywordtype">long</font> away = 0);
00066         <font class="keywordtype">void</font> getText(<font class="keywordtype">long</font> index, <font class="keywordtype">char</font> **idxbuf, <font class="keywordtype">char</font> **buf);
00067         <font class="keywordtype">void</font> setText(<font class="keyword">const</font> <font class="keywordtype">char</font> *ikey, <font class="keyword">const</font> <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> len = 0);
00068         <font class="keywordtype">void</font> linkEntry(<font class="keyword">const</font> <font class="keywordtype">char</font> *destkey, <font class="keyword">const</font> <font class="keywordtype">char</font> *srckey);
00069         <font class="keyword">static</font> <font class="keywordtype">signed</font> <font class="keywordtype">char</font> createModule (<font class="keyword">const</font> <font class="keywordtype">char</font> *path);
00070 };
00071 
00072 <font class="preprocessor">#endif</font>
</pre></div><hr><address align="right"><small>Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.15 </small></address>
</body>
</html>