aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/zstr_8h-source.html
blob: 17889cfa6bb3c311a19b330b412c1002b02513f7 (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
87
88
89
90
<!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.17 -->
<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="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>zstr.h</h1><div class="fragment"><pre>00001 <span class="comment">/*****************************************************************************</span>
00002 <span class="comment"> * zstr.h   - code for class 'zStr'- a module that reads compressed text</span>
00003 <span class="comment"> *                      files.</span>
00004 <span class="comment"> *                      and provides lookup and parsing functions based on</span>
00005 <span class="comment"> *                      class StrKey</span>
00006 <span class="comment"> *</span>
00007 <span class="comment"> * $Id: zstr_8h-source.html,v 1.5 2002/10/31 11:30:16 joachim Exp $</span>
00008 <span class="comment"> *</span>
00009 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span>
00010 <span class="comment"> *      CrossWire Bible Society</span>
00011 <span class="comment"> *      P. O. Box 2528</span>
00012 <span class="comment"> *      Tempe, AZ  85280-2528</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span>
00015 <span class="comment"> * under the terms of the GNU General Public License as published by the</span>
00016 <span class="comment"> * Free Software Foundation version 2.</span>
00017 <span class="comment"> *</span>
00018 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span>
00019 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
00020 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
00021 <span class="comment"> * General Public License for more details.</span>
00022 <span class="comment"> *</span>
00023 <span class="comment"> */</span>
00024 
00025 <span class="preprocessor">#ifndef ZSTR_H</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define ZSTR_H</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include &lt;filemgr.h&gt;</span>
00029 
00030 <span class="preprocessor">#include &lt;defs.h&gt;</span>
00031 
00032 SWORD_NAMESPACE_START
00033 
00034 <span class="keyword">class </span>SWCompress;
00035 <span class="keyword">class </span>EntriesBlock;
00036 
00037 <span class="keyword">class </span>SWDLLEXPORT zStr {
00038 
00039 <span class="keyword">private</span>:
00040         <span class="keyword">static</span> <span class="keywordtype">int</span> instance;            <span class="comment">// number of instantiated zStr objects or derivitives</span>
00041         EntriesBlock *cacheBlock;
00042         <span class="keywordtype">long</span> cacheBlockIndex;
00043         <span class="keywordtype">bool</span> cacheDirty;
00044         <span class="keywordtype">char</span> *path;
00045         <span class="keywordtype">long</span> lastoff;
00046         <span class="keywordtype">long</span> blockCount;
00047         SWCompress *compressor;
00048 
00049 <span class="keyword">protected</span>:
00050         FileDesc *idxfd;
00051         FileDesc *datfd;
00052         FileDesc *zdxfd;
00053         FileDesc *zdtfd;
00054         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> IDXENTRYSIZE;
00055         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> ZDXENTRYSIZE;
00056 
00057         <span class="keywordtype">void</span> getCompressedText(<span class="keywordtype">long</span> block, <span class="keywordtype">long</span> entry, <span class="keywordtype">char</span> **buf);
00058         <span class="keywordtype">void</span> flushCache();
00059         <span class="keywordtype">void</span> prepText(<span class="keywordtype">char</span> *buf);
00060         <span class="keywordtype">void</span> getKeyFromDatOffset(<span class="keywordtype">long</span> ioffset, <span class="keywordtype">char</span> **buf);
00061         <span class="keywordtype">void</span> getKeyFromIdxOffset(<span class="keywordtype">long</span> ioffset, <span class="keywordtype">char</span> **buf);
00062 
00063 <span class="keyword">public</span>:
00064         <span class="keywordtype">char</span> nl;
00065         zStr(<span class="keyword">const</span> <span class="keywordtype">char</span> *ipath, <span class="keywordtype">int</span> fileMode = -1, <span class="keywordtype">long</span> blockCount = 100, SWCompress *icomp = 0);
00066         <span class="keyword">virtual</span> ~zStr();
00067         <span class="keywordtype">signed</span> <span class="keywordtype">char</span> findKeyIndex(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey, <span class="keywordtype">long</span> *idxoff, <span class="keywordtype">long</span> away = 0);
00068         <span class="keywordtype">void</span> getText(<span class="keywordtype">long</span> index, <span class="keywordtype">char</span> **idxbuf, <span class="keywordtype">char</span> **buf);
00069         <span class="keywordtype">void</span> setText(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey, <span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">long</span> len = -1);
00070         <span class="keywordtype">void</span> linkEntry(<span class="keyword">const</span> <span class="keywordtype">char</span> *destkey, <span class="keyword">const</span> <span class="keywordtype">char</span> *srckey);
00071         <span class="keyword">virtual</span> <span class="keywordtype">void</span> rawZFilter(<span class="keywordtype">char</span> *buf, <span class="keywordtype">long</span> size, <span class="keywordtype">char</span> direction = 0) {}
00072         <span class="keyword">static</span> <span class="keywordtype">signed</span> <span class="keywordtype">char</span> createModule (<span class="keyword">const</span> <span class="keywordtype">char</span> *path);
00073 };
00074 
00075 SWORD_NAMESPACE_END
00076 <span class="preprocessor">#endif</span>
</pre></div><hr><address style="align: right;"><small>Generated on Thu Oct 31 12:11:28 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.17 </small></address>
</body>
</html>