diff options
Diffstat (limited to 'doc/api-documentation/html/zstr_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/zstr_8h-source.html | 148 |
1 files changed, 76 insertions, 72 deletions
diff --git a/doc/api-documentation/html/zstr_8h-source.html b/doc/api-documentation/html/zstr_8h-source.html index 47bf10b..17889cf 100644 --- a/doc/api-documentation/html/zstr_8h-source.html +++ b/doc/api-documentation/html/zstr_8h-source.html @@ -3,84 +3,88 @@ <title>zstr.h Source File</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> -<!-- Generated by Doxygen 1.2.15 --> +<!-- Generated by Doxygen 1.2.17 --> <center> -<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </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> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> </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 <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 <filemgr.h></font> +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 <filemgr.h></span> 00029 -00030 <font class="preprocessor">#include <defs.h></font> +00030 <span class="preprocessor">#include <defs.h></span> 00031 -00032 <font class="keyword">class </font>SWCompress; -00033 <font class="keyword">class </font>EntriesBlock; -00034 -00035 <font class="keyword">class </font>SWDLLEXPORT zStr { +00032 SWORD_NAMESPACE_START +00033 +00034 <span class="keyword">class </span>SWCompress; +00035 <span class="keyword">class </span>EntriesBlock; 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 +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.15 </small></address> +width=110 height=53></a>1.2.17 </small></address> </body> </html> |