aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api-documentation/html/ztext_8h-source.html
blob: 432e693f0ef2a1b6c5f13091431a7bc3458bde59 (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
91
92
93
94
95
96
<!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>ztext.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>ztext.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span>
00002 <span class="comment"> *  ztext.h   - code for class 'zText'- 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: ztext_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 <span class="preprocessor">#ifndef ZTEXT_H</span>
00024 <span class="preprocessor"></span><span class="preprocessor">#define ZTEXT_H</span>
00025 <span class="preprocessor"></span>
00026 <span class="preprocessor">#include &lt;zverse.h&gt;</span>
00027 <span class="preprocessor">#include &lt;swtext.h&gt;</span>
00028 <span class="comment">//#include &lt;swcomprs.h&gt;</span>
00029 
00030 <span class="preprocessor">#include &lt;defs.h&gt;</span>
00031 
00032 SWORD_NAMESPACE_START
00033 
00034 <span class="comment">/*** SWModule implementation for compressed modules</span>
00035 <span class="comment">* This class handles compressed modules.</span>
00036 <span class="comment">* It should not be used in frontends, unless you are doing very special things.</span>
00037 <span class="comment">*/</span>
00038 <span class="keyword">class </span>SWDLLEXPORT zText:<span class="keyword">public</span> zVerse, <span class="keyword">public</span> SWText {
00039 
00040      VerseKey *lastWriteKey;
00041      <span class="keywordtype">bool</span> sameBlock(VerseKey * lastWriteKey, VerseKey * key);
00042         <span class="keywordtype">int</span> blockType;
00043         VerseKey &amp;getVerseKey();
00044 
00045 
00046 <span class="keyword">public</span>:
00047     
00048         zText(<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,
00049                         <span class="keywordtype">int</span> blockType = CHAPTERBLOCKS, SWCompress * icomp = 0,
00050                         SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
00051                         SWTextDirection dir = DIRECTION_LTR,
00052                         SWTextMarkup markup = FMT_UNKNOWN, <span class="keyword">const</span> <span class="keywordtype">char</span>* ilang = 0);
00053 
00054         <span class="keyword">virtual</span> ~zText();
00055         <span class="keyword">virtual</span> <span class="keywordtype">char</span> *getRawEntry();
00056 
00057         <span class="keyword">virtual</span> <span class="keywordtype">void</span> increment(<span class="keywordtype">int</span> steps = 1);
00058         <span class="keyword">virtual</span> <span class="keywordtype">void</span> decrement(<span class="keywordtype">int</span> steps = 1) { increment(-steps); }
00059 
00060   <span class="comment">// write interface ----------------------------</span>
00061         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isWritable() { <span class="keywordflow">return</span> ((idxfp[0]-&gt;getFd() &gt; 0) &amp;&amp; ((idxfp[0]-&gt;mode &amp; O_RDWR) == O_RDWR)); }
00062         <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) {
00063                 <span class="keywordflow">return</span> zVerse::createModule(path, blockBound);
00064         }
00065 
00066      <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>
00067      <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>
00068      <span class="keyword">virtual</span> <span class="keywordtype">void</span> deleteEntry();        <span class="comment">// Delete current module entry</span>
00069   <span class="comment">// end write interface ------------------------</span>
00070   
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) { rawFilter(buf, size, (SWKey *)(<span class="keywordtype">long</span>)direction); }<span class="comment">// hack, use key as direction for enciphering</span>
00072 
00073         <span class="comment">// swcacher interface ----------------------</span>
00074         <span class="keyword">virtual</span> <span class="keywordtype">void</span> flush() { flushCache(); }
00075         <span class="comment">// end swcacher interface ----------------------</span>
00076 
00077         SWMODULE_OPERATORS
00078 
00079 };
00080 
00081 SWORD_NAMESPACE_END
00082 <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>