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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>swmodule.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.6 -->
<center>
<a class="qindex" href="index.html">Main Page</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>swmodule.h</h1><div class="fragment"><pre>00001 <font class="comment">/******************************************************************************</font>
00002 <font class="comment"> * swmodule.h - code for base class 'module'. Module is the basis for all</font>
00003 <font class="comment"> * types of modules (e.g. texts, commentaries, maps, lexicons,</font>
00004 <font class="comment"> * etc.)</font>
00005 <font class="comment"> *</font>
00006 <font class="comment"> * $Id: swmodule_h-source.html,v 1.4 2001/10/05 20:45:22 mgruner Exp $</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</font>
00009 <font class="comment"> * CrossWire Bible Society</font>
00010 <font class="comment"> * P. O. Box 2528</font>
00011 <font class="comment"> * Tempe, AZ 85280-2528</font>
00012 <font class="comment"> *</font>
00013 <font class="comment"> * This program is free software; you can redistribute it and/or modify it</font>
00014 <font class="comment"> * under the terms of the GNU General Public License as published by the</font>
00015 <font class="comment"> * Free Software Foundation version 2.</font>
00016 <font class="comment"> *</font>
00017 <font class="comment"> * This program is distributed in the hope that it will be useful, but</font>
00018 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00019 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00020 <font class="comment"> * General Public License for more details.</font>
00021 <font class="comment"> *</font>
00022 <font class="comment"> */</font>
00023
00024 <font class="preprocessor">#ifndef SWMODULE_H</font>
00025 <font class="preprocessor"></font><font class="preprocessor">#define SWMODULE_H</font>
00026 <font class="preprocessor"></font>
00027 <font class="preprocessor">#include <swdisp.h></font>
00028 <font class="preprocessor">#include <swkey.h></font>
00029 <font class="preprocessor">#include <listkey.h></font>
00030 <font class="preprocessor">#include <swfilter.h></font>
00031 <font class="preprocessor">#include <list></font>
00032
00033 <font class="preprocessor">#include <defs.h></font>
00034
00035 <font class="preprocessor">#define FILTERPAD 8</font>
00036 <font class="preprocessor"></font>
00037 <font class="keyword">using</font> <font class="keyword">namespace </font>std;
00038
00039 <font class="keyword">typedef</font> list < SWFilter * >FilterList;
00040
00041
<a name="l00047"></a><a class="code" href="class_swmodule.html">00047</a> <font class="keyword">class </font>SWDLLEXPORT <a class="code" href="class_swmodule.html">SWModule</a> {
00048
00049 <font class="keyword">protected</font>:
00050
00051 <font class="keywordtype">char</font> error;
00052
<a name="l00054"></a><a class="code" href="class_swmodule.html#n1">00054</a> <a class="code" href="class_swkey.html">SWKey</a> *key;
00055
00056 <a class="code" href="class_listkey.html">ListKey</a> listkey;
00057 <font class="keywordtype">char</font> *modname;
00058 <font class="keywordtype">char</font> *moddesc;
00059 <font class="keywordtype">char</font> *modtype;
00060
<a name="l00062"></a><a class="code" href="class_swmodule.html#n6">00062</a> <a class="code" href="class_swdisplay.html">SWDisplay</a> *disp;
00063
00064 <font class="keyword">static</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> rawdisp;
00065 <font class="keywordtype">char</font> *entrybuf;
00066
<a name="l00068"></a><a class="code" href="class_swmodule.html#n8">00068</a> FilterList *stripFilters;
00069
<a name="l00071"></a><a class="code" href="class_swmodule.html#n9">00071</a> FilterList *rawFilters;
00072
<a name="l00074"></a><a class="code" href="class_swmodule.html#n10">00074</a> FilterList *renderFilters;
00075
<a name="l00077"></a><a class="code" href="class_swmodule.html#n11">00077</a> FilterList *optionFilters;
00078
00079 <font class="keywordtype">bool</font> render;
00080 <font class="keywordtype">bool</font> unicode;
00081 <font class="keywordtype">int</font> entrySize;
00082
00083 <font class="keyword">public</font>:
00084
00091 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#d0">nullPercent</a> (<font class="keywordtype">char</font> percent, <font class="keywordtype">void</font> *userData);
00092
<a name="l00097"></a><a class="code" href="class_swmodule.html#m0">00097</a> <font class="keywordtype">bool</font> terminateSearch;
00098
00111 <a class="code" href="class_swmodule.html#a0">SWModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0, <font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0, <a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0, <font class="keywordtype">char</font> *imodtype = 0, <font class="keywordtype">bool</font> unicode = <font class="keyword">false</font>);
00112
00115 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a1">~ SWModule</a> ();
00116
00121 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a2">Error</a> ();
00122
<a name="l00126"></a><a class="code" href="class_swmodule.html#a3">00126</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a3">isUnicode</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> unicode;}
<a name="l00130"></a><a class="code" href="class_swmodule.html#a4">00130</a> <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">int</font> <a class="code" href="class_swmodule.html#a4">getEntrySize</a>()<font class="keyword"> const </font>{<font class="keywordflow">return</font> entrySize;}
00131
00139 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *ikey);
00140
00146 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> &ikey);
00147
<a name="l00151"></a><a class="code" href="class_swmodule.html#a7">00151</a> <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> & <a class="code" href="class_swmodule.html#a7">Key</a> ()<font class="keyword"> const </font>{
00152 <font class="keywordflow">return</font> *key;
00153 }
00154
<a name="l00161"></a><a class="code" href="class_swmodule.html#a8">00161</a> <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a7">Key</a> (<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> & ikey)<font class="keyword"> </font>{
00162 <font class="keywordflow">return</font> <a class="code" href="class_swmodule.html#a5">SetKey</a> (ikey);
00163 }
00164
00171 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a9">KeyText</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0);
00172
00177 <font class="keyword">virtual</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#a10">Display</a> ();
00178
00185 <font class="keyword">virtual</font> <a class="code" href="class_swdisplay.html">SWDisplay</a> *<a class="code" href="class_swmodule.html#a11">Disp</a> (<a class="code" href="class_swdisplay.html">SWDisplay</a> * idisp = 0);
00186
00193 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a12">Name</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodname = 0);
00194
00201 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a13">Description</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imoddesc = 0);
00202
00209 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a14">Type</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *imodtype = 0);
00210
00211 <font class="comment">// search methods</font>
00212
00224 <font class="keyword">virtual</font> <a class="code" href="class_listkey.html">ListKey</a> & <a class="code" href="class_swmodule.html#a15">Search</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType = 0, <font class="keywordtype">int</font> flags = 0,
00225 <a class="code" href="class_swkey.html">SWKey</a> * scope = 0,
00226 <font class="keywordtype">bool</font> * justCheckIfSupported = 0,
00227 <font class="keywordtype">void</font> (*percent) (<font class="keywordtype">char</font>, <font class="keywordtype">void</font> *) = &nullPercent,
00228 <font class="keywordtype">void</font> *percentUserData = 0);
00232 <font class="keyword">virtual</font> <font class="keywordtype">char</font> createSearchFramework ()<font class="keyword"> </font>{
00233 <font class="keywordflow">return</font> 0;
00234 } <font class="comment">// special search framework</font>
00235
00239 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> hasSearchFramework ()<font class="keyword"> </font>{
00240 <font class="keywordflow">return</font> <font class="keyword">false</font>;
00241 } <font class="comment">// special search framework</font>
00242
00246 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> isSearchOptimallySupported (<font class="keyword">const</font> <font class="keywordtype">char</font> *istr, <font class="keywordtype">int</font> searchType,
00247 <font class="keywordtype">int</font> flags, <a class="code" href="class_swkey.html">SWKey</a> * scope)<font class="keyword"> </font>{
00248 <font class="keywordtype">bool</font> retVal = <font class="keyword">false</font>;
00249 <a class="code" href="class_swmodule.html#a15">Search</a> (istr, searchType, flags, scope, &retVal);
00250 <font class="keywordflow">return</font> retVal;
00251 }
00252
00257 <font class="keyword">virtual</font> <a class="code" href="class_swkey.html">SWKey</a> *<a class="code" href="class_swmodule.html#a19">CreateKey</a> ();
00258
00262 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html#a20">operator char *</a>();
00263
00268 <font class="keyword">virtual</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a21">getRawEntry</a> () = 0;
00269
00273 <font class="keyword">virtual</font> operator SWKey & ()<font class="keyword"> </font>{
00274 <font class="keywordflow">return</font> *key;
00275 }
00276
00280 <font class="keyword">virtual</font> operator SWKey *()<font class="keyword"> </font>{
00281 <font class="keywordflow">return</font> key;
00282 }
00283
00284 <font class="comment">// write interface ----------------------------</font>
<a name="l00288"></a><a class="code" href="class_swmodule.html#a24">00288</a> <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="class_swmodule.html#a24">isWritable</a> ()<font class="keyword"> </font>{
00289 <font class="keywordflow">return</font> <font class="keyword">false</font>;
00290 }
00291
<a name="l00296"></a><a class="code" href="class_swmodule.html#d1">00296</a> <font class="keyword">static</font> <font class="keywordtype">char</font> <a class="code" href="class_swmodule.html#d1">createModule</a> (<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{
00297 <font class="keywordflow">return</font> -1;
00298 }
00299
<a name="l00304"></a><a class="code" href="class_swmodule.html#a25">00304</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <font class="keywordtype">char</font> *)<font class="keyword"> </font>{
00305 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00306 }
00307
<a name="l00312"></a><a class="code" href="class_swmodule.html#a26">00312</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a25">operator << </a>(<font class="keyword">const</font> <a class="code" href="class_swkey.html">SWKey</a> *)<font class="keyword"> </font>{
00313 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00314 }
00315
<a name="l00319"></a><a class="code" href="class_swmodule.html#a27">00319</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a27">deleteEntry</a> ()<font class="keyword"> </font>{
00320 }
00321
00322 <font class="comment">// end write interface ------------------------</font>
00323
00329 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a28">operator -= </a>(<font class="keywordtype">int</font> decrement);
00330
00336 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a29">operator += </a>(<font class="keywordtype">int</font> increment);
00337
<a name="l00341"></a><a class="code" href="class_swmodule.html#a30">00341</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a30">operator++ </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{
00342 <font class="keywordflow">return</font> *<font class="keyword">this</font> += 1;
00343 }
00344
<a name="l00348"></a><a class="code" href="class_swmodule.html#a31">00348</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a31">operator-- </a>(<font class="keywordtype">int</font>)<font class="keyword"> </font>{
00349 <font class="keywordflow">return</font> *<font class="keyword">this</font> -= 1;
00350 }
00351
00357 <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a32">operator = </a>(SW_POSITION p);
00358
<a name="l00363"></a><a class="code" href="class_swmodule.html#a33">00363</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a33">AddRenderFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{
00364 renderFilters->push_back (newfilter);
00365 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00366 }
00367
<a name="l00372"></a><a class="code" href="class_swmodule.html#a34">00372</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a34">RemoveRenderFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * oldfilter)<font class="keyword"> </font>{
00373 renderFilters->remove (oldfilter);
00374 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00375 }
00376
<a name="l00383"></a><a class="code" href="class_swmodule.html#a35">00383</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a35">renderFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{
00384 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(renderFilters, buf, size, key);
00385 }
00386
<a name="l00391"></a><a class="code" href="class_swmodule.html#a36">00391</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a36">AddStripFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{
00392 stripFilters->push_back (newfilter);
00393 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00394 }
00395
<a name="l00402"></a><a class="code" href="class_swmodule.html#a37">00402</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a37">stripFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{
00403 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(stripFilters, buf, size, key);
00404 }
00405
<a name="l00410"></a><a class="code" href="class_swmodule.html#a38">00410</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a38">AddRawFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{
00411 rawFilters->push_back (newfilter);
00412 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00413 }
00414
<a name="l00422"></a><a class="code" href="class_swmodule.html#a39">00422</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a39">filterBuffer</a> (FilterList *filters, <font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{
00423 FilterList::iterator it;
00424 <font class="keywordflow">for</font> (it = filters->begin(); it != filters->end(); it++) {
00425 (*it)->ProcessText(buf, size, key);
00426 }
00427 }
00428
<a name="l00435"></a><a class="code" href="class_swmodule.html#a40">00435</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a40">rawFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{
00436 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(rawFilters, buf, size, key);
00437 }
00438
<a name="l00443"></a><a class="code" href="class_swmodule.html#a41">00443</a> <font class="keyword">virtual</font> <a class="code" href="class_swmodule.html">SWModule</a> & <a class="code" href="class_swmodule.html#a41">AddOptionFilter</a> (<a class="code" href="class_swfilter.html">SWFilter</a> * newfilter)<font class="keyword"> </font>{
00444 optionFilters->push_back (newfilter);
00445 <font class="keywordflow">return</font> *<font class="keyword">this</font>;
00446 }
00447
<a name="l00454"></a><a class="code" href="class_swmodule.html#a42">00454</a> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="class_swmodule.html#a42">optionFilter</a> (<font class="keywordtype">char</font> *buf, <font class="keywordtype">long</font> size, <a class="code" href="class_swkey.html">SWKey</a> *key)<font class="keyword"> </font>{
00455 <a class="code" href="class_swmodule.html#a39">filterBuffer</a>(optionFilters, buf, size, key);
00456 }
00457
00465 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a43">StripText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1);
00466
00474 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a44">RenderText</a> (<font class="keywordtype">char</font> *buf = 0, <font class="keywordtype">int</font> len = -1);
00475
00481 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a43">StripText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey);
00482
00488 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="class_swmodule.html#a44">RenderText</a> (<a class="code" href="class_swkey.html">SWKey</a> * tmpKey);
00489
00490 };
00491
00492
00493 <font class="preprocessor">#endif</font>
</font></pre></div><hr><address><small>Generated at Fri Oct 5 22:45:33 2001 for The Sword Project by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.6 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
|
