blob: a417c0711a3e0c4974a8c3a9de8d6adcde2e396d (
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
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
|
<!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>versekey.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> <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>versekey.h</h1><div class="fragment"><pre>00001 <span class="comment">/******************************************************************************</span>
00002 <span class="comment"> * versekey.h - code for class 'versekey'- a standard Biblical verse key</span>
00003 <span class="comment"> *</span>
00004 <span class="comment"> * $Id: versekey_8h-source.html,v 1.9 2002/10/31 11:30:16 joachim Exp $</span>
00005 <span class="comment"> *</span>
00006 <span class="comment"> * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)</span>
00007 <span class="comment"> * CrossWire Bible Society</span>
00008 <span class="comment"> * P. O. Box 2528</span>
00009 <span class="comment"> * Tempe, AZ 85280-2528</span>
00010 <span class="comment"> *</span>
00011 <span class="comment"> * This program is free software; you can redistribute it and/or modify it</span>
00012 <span class="comment"> * under the terms of the GNU General Public License as published by the</span>
00013 <span class="comment"> * Free Software Foundation version 2.</span>
00014 <span class="comment"> *</span>
00015 <span class="comment"> * This program is distributed in the hope that it will be useful, but</span>
00016 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
00017 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
00018 <span class="comment"> * General Public License for more details.</span>
00019 <span class="comment"> *</span>
00020 <span class="comment"> */</span>
00021
00022
00023 <span class="preprocessor">#ifndef VERSEKEY_H</span>
00024 <span class="preprocessor"></span><span class="preprocessor">#define VERSEKEY_H</span>
00025 <span class="preprocessor"></span>
00026 <span class="preprocessor">#include <swkey.h></span>
00027 <span class="preprocessor">#include <swmacs.h></span>
00028 <span class="preprocessor">#include <listkey.h></span>
00029 <span class="preprocessor">#include <ctype.h></span>
00030
00031 <span class="preprocessor">#include <defs.h></span>
00032
00033 SWORD_NAMESPACE_START
00034
00035 <span class="preprocessor">#define POS_MAXVERSE ((char)3)</span>
00036 <span class="preprocessor"></span><span class="preprocessor">#define POS_MAXCHAPTER ((char)4)</span>
00037 <span class="preprocessor"></span><span class="preprocessor">#define POS_MAXBOOK ((char)5)</span>
00038 <span class="preprocessor"></span>
00039 <span class="preprocessor">#define MAXVERSE SW_POSITION(POS_MAXVERSE)</span>
00040 <span class="preprocessor"></span><span class="preprocessor">#define MAXCHAPTER SW_POSITION(POS_MAXCHAPTER)</span>
00041 <span class="preprocessor"></span><span class="preprocessor">#define MAXBOOK SW_POSITION(POS_MAXBOOK)</span>
00042 <span class="preprocessor"></span>
00043 <span class="keyword">struct </span>sbook
00044 {
00047 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
00048
00051 <span class="keyword">const</span> <span class="keywordtype">char</span> *prefAbbrev;
00052
00055 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> chapmax;
00058 <span class="keywordtype">int</span> *versemax;
00059 };
00060
00061 <span class="keyword">struct </span>abbrev
00062 {
00063 <span class="keyword">const</span> <span class="keywordtype">char</span> *ab;
00064 <span class="keywordtype">int</span> book;
00065 };
00066
00067
00068 <span class="keyword">class </span>SWLocale;
00069
<a name="l00074"></a><a class="code" href="classsword_1_1_verse_key.html">00074</a> <span class="keyword">class </span>SWDLLEXPORT <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a>:<span class="keyword">public</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a>
00075 {
00076 <span class="keyword">class </span>LocaleCache
00077 {
00078 <span class="keyword">public</span>:
00079 <span class="keywordtype">char</span> *name;
00080 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> abbrevsCnt;
00081 <a class="code" href="classsword_1_1_s_w_locale.html">SWLocale</a> *locale;
00082 LocaleCache()
00083 {
00084 name = 0;
00085 abbrevsCnt = 0;
00086 locale = 0;
00087 }
00088 <span class="keyword">virtual</span> ~LocaleCache()
00089 {
00090 <span class="keywordflow">if</span> (name)
00091 <span class="keyword">delete</span>[]name;
00092 }
00093 };
00094
00095 <span class="keyword">static</span> <a class="code" href="classsword_1_1_s_w_class.html">SWClass</a> classdef;
00096
00097 <span class="keyword">static</span> <span class="keywordtype">long</span> *offsets[2][2];
00098 <span class="keyword">static</span> <span class="keywordtype">int</span> offsize[2][2];
00101 <span class="keyword">static</span> <span class="keywordtype">int</span> instance;
00102 <span class="keyword">static</span> <span class="keyword">struct </span>sbook otbooks[];
00103 <span class="keyword">static</span> <span class="keyword">struct </span>sbook ntbooks[];
00104 <span class="keyword">static</span> <span class="keywordtype">long</span> otbks[];
00105 <span class="keyword">static</span> <span class="keywordtype">long</span> otcps[];
00106 <span class="keyword">static</span> <span class="keywordtype">long</span> ntbks[];
00107 <span class="keyword">static</span> <span class="keywordtype">long</span> ntcps[];
00108 <span class="keyword">static</span> <span class="keywordtype">int</span> vm[];
00109 <span class="keyword">static</span> LocaleCache localeCache;
00110 <a class="code" href="classsword_1_1_list_key.html">ListKey</a> internalListKey;
00111
00112 <span class="keyword">const</span> <span class="keyword">struct </span>abbrev *abbrevs;
00113 <span class="keywordtype">char</span> *locale;
00114 <span class="keywordtype">int</span> abbrevsCnt;
<a name="l00117"></a><a class="code" href="classsword_1_1_verse_key.html#o4">00117</a> <span class="keywordtype">signed</span> <span class="keywordtype">char</span> testament;
00118 <span class="keyword">mutable</span> <span class="keywordtype">signed</span> <span class="keywordtype">char</span> book;
00119 <span class="keyword">mutable</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> chapter;
00120 <span class="keyword">mutable</span> <span class="keywordtype">signed</span> <span class="keywordtype">int</span> verse;
<a name="l00123"></a><a class="code" href="classsword_1_1_verse_key.html#o8">00123</a> <span class="keywordtype">char</span> autonorm;
<a name="l00126"></a><a class="code" href="classsword_1_1_verse_key.html#o9">00126</a> <span class="keywordtype">char</span> headings;
00127
00128 <span class="keywordtype">int</span> getBookAbbrev(<span class="keyword">const</span> <span class="keywordtype">char</span> *abbr);
00129 <span class="keywordtype">void</span> initBounds() <span class="keyword">const</span>;
00132 <span class="keywordtype">void</span> initstatics();
00135 <span class="keywordtype">void</span> init();
00140 <span class="keywordtype">void</span> freshtext() <span class="keyword">const</span>;
00144 <span class="keyword">virtual</span> <span class="keywordtype">char</span> parse();
00153 <span class="keywordtype">int</span> findindex(<span class="keywordtype">long</span> *array, <span class="keywordtype">int</span> size, <span class="keywordtype">long</span> value);
00154 <span class="keyword">mutable</span> <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> *lowerBound, *upperBound;
00155
00156 <span class="keyword">public</span>:
00157 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> builtin_BMAX[2];
00158 <span class="keyword">static</span> <span class="keyword">struct </span>sbook *builtin_books[2];
00159 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">struct </span>abbrev builtin_abbrevs[];
00160 <span class="keyword">const</span> <span class="keywordtype">char</span> *BMAX;
00161 <span class="keyword">struct </span>sbook **books;
00162
00169 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey = 0);
00170
00177 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a>(<span class="keyword">const</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> * ikey);
00178
00185 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *min, <span class="keyword">const</span> <span class="keywordtype">char</span> *max);
00186
00192 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a>(<span class="keyword">const</span> <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> &k);
00193
00197 <span class="keyword">virtual</span> ~ VerseKey();
00198
00205 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> & LowerBound(<span class="keyword">const</span> <span class="keywordtype">char</span> *lb);
00206
00212 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> & UpperBound(<span class="keyword">const</span> <span class="keywordtype">char</span> *ub);
00213
00217 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> & LowerBound() <span class="keyword">const</span>;
00218
00222 <a class="code" href="classsword_1_1_verse_key.html">VerseKey</a> & UpperBound() <span class="keyword">const</span>;
00223
00226 <span class="keywordtype">void</span> ClearBounds();
00227
00231 <span class="keyword">virtual</span> <a class="code" href="classsword_1_1_s_w_key.html">SWKey</a> *<a class="code" href="classsword_1_1_s_w_key.html#a3">clone</a>() <span class="keyword">const</span>;
00232
00236 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classsword_1_1_s_w_key.html#a9">getText</a>() <span class="keyword">const</span>;
00237 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getShortText() <span class="keyword">const</span>;
<a name="l00238"></a><a class="code" href="classsword_1_1_verse_key.html#a13">00238</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a7">setText</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *ikey) { SWKey::setText(ikey); parse (); }
00239 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(<span class="keyword">const</span> SWKey & ikey);
00240
00243 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(<span class="keyword">const</span> VerseKey & ikey);
00244
00250 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setPosition(SW_POSITION);
00251
00257 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a16">decrement</a>(<span class="keywordtype">int</span> step);
00258
00264 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsword_1_1_s_w_key.html#a17">increment</a>(<span class="keywordtype">int</span> step);
00265 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Traversable() { <span class="keywordflow">return</span> 1; }
00266
00267 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getBookName() <span class="keyword">const</span>;
00268 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getBookAbbrev() <span class="keyword">const</span>;
00273 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Testament() <span class="keyword">const</span>;
00274
00279 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Book() <span class="keyword">const</span>;
00280
00285 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Chapter() <span class="keyword">const</span>;
00286
00291 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Verse() <span class="keyword">const</span>;
00292
00300 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Testament(<span class="keywordtype">char</span> itestament);
00301
00309 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Book(<span class="keywordtype">char</span> ibook);
00310
00318 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Chapter(<span class="keywordtype">int</span> ichapter);
00319
00327 <span class="keyword">virtual</span> <span class="keywordtype">int</span> Verse(<span class="keywordtype">int</span> iverse);
00328
00335 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Normalize(<span class="keywordtype">char</span> autocheck = 0);
00336
00345 <span class="keyword">virtual</span> <span class="keywordtype">char</span> AutoNormalize(<span class="keywordtype">char</span> iautonorm = MAXPOS (<span class="keywordtype">char</span>));
00346
00355 <span class="keyword">virtual</span> <span class="keywordtype">char</span> Headings(<span class="keywordtype">char</span> iheadings = MAXPOS (<span class="keywordtype">char</span>));
00356
00357 <span class="keyword">virtual</span> <span class="keywordtype">long</span> NewIndex() <span class="keyword">const</span>;
00358
00363 <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classsword_1_1_s_w_key.html#a19">Index</a>() <span class="keyword">const</span>;
00364
00370 <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="classsword_1_1_s_w_key.html#a19">Index</a>(<span class="keywordtype">long</span> iindex);
00371
00372 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getOSISRef() <span class="keyword">const</span>;
00373
00374 <span class="keyword">virtual</span> ListKey ParseVerseList(<span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keyword">const</span> <span class="keywordtype">char</span> *defaultKey = <span class="stringliteral">"Genesis 1:1"</span>, <span class="keywordtype">bool</span> expandRange = <span class="keyword">false</span>);
00375 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getRangeText() <span class="keyword">const</span>;
00383 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classsword_1_1_s_w_key.html#a13">compare</a>(<span class="keyword">const</span> SWKey & ikey);
00384
00392 <span class="keyword">virtual</span> <span class="keywordtype">int</span> _compare(<span class="keyword">const</span> VerseKey & ikey);
00393
00394 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setBookAbbrevs(<span class="keyword">const</span> <span class="keyword">struct</span> abbrev *bookAbbrevs, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size = 0 <span class="comment">/* default determine size */</span> );
00395 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setBooks(<span class="keyword">const</span> <span class="keywordtype">char</span> *iBMAX, <span class="keyword">struct</span> sbook **ibooks);
00396 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setLocale(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00397 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *getLocale()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> locale; }
00398
00399
00400
00401 <span class="comment">// OPERATORS --------------------------------------------------------------------</span>
00402
00403
00404 SWKEY_OPERATORS
00405
00406 <span class="keyword">virtual</span> SWKey & operator = (<span class="keyword">const</span> VerseKey & ikey) { <a class="code" href="classsword_1_1_s_w_key.html#a8">copyFrom</a>(ikey); <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
00407 };
00408
00409 SWORD_NAMESPACE_END
00410 <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>
|
