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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
/******************************************************************************
*
* flatapi.h - This file contains an api usable by non-C++ environments
*
* $Id: flatapi.h 3184 2014-04-17 04:30:54Z greg.hellings $
*
* Copyright 2002-2014 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
* P. O. Box 2528
* Tempe, AZ 85280-2528
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation version 2.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
*/
#ifndef SWORDFLATAPI_H
#define SWORDFLATAPI_H
#include <inttypes.h>
#include <defs.h>
#ifdef __cplusplus
extern "C" {
#endif
#define SWHANDLE intptr_t
struct org_crosswire_sword_ModInfo {
char *name;
char *description;
char *category;
char *language;
char *version;
char *delta;
};
struct org_crosswire_sword_SearchHit {
const char *modName;
char *key;
long score;
};
#undef org_crosswire_sword_SWModule_SEARCHTYPE_REGEX
#define org_crosswire_sword_SWModule_SEARCHTYPE_REGEX 1L
#undef org_crosswire_sword_SWModule_SEARCHTYPE_PHRASE
#define org_crosswire_sword_SWModule_SEARCHTYPE_PHRASE -1L
#undef org_crosswire_sword_SWModule_SEARCHTYPE_MULTIWORD
#define org_crosswire_sword_SWModule_SEARCHTYPE_MULTIWORD -2L
#undef org_crosswire_sword_SWModule_SEARCHTYPE_ENTRYATTR
#define org_crosswire_sword_SWModule_SEARCHTYPE_ENTRYATTR -3L
#undef org_crosswire_sword_SWModule_SEARCHTYPE_LUCENE
#define org_crosswire_sword_SWModule_SEARCHTYPE_LUCENE -4L
/*
* Class: org_crosswire_sword_SWModule
* Method: terminateSearch
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_terminateSearch
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: search
* Signature: (Ljava/lang/String;IJLjava/lang/String;Lorg/crosswire/android/sword/SWModule/SearchProgressReporter;)[Lorg/crosswire/android/sword/SWModule/SearchHit;
*/
const struct org_crosswire_sword_SearchHit * SWDLLEXPORT org_crosswire_sword_SWModule_search
(SWHANDLE hSWModule, const char *searchString, int searchType, long flags, const char *scope, SWHANDLE progressReporter);
/*
* Class: org_crosswire_sword_SWModule
* Method: error
* Signature: ()C
*/
char SWDLLEXPORT org_crosswire_sword_SWModule_popError
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getEntrySize
* Signature: ()J
*/
long SWDLLEXPORT org_crosswire_sword_SWModule_getEntrySize
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getEntryAttribute
* Signature: (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Z)[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_SWModule_getEntryAttribute
(SWHANDLE hSWModule, const char *level1, const char *level2, const char *level3, char filteredBool);
/*
* Class: org_crosswire_sword_SWModule
* Method: parseKeyList
* Signature: (Ljava/lang/String;)[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_SWModule_parseKeyList
(SWHANDLE hSWModule, const char *keyText);
/*
* Class: org_crosswire_sword_SWModule
* Method: setKeyText
* Signature: (Ljava/lang/String;)V
*/
// Special values handled for VerseKey modules:
// [+-][book|chapter] - [de|in]crement by chapter or book
// (e.g. "+chapter" will increment the VerseKey 1 chapter)
// [=][key] - position absolutely and don't normalize
// (e.g. "jn.1.0" for John Chapter 1 intro; "jn.0.0" For Book of John Intro)
void SWDLLEXPORT org_crosswire_sword_SWModule_setKeyText
(SWHANDLE hSWModule, const char *key);
/*
* Class: org_crosswire_sword_SWModule
* Method: getKeyText
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getKeyText
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: hasKeyChildren
* Signature: ()Z
*/
char SWDLLEXPORT org_crosswire_sword_SWModule_hasKeyChildren
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getKeyChildren
* Signature: ()[Ljava/lang/String;
*/
// This method returns child nodes for a genbook,
// but has special handling if called on a VerseKey module:
// [0..7] [testament, book, chapter, verse, chapterMax, verseMax, bookName, osisRef]
const char ** SWDLLEXPORT org_crosswire_sword_SWModule_getKeyChildren
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getName
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getName
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getDescription
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getDescription
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getCategory
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getCategory
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getKeyParent
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getKeyParent
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: previous
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_previous
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: next
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_next
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: begin
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_begin
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getStripText
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_stripText
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getRenderText
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_renderText
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getRenderHeader
* Signature: ()Ljava/lang/String;
*/
// CSS styles associated with this text
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getRenderHeader
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: getRawEntry
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getRawEntry
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: setRawEntry
* Signature: (Ljava/lang/String;)V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_setRawEntry
(SWHANDLE hSWModule, const char *entryBuffer);
/*
* Class: org_crosswire_sword_SWModule
* Method: getConfigEntry
* Signature: (Ljava/lang/String;)Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWModule_getConfigEntry
(SWHANDLE hSWModule, const char *key);
/*
* Class: org_crosswire_sword_SWModule
* Method: deleteSearchFramework
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWModule_deleteSearchFramework
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWModule
* Method: hasSearchFramework
* Signature: ()Z
*/
char SWDLLEXPORT org_crosswire_sword_SWModule_hasSearchFramework
(SWHANDLE hSWModule);
/*
* Class: org_crosswire_sword_SWMgr
* Method: new
* Signature: ()V
*/
SWHANDLE SWDLLEXPORT org_crosswire_sword_SWMgr_new
();
/*
* Class: org_crosswire_sword_SWMgr
* Method: delete
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_SWMgr_delete
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: version
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_version
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getModInfoList
* Signature: ()[Lorg/crosswire/android/sword/SWMgr/ModInfo;
*/
const struct org_crosswire_sword_ModInfo * SWDLLEXPORT org_crosswire_sword_SWMgr_getModInfoList
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getModuleByName
* Signature: (Ljava/lang/String;)Lorg/crosswire/android/sword/SWModule;
*/
SWHANDLE SWDLLEXPORT org_crosswire_sword_SWMgr_getModuleByName
(SWHANDLE hSWMgr, const char *moduleName);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getPrefixPath
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_getPrefixPath
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getConfigPath
* Signature: ()Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_getConfigPath
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: setGlobalOption
* Signature: (Ljava/lang/String;Ljava/lang/String;)V
*/
void SWDLLEXPORT org_crosswire_sword_SWMgr_setGlobalOption
(SWHANDLE hSWMgr, const char *option, const char *value);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getGlobalOption
* Signature: (Ljava/lang/String;)Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_getGlobalOption
(SWHANDLE hSWMgr, const char *option);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getGlobalOptionTip
* Signature: (Ljava/lang/String;)Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_getGlobalOptionTip
(SWHANDLE hSWMgr, const char *option);
/*
* Class: org_crosswire_sword_SWMgr
* Method: filterText
* Signature: (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_filterText
(SWHANDLE hSWMgr, const char *filterName, const char *text);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getGlobalOptions
* Signature: ()[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_SWMgr_getGlobalOptions
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getGlobalOptionValues
* Signature: (Ljava/lang/String;)[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_SWMgr_getGlobalOptionValues
(SWHANDLE hSWMgr, const char *option);
/*
* Class: org_crosswire_sword_SWMgr
* Method: setCipherKey
* Signature: (Ljava/lang/String;Ljava/lang/String;)V
*/
void SWDLLEXPORT org_crosswire_sword_SWMgr_setCipherKey
(SWHANDLE hSWMgr, const char *modName, const char *key);
/*
* Class: org_crosswire_sword_SWMgr
* Method: setJavascript
* Signature: (Z)V
*/
void SWDLLEXPORT org_crosswire_sword_SWMgr_setJavascript
(SWHANDLE hSWMgr, char valueBool);
/*
* Class: org_crosswire_sword_SWMgr
* Method: getAvailableLocales
* Signature: ()[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_SWMgr_getAvailableLocales
(SWHANDLE hSWMgr);
/*
* Class: org_crosswire_sword_SWMgr
* Method: setDefaultLocale
* Signature: (Ljava/lang/String;)V
*/
void SWDLLEXPORT org_crosswire_sword_SWMgr_setDefaultLocale
(SWHANDLE hSWMgr, const char *name);
/*
* Class: org_crosswire_sword_SWMgr
* Method: translate
* Signature: (Ljava/lang/String;Ljava/lang/String;)Ljava/lang/String;
*/
const char * SWDLLEXPORT org_crosswire_sword_SWMgr_translate
(SWHANDLE hSWMgr, const char *text, const char *localeName);
//
// InstallMgr methods
//
//
/*
* Class: org_crosswire_sword_InstallMgr
* Method: new
* Signature: (Ljava/lang/String;Lorg/crosswire/android/sword/SWModule/SearchProgressReporter;)V
*/
SWHANDLE SWDLLEXPORT org_crosswire_sword_InstallMgr_new
(const char *baseDir, SWHANDLE statusReporter);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: setUserDisclaimerConfirmed
* Signature: ()V
*/
void SWDLLEXPORT org_crosswire_sword_InstallMgr_setUserDisclaimerConfirmed
(SWHANDLE hInstallMgr);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: syncConfig
* Signature: ()I
*/
int SWDLLEXPORT org_crosswire_sword_InstallMgr_syncConfig
(SWHANDLE hInstallMgr);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: uninstallModule
* Signature: (Lorg/crosswire/android/sword/SWMgr;Ljava/lang/String;)I
*/
int SWDLLEXPORT org_crosswire_sword_InstallMgr_uninstallModule
(SWHANDLE hInstallMgr, SWHANDLE hSWMgr_removeFrom, const char *modName);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: getRemoteSources
* Signature: ()[Ljava/lang/String;
*/
const char ** SWDLLEXPORT org_crosswire_sword_InstallMgr_getRemoteSources
(SWHANDLE hInstallMgr);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: refreshRemoteSource
* Signature: (Ljava/lang/String;)I
*/
int SWDLLEXPORT org_crosswire_sword_InstallMgr_refreshRemoteSource
(SWHANDLE hInstallMgr, const char *sourceName);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: getRemoteModInfoList
* Signature: (Lorg/crosswire/android/sword/SWMgr;Ljava/lang/String;)[Lorg/crosswire/android/sword/SWMgr/ModInfo;
*/
const struct org_crosswire_sword_ModInfo * SWDLLEXPORT org_crosswire_sword_InstallMgr_getRemoteModInfoList
(SWHANDLE hInstallMgr, SWHANDLE hSWMgr_deltaCompareTo, const char *sourceName);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: remoteInstallModule
* Signature: (Lorg/crosswire/android/sword/SWMgr;Ljava/lang/String;Ljava/lang/String;)I
*/
int SWDLLEXPORT org_crosswire_sword_InstallMgr_remoteInstallModule
(SWHANDLE hInstallMgr_from, SWHANDLE hSWMgr_to, const char *sourceName, const char *modName);
/*
* Class: org_crosswire_sword_InstallMgr
* Method: getRemoteModuleByName
* Signature: (Ljava/lang/String;Ljava/lang/String;)Lorg/crosswire/android/sword/SWModule;
*/
SWHANDLE SWDLLEXPORT org_crosswire_sword_InstallMgr_getRemoteModuleByName
(SWHANDLE hInstallMgr, const char *sourceName, const char *modName);
#ifdef __cplusplus
}
#endif
#endif
|
