diff options
Diffstat (limited to 'doc/api-documentation/html/zcom_8h-source.html')
| -rw-r--r-- | doc/api-documentation/html/zcom_8h-source.html | 147 |
1 files changed, 78 insertions, 69 deletions
diff --git a/doc/api-documentation/html/zcom_8h-source.html b/doc/api-documentation/html/zcom_8h-source.html index 3f79593..f024413 100644 --- a/doc/api-documentation/html/zcom_8h-source.html +++ b/doc/api-documentation/html/zcom_8h-source.html @@ -3,81 +3,90 @@ <title>zcom.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>zcom.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font> -00002 <font class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text</font> -00003 <font class="comment"> * files: ot and nt using indexs ??.vss</font> -00004 <font class="comment"> *</font> -00005 <font class="comment"> * $Id: zcom_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $</font> -00006 <font class="comment"> *</font> -00007 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font> -00008 <font class="comment"> * CrossWire Bible Society</font> -00009 <font class="comment"> * P. O. Box 2528</font> -00010 <font class="comment"> * Tempe, AZ 85280-2528</font> -00011 <font class="comment"> *</font> -00012 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font> -00013 <font class="comment"> * under the terms of the GNU General Public License as published by the</font> -00014 <font class="comment"> * Free Software Foundation version 2.</font> -00015 <font class="comment"> *</font> -00016 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font> -00017 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> -00018 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> -00019 <font class="comment"> * General Public License for more details.</font> -00020 <font class="comment"> *</font> -00021 <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>zcom.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span> +00002 <span class="comment"> * zcom.h - code for class 'zCom'- a module that reads compressed text</span> +00003 <span class="comment"> * files: ot and nt using indexs ??.vss</span> +00004 <span class="comment"> *</span> +00005 <span class="comment"> * $Id: zcom_8h-source.html,v 1.9 2002/10/31 11:30:16 joachim Exp $</span> +00006 <span class="comment"> *</span> +00007 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span> +00008 <span class="comment"> * CrossWire Bible Society</span> +00009 <span class="comment"> * P. O. Box 2528</span> +00010 <span class="comment"> * Tempe, AZ 85280-2528</span> +00011 <span class="comment"> *</span> +00012 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span> +00013 <span class="comment"> * under the terms of the GNU General Public License as published by the</span> +00014 <span class="comment"> * Free Software Foundation version 2.</span> +00015 <span class="comment"> *</span> +00016 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span> +00017 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span> +00018 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> +00019 <span class="comment"> * General Public License for more details.</span> +00020 <span class="comment"> *</span> +00021 <span class="comment"> */</span> 00022 -00023 <font class="preprocessor">#ifndef ZCOM_H</font> -00024 <font class="preprocessor"></font><font class="preprocessor">#define ZCOM_H</font> -00025 <font class="preprocessor"></font> -00026 <font class="preprocessor">#include <rawverse.h></font> -00027 <font class="preprocessor">#include <swcom.h></font> -00028 <font class="preprocessor">#include <swcomprs.h></font> +00023 <span class="preprocessor">#ifndef ZCOM_H</span> +00024 <span class="preprocessor"></span><span class="preprocessor">#define ZCOM_H</span> +00025 <span class="preprocessor"></span> +00026 <span class="preprocessor">#include <rawverse.h></span> +00027 <span class="preprocessor">#include <swcom.h></span> +00028 <span class="preprocessor">#include <swcomprs.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>SWDLLEXPORT zCom:<font class="keyword">public</font> zVerse, <font class="keyword">public</font> <a class="code" href="class_s_w_com.html">SWCom</a> { -00033 <a class="code" href="class_verse_key.html">VerseKey</a> *lastWriteKey; -00034 <font class="keywordtype">bool</font> sameBlock (<a class="code" href="class_verse_key.html">VerseKey</a> * lastWriteKey, <a class="code" href="class_verse_key.html">VerseKey</a> * key); -00035 <font class="keywordtype">int</font> blockType; -00036 <font class="keyword">public</font>: -00037 -00038 -00039 zCom (<font class="keyword">const</font> <font class="keywordtype">char</font> *ipath, <font class="keyword">const</font> <font class="keywordtype">char</font> *iname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *idesc = -00040 0, <font class="keywordtype">int</font> blockType = CHAPTERBLOCKS, SWCompress * icomp = -00041 0, <a class="code" href="class_s_w_display.html">SWDisplay</a> * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, -00042 <font class="keyword">const</font> <font class="keywordtype">char</font>* ilang = 0); -00043 <font class="keyword">virtual</font> ~ zCom (); -00044 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_s_w_module.html#a28">getRawEntry</a> (); -00045 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a37">operator += </a>(<font class="keywordtype">int</font> increment); -00046 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a36">operator -= </a>(<font class="keywordtype">int</font> decrement) -00047 { -00048 <font class="keywordflow">return</font> this-><a class="code" href="class_s_w_module.html#a37">operator += </a>(-decrement); -00049 } -00050 -00051 <font class="comment">// write interface ----------------------------</font> -00052 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_s_w_module.html#a31">isWritable</a> () { <font class="keywordflow">return</font> ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); } -00053 <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_s_w_module.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *path, <font class="keywordtype">int</font> blockBound) -00054 { -00055 <font class="keywordflow">return</font> zVerse::createModule (path, blockBound); -00056 } -00057 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a32">setentry</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf, <font class="keywordtype">long</font> len); <font class="comment">// Modify current module entry</font> -00058 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *inbuf); <font class="comment">// Modify current module entry</font> -00059 <font class="keyword">virtual</font> <a class="code" href="class_s_w_module.html">SWModule</a> & <a class="code" href="class_s_w_module.html#a33">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_s_w_key.html">SWKey</a> * linkKey); <font class="comment">// Link current module entry to other module entry</font> -00060 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_s_w_module.html#a35">deleteEntry</a> (); <font class="comment">// Delete current module entry</font> -00061 <font class="comment">// end write interface ------------------------</font> -00062 -00063 <font class="comment">// swcacher interface ----------------------</font> -00064 <font class="keyword">virtual</font> <font class="keywordtype">void</font> flush() { flushCache(); } -00065 <font class="comment">// end swcacher interface ----------------------</font> -00066 }; +00032 SWORD_NAMESPACE_START +00033 +00034 <span class="keyword">class </span>SWDLLEXPORT zCom:<span class="keyword">public</span> zVerse, <span class="keyword">public</span> SWCom { +00035 +00036 VerseKey *lastWriteKey; +00037 <span class="keywordtype">bool</span> sameBlock(VerseKey * lastWriteKey, VerseKey * key); +00038 <span class="keywordtype">int</span> blockType; +00039 VerseKey &getVerseKey(); +00040 +00041 +00042 <span class="keyword">public</span>: +00043 +00044 zCom(<span class="keyword">const</span> <span class="keywordtype">char</span> *ipath, <span class="keyword">const</span> <span class="keywordtype">char</span> *iname = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> *idesc = 0, +00045 <span class="keywordtype">int</span> blockType = CHAPTERBLOCKS, SWCompress * icomp = 0, +00046 SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, +00047 SWTextDirection dir = DIRECTION_LTR, +00048 SWTextMarkup markup = FMT_UNKNOWN, <span class="keyword">const</span> <span class="keywordtype">char</span>* ilang = 0); +00049 <span class="keyword">virtual</span> ~zCom(); +00050 <span class="keyword">virtual</span> <span class="keywordtype">char</span> *getRawEntry(); +00051 <span class="keyword">virtual</span> <span class="keywordtype">void</span> increment(<span class="keywordtype">int</span> steps = 1); +00052 <span class="keyword">virtual</span> <span class="keywordtype">void</span> decrement(<span class="keywordtype">int</span> steps = 1) { increment(-steps); } +00053 +00054 <span class="comment">// write interface ----------------------------</span> +00055 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isWritable() { +00056 <span class="keywordflow">return</span> ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); +00057 } +00058 <span class="keyword">static</span> <span class="keywordtype">char</span> createModule(<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keywordtype">int</span> blockBound) { +00059 <span class="keywordflow">return</span> zVerse::createModule(path, blockBound); +00060 } +00061 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEntry(<span class="keyword">const</span> <span class="keywordtype">char</span> *inbuf, <span class="keywordtype">long</span> len = -1); <span class="comment">// Modify current module entry</span> +00062 <span class="keyword">virtual</span> <span class="keywordtype">void</span> linkEntry(<span class="keyword">const</span> SWKey * linkKey); <span class="comment">// Link current module entry to other module entry</span> +00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> deleteEntry(); <span class="comment">// Delete current module entry</span> +00064 <span class="comment">// end write interface ------------------------</span> +00065 +00066 <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) { rawFilter(buf, size, (SWKey *)(<span class="keywordtype">long</span>)direction); }<span class="comment">// hack, use key as direction for enciphering</span> 00067 -00068 -00069 <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 +00068 <span class="comment">// swcacher interface ----------------------</span> +00069 <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() { flushCache(); } +00070 <span class="comment">// end swcacher interface ----------------------</span> +00071 +00072 SWMODULE_OPERATORS +00073 +00074 }; +00075 +00076 SWORD_NAMESPACE_END +00077 +00078 <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> |