From daa67ff1f728c07f2a116ee9a9f4505479ca6808 Mon Sep 17 00:00:00 2001 From: danglassey Date: Wed, 14 Aug 2002 09:57:17 +0000 Subject: Initial import from crosswire CVS for syncing --- .../html/_greek2_greek_8h-source.html | 128 +++++++++ .../html/_greek_chars_8h-source.html | 163 ++++++++++++ doc/api-documentation/html/annotated.html | 79 ++++++ .../html/cipherfil_8h-source.html | 53 ++++ doc/api-documentation/html/classes.html | 31 +++ doc/api-documentation/html/defs_8h-source.html | 88 +++++++ doc/api-documentation/html/dirent_8h-source.html | 46 ++++ doc/api-documentation/html/doxygen.css | 49 ++++ doc/api-documentation/html/echomod_8h-source.html | 52 ++++ .../html/encfiltmgr_8h-source.html | 69 +++++ .../html/entriesblk_8h-source.html | 44 ++++ doc/api-documentation/html/femain_8h-source.html | 46 ++++ doc/api-documentation/html/filemgr_8h-source.html | 96 +++++++ doc/api-documentation/html/files.html | 268 +++++++++++++++++++ doc/api-documentation/html/flatapi_8h-source.html | 92 +++++++ doc/api-documentation/html/functions.html | 241 +++++++++++++++++ doc/api-documentation/html/gbf_8h-source.html | 81 ++++++ .../html/gbffootnotes_8h-source.html | 70 +++++ .../html/gbfheadings_8h-source.html | 70 +++++ doc/api-documentation/html/gbfhtml_8h-source.html | 50 ++++ .../html/gbfhtmlhref_8h-source.html | 45 ++++ doc/api-documentation/html/gbfmorph_8h-source.html | 69 +++++ doc/api-documentation/html/gbfosis_8h-source.html | 47 ++++ doc/api-documentation/html/gbfplain_8h-source.html | 49 ++++ doc/api-documentation/html/gbfrtf_8h-source.html | 49 ++++ .../html/gbfstrongs_8h-source.html | 70 +++++ doc/api-documentation/html/gbfthml_8h-source.html | 46 ++++ doc/api-documentation/html/graph_legend.html | 60 +++++ .../html/greeklexattribs_8h-source.html | 48 ++++ .../html/hebrewmcim_8h-source.html | 34 +++ doc/api-documentation/html/hierarchy.html | 93 +++++++ doc/api-documentation/html/hrefcom_8h-source.html | 60 +++++ doc/api-documentation/html/index.html | 26 ++ doc/api-documentation/html/inherits.html | 222 ++++++++++++++++ .../html/latin1utf16_8h-source.html | 47 ++++ .../html/latin1utf8_8h-source.html | 47 ++++ doc/api-documentation/html/listkey_8h-source.html | 86 ++++++ .../html/localemgr_8h-source.html | 82 ++++++ .../html/lzsscomprs_8h-source.html | 93 +++++++ .../html/markupfiltmgr_8h-source.html | 64 +++++ .../html/multimapwdef_8h-source.html | 45 ++++ doc/api-documentation/html/namespaces.html | 17 ++ doc/api-documentation/html/nullim_8h-source.html | 28 ++ .../html/plainfootnotes_8h-source.html | 73 +++++ .../html/plainhtml_8h-source.html | 50 ++++ doc/api-documentation/html/rawcom_8h-source.html | 69 +++++ doc/api-documentation/html/rawfiles_8h-source.html | 74 ++++++ doc/api-documentation/html/rawgbf_8h-source.html | 59 +++++ .../html/rawgenbook_8h-source.html | 73 +++++ doc/api-documentation/html/rawld4_8h-source.html | 78 ++++++ doc/api-documentation/html/rawld_8h-source.html | 80 ++++++ doc/api-documentation/html/rawstr4_8h-source.html | 70 +++++ doc/api-documentation/html/rawstr_8h-source.html | 68 +++++ doc/api-documentation/html/rawtext_8h-source.html | 78 ++++++ doc/api-documentation/html/rawverse_8h-source.html | 52 ++++ doc/api-documentation/html/roman_8h-source.html | 39 +++ doc/api-documentation/html/rtfhtml_8h-source.html | 49 ++++ doc/api-documentation/html/rwphtml_8h-source.html | 50 ++++ doc/api-documentation/html/rwprtf_8h-source.html | 52 ++++ doc/api-documentation/html/sapphire_8h-source.html | 67 +++++ doc/api-documentation/html/scsuutf8_8h-source.html | 53 ++++ doc/api-documentation/html/strkey_8h-source.html | 58 ++++ .../html/swbasicfilter_8h-source.html | 99 +++++++ doc/api-documentation/html/swcacher_8h-source.html | 51 ++++ doc/api-documentation/html/swcipher_8h-source.html | 63 +++++ doc/api-documentation/html/swcom_8h-source.html | 57 ++++ doc/api-documentation/html/swcomprs_8h-source.html | 59 +++++ doc/api-documentation/html/swconfig_8h-source.html | 75 ++++++ doc/api-documentation/html/swdisp_8h-source.html | 51 ++++ .../html/swdisprtf_8h-source.html | 116 ++++++++ .../html/swdisprtfchap_8h-source.html | 80 ++++++ doc/api-documentation/html/swfilter_8h-source.html | 84 ++++++ .../html/swfiltermgr_8h-source.html | 76 ++++++ .../html/swgenbook_8h-source.html | 56 ++++ .../html/swinputmeth_8h-source.html | 36 +++ doc/api-documentation/html/swkey_8h-source.html | 142 ++++++++++ doc/api-documentation/html/swld_8h-source.html | 60 +++++ doc/api-documentation/html/swlocale_8h-source.html | 74 ++++++ doc/api-documentation/html/swlog_8h-source.html | 60 +++++ doc/api-documentation/html/swmacs_8h-source.html | 44 ++++ doc/api-documentation/html/swmgr_8h-source.html | 117 ++++++++ doc/api-documentation/html/swmodule_8h-source.html | 283 ++++++++++++++++++++ doc/api-documentation/html/swobject_8h-source.html | 57 ++++ doc/api-documentation/html/swtext_8h-source.html | 55 ++++ doc/api-documentation/html/swunicod_8h-source.html | 42 +++ .../html/swversion_8h-source.html | 59 +++++ doc/api-documentation/html/swwinlog_8h-source.html | 56 ++++ doc/api-documentation/html/sysdata_8h-source.html | 90 +++++++ doc/api-documentation/html/tbdisp_8h-source.html | 53 ++++ .../html/thmlfootnotes_8h-source.html | 70 +++++ doc/api-documentation/html/thmlgbf_8h-source.html | 49 ++++ .../html/thmlheadings_8h-source.html | 70 +++++ doc/api-documentation/html/thmlhtml_8h-source.html | 47 ++++ .../html/thmlhtmlhref_8h-source.html | 45 ++++ .../html/thmllemma_8h-source.html | 70 +++++ .../html/thmlmorph_8h-source.html | 69 +++++ doc/api-documentation/html/thmlolb_8h-source.html | 49 ++++ doc/api-documentation/html/thmlosis_8h-source.html | 47 ++++ .../html/thmlplain_8h-source.html | 49 ++++ doc/api-documentation/html/thmlrtf_8h-source.html | 50 ++++ .../html/thmlscripref_8h-source.html | 70 +++++ .../html/thmlstrongs_8h-source.html | 70 +++++ .../html/thmlvariants_8h-source.html | 73 +++++ doc/api-documentation/html/treekey_8h-source.html | 99 +++++++ .../html/treekeyidx_8h-source.html | 126 +++++++++ .../html/unicodertf_8h-source.html | 48 ++++ doc/api-documentation/html/unixstr_8h-source.html | 42 +++ doc/api-documentation/html/untgz_8h-source.html | 23 ++ .../html/utf16utf8_8h-source.html | 47 ++++ .../html/utf8arshaping_8h-source.html | 60 +++++ .../html/utf8bidireorder_8h-source.html | 60 +++++ .../html/utf8cantillation_8h-source.html | 69 +++++ .../html/utf8greekaccents_8h-source.html | 69 +++++ .../html/utf8hebrewpoints_8h-source.html | 69 +++++ doc/api-documentation/html/utf8html_8h-source.html | 47 ++++ .../html/utf8latin1_8h-source.html | 48 ++++ doc/api-documentation/html/utf8nfc_8h-source.html | 60 +++++ doc/api-documentation/html/utf8nfkd_8h-source.html | 60 +++++ .../html/utf8transliterator_8h-source.html | 85 ++++++ .../html/utf8utf16_8h-source.html | 47 ++++ doc/api-documentation/html/utilconf_8h-source.html | 22 ++ doc/api-documentation/html/utilfuns_8h-source.html | 43 +++ doc/api-documentation/html/utilstr_8h-source.html | 95 +++++++ doc/api-documentation/html/versekey_8h-source.html | 220 ++++++++++++++++ doc/api-documentation/html/zcom_8h-source.html | 83 ++++++ doc/api-documentation/html/zconf_8h-source.html | 293 +++++++++++++++++++++ .../html/zipcomprs_8h-source.html | 53 ++++ doc/api-documentation/html/zld_8h-source.html | 81 ++++++ doc/api-documentation/html/zstr_8h-source.html | 86 ++++++ doc/api-documentation/html/ztext_8h-source.html | 84 ++++++ doc/api-documentation/html/zverse_8h-source.html | 70 +++++ 131 files changed, 9547 insertions(+) create mode 100644 doc/api-documentation/html/_greek2_greek_8h-source.html create mode 100644 doc/api-documentation/html/_greek_chars_8h-source.html create mode 100644 doc/api-documentation/html/annotated.html create mode 100644 doc/api-documentation/html/cipherfil_8h-source.html create mode 100644 doc/api-documentation/html/classes.html create mode 100644 doc/api-documentation/html/defs_8h-source.html create mode 100644 doc/api-documentation/html/dirent_8h-source.html create mode 100644 doc/api-documentation/html/doxygen.css create mode 100644 doc/api-documentation/html/echomod_8h-source.html create mode 100644 doc/api-documentation/html/encfiltmgr_8h-source.html create mode 100644 doc/api-documentation/html/entriesblk_8h-source.html create mode 100644 doc/api-documentation/html/femain_8h-source.html create mode 100644 doc/api-documentation/html/filemgr_8h-source.html create mode 100644 doc/api-documentation/html/files.html create mode 100644 doc/api-documentation/html/flatapi_8h-source.html create mode 100644 doc/api-documentation/html/functions.html create mode 100644 doc/api-documentation/html/gbf_8h-source.html create mode 100644 doc/api-documentation/html/gbffootnotes_8h-source.html create mode 100644 doc/api-documentation/html/gbfheadings_8h-source.html create mode 100644 doc/api-documentation/html/gbfhtml_8h-source.html create mode 100644 doc/api-documentation/html/gbfhtmlhref_8h-source.html create mode 100644 doc/api-documentation/html/gbfmorph_8h-source.html create mode 100644 doc/api-documentation/html/gbfosis_8h-source.html create mode 100644 doc/api-documentation/html/gbfplain_8h-source.html create mode 100644 doc/api-documentation/html/gbfrtf_8h-source.html create mode 100644 doc/api-documentation/html/gbfstrongs_8h-source.html create mode 100644 doc/api-documentation/html/gbfthml_8h-source.html create mode 100644 doc/api-documentation/html/graph_legend.html create mode 100644 doc/api-documentation/html/greeklexattribs_8h-source.html create mode 100644 doc/api-documentation/html/hebrewmcim_8h-source.html create mode 100644 doc/api-documentation/html/hierarchy.html create mode 100644 doc/api-documentation/html/hrefcom_8h-source.html create mode 100644 doc/api-documentation/html/index.html create mode 100644 doc/api-documentation/html/inherits.html create mode 100644 doc/api-documentation/html/latin1utf16_8h-source.html create mode 100644 doc/api-documentation/html/latin1utf8_8h-source.html create mode 100644 doc/api-documentation/html/listkey_8h-source.html create mode 100644 doc/api-documentation/html/localemgr_8h-source.html create mode 100644 doc/api-documentation/html/lzsscomprs_8h-source.html create mode 100644 doc/api-documentation/html/markupfiltmgr_8h-source.html create mode 100644 doc/api-documentation/html/multimapwdef_8h-source.html create mode 100644 doc/api-documentation/html/namespaces.html create mode 100644 doc/api-documentation/html/nullim_8h-source.html create mode 100644 doc/api-documentation/html/plainfootnotes_8h-source.html create mode 100644 doc/api-documentation/html/plainhtml_8h-source.html create mode 100644 doc/api-documentation/html/rawcom_8h-source.html create mode 100644 doc/api-documentation/html/rawfiles_8h-source.html create mode 100644 doc/api-documentation/html/rawgbf_8h-source.html create mode 100644 doc/api-documentation/html/rawgenbook_8h-source.html create mode 100644 doc/api-documentation/html/rawld4_8h-source.html create mode 100644 doc/api-documentation/html/rawld_8h-source.html create mode 100644 doc/api-documentation/html/rawstr4_8h-source.html create mode 100644 doc/api-documentation/html/rawstr_8h-source.html create mode 100644 doc/api-documentation/html/rawtext_8h-source.html create mode 100644 doc/api-documentation/html/rawverse_8h-source.html create mode 100644 doc/api-documentation/html/roman_8h-source.html create mode 100644 doc/api-documentation/html/rtfhtml_8h-source.html create mode 100644 doc/api-documentation/html/rwphtml_8h-source.html create mode 100644 doc/api-documentation/html/rwprtf_8h-source.html create mode 100644 doc/api-documentation/html/sapphire_8h-source.html create mode 100644 doc/api-documentation/html/scsuutf8_8h-source.html create mode 100644 doc/api-documentation/html/strkey_8h-source.html create mode 100644 doc/api-documentation/html/swbasicfilter_8h-source.html create mode 100644 doc/api-documentation/html/swcacher_8h-source.html create mode 100644 doc/api-documentation/html/swcipher_8h-source.html create mode 100644 doc/api-documentation/html/swcom_8h-source.html create mode 100644 doc/api-documentation/html/swcomprs_8h-source.html create mode 100644 doc/api-documentation/html/swconfig_8h-source.html create mode 100644 doc/api-documentation/html/swdisp_8h-source.html create mode 100644 doc/api-documentation/html/swdisprtf_8h-source.html create mode 100644 doc/api-documentation/html/swdisprtfchap_8h-source.html create mode 100644 doc/api-documentation/html/swfilter_8h-source.html create mode 100644 doc/api-documentation/html/swfiltermgr_8h-source.html create mode 100644 doc/api-documentation/html/swgenbook_8h-source.html create mode 100644 doc/api-documentation/html/swinputmeth_8h-source.html create mode 100644 doc/api-documentation/html/swkey_8h-source.html create mode 100644 doc/api-documentation/html/swld_8h-source.html create mode 100644 doc/api-documentation/html/swlocale_8h-source.html create mode 100644 doc/api-documentation/html/swlog_8h-source.html create mode 100644 doc/api-documentation/html/swmacs_8h-source.html create mode 100644 doc/api-documentation/html/swmgr_8h-source.html create mode 100644 doc/api-documentation/html/swmodule_8h-source.html create mode 100644 doc/api-documentation/html/swobject_8h-source.html create mode 100644 doc/api-documentation/html/swtext_8h-source.html create mode 100644 doc/api-documentation/html/swunicod_8h-source.html create mode 100644 doc/api-documentation/html/swversion_8h-source.html create mode 100644 doc/api-documentation/html/swwinlog_8h-source.html create mode 100644 doc/api-documentation/html/sysdata_8h-source.html create mode 100644 doc/api-documentation/html/tbdisp_8h-source.html create mode 100644 doc/api-documentation/html/thmlfootnotes_8h-source.html create mode 100644 doc/api-documentation/html/thmlgbf_8h-source.html create mode 100644 doc/api-documentation/html/thmlheadings_8h-source.html create mode 100644 doc/api-documentation/html/thmlhtml_8h-source.html create mode 100644 doc/api-documentation/html/thmlhtmlhref_8h-source.html create mode 100644 doc/api-documentation/html/thmllemma_8h-source.html create mode 100644 doc/api-documentation/html/thmlmorph_8h-source.html create mode 100644 doc/api-documentation/html/thmlolb_8h-source.html create mode 100644 doc/api-documentation/html/thmlosis_8h-source.html create mode 100644 doc/api-documentation/html/thmlplain_8h-source.html create mode 100644 doc/api-documentation/html/thmlrtf_8h-source.html create mode 100644 doc/api-documentation/html/thmlscripref_8h-source.html create mode 100644 doc/api-documentation/html/thmlstrongs_8h-source.html create mode 100644 doc/api-documentation/html/thmlvariants_8h-source.html create mode 100644 doc/api-documentation/html/treekey_8h-source.html create mode 100644 doc/api-documentation/html/treekeyidx_8h-source.html create mode 100644 doc/api-documentation/html/unicodertf_8h-source.html create mode 100644 doc/api-documentation/html/unixstr_8h-source.html create mode 100644 doc/api-documentation/html/untgz_8h-source.html create mode 100644 doc/api-documentation/html/utf16utf8_8h-source.html create mode 100644 doc/api-documentation/html/utf8arshaping_8h-source.html create mode 100644 doc/api-documentation/html/utf8bidireorder_8h-source.html create mode 100644 doc/api-documentation/html/utf8cantillation_8h-source.html create mode 100644 doc/api-documentation/html/utf8greekaccents_8h-source.html create mode 100644 doc/api-documentation/html/utf8hebrewpoints_8h-source.html create mode 100644 doc/api-documentation/html/utf8html_8h-source.html create mode 100644 doc/api-documentation/html/utf8latin1_8h-source.html create mode 100644 doc/api-documentation/html/utf8nfc_8h-source.html create mode 100644 doc/api-documentation/html/utf8nfkd_8h-source.html create mode 100644 doc/api-documentation/html/utf8transliterator_8h-source.html create mode 100644 doc/api-documentation/html/utf8utf16_8h-source.html create mode 100644 doc/api-documentation/html/utilconf_8h-source.html create mode 100644 doc/api-documentation/html/utilfuns_8h-source.html create mode 100644 doc/api-documentation/html/utilstr_8h-source.html create mode 100644 doc/api-documentation/html/versekey_8h-source.html create mode 100644 doc/api-documentation/html/zcom_8h-source.html create mode 100644 doc/api-documentation/html/zconf_8h-source.html create mode 100644 doc/api-documentation/html/zipcomprs_8h-source.html create mode 100644 doc/api-documentation/html/zld_8h-source.html create mode 100644 doc/api-documentation/html/zstr_8h-source.html create mode 100644 doc/api-documentation/html/ztext_8h-source.html create mode 100644 doc/api-documentation/html/zverse_8h-source.html (limited to 'doc/api-documentation') diff --git a/doc/api-documentation/html/_greek2_greek_8h-source.html b/doc/api-documentation/html/_greek2_greek_8h-source.html new file mode 100644 index 0000000..2284aa1 --- /dev/null +++ b/doc/api-documentation/html/_greek2_greek_8h-source.html @@ -0,0 +1,128 @@ + + +Greek2Greek.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

Greek2Greek.h

00001 //*****************************************************************************
+00002 // Author      : William Dicks                                              ***
+00003 // Date Created: 10 February 1998                                           ***
+00004 // Purpose     : Interface for Greek to b-Greek conversion and vice versa   ***
+00005 // File Name   : Greek2Greek.h                                              ***
+00006 //                                                                          ***
+00007 // Author info : ---------------------------------------------------------- ***
+00008 //     Address : 23 Tieroogpark                                             ***
+00009 //             : Hoewe Str                                                  ***
+00010 //             : Elarduspark X3                                             ***
+00011 //             : 0181                                                       ***
+00012 //             : South Africa                                               ***
+00013 //     Home Tel: +27 (0)12 345 3166                                         ***
+00014 //     Cell No : +27 (0)82 577 4424                                         ***
+00015 //     e-mail  : wd@isis.co.za                                              ***
+00016 // Church WWW  : http://www.hatfield.co.za                                  ***
+00017 //*****************************************************************************
+00018 /*
+00019  *
+00020  * $Id: _greek2_greek_8h-source.html,v 1.7 2002/06/20 20:23:07 mgruner Exp $
+00021  *
+00022  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00023  *      CrossWire Bible Society
+00024  *      P. O. Box 2528
+00025  *      Tempe, AZ  85280-2528
+00026  *
+00027  * This program is free software; you can redistribute it and/or modify it
+00028  * under the terms of the GNU General Public License as published by the
+00029  * Free Software Foundation version 2.
+00030  *
+00031  * This program is distributed in the hope that it will be useful, but
+00032  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00033  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00034  * General Public License for more details.
+00035  *
+00036  */
+00037 
+00038 #ifndef __GREEK2GREEK
+00039 #define __GREEK2GREEK
+00040 
+00041 //*****************************************************************************
+00042 // Used to convert a string created by using the Greek font supplied with the
+00043 // Sword Project to a string that conforms to the b-Greek discussion list 
+00044 // method of transliteration.
+00045 //*****************************************************************************
+00046 unsigned char Greek2bGreek (unsigned char *sResult, unsigned char *sGreekText,
+00047                             int nMaxResultBuflen);
+00048 
+00049 //*****************************************************************************
+00050 // Used to convert a string created by using the b-Greek method of 
+00051 // transliteration to a string that can be converted to a Greek-font readable 
+00052 // string.
+00053 //*****************************************************************************
+00054 unsigned char bGreek2Greek (unsigned char *sResult,
+00055                             unsigned char *sGreekText, int nMaxResultBuflen);
+00056 
+00057 //*****************************************************************************
+00058 // Parse a Greek font created string and return the b-Greek equivalent
+00059 //*****************************************************************************
+00060 int ParseGreek (unsigned char *sResult,
+00061                 unsigned char *sGreekText, int nMaxResultBuflen);
+00062 
+00063 //*****************************************************************************
+00064 // Parse a b-Greek string and return the Greek font equivalent
+00065 //*****************************************************************************
+00066 int ParsebGreek (unsigned char *sResult,
+00067                  unsigned char *sGreekText, int nMaxResultBuflen);
+00068 
+00069 //*****************************************************************************
+00070 // Convert a unsigned character to a GREEK font unsigned character
+00071 //*****************************************************************************
+00072 unsigned char char2Font (unsigned char letter,  // bGreek letter to convert to Font letter
+00073                          bool finalSigma,       // Is it a final SIGMA
+00074                          bool iota,     // TRUE = IOTA subscript; FALSE = No IOTA
+00075                          bool breathing,        // TRUE = add breathing; FALSE = no breathing
+00076                          bool rough);   // TRUE = rough breathing; False = smooth
+00077 
+00078 //*****************************************************************************
+00079 // Convert a GREEK font unsigned character to a unsigned character
+00080 //*****************************************************************************
+00081 unsigned char Font2char (unsigned char letter,  // bGreek letter to convert to Font letter
+00082                          bool & iota,   // TRUE = IOTA subscript; FALSE = No IOTA
+00083                          bool & breathing,      // TRUE = add breathing; FALSE = no breathing
+00084                          bool & rough); // TRUE = rough breathing; False = smooth
+00085 
+00086 
+00087 //*****************************************************************************
+00088 // Identify and return a bGreek letter from a special font char
+00089 //*****************************************************************************
+00090 bool getSpecialChar (unsigned char Font, unsigned char &letter);
+00091 
+00092 //*****************************************************************************
+00093 // true if the font character is a special character; false it isn't
+00094 //*****************************************************************************
+00095 bool SpecialGreek (unsigned char Font);
+00096 
+00097 //*****************************************************************************
+00098 // Return Greek font puntuation from bGreek punstuation
+00099 //*****************************************************************************
+00100 unsigned char getGreekPunct (unsigned char bGreek);
+00101 
+00102 //*****************************************************************************
+00103 // Return bGreek puntuation from Greek font punstuation
+00104 //*****************************************************************************
+00105 unsigned char getbGreekPunct (unsigned char Greek);
+00106 
+00107 //*****************************************************************************
+00108 // Is the character punctuation or a space: true it is, false it isn't
+00109 //*****************************************************************************
+00110 bool isPunctSpace (unsigned char c);
+00111 
+00112 
+00113 
+00114 #endif // __GREEK2GREEK
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/_greek_chars_8h-source.html b/doc/api-documentation/html/_greek_chars_8h-source.html new file mode 100644 index 0000000..8bf35f7 --- /dev/null +++ b/doc/api-documentation/html/_greek_chars_8h-source.html @@ -0,0 +1,163 @@ + + +GreekChars.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

GreekChars.h

00001 //*****************************************************************************
+00002 // Author      : William Dicks                                              ***
+00003 // Date Created: 10 February 1998                                           ***
+00004 // Purpose     : Enumeration for Greek to b-Greek conversion and vice       ***
+00005 //             : versa.                                                     ***
+00006 // File Name   : GreekChars.h                                               ***
+00007 //                                                                          ***
+00008 // Author info : ---------------------------------------------------------- ***
+00009 //     Address : 23 Tieroogpark                                             ***
+00010 //             : Hoewe Str                                                  ***
+00011 //             : Elarduspark X3                                             ***
+00012 //             : 0181                                                       ***
+00013 //             : South Africa                                               ***
+00014 //     Home Tel: +27 (0)12 345 3166                                         ***
+00015 //     Cell No : +27 (0)82 577 4424                                         ***
+00016 //     e-mail  : wd@isis.co.za                                              ***
+00017 // Church WWW  : http://www.hatfield.co.za                                  ***
+00018 //*****************************************************************************
+00019 /*
+00020  *
+00021  * $Id: _greek_chars_8h-source.html,v 1.7 2002/06/20 20:23:07 mgruner Exp $
+00022  *
+00023  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00024  *      CrossWire Bible Society
+00025  *      P. O. Box 2528
+00026  *      Tempe, AZ  85280-2528
+00027  *
+00028  * This program is free software; you can redistribute it and/or modify it
+00029  * under the terms of the GNU General Public License as published by the
+00030  * Free Software Foundation version 2.
+00031  *
+00032  * This program is distributed in the hope that it will be useful, but
+00033  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00034  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00035  * General Public License for more details.
+00036  *
+00037  */
+00038 
+00039 #ifndef __GREEKCHARS_H
+00040 #define __GREEKCHARS_H
+00041 
+00042 // This enum represents the values of the characters used for the 
+00043 // transliteration as used on the b-greek discussion list.
+00044 
+00045 enum bGreekChars
+00046 {
+00047   ALPHA = 65,                   // A
+00048   BETA,                         // B
+00049   CHI,                          // C
+00050   DELTA,                        // D
+00051   EPSILON,                      // E
+00052   PHI,                          // F
+00053   GAMMA,                        // G
+00054   ETA,                          // H
+00055   IOTA,                         // I
+00056   // No J
+00057   KAPPA = 75,                   // K
+00058   LAMBDA,                       // L
+00059   MU,                           // M
+00060   NU,                           // N
+00061   OMICRON,                      // O
+00062   PI,                           // P
+00063   THETA,                        // Q
+00064   RHO,                          // R
+00065   SIGMA,                        // S
+00066   TAU,                          // T
+00067   UPSILON,                      // U
+00068   // No V
+00069   OMEGA = 'W',                  // W
+00070   XI,                           // X
+00071   PSI,                          // Y
+00072   ZETA,                         // Z
+00073   ROUGH = 104,                  // h
+00074   IOTA_SUB                      // i
+00075 };
+00076 
+00077 // This enum represents the values of the characters ib the Greek.ttf font,
+00078 // and the comments on the right are the corresponding bGreek equivalents.
+00079 
+00080 enum GreekFontChars
+00081 {
+00082   gALPHA = 'a',                 // A
+00083   gBETA,                        // B
+00084   gCHI,                         // C
+00085   gDELTA,                       // D
+00086   gEPSILON,                     // E
+00087   gPHI,                         // F
+00088   gGAMMA,                       // G
+00089   gETA,                         // H
+00090   gIOTA,                        // I
+00091   gSIGMA_END,                   // j
+00092   gKAPPA,                       // K
+00093   gLAMBDA,                      // L
+00094   gMU,                          // M
+00095   gNU,                          // N
+00096   gOMICRON,                     // O
+00097   gPI,                          // P
+00098   gTHETA,                       // Q
+00099   gRHO,                         // R
+00100   gSIGMA,                       // S
+00101   gTAU,                         // T
+00102   gUPSILON,                     // U
+00103   // No V
+00104   gOMEGA = 'w',                 // W
+00105   gXI,                          // X
+00106   gPSI,                         // Y
+00107   gZETA,                        // Z
+00108   gROUGH_ALPHA = 161,           // hA
+00109   gROUGH_EPSILON = 152,         // hE
+00110   gROUGH_ETA = 185,             // hH
+00111   gROUGH_IOTA = 131,            // hH
+00112   gROUGH_OMICRON = 208,         // hH
+00113   gROUGH_RHO = 183,             // hR
+00114   gROUGH_UPSILON = 216,         // hU
+00115   gROUGH_OMEGA = 230,           // hW
+00116   gIOTA_ALPHA = 'v',            // Ai
+00117   gIOTA_ETA = 'V',              // Ei
+00118   gIOTA_OMEGA = 'J',            // Wi
+00119   gNON_ROUGH_ALPHA = 162,       // hA
+00120   gNON_ROUGH_EPSILON = 153,     // hE
+00121   gNON_ROUGH_ETA = 186,         // hH
+00122   gNON_ROUGH_IOTA = 132,        // hH
+00123   gNON_ROUGH_OMICRON = 209,     // hH
+00124   gNON_ROUGH_RHO = 184,         // hR
+00125   gNON_ROUGH_UPSILON = 217,     // hU
+00126   gNON_ROUGH_OMEGA = 231        // hW
+00127 };
+00128 
+00129 // English puntuation as used on bGreek
+00130 
+00131 enum bGreekPunct
+00132 {
+00133   COMMA = ',',
+00134   STOP = '.',
+00135   SEMI_COLON = ';',
+00136   QUESTION = '?'
+00137 };
+00138 
+00139 // English puntuation as used in the Greek font
+00140 
+00141 enum GreekPunct
+00142 {
+00143   gCOMMA = ',',
+00144   gSTOP = '.',
+00145   gSEMI_COLON = ':',
+00146   gQUESTION = ';'
+00147 };
+00148 
+00149 #endif // __GREEKCHARS_H
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/annotated.html b/doc/api-documentation/html/annotated.html new file mode 100644 index 0000000..9616ef2 --- /dev/null +++ b/doc/api-documentation/html/annotated.html @@ -0,0 +1,79 @@ + + +Annotated Index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Compound List

Here are the classes, structs, unions and interfaces with brief descriptions: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EncodingFilterMgrThis class is like a normal SWMgr, but you can additonally specify which encoding you want to use
GBFFootnotesThis Filter shows/hides footnotes in a GBF text
GBFHeadingsThis Filter shows/hides headings in a GBF text
GBFHTMLThis filter converts GBF Text into HTML
GBFHTMLHREFThis filter converts GBF text to HTML text with hrefs
GBFMorphThis Filter shows/hides morph tags in a GBF text
GBFOSISThis filter converts GBF text to HTML text with hrefs
GBFPlainThis filter converts GBF text into plain text
GBFRTFThis filter converts GBF text into RTF text
GBFStrongsThis Filter shows/hides strong's numbers in a GBF text
GBFThMLThis filter converts GBF text into ThML text
GreekLexAttribsThis filter converts ThML text to plain text
Latin1UTF16This filter converts Latin-1 encoded text to UTF-8
Latin1UTF8This filter converts Latin-1 encoded text to UTF-8
ListKeyListKey is the basis for all types of keys that have lists of specified indexes (e.g
LocaleMgrHandles all the different locales of Sword
MarkupFilterMgrThis class is like a normal SWEncodingMgr, but you can additonally specify which markup you want to use
PLAINFootnotesShows or hides footnotes in plain text
PLAINHTMLThis filter converts plain text to HTML text
RTFHTMLThis filter converts RTF text into HTML text
RWPHTMLThis filter converts RWP text to HTML text
RWPRTFThis filter converts RWP text to RTF text
SCSUUTF8This filter converts SCSU compressed (encoded) text to UTF-8
StrKeyA standard string key class (used for modules that index on single strings (eg
SWBasicFilterA filter providing commonly used functionality
SWClassClass used for SWDYNAMIC_CAST to save the inheritance order
SWComThe basis for all commentary modules
SWConfigThe class to read and save settings using a file on disk
SWDisplaySwdisp is the basis for all types of displays (e.g
SWGenBookThe basis for all types of Lexicon and Dictionary modules (hence the 'LD')
SWInputMethodTitle: Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:
SWKeySWKey is the basis for all types of keys for indexing into modules (e.g
SWLDThe basis for all types of Lexicon and Dictionary modules (hence the 'LD')
SWLocaleSWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language
SWMgrSWMgr is the main class of the Sword library
SWModuleThe class SWModule is the base class for all modules used in Sword
SWObjectBase class for major Sword classes
SWTextThe basis for all text modules
ThMLFootnotesThis Filter shows/hides footnotes in a ThML text
ThMLGBFThis filter converts ThML text to GBF text
ThMLHeadingsThis Filter shows/hides headings in a ThML text
ThMLHTMLThis filter converts ThML text to HTML text
ThMLHTMLHREFThis filter converts ThML text to HTML text with hrefs
ThMLLemmaThis Filter shows/hides lemmas in a ThML text
ThMLMorphThis Filter shows/hides morph tags in a ThML text
ThMLOLBThis filter converts ThML text to OLB text
ThMLOSISThis filter converts ThML text to HTML text with hrefs
ThMLPlainThis filter converts ThML text to plain text
ThMLRTFThis filter converts ThML text to RTF text
ThMLScriprefThis Filter shows/hides scripture references in a ThML text
ThMLStrongsThis Filter shows/hides strong's numbers in a ThML text
ThMLVariantsThis Filter shows/hides textual variants
TreeKeyClass VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries
TreeKeyIdxClass VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries
UnicodeRTFThis filter converts UTF-8 text into RTF Unicode tags
UTF16UTF8This filter converts UTF-16 encoded text to UTF-8
UTF8CantillationThis Filter shows/hides Hebrew cantillation marks in UTF8 text
UTF8GreekAccentsThis Filter shows/hides Greek Accents marks in UTF8 text
UTF8HebrewPointsThis Filter shows/hides Hebrew vowel points in UTF8 text
UTF8HTMLThis filter converts UTF-8 text into HTML escape sequences
UTF8Latin1This filter converts UTF-8 encoded text to Latin-1
UTF8UTF16This filter converts UTF-8 encoded text to UTF-16
VerseKeyClass VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/cipherfil_8h-source.html b/doc/api-documentation/html/cipherfil_8h-source.html new file mode 100644 index 0000000..ecaf1d3 --- /dev/null +++ b/doc/api-documentation/html/cipherfil_8h-source.html @@ -0,0 +1,53 @@ + + +cipherfil.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

cipherfil.h

00001 /*
+00002  *
+00003  * $Id: cipherfil_8h-source.html,v 1.7 2002/06/20 20:23:07 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef CIPHERFIL_H
+00022 #define CIPHERFIL_H
+00023 
+00024 #include <swfilter.h>
+00025 #include <swcipher.h>
+00026 
+00027 #include <defs.h>
+00028 
+00029 class SWDLLEXPORT CipherFilter:public SWFilter
+00030 {
+00031   SWCipher *cipher;
+00032 public:
+00033     CipherFilter (const char *key);
+00034     virtual ~ CipherFilter ();
+00035   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00036   virtual SWCipher *getCipher ();
+00037 };
+00038 
+00039 #endif
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/classes.html b/doc/api-documentation/html/classes.html new file mode 100644 index 0000000..38b32af --- /dev/null +++ b/doc/api-documentation/html/classes.html @@ -0,0 +1,31 @@ + + +Alphabetical index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Compound Index

+ + + + + + + + + + + + + + + +
  E  
Latin1UTF16   StrKey   
  T  
ThMLVariants   
EncodingFilterMgr   Latin1UTF8   SWBasicFilter   ThMLFootnotes   TreeKey   
  G  
ListKey   SWClass   ThMLGBF   TreeKeyIdx   
GBFFootnotes   LocaleMgr   SWCom   ThMLHeadings   
  U  
GBFHeadings   
  M  
SWConfig   ThMLHTML   UnicodeRTF   
GBFHTML   MarkupFilterMgr   SWDisplay   ThMLHTMLHREF   UTF16UTF8   
GBFHTMLHREF   
  P  
SWGenBook   ThMLLemma   UTF8Cantillation   
GBFMorph   PLAINFootnotes   SWInputMethod   ThMLMorph   UTF8GreekAccents   
GBFOSIS   PLAINHTML   SWKey   ThMLOLB   UTF8HebrewPoints   
GBFPlain   
  R  
SWLD   ThMLOSIS   UTF8HTML   
GBFRTF   RTFHTML   SWLocale   ThMLPlain   UTF8Latin1   
GBFStrongs   RWPHTML   SWMgr   ThMLRTF   UTF8UTF16   
GBFThML   RWPRTF   SWModule   ThMLScripref   
  V  
GreekLexAttribs   
  S  
SWObject   ThMLStrongs   VerseKey   
  L  
SCSUUTF8   SWText   
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/defs_8h-source.html b/doc/api-documentation/html/defs_8h-source.html new file mode 100644 index 0000000..5cd9a9b --- /dev/null +++ b/doc/api-documentation/html/defs_8h-source.html @@ -0,0 +1,88 @@ + + +defs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

defs.h

00001 // ----------------------------------------------------------------------------
+00002 // Making or using sword as a Windows DLL
+00003 // ----------------------------------------------------------------------------
+00004 
+00005 #if defined(__SWMSW__)
+00006 
+00007 // _declspec works in BC++ 5 and later, as well as VC++
+00008 #if defined(_MSC_VER)
+00009 
+00010 #  ifdef SWMAKINGDLL
+00011 #    define SWDLLEXPORT _declspec( dllexport )
+00012 #    define SWDLLEXPORT_DATA(type) _declspec( dllexport ) type
+00013 #    define SWDLLEXPORT_CTORFN
+00014 #  elif defined(SWUSINGDLL)
+00015 #    define SWDLLEXPORT _declspec( dllimport )
+00016 #    define SWDLLEXPORT_DATA(type) _declspec( dllimport ) type
+00017 #    define SWDLLEXPORT_CTORFN
+00018 #  else
+00019 #    define SWDLLEXPORT
+00020 #    define SWDLLEXPORT_DATA(type) type
+00021 #    define SWDLLEXPORT_CTORFN
+00022 #  endif
+00023 
+00024 #elif defined(__SWPM__)
+00025 
+00026 #  ifdef SWMAKINGDLL
+00027 #    define SWDLLEXPORT _Export
+00028 #    define SWDLLEXPORT_DATA(type) _Export type
+00029 #    define SWDLLEXPORT_CTORFN
+00030 #  elif defined(SWUSINGDLL)
+00031 #    define SWDLLEXPORT _Export
+00032 #    define SWDLLEXPORT_DATA(type) _Export type
+00033 #    define SWDLLEXPORT_CTORFN
+00034 #  else
+00035 #    define SWDLLEXPORT
+00036 #    define SWDLLEXPORT_DATA(type) type
+00037 #    define SWDLLEXPORT_CTORFN
+00038 #  endif
+00039 
+00040 #elif defined(__GNUWIN32__) || defined(__BORLANDC__)
+00041 
+00042 #  ifdef SWMAKINGDLL
+00043 #    define SWDLLEXPORT __declspec( dllexport )
+00044 #    define SWDLLEXPORT_DATA(type) __declspec( dllexport ) type
+00045 #    define SWDLLEXPORT_CTORFN
+00046 #  elif defined(SWUSINGDLL)
+00047 #    define SWDLLEXPORT __declspec( dllimport )
+00048 #    define SWDLLEXPORT_DATA(type) __declspec( dllimport ) type
+00049 #    define SWDLLEXPORT_CTORFN
+00050 #  else
+00051 #    define SWDLLEXPORT
+00052 #    define SWDLLEXPORT_DATA(type) type
+00053 #    define SWDLLEXPORT_CTORFN
+00054 #  endif
+00055 
+00056 
+00057 #else
+00058 #  define SWDLLEXPORT
+00059 #  define SWDLLEXPORT_DATA(type) type
+00060 #  define SWDLLEXPORT_CTORFN
+00061 #endif
+00062 
+00063 #else // !Windows
+00064 #  define SWDLLEXPORT
+00065 #  define SWDLLEXPORT_DATA(type) type
+00066 #  define SWDLLEXPORT_CTORFN
+00067 #endif // Win/!Win
+00068 
+00069 // For ostream, istream ofstream
+00070 #if defined(__BORLANDC__) && defined( _RTLDLL )
+00071 #  define SWDLLIMPORT __import
+00072 #else
+00073 #  define SWDLLIMPORT
+00074 #endif
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/dirent_8h-source.html b/doc/api-documentation/html/dirent_8h-source.html new file mode 100644 index 0000000..d65109d --- /dev/null +++ b/doc/api-documentation/html/dirent_8h-source.html @@ -0,0 +1,46 @@ + + +dirent.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

dirent.h

00001 /*
+00002 
+00003     Declaration of POSIX directory browsing functions and types for Win32.
+00004 
+00005     Kevlin Henney (mailto:kevlin@acm.org), March 1997.
+00006 
+00007     Copyright Kevlin Henney, 1997. All rights reserved.
+00008 
+00009     Permission to use, copy, modify, and distribute this software and its
+00010     documentation for any purpose is hereby granted without fee, provided
+00011     that this copyright and permissions notice appear in all copies and
+00012     derivatives, and that no charge may be made for the software and its
+00013     documentation except to cover cost of distribution.
+00014     
+00015 */
+00016 
+00017 #ifndef DIRENT_INCLUDED
+00018 #define DIRENT_INCLUDED
+00019 
+00020 typedef struct DIR DIR;
+00021 
+00022 struct dirent
+00023 {
+00024     char *d_name;
+00025 };
+00026 
+00027 DIR           *opendir(const char *);
+00028 int           closedir(DIR *);
+00029 struct dirent *readdir(DIR *);
+00030 void          rewinddir(DIR *);
+00031 
+00032 #endif
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/doxygen.css b/doc/api-documentation/html/doxygen.css new file mode 100644 index 0000000..841f709 --- /dev/null +++ b/doc/api-documentation/html/doxygen.css @@ -0,0 +1,49 @@ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #eeeeee } +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #f2f2ff; font-weight: bold; } +TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; } +TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: white } +TD.indexkey { + background-color: #eeeeff; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #eeeeff; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +FONT.keyword { color: #008000 } +FONT.keywordtype { color: #604020 } +FONT.keywordflow { color: #e08000 } +FONT.comment { color: #800000 } +FONT.preprocessor { color: #806020 } +FONT.stringliteral { color: #002080 } +FONT.charliteral { color: #008080 } diff --git a/doc/api-documentation/html/echomod_8h-source.html b/doc/api-documentation/html/echomod_8h-source.html new file mode 100644 index 0000000..25c1475 --- /dev/null +++ b/doc/api-documentation/html/echomod_8h-source.html @@ -0,0 +1,52 @@ + + +echomod.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

echomod.h

00001 /******************************************************************************
+00002  *  echomod.h  - code for class 'EchoMod' - a test module that just echo back
+00003  *               text of key.
+00004  *
+00005  * $Id: echomod_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef ECHOMOD_H
+00024 #define ECHOMOD_H
+00025 
+00026 #include <swtext.h>
+00027 #include <versekey.h>
+00028 
+00029 class EchoMod:public SWText
+00030 {
+00031 public:
+00032   EchoMod ();
+00033   virtual ~ EchoMod ();
+00034   virtual operator const char *();
+00035 };
+00036 
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/encfiltmgr_8h-source.html b/doc/api-documentation/html/encfiltmgr_8h-source.html new file mode 100644 index 0000000..38e7ee3 --- /dev/null +++ b/doc/api-documentation/html/encfiltmgr_8h-source.html @@ -0,0 +1,69 @@ + + +encfiltmgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

encfiltmgr.h

00001 /******************************************************************************
+00002  *  swencodingmgr.h   - definition of class SWEncodingMgr, subclass of
+00003  *                        used to transcode all module text to a requested
+00004  *                        markup.
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef ENCFILTERMGR_H
+00023 #define ENCFILTERMGR_H
+00024 
+00025 #include <swfiltermgr.h>
+00026 
+00027 
+00033 class SWDLLEXPORT EncodingFilterMgr : public SWFilterMgr {
+00034 
+00035 protected:
+00036         SWFilter *latin1utf8;
+00037         SWFilter *scsuutf8;
+00038         SWFilter *targetenc;
+00039 
+00040 
+00041         /*
+00042          * current encoding value
+00043          */        
+00044         char encoding;
+00045 
+00046 public:
+00047 
+00048 
+00056         EncodingFilterMgr (char encoding = ENC_UTF8);
+00057 
+00061         ~EncodingFilterMgr();
+00062 
+00068         char Encoding(char enc);
+00069 
+00075         virtual void AddRawFilters(SWModule *module, ConfigEntMap &section);
+00076 
+00082         virtual void AddEncodingFilters(SWModule *module, ConfigEntMap &section);
+00083 };
+00084 
+00085 #endif
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/entriesblk_8h-source.html b/doc/api-documentation/html/entriesblk_8h-source.html new file mode 100644 index 0000000..59b0a5d --- /dev/null +++ b/doc/api-documentation/html/entriesblk_8h-source.html @@ -0,0 +1,44 @@ + + +entriesblk.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

entriesblk.h

00001 #ifndef ENTRIESBLK_H
+00002 #define ENTRIESBLK_H
+00003 
+00004 #include <sysdata.h>
+00005 
+00006 class EntriesBlock {
+00007         static const int METAHEADERSIZE;
+00008         static const int METAENTRYSIZE;
+00009 
+00010 private:
+00011         char *block;
+00012         void setCount(int count);
+00013         void getMetaEntry(int index, unsigned long *offset, unsigned long *size);
+00014         void setMetaEntry(int index, unsigned long offset, unsigned long size);
+00015 
+00016 public:
+00017         EntriesBlock(const char *iBlock, unsigned long size);
+00018         EntriesBlock();
+00019         ~EntriesBlock();
+00020 
+00021         int getCount();
+00022         int addEntry(const char *entry);
+00023         const char *getEntry(int entryIndex);
+00024         unsigned long getEntrySize(int entryIndex);
+00025         void removeEntry(int entryIndex);
+00026         const char *getRawData(unsigned long *size);
+00027 };
+00028 
+00029 
+00030 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/femain_8h-source.html b/doc/api-documentation/html/femain_8h-source.html new file mode 100644 index 0000000..ec1cadf --- /dev/null +++ b/doc/api-documentation/html/femain_8h-source.html @@ -0,0 +1,46 @@ + + +femain.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

femain.h

00001 /*
+00002  *
+00003  * $Id: femain_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef FEMAIN_H
+00022 #define FEMAIN_H
+00023 
+00024 class FEMain
+00025 {
+00026 public:
+00027   FEMain ();
+00028   virtual ~FEMain ();
+00029   list < SWDisplay * >displays; // so we can delete each display we create
+00030 };
+00031 
+00032 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/filemgr_8h-source.html b/doc/api-documentation/html/filemgr_8h-source.html new file mode 100644 index 0000000..e611129 --- /dev/null +++ b/doc/api-documentation/html/filemgr_8h-source.html @@ -0,0 +1,96 @@ + + +filemgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

filemgr.h

00001 /******************************************************************************
+00002  *  filemgr.h   - definition of class FileMgr used for pooling file handles
+00003  *
+00004  * $Id: filemgr_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef FILEMGR_H
+00023 #define FILEMGR_H
+00024 
+00025 #include <sys/stat.h>
+00026 #include <fcntl.h>
+00027 
+00028 #include <defs.h>
+00029 
+00030 class SWDLLEXPORT FileMgr;
+00031 
+00032 class SWDLLEXPORT FileDesc
+00033 {
+00034 
+00035   friend class FileMgr;
+00036 
+00037   long offset;
+00038   int fd;                       // -77 closed;
+00039   FileMgr *parent;
+00040   FileDesc *next;
+00041 
+00042 public:
+00043    FileDesc (FileMgr * parent, char *path, int mode, int perms, bool tryDowngrade);
+00044    virtual ~FileDesc ();
+00045   int getFd ();
+00046   char *path;
+00047   int mode;
+00048   int perms;
+00049   bool tryDowngrade;
+00050 };
+00051 
+00052 
+00053 class FileMgr
+00054 {
+00055 
+00056   friend class FileDesc;
+00057 
+00058   FileDesc *files;
+00059   int sysOpen (FileDesc * file);
+00060 public:
+00061 
+00062     FileMgr (int maxFiles = 35);
+00063    ~FileMgr ();
+00064   FileDesc *open (char *path, int mode, bool tryDowngrade);
+00065   FileDesc *open (char *path, int mode, int perms = S_IREAD | S_IWRITE, bool tryDowngrade = false);
+00066   void close (FileDesc *);
+00067 
+00068   static signed char existsFile (const char *ipath, const char *ifileName = 0);
+00069   static signed char existsDir (const char *ipath, const char *idirName = 0);
+00070   // to truncate a file at its current position
+00071   // leaving byte at current possition intact
+00072   // deleting everything afterward.
+00073   signed char trunc (FileDesc *);
+00074 
+00075   int maxFiles;
+00076   static FileMgr systemFileMgr;
+00077 };
+00078 
+00079 
+00080 
+00081 
+00082 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/files.html b/doc/api-documentation/html/files.html new file mode 100644 index 0000000..fbd2cc9 --- /dev/null +++ b/doc/api-documentation/html/files.html @@ -0,0 +1,268 @@ + + +File Index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project File List

Here is a list of all documented files with brief descriptions: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
cipherfil.cpp [code]
cipherfil.h [code]
compress.cpp [code]
deflate.h [code]
defs.h [code]
dirent.cpp [code]
dirent.h [code]
echomod.cpp [code]
echomod.h [code]
encfiltmgr.cpp [code]
encfiltmgr.h [code]
entriesblk.cpp [code]
entriesblk.h [code]
femain.cpp [code]
femain.h [code]
filemgr.cpp [code]
filemgr.h [code]
flatapi.h [code]
gbf.cpp [code]
gbf.h [code]
gbffootnotes.cpp [code]
gbffootnotes.h [code]
gbfheadings.cpp [code]
gbfheadings.h [code]
gbfhtml.cpp [code]
gbfhtml.h [code]
gbfhtmlhref.cpp [code]
gbfhtmlhref.h [code]
rawgbf/gbfidx.cpp [code]
ztext/gbfidx.cpp [code]
gbfmorph.cpp [code]
gbfmorph.h [code]
gbfosis.cpp [code]
gbfosis.h [code]
gbfplain.cpp [code]
gbfplain.h [code]
gbfrtf.cpp [code]
gbfrtf.h [code]
gbfstrongs.cpp [code]
gbfstrongs.h [code]
gbfthml.cpp [code]
gbfthml.h [code]
Greek2Greek.cpp [code]
Greek2Greek.h [code]
GreekChars.h [code]
greeklexattribs.cpp [code]
greeklexattribs.h [code]
hebrewmcim.cpp [code]
hebrewmcim.h [code]
hrefcom.cpp [code]
hrefcom.h [code]
infblock.h [code]
infcodes.h [code]
inffast.h [code]
inffixed.h [code]
inftrees.h [code]
infutil.h [code]
jfbgen.cpp [code]
kjvidx.cpp [code]
latin1utf16.cpp [code]
latin1utf16.h [code]
latin1utf8.cpp [code]
latin1utf8.h [code]
listkey.cpp [code]
listkey.h [code]
localemgr.cpp [code]
localemgr.h [code]
lzsscomprs.cpp [code]
lzsscomprs.h [code]
markupfiltmgr.cpp [code]
markupfiltmgr.h [code]
mhcidx.cpp [code]
multimapwdef.h [code]
nasb.cpp [code]
nuidx.cpp [code]
nullim.cpp [code]
nullim.h [code]
plainfootnotes.cpp [code]
plainfootnotes.h [code]
plainhtml.cpp [code]
plainhtml.h [code]
rawcom.cpp [code]
rawcom.h [code]
rawfiles.cpp [code]
rawfiles.h [code]
rawfilesgen.cpp [code]
rawgbf.cpp [code]
rawgbf.h [code]
rawgenbook.cpp [code]
rawgenbook.h [code]
rawld.cpp [code]
rawld.h [code]
rawld4.cpp [code]
rawld4.h [code]
rawstr.cpp [code]
rawstr.h [code]
rawstr4.cpp [code]
rawstr4.h [code]
rawtext.cpp [code]
rawtext.h [code]
comments/zcom/rawtxt2z.cpp [code]
texts/ztext/rawtxt2z.cpp [code]
rawverse.cpp [code]
rawverse.h [code]
regex.h [code]
roman.h [code]
rtfhtml.cpp [code]
rtfhtml.h [code]
comments/rawcom/rtfidx.cpp [code]
texts/rawtext/rtfidx.cpp [code]
rwphtml.cpp [code]
rwphtml.h [code]
rwpidx.cpp [code]
rwprtf.cpp [code]
rwprtf.h [code]
sapphire.cpp [code]
sapphire.h [code]
scsuutf8.cpp [code]
scsuutf8.h [code]
strkey.cpp [code]
strkey.h [code]
swbasicfilter.cpp [code]
swbasicfilter.h [code]
swcacher.cpp [code]
swcacher.h [code]
swcipher.cpp [code]
swcipher.h [code]
swcom.cpp [code]
swcom.h [code]
swcomprs.cpp [code]
swcomprs.h [code]
swconfig.cpp [code]
swconfig.h [code]
swdisp.cpp [code]
swdisp.h [code]
swdisprtf.h [code]
swdisprtfchap.h [code]
swfilter.h [code]
swfiltermgr.cpp [code]
swfiltermgr.h [code]
swgenbook.cpp [code]
swgenbook.h [code]
swinputmeth.cpp [code]
swinputmeth.h [code]
swkey.cpp [code]
swkey.h [code]
swld.cpp [code]
swld.h [code]
swlocale.cpp [code]
swlocale.h [code]
swlog.cpp [code]
swlog.h [code]
swmacs.h [code]
swmgr.cpp [code]
swmgr.h [code]
swmodule.cpp [code]
swmodule.h [code]
swobject.h [code]
swtext.cpp [code]
swtext.h [code]
swunicod.cpp [code]
swunicod.h [code]
swversion.cpp [code]
swversion.h [code]
swwinlog.h [code]
sysdata.h [code]
tbdisp.h [code]
thmlfootnotes.cpp [code]
thmlfootnotes.h [code]
thmlgbf.cpp [code]
thmlgbf.h [code]
thmlheadings.cpp [code]
thmlheadings.h [code]
thmlhtml.cpp [code]
thmlhtml.h [code]
thmlhtmlhref.cpp [code]
thmlhtmlhref.h [code]
thmllemma.cpp [code]
thmllemma.h [code]
thmlmorph.cpp [code]
thmlmorph.h [code]
thmlolb.cpp [code]
thmlolb.h [code]
thmlosis.cpp [code]
thmlosis.h [code]
thmlplain.cpp [code]
thmlplain.h [code]
thmlrtf.cpp [code]
thmlrtf.h [code]
thmlscripref.cpp [code]
thmlscripref.h [code]
thmlstrongs.cpp [code]
thmlstrongs.h [code]
thmlvariants.cpp [code]
thmlvariants.h [code]
treekey.cpp [code]
treekey.h [code]
treekeyidx.cpp [code]
treekeyidx.h [code]
trees.h [code]
unicodertf.cpp [code]
unicodertf.h [code]
unixstr.cpp [code]
unixstr.h [code]
untgz.h [code]
utf16utf8.cpp [code]
utf16utf8.h [code]
utf8arshaping.cpp [code]
utf8arshaping.h [code]
utf8bidireorder.cpp [code]
utf8bidireorder.h [code]
utf8cantillation.cpp [code]
utf8cantillation.h [code]
utf8greekaccents.cpp [code]
utf8greekaccents.h [code]
utf8hebrewpoints.cpp [code]
utf8hebrewpoints.h [code]
utf8html.cpp [code]
utf8html.h [code]
utf8latin1.cpp [code]
utf8latin1.h [code]
utf8nfc.cpp [code]
utf8nfc.h [code]
utf8nfkd.cpp [code]
utf8nfkd.h [code]
utf8transliterator.cpp [code]
utf8transliterator.h [code]
utf8utf16.cpp [code]
utf8utf16.h [code]
utilconf.cpp [code]
utilconf.h [code]
utilfuns.h [code]
utilstr.cpp [code]
utilstr.h [code]
versekey.cpp [code]
versekey.h [code]
vntidx.cpp [code]
zcom.cpp [code]
zcom.h [code]
zconf.h [code]
zipcomprs.cpp [code]
zipcomprs.h [code]
zld.cpp [code]
zld.h [code]
zlib.h [code]
zstr.cpp [code]
zstr.h [code]
ztext.cpp [code]
ztext.h [code]
zutil.h [code]
zverse.cpp [code]
zverse.h [code]
+
Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/flatapi_8h-source.html b/doc/api-documentation/html/flatapi_8h-source.html new file mode 100644 index 0000000..ef66468 --- /dev/null +++ b/doc/api-documentation/html/flatapi_8h-source.html @@ -0,0 +1,92 @@ + + +flatapi.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

flatapi.h

00001 #ifndef SWORDAPI_H
+00002 #define SWORDAPI_H
+00003 
+00004 #include <swmodule.h>
+00005 #include <swkey.h>
+00006 #include <versekey.h>
+00007 #include <swmgr.h>
+00008 
+00009 #ifdef __cplusplus
+00010 #endif
+00011 
+00012 extern "C" {
+00013 
+00014 #define SWHANDLE int
+00015 
+00016 typedef struct {
+00017         ModMap::iterator it;
+00018         ModMap::iterator end;
+00019 } ModItType;
+00020 
+00021 //-----------------------------------------------------------------
+00022 // stringlist_iterator methods
+00023 
+00024 void stringlist_iterator_next(SWHANDLE hsli);
+00025 const char *stringlist_iterator_val(SWHANDLE hsli);
+00026 
+00027 
+00028 //-----------------------------------------------------------------
+00029 // modmap methods
+00030 //
+00031 void ModList_iterator_next(SWHANDLE hmmi);
+00032 SWHANDLE ModList_iterator_val(SWHANDLE hmmi);
+00033 
+00034 
+00035 //-----------------------------------------------------------------
+00036 // SWMgr methods
+00037 //
+00038 SWHANDLE SWMgr_new();
+00039 // SWConfig *, SWConfig *, bool, SWFilterMgr *
+00040 SWHANDLE SWMgr_newEx(SWHANDLE hiconfig, SWHANDLE hisysconfig, char autoload, SWHANDLE hfilterMgr);
+00041 void     SWMgr_delete(SWHANDLE hmgr);
+00042 SWHANDLE SWMgr_getConfig(SWHANDLE hmgr);
+00043 SWHANDLE SWMgr_getModulesIterator(SWHANDLE hmgr);
+00044 SWHANDLE SWMgr_getModuleByName(SWHANDLE hmgr, const char *name);
+00045 const char *   SWMgr_getPrefixPath(SWHANDLE hmgr);
+00046 const char *   SWMgr_getConfigPath(SWHANDLE hmgr);
+00047 void     SWMgr_setGlobalOption(SWHANDLE hmgr, const char *option, const char *value);
+00048 const char *   SWMgr_getGlobalOption(SWHANDLE hmgr, const char *option);
+00049 const char *   SWMgr_getGlobalOptionTip(SWHANDLE hmgr, const char *option);
+00050 // ret: forward_iterator
+00051 SWHANDLE SWMgr_getGlobalOptionsIterator(SWHANDLE hmgr);
+00052 // ret: forward_iterator
+00053 SWHANDLE SWMgr_getGlobalOptionValuesIterator(SWHANDLE hmgr, const char *option);
+00054 void     SWMgr_setCipherKey(SWHANDLE hmgr, const char *modName, const char *key);
+00055 
+00056 
+00057 //-----------------------------------------------------------------
+00058 // SWModule methods
+00059 
+00060 void  SWModule_terminateSearch(SWHANDLE hmodule);
+00061 char  SWModule_error(SWHANDLE hmodule);
+00062 int   SWModule_getEntrySize(SWHANDLE hmodule);
+00063 void  SWModule_setKeyText(SWHANDLE hmodule, const char *key);
+00064 const char *SWModule_getKeyText(SWHANDLE hmodule);
+00065 const char *SWModule_getName(SWHANDLE hmodule);
+00066 const char *SWModule_getDescription(SWHANDLE hmodule);
+00067 const char *SWModule_getType(SWHANDLE hmodule);
+00068 void  SWModule_previous(SWHANDLE hmodule);
+00069 void  SWModule_next(SWHANDLE hmodule);
+00070 void  SWModule_begin(SWHANDLE hmodule);
+00071 const char *SWModule_getStripText(SWHANDLE hmodule);
+00072 const char *SWModule_getRenderText(SWHANDLE hmodule);
+00073 
+00074 }
+00075 #ifdef __cplusplus
+00076 #endif
+00077 
+00078 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/functions.html b/doc/api-documentation/html/functions.html new file mode 100644 index 0000000..c4c8fd1 --- /dev/null +++ b/doc/api-documentation/html/functions.html @@ -0,0 +1,241 @@ + + +Compound Member Index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Compound Members

+_ | a | b | c | d | e | f | g | h | i | k | l | m | n | o | p | r | s | t | u | v | ~
+ +

+Here is a list of all documented class members with links to the classes they belong to:

- _ -

+ +

- a -

 + +

- b -

 + +

- c -

 + +

- d -

 + +

- e -

 + +

- f -

 + +

- g -

 + +

- h -

 + +

- i -

 + +

- k -

 + +

- l -

 + +

- m -

 + +

- n -

 + +

- o -

 + +

- p -

 + +

- r -

 + +

- s -

 + +

- t -

 + +

- u -

 + +

- v -

 + +

- ~ -

 + +
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbf_8h-source.html b/doc/api-documentation/html/gbf_8h-source.html new file mode 100644 index 0000000..6feefcb --- /dev/null +++ b/doc/api-documentation/html/gbf_8h-source.html @@ -0,0 +1,81 @@ + + +gbf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbf.h

00001 /* Header for module GBF, generated by p2c */
+00002 #ifndef GBF_H
+00003 #define GBF_H
+00004 /* p2c: Gbf.pas, line 5: Warning: Could not find module SYSUTILS [271] */
+00005 
+00006 
+00007 #include "sysutils.h"
+00008 /* p2c: Gbf.pas, line 5: Warning: Could not find module DIALOGS [271] */
+00009 #include "dialogs.h"
+00010 
+00011 
+00012 #ifdef GBF_G
+00013 # define vextern
+00014 #else
+00015 # define vextern extern
+00016 #endif
+00017 
+00018 
+00019 
+00020 typedef enum {
+00021   tokNull, tokEOF, tokHeader, tokContent, tokTail, tokStyle, tokWord,
+00022   tokSpace, tokSync, tokControl, tokChar, tokFont
+00023 } TToken;
+00024 typedef enum {
+00025   caBold, caSmallCaps, caItalic, caOTQuote, caRed, caSuperscript, caUnderline,
+00026   caSubscript
+00027 } TCharacterAttribute;
+00028 typedef long TCharAttribs;
+00029 
+00030 
+00031 
+00032 typedef struct TBookNameRec {
+00033   Char Name[256], Abbr[256];
+00034   uchar Num;
+00035 } TBookNameRec;
+00036 
+00037 typedef TBookNameRec TBookAbbr[116];
+00038 /* p2c: Gbf.pas, line 25: 
+00039  * Warning: Expected an expression, found a '/' [227] */
+00040 /* p2c: Gbf.pas, line 25: 
+00041  * Warning: Expected an expression, found a '/' [227] */
+00042 /* p2c: Gbf.pas, line 25: Warning: Division by zero [163] */
+00043 /* p2c: Gbf.pas, line 26: Warning: Division by zero [163] */
+00044 /* p2c: Gbf.pas, line 26: Warning: Expected a ')', found a '(' [227] */
+00045 /* p2c: Gbf.pas, line 144: 
+00046  * Warning: Expected an expression, found a '/' [227] */
+00047 /* p2c: Gbf.pas, line 144: 
+00048  * Warning: Expected an expression, found a '/' [227] */
+00049 /* p2c: Gbf.pas, line 144: Warning: Division by zero [163] */
+00050 /* p2c: Gbf.pas, line 144: Warning: Division by zero [163] */
+00051 /* p2c: Gbf.pas, line 145: Warning: Mixing non-strings with strings [170] */
+00052 /* p2c: Gbf.pas, line 145: 
+00053  * Warning: Expected a ')', found a string literal [227] */
+00054 
+00055 
+00056 extern TBookAbbr BookAbbr;
+00057 
+00058 extern Char BookFileName[91][256];
+00059 
+00060 vextern Char STR1[256];
+00061 
+00062 
+00063 #undef vextern
+00064 
+00065 #endif /*GBF_H*/
+00066 
+00067 /* End. */
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbffootnotes_8h-source.html b/doc/api-documentation/html/gbffootnotes_8h-source.html new file mode 100644 index 0000000..abc8281 --- /dev/null +++ b/doc/api-documentation/html/gbffootnotes_8h-source.html @@ -0,0 +1,70 @@ + + +gbffootnotes.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbffootnotes.h

00001 /*
+00002  *
+00003  * $Id: gbffootnotes_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GBFFOOTNOTES_H
+00022 #define GBFFOOTNOTES_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GBFFootnotes:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039   GBFFootnotes ();
+00040   virtual ~ GBFFootnotes ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfheadings_8h-source.html b/doc/api-documentation/html/gbfheadings_8h-source.html new file mode 100644 index 0000000..215c2a9 --- /dev/null +++ b/doc/api-documentation/html/gbfheadings_8h-source.html @@ -0,0 +1,70 @@ + + +gbfheadings.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfheadings.h

00001 /*
+00002  *
+00003  * $Id: gbfheadings_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GBFHEADINGS_H
+00022 #define GBFHEADINGS_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GBFHeadings:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039   GBFHeadings ();
+00040   virtual ~ GBFHeadings ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfhtml_8h-source.html b/doc/api-documentation/html/gbfhtml_8h-source.html new file mode 100644 index 0000000..1f12ccd --- /dev/null +++ b/doc/api-documentation/html/gbfhtml_8h-source.html @@ -0,0 +1,50 @@ + + +gbfhtml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfhtml.h

00001 /***************************************************************************
+00002                           gbfhtml.h  -  description
+00003                              -------------------
+00004     begin                : Tue Jun 15 15:34:26 CEST 1999
+00005 
+00006     copyright            : (C) 1999 by Torsten Uhlmann
+00007     email                : TUhlmann@gmx.de
+00008  ***************************************************************************/
+00009 
+00010 /***************************************************************************
+00011  *                                                                         *
+00012  *   This program is free software; you can redistribute it and/or modify  *
+00013  *   it under the terms of the GNU General Public License as published by  *
+00014  *   the Free Software Foundation; either version 2 of the License, or     *
+00015  *   (at your option) any later version.                                   *
+00016  *                                                                         *
+00017  ***************************************************************************/
+00018 
+00019 /* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/gbfhtml_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $ */
+00020 /* $Revision: 1.7 $ */
+00021 
+00022 #ifndef GBFHTML_H
+00023 #define GBFHTML_H
+00024 
+00025 #include <swfilter.h>
+00026 
+00027 #include <defs.h>
+00028 
+00031 class SWDLLEXPORT GBFHTML:public SWFilter
+00032 {
+00033 public:
+00034   GBFHTML ();
+00035   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00036 };
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfhtmlhref_8h-source.html b/doc/api-documentation/html/gbfhtmlhref_8h-source.html new file mode 100644 index 0000000..237131f --- /dev/null +++ b/doc/api-documentation/html/gbfhtmlhref_8h-source.html @@ -0,0 +1,45 @@ + + +gbfhtmlhref.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfhtmlhref.h

00001 /*-*************************************************************************
+00002                           gbfhtmlhref.h  -  description
+00003                              -------------------
+00004     begin                    : 2001-09-03
+00005     copyright            : 2001 by CrossWire Bible Society
+00006  ***************************************************************************/
+00007 
+00008 /***************************************************************************
+00009  *                                                                         *
+00010  *   This program is free software; you can redistribute it and/or modify  *
+00011  *   it under the terms of the GNU General Public License as published by  *
+00012  *   the Free Software Foundation; either version 2 of the License, or     *
+00013  *   (at your option) any later version.                                   *
+00014  *                                                                         *
+00015  ***************************************************************************/
+00016 
+00017 #ifndef GBFHTMLHREF_H
+00018 #define GBFHTMLHREF_H
+00019 
+00020 #include <swbasicfilter.h>
+00021 
+00022 #include <defs.h>
+00023 
+00026 class SWDLLEXPORT GBFHTMLHREF : public SWBasicFilter {
+00027 protected:
+00028         virtual bool handleToken(char **buf, const char *token, DualStringMap &userData);
+00029 public:
+00030   GBFHTMLHREF ();
+00031 };
+00032 
+00033 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfmorph_8h-source.html b/doc/api-documentation/html/gbfmorph_8h-source.html new file mode 100644 index 0000000..b92fd2c --- /dev/null +++ b/doc/api-documentation/html/gbfmorph_8h-source.html @@ -0,0 +1,69 @@ + + +gbfmorph.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfmorph.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef GBFMORPH_H
+00021 #define GBFMORPH_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT GBFMorph:public SWFilter
+00030 {
+00031   bool option;
+00032   static const char on[];
+00033   static const char off[];
+00034   static const char optName[];
+00035   static const char optTip[];
+00036   OptionsList options;
+00037 public:
+00038     GBFMorph ();
+00039     virtual ~ GBFMorph ();
+00040   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00041   virtual const char *getOptionName ()
+00042   {
+00043     return optName;
+00044   }
+00045   virtual const char *getOptionTip ()
+00046   {
+00047     return optTip;
+00048   }
+00049   virtual void setOptionValue (const char *ival);
+00050   virtual const char *getOptionValue ();
+00051   virtual OptionsList getOptionValues ()
+00052   {
+00053     return options;
+00054   }
+00055 };
+00056 
+00057 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfosis_8h-source.html b/doc/api-documentation/html/gbfosis_8h-source.html new file mode 100644 index 0000000..3705dd1 --- /dev/null +++ b/doc/api-documentation/html/gbfosis_8h-source.html @@ -0,0 +1,47 @@ + + +gbfosis.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfosis.h

00001 /***************************************************************************
+00002                           gbfosis.h  -  description
+00003                              -------------------
+00004     begin                : 2001-09-03
+00005     copyright            : 2001 by CrossWire Bible Society
+00006  ***************************************************************************/
+00007 
+00008 /***************************************************************************
+00009  *                                                                         *
+00010  *   This program is free software; you can redistribute it and/or modify  *
+00011  *   it under the terms of the GNU General Public License as published by  *
+00012  *   the Free Software Foundation; either version 2 of the License, or     *
+00013  *   (at your option) any later version.                                   *
+00014  *                                                                         *
+00015  ***************************************************************************/
+00016 
+00017 #ifndef GBFOSIS_H
+00018 #define GBFOSIS_H
+00019 
+00020 #include <defs.h>
+00021 #include <swfilter.h>
+00022 
+00025 class SWDLLEXPORT GBFOSIS : public SWFilter {
+00026 protected:
+00027         virtual const char *convertToOSIS(const char *, const SWKey *key);
+00028         void pushString(char **buf, const char *format, ...);
+00029 public:
+00030         GBFOSIS();
+00031         virtual ~GBFOSIS();
+00032         char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif /* THMLOSIS_H */
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfplain_8h-source.html b/doc/api-documentation/html/gbfplain_8h-source.html new file mode 100644 index 0000000..48a2482 --- /dev/null +++ b/doc/api-documentation/html/gbfplain_8h-source.html @@ -0,0 +1,49 @@ + + +gbfplain.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfplain.h

00001 /*
+00002  *
+00003  * $Id: gbfplain_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GBFPLAIN_H
+00022 #define GBFPLAIN_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GBFPlain:public SWFilter
+00031 {
+00032 public:
+00033   GBFPlain ();
+00034   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfrtf_8h-source.html b/doc/api-documentation/html/gbfrtf_8h-source.html new file mode 100644 index 0000000..208e65e --- /dev/null +++ b/doc/api-documentation/html/gbfrtf_8h-source.html @@ -0,0 +1,49 @@ + + +gbfrtf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfrtf.h

00001 /*
+00002  *
+00003  * $Id: gbfrtf_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GBFRTF_H
+00022 #define GBFRTF_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GBFRTF:public SWFilter
+00031 {
+00032 public:
+00033   GBFRTF ();
+00034   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfstrongs_8h-source.html b/doc/api-documentation/html/gbfstrongs_8h-source.html new file mode 100644 index 0000000..15b32ec --- /dev/null +++ b/doc/api-documentation/html/gbfstrongs_8h-source.html @@ -0,0 +1,70 @@ + + +gbfstrongs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfstrongs.h

00001 /*
+00002  *
+00003  * $Id: gbfstrongs_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GBFSTRONGS_H
+00022 #define GBFSTRONGS_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GBFStrongs:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039     GBFStrongs ();
+00040     virtual ~ GBFStrongs ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/gbfthml_8h-source.html b/doc/api-documentation/html/gbfthml_8h-source.html new file mode 100644 index 0000000..d6e42fb --- /dev/null +++ b/doc/api-documentation/html/gbfthml_8h-source.html @@ -0,0 +1,46 @@ + + +gbfthml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

gbfthml.h

00001 /***************************************************************************
+00002                           gbfthml.h  -  description
+00003                              -------------------
+00004     begin                : 1999-10-28
+00005     copyright            : 1999 by Chris Little
+00006     email                : chrislit@chiasma.org
+00007  ***************************************************************************/
+00008 
+00009 /***************************************************************************
+00010  *                                                                         *
+00011  *   This program is free software; you can redistribute it and/or modify  *
+00012  *   it under the terms of the GNU General Public License as published by  *
+00013  *   the Free Software Foundation; either version 2 of the License, or     *
+00014  *   (at your option) any later version.                                   *
+00015  *                                                                         *
+00016  ***************************************************************************/
+00017 
+00018 #ifndef GBFTHML_H
+00019 #define GBFTHML_H
+00020 
+00021 #include <swfilter.h>
+00022 
+00023 #include <defs.h>
+00024 
+00027 class SWDLLEXPORT GBFThML:public SWFilter
+00028 {
+00029 public:
+00030   GBFThML ();
+00031   virtual char ProcessText (char *text, int maxlen = -1);
+00032 };
+00033 
+00034 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/graph_legend.html b/doc/api-documentation/html/graph_legend.html new file mode 100644 index 0000000..8c7f1a8 --- /dev/null +++ b/doc/api-documentation/html/graph_legend.html @@ -0,0 +1,60 @@ + + +Graph Legend + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen. +

+ Consider the following example: 

/*! Invisible class because of truncation */
+class Invisible { };
+
+/*! Truncated class, inheritance relation is hidden */
+class Truncated : public Invisible { };
+
+/* Class not documented with doxygen comments */
+class Undocumented { };
+
+/*! Class that is inherited using public inheritance */
+class PublicBase : public Truncated { };
+
+/*! A template class */
+template<class T> class Templ { };
+
+/*! Class that is inherited using protected inheritance */
+class ProtectedBase { };
+
+/*! Class that is inherited using private inheritance */
+class PrivateBase { };
+
+/*! Class that is used by the Inherited class */
+class Used { };
+
+/*! Super class that inherits a number of other classes */
+class Inherited : public PublicBase,
+                  protected ProtectedBase,
+                  private PrivateBase,
+                  public Undocumented
+                  public Templ<int>
+{
+  private:
+    Used *m_usedClass;
+};
+
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 240 this will result in the following graph: +

+

+
+ +

+ The boxes in the above graph have the following meaning:

+The arrows have the following meaning: +
Generated on Thu Jun 20 22:13:05 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/greeklexattribs_8h-source.html b/doc/api-documentation/html/greeklexattribs_8h-source.html new file mode 100644 index 0000000..f67415b --- /dev/null +++ b/doc/api-documentation/html/greeklexattribs_8h-source.html @@ -0,0 +1,48 @@ + + +greeklexattribs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

greeklexattribs.h

00001 /*
+00002  *
+00003  * thmlplain.h
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef GREEKLEXATTRIBS_H
+00022 #define GREEKLEXATTRIBS_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT GreekLexAttribs:public SWFilter {
+00031 public:
+00032         GreekLexAttribs();
+00033         virtual char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0);
+00034 };
+00035 
+00036 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/hebrewmcim_8h-source.html b/doc/api-documentation/html/hebrewmcim_8h-source.html new file mode 100644 index 0000000..650c5cd --- /dev/null +++ b/doc/api-documentation/html/hebrewmcim_8h-source.html @@ -0,0 +1,34 @@ + + +hebrewmcim.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

hebrewmcim.h

00001 #ifndef HEBREWMCIM_H
+00002 #define HEBREWMCIM_H
+00003 
+00013 #include <swinputmeth.h>
+00014 #include <map>
+00015 using namespace std;
+00016 
+00017 class HebrewMCIM : public SWInputMethod {
+00018 
+00019     void init();
+00020     int subst[255];
+00021     map<int, int> subst2[12];
+00022     map<int, int*> multiChars;
+00023 
+00024 public:
+00025     HebrewMCIM();
+00026     int *translate(char in);
+00027 };
+00028 
+00029 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/hierarchy.html b/doc/api-documentation/html/hierarchy.html new file mode 100644 index 0000000..806c262 --- /dev/null +++ b/doc/api-documentation/html/hierarchy.html @@ -0,0 +1,93 @@ + + +Hierarchical Index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Class Hierarchy

Go to the graphical class hierarchy +

+This inheritance list is sorted roughly, but not completely, alphabetically:

+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/hrefcom_8h-source.html b/doc/api-documentation/html/hrefcom_8h-source.html new file mode 100644 index 0000000..8e5c400 --- /dev/null +++ b/doc/api-documentation/html/hrefcom_8h-source.html @@ -0,0 +1,60 @@ + + +hrefcom.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

hrefcom.h

00001 /******************************************************************************
+00002  *  hrefcom.h - code for class 'HREFCom'- a module that produces HTML HREFs
+00003  *                      pointing to actual text desired.  Uses standard
+00004  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00005  *
+00006  * $Id: hrefcom_8h-source.html,v 1.7 2002/06/20 20:23:08 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef HREFCOM_H
+00025 #define HREFCOM_H
+00026 
+00027 #include <rawverse.h>
+00028 #include <swcom.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT HREFCom:public RawVerse, public SWCom
+00033 {
+00034   char *prefix;
+00035 
+00036 public:
+00037   
+00038     
+00039     HREFCom (const char *ipath, const char *prefix, const char *iname =
+00040              0, const char *idesc = 0, SWDisplay * idisp = 0);
+00041     virtual ~ HREFCom ();
+00042   virtual char *getRawEntry ();
+00043 };
+00044 
+00045 
+00046 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/index.html b/doc/api-documentation/html/index.html new file mode 100644 index 0000000..a39bf85 --- /dev/null +++ b/doc/api-documentation/html/index.html @@ -0,0 +1,26 @@ + + +The Sword Project 1.5.3 - API documentation + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project 1.5.3 - API documentation

+

+

1.5.3

This is the API documentation of the Sword project. it describes the structure of the Sword library and documents the functions of the classes. From time to time this documentation gives programming examples, too. +

+Sword provides an interface to different modules (Bibles/Commentaries/Lexicons) on disk. The object to work directly with the modules is SWModule. Use the class SWMgr to manage the modules. +

+If you want to write your own frontend for Sword please have a look at the already existing ones. Well knwon frontends are:
+ -BibleCS for Windows (the sourcecode is availble in the CVS of crosswire.org)
+ -GnomeSword (http://gnomesword.sourceforge.net/)
+ -BibleTime (http://www.bibletime.de/)
+ +

+

Generated on Thu Jun 20 22:12:58 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/inherits.html b/doc/api-documentation/html/inherits.html new file mode 100644 index 0000000..ac96391 --- /dev/null +++ b/doc/api-documentation/html/inherits.html @@ -0,0 +1,222 @@ + + +Graphical Class Hierarchy + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Graphical Class Hierarchy

Go to the textual class hierarchy +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Generated on Thu Jun 20 22:13:06 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/latin1utf16_8h-source.html b/doc/api-documentation/html/latin1utf16_8h-source.html new file mode 100644 index 0000000..d7b7c3c --- /dev/null +++ b/doc/api-documentation/html/latin1utf16_8h-source.html @@ -0,0 +1,47 @@ + + +latin1utf16.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

latin1utf16.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef LATIN1UTF16_H
+00021 #define LATIN1UTF16_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT Latin1UTF16:public SWFilter {
+00030 public:
+00031   Latin1UTF16();
+00032   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/latin1utf8_8h-source.html b/doc/api-documentation/html/latin1utf8_8h-source.html new file mode 100644 index 0000000..5291b69 --- /dev/null +++ b/doc/api-documentation/html/latin1utf8_8h-source.html @@ -0,0 +1,47 @@ + + +latin1utf8.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

latin1utf8.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef LATIN1UTF8_H
+00021 #define LATIN1UTF8_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT Latin1UTF8:public SWFilter {
+00030 public:
+00031   Latin1UTF8();
+00032   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/listkey_8h-source.html b/doc/api-documentation/html/listkey_8h-source.html new file mode 100644 index 0000000..2926de3 --- /dev/null +++ b/doc/api-documentation/html/listkey_8h-source.html @@ -0,0 +1,86 @@ + + +listkey.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

listkey.h

00001 /******************************************************************************
+00002  * listkey.h    - code for base class 'listkey'.  listkey is the basis for all
+00003  *                              types of keys for indexing into modules
+00004  *                              (e.g. verse, word,
+00005  *                              place, etc.)
+00006  *
+00007  * $Id: listkey_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00008  *
+00009  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00010  *      CrossWire Bible Society
+00011  *      P. O. Box 2528
+00012  *      Tempe, AZ  85280-2528
+00013  *
+00014  * This program is free software; you can redistribute it and/or modify it
+00015  * under the terms of the GNU General Public License as published by the
+00016  * Free Software Foundation version 2.
+00017  *
+00018  * This program is distributed in the hope that it will be useful, but
+00019  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00021  * General Public License for more details.
+00022  *
+00023  */
+00024 
+00025 #ifndef SWLSTKEY_H
+00026 #define SWLSTKEY_H
+00027 
+00028 #include <swkey.h>
+00029 
+00030 #include <defs.h>
+00031 
+00036 class SWDLLEXPORT ListKey : public SWKey {
+00037 
+00038   static SWClass classdef;
+00039   void init ();
+00040 protected:
+00041   int arraypos;
+00042   int arraymax;
+00043   int arraycnt;
+00044   SWKey **array;
+00045 public:
+00050         ListKey (const char *ikey = 0);
+00051         ListKey (ListKey const &k);
+00054         virtual ~ ListKey ();
+00055 
+00056         virtual SWKey *clone () const;
+00059         virtual void ClearList ();
+00063         virtual int Count ();
+00066         virtual void Remove ();
+00072         virtual char SetToElement (int ielement, SW_POSITION = TOP);
+00078         virtual SWKey *GetElement (int pos = -1);
+00082         ListKey & operator << (const SWKey &ikey) { add(ikey); return *this; }
+00083         virtual void add(const SWKey &ikey);
+00084 
+00089         virtual void copyFrom(const ListKey & ikey);
+00090         virtual void copyFrom(const SWKey & ikey) { SWKey::copyFrom(ikey); }
+00091 
+00097         virtual void setPosition(SW_POSITION);
+00100         virtual void decrement(int step);
+00103         virtual void increment(int step);
+00104 
+00105         virtual char Traversable () { return 1; }
+00106         virtual long Index () const { return arraypos; }
+00107 
+00112         virtual long Index (long index) { SetToElement (index); return Index (); }
+00113 
+00114         SWKEY_OPERATORS
+00115         ListKey & operator =(const ListKey &key) { copyFrom(key); return *this; }
+00116 };
+00117 
+00118 
+00119 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/localemgr_8h-source.html b/doc/api-documentation/html/localemgr_8h-source.html new file mode 100644 index 0000000..8e7ab4e --- /dev/null +++ b/doc/api-documentation/html/localemgr_8h-source.html @@ -0,0 +1,82 @@ + + +localemgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

localemgr.h

00001 /******************************************************************************
+00002  *  localemgr.h   - definition of class LocaleMgr used to interact with
+00003  *                              registered locales for a sword installation
+00004  *
+00005  * $Id: localemgr_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef LOCALEMGR_H
+00024 #define LOCALEMGR_H
+00025 
+00026 #include <string>
+00027 #include <map>
+00028 #include <list>
+00029 #include <swconfig.h>
+00030 #include <swlocale.h>
+00031 
+00032 #include <defs.h>
+00033 
+00034 using namespace std;
+00035 
+00036 typedef map < string, SWLocale *, less < string > >LocaleMap;
+00037 
+00049 class SWDLLEXPORT LocaleMgr
+00050 {
+00051 private:
+00052   void deleteLocales ();
+00053   char *defaultLocaleName;
+00054 
+00055 protected:
+00056   LocaleMap locales;
+00057 
+00058 public:
+00062   LocaleMgr (const char *iConfigPath = 0);
+00063 
+00067   virtual ~ LocaleMgr ();
+00068 
+00074   virtual SWLocale *getLocale (const char *name);
+00075 
+00080   virtual list < string > getAvailableLocales ();
+00081   
+00089   virtual const char *translate (const char *text, const char *localeName = 0);
+00090 
+00095   virtual const char *getDefaultLocaleName ();
+00096 
+00101   virtual void setDefaultLocaleName (const char *name);
+00102 
+00106   static LocaleMgr systemLocaleMgr;
+00107 
+00108   
+00111   virtual void loadConfigDir(const char *ipath);
+00112   
+00113 };
+00114 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/lzsscomprs_8h-source.html b/doc/api-documentation/html/lzsscomprs_8h-source.html new file mode 100644 index 0000000..0fe73f6 --- /dev/null +++ b/doc/api-documentation/html/lzsscomprs_8h-source.html @@ -0,0 +1,93 @@ + + +lzsscomprs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

lzsscomprs.h

00001 /******************************************************************************
+00002  *  lzsscomprs.h   - definition of Class SWCompress used for data compression
+00003  *
+00004  * $Id: lzsscomprs_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef LZSSCOMPRS_H
+00023 #define LZSSCOMPRS_H
+00024 
+00025 #include <swcomprs.h>
+00026 
+00027 #include <defs.h>
+00028 
+00029 // The following are constant sizes used by the compression algorithm.
+00030 //
+00031 //  N         - This is the size of the ring buffer.  It is set
+00032 //              to 4K.  It is important to note that a position
+00033 //              within the ring buffer requires 12 bits.  
+00034 //
+00035 //  F         - This is the maximum length of a character sequence
+00036 //              that can be taken from the ring buffer.  It is set
+00037 //              to 18.  Note that a length must be 3 before it is
+00038 //              worthwhile to store a position/length pair, so the
+00039 //              length can be encoded in only 4 bits.  Or, put yet
+00040 //              another way, it is not necessary to encode a length
+00041 //              of 0-18, it is necessary to encode a length of
+00042 //              3-18, which requires 4 bits.
+00043 //              
+00044 //  THRESHOLD - It takes 2 bytes to store an offset and
+00045 //              a length.  If a character sequence only
+00046 //              requires 1 or 2 characters to store 
+00047 //              uncompressed, then it is better to store
+00048 //              it uncompressed than as an offset into
+00049 //              the ring buffer.
+00050 //
+00051 // Note that the 12 bits used to store the position and the 4 bits
+00052 // used to store the length equal a total of 16 bits, or 2 bytes.
+00053 
+00054 #define N               4096
+00055 #define F               18
+00056 #define THRESHOLD       3
+00057 #define NOT_USED        N
+00058 
+00059 
+00060 
+00061 class SWDLLEXPORT LZSSCompress:public SWCompress
+00062 {
+00063   static unsigned char m_ring_buffer[N + F - 1];
+00064   static short int m_match_position;
+00065   static short int m_match_length;
+00066   static short int m_lson[N + 1];
+00067   static short int m_rson[N + 257];
+00068   static short int m_dad[N + 1];
+00069   void InitTree ();
+00070   void InsertNode (short int Pos);
+00071   void DeleteNode (short int Node);
+00072 public:
+00073     LZSSCompress ();
+00074     virtual ~ LZSSCompress ();
+00075   virtual void Encode (void);
+00076   virtual void Decode (void);
+00077 };
+00078 
+00079 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/markupfiltmgr_8h-source.html b/doc/api-documentation/html/markupfiltmgr_8h-source.html new file mode 100644 index 0000000..4f06d77 --- /dev/null +++ b/doc/api-documentation/html/markupfiltmgr_8h-source.html @@ -0,0 +1,64 @@ + + +markupfiltmgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

markupfiltmgr.h

00001 /******************************************************************************
+00002  *  swmarkupmgr.h   - definition of class SWMarkupMgr, subclass of
+00003  *                        used to transcode all module text to a requested
+00004  *                        markup.
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef MARKUPFILTMGR_H
+00023 #define MARKUPFILTMGR_H
+00024 
+00025 #include <encfiltmgr.h>
+00026 
+00031 class SWDLLEXPORT MarkupFilterMgr : public EncodingFilterMgr {
+00032 protected:
+00033         SWFilter* fromthml;
+00034         SWFilter* fromgbf;
+00035         SWFilter* fromplain;
+00036         SWFilter* fromosis;
+00037 
+00038         /*
+00039          * current markup value
+00040          */
+00041         char markup;
+00042 
+00043         void CreateFilters(char markup);
+00044 public:
+00053         MarkupFilterMgr(char markup = FMT_THML, char encoding = ENC_UTF8);
+00054 
+00058         ~MarkupFilterMgr();
+00059 
+00065         char Markup(char m = FMT_UNKNOWN);
+00066 
+00072         virtual void AddRenderFilters(SWModule *module, ConfigEntMap &section);
+00073 };
+00074 
+00075 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/multimapwdef_8h-source.html b/doc/api-documentation/html/multimapwdef_8h-source.html new file mode 100644 index 0000000..e17bed9 --- /dev/null +++ b/doc/api-documentation/html/multimapwdef_8h-source.html @@ -0,0 +1,45 @@ + + +multimapwdef.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

multimapwdef.h

00001 #ifndef MULTIMAPWDEF
+00002 #define MULTIMAPWDEF
+00003 
+00004 #include <map>
+00005 
+00006 using namespace std;
+00007 
+00008 // multmap that still lets you use [] to reference FIRST
+00009 // entry of a key if multiples exist
+00010 template <class Key, class T, class Compare>
+00011 class multimapwithdefault : public multimap<Key, T, Compare> {
+00012 public:
+00013         typedef pair<const Key, T> value_type;
+00014         T& operator[](const Key& k) {
+00015                 if (find(k) == end()) {
+00016                         insert(value_type(k, T()));
+00017                 }
+00018                 return (*(find(k))).second;
+00019         }
+00020         bool has(const Key& k, const T &val) const {
+00021                 typename multimap<Key, T, Compare>::const_iterator start = lower_bound(k);
+00022                 typename multimap<Key, T, Compare>::const_iterator end = upper_bound(k);
+00023                 for (; start!=end; start++) {
+00024                         if (start->second == val)
+00025                                 return true;
+00026                 }
+00027                 return false;
+00028         }
+00029 };
+00030 
+00031 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/namespaces.html b/doc/api-documentation/html/namespaces.html new file mode 100644 index 0000000..f6867be --- /dev/null +++ b/doc/api-documentation/html/namespaces.html @@ -0,0 +1,17 @@ + + +Namespace Index + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

The Sword Project Namespace List

Here is a list of all documented namespaces with brief descriptions: + +
stdTitle: Keyboard mapping for Michigan-Claremont Hebrew input Description: Copyright: Copyright (c) 2001 CrossWire Bible Society under the terms of the GNU GPL Company:
+
Generated on Thu Jun 20 22:13:05 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/nullim_8h-source.html b/doc/api-documentation/html/nullim_8h-source.html new file mode 100644 index 0000000..cfd1d3b --- /dev/null +++ b/doc/api-documentation/html/nullim_8h-source.html @@ -0,0 +1,28 @@ + + +nullim.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

nullim.h

00001 #ifndef NULLIM_H
+00002 #define NULLIM_H
+00003 
+00004 #include <swinputmeth.h>
+00005 
+00006 
+00007 class NullIM : public SWInputMethod {
+00008 
+00009 public:
+00010         NullIM();
+00011         int * translate(char ch);
+00012 };
+00013 
+00014 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/plainfootnotes_8h-source.html b/doc/api-documentation/html/plainfootnotes_8h-source.html new file mode 100644 index 0000000..f23216b --- /dev/null +++ b/doc/api-documentation/html/plainfootnotes_8h-source.html @@ -0,0 +1,73 @@ + + +plainfootnotes.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

plainfootnotes.h

00001 /***************************************************************************
+00002                           plainfootnotes.h  -  description                              
+00003                              -------------------                                         
+00004     begin                : Wed Oct 13 1999                                           
+00005     copyright            : (C) 1999 by The team of BibleTime                         
+00006     email                : info@bibletime.de                                     
+00007  ***************************************************************************/
+00008 
+00009 /***************************************************************************
+00010  *                                                                         *
+00011  *   This program is free software; you can redistribute it and/or modify  *
+00012  *   it under the terms of the GNU General Public License as published by  *
+00013  *   the Free Software Foundation; either version 2 of the License, or     *
+00014  *   (at your option) any later version.                                   * 
+00015  *                                                                         *
+00016  ***************************************************************************/
+00017 
+00018 /* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainfootnotes_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $ */
+00019 /* $Revision: 1.7 $ */
+00020 
+00021 #ifndef PLAINFOOTNOTES_H
+00022 #define PLAINFOOTNOTES_H
+00023 
+00024 #include <defs.h>
+00025 
+00026 class QObject;
+00027 #include <swfilter.h>
+00028 class SWKey;
+00029 
+00033 class SWDLLEXPORT PLAINFootnotes:public SWFilter
+00034 {
+00035   bool option;
+00036   static const char on[];
+00037   static const char off[];
+00038   static const char optName[];
+00039   static const char optTip[];
+00040   OptionsList options;
+00041 
+00042 public:
+00043     PLAINFootnotes ();
+00044     virtual ~ PLAINFootnotes ();
+00045   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00046   virtual const char *getOptionName ()
+00047   {
+00048     return optName;
+00049   }
+00050   virtual const char *getOptionTip ()
+00051   {
+00052     return optTip;
+00053   }
+00054   virtual void setOptionValue (const char *ival);
+00055   virtual const char *getOptionValue ();
+00056   virtual OptionsList getOptionValues ()
+00057   {
+00058     return options;
+00059   }
+00060 };
+00061 
+00062 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/plainhtml_8h-source.html b/doc/api-documentation/html/plainhtml_8h-source.html new file mode 100644 index 0000000..a7fc76a --- /dev/null +++ b/doc/api-documentation/html/plainhtml_8h-source.html @@ -0,0 +1,50 @@ + + +plainhtml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

plainhtml.h

00001 /***************************************************************************
+00002                           rwphtml.h  -  description
+00003                              -------------------
+00004     begin                : Tue Jun 15 15:34:26 CEST 1999
+00005 
+00006     copyright            : (C) 1999 by Torsten Uhlmann
+00007     email                : TUhlmann@gmx.de
+00008  ***************************************************************************/
+00009 
+00010 /***************************************************************************
+00011  *                                                                         *
+00012  *   This program is free software; you can redistribute it and/or modify  *
+00013  *   it under the terms of the GNU General Public License as published by  *
+00014  *   the Free Software Foundation; either version 2 of the License, or     *
+00015  *   (at your option) any later version.                                   *
+00016  *                                                                         *
+00017  ***************************************************************************/
+00018 
+00019 /* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/plainhtml_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $ */
+00020 /* $Revision: 1.7 $ */
+00021 
+00022 #ifndef PLAINHTML_H
+00023 #define PLAINHTML_H
+00024 
+00025 #include <swfilter.h>
+00026 
+00027 #include <defs.h>
+00028 
+00031 class SWDLLEXPORT PLAINHTML:public SWFilter
+00032 {
+00033 public:
+00034   PLAINHTML ();
+00035   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00036 };
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:12:59 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawcom_8h-source.html b/doc/api-documentation/html/rawcom_8h-source.html new file mode 100644 index 0000000..ad92d79 --- /dev/null +++ b/doc/api-documentation/html/rawcom_8h-source.html @@ -0,0 +1,69 @@ + + +rawcom.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawcom.h

00001 /******************************************************************************
+00002  *  rawcom.h   - code for class 'RawCom'- a module that reads raw commentary
+00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *
+00005  * $Id: rawcom_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWCOM_H
+00024 #define RAWCOM_H
+00025 
+00026 #include <rawverse.h>
+00027 #include <swcom.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 class SWDLLEXPORT RawCom:public RawVerse, public SWCom {
+00032 
+00033 public:
+00034   
+00035     
+00036         RawCom (const char *ipath, const char *iname = 0, const char *idesc = 0,
+00037                 SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00038                 const char* ilang = 0);
+00039      virtual ~ RawCom ();
+00040      virtual char *getRawEntry ();
+00041 
+00042      virtual SWModule & operator += (int increment);
+00043      virtual SWModule & operator -= (int decrement) { return this->operator += (-decrement); }
+00044 
+00045         // write interface ----------------------------
+00046         virtual bool isWritable () { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
+00047         static char createModule (const char *path) { return RawVerse::createModule (path); }
+00048         virtual SWModule & setentry (const char *inbuf, long len);      // Modify current module entry
+00049         virtual SWModule & operator << (const char *inbuf);     // Modify current module entry
+00050         virtual SWModule & operator << (const SWKey * linkKey); // Link current module entry to other module entry
+00051         virtual void deleteEntry ();    // Delete current module entry
+00052         // end write interface ------------------------
+00053 
+00054 };
+00055 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawfiles_8h-source.html b/doc/api-documentation/html/rawfiles_8h-source.html new file mode 100644 index 0000000..5935e4e --- /dev/null +++ b/doc/api-documentation/html/rawfiles_8h-source.html @@ -0,0 +1,74 @@ + + +rawfiles.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawfiles.h

00001 /******************************************************************************
+00002  *  rawfiles.h - code for class 'RawFiles'- a module that produces HTML HREFs
+00003  *                      pointing to actual text desired.  Uses standard
+00004  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00005  *
+00006  * $Id: rawfiles_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef RAWFILES_H
+00025 #define RAWFILES_H
+00026 
+00027 #include <rawverse.h>
+00028 #include <swcom.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT RawFiles:public RawVerse, public SWCom
+00033 {
+00034 
+00035   char *getnextfilename ();
+00036 
+00037 public:
+00038   
+00039     
+00040     RawFiles (const char *ipath, const char *iname = 0, const char *idesc =
+00041               0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00042               const char* ilang = 0);
+00043     virtual ~RawFiles ();
+00044   virtual char *getRawEntry ();
+00045 
+00046   // write interface ----------------------------
+00050         virtual bool isWritable () { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
+00051   
+00056   static char createModule (const char *);
+00057   
+00062   virtual SWModule & operator << (const char *);
+00063   
+00068   virtual SWModule & operator << (const SWKey *);
+00069   
+00073   virtual void deleteEntry ();
+00074   // end write interface ------------------------
+00075 };
+00076 
+00077 
+00078 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawgbf_8h-source.html b/doc/api-documentation/html/rawgbf_8h-source.html new file mode 100644 index 0000000..ca89793 --- /dev/null +++ b/doc/api-documentation/html/rawgbf_8h-source.html @@ -0,0 +1,59 @@ + + +rawgbf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawgbf.h

00001 /******************************************************************************
+00002  *  rawgbf.h   - code for class 'RawGBF'- a module that reads raw text files:
+00003  *                ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *
+00005  * $Id: rawgbf_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWGBF_H
+00024 #define RAWGBF_H
+00025 
+00026 #include <rawverse.h>
+00027 #include <swtext.h>
+00028 #include <swfilter.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT RawGBF:public SWText, public RawVerse
+00033 {
+00034 
+00035 public:
+00036   
+00037     
+00038     RawGBF (const char *ipath, const char *iname = 0, const char *idesc =
+00039             0, SWDisplay * idisp = 0);
+00040     virtual ~ RawGBF ();
+00041   virtual operator char *();
+00042 };
+00043 
+00044 
+00045 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawgenbook_8h-source.html b/doc/api-documentation/html/rawgenbook_8h-source.html new file mode 100644 index 0000000..e050f22 --- /dev/null +++ b/doc/api-documentation/html/rawgenbook_8h-source.html @@ -0,0 +1,73 @@ + + +rawgenbook.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawgenbook.h

00001 /******************************************************************************
+00002  *  rawtext.h   - code for class 'RawText'- a module that reads raw text files:
+00003  *                ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *
+00005  * $Id: rawgenbook_8h-source.html,v 1.3 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWGENBOOK_H
+00024 #define RAWGENBOOK_H
+00025 
+00026 #include <swgenbook.h>
+00027 #include <filemgr.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 class SWDLLEXPORT RawGenBook:public SWGenBook {
+00032         char *entryBuf;
+00033         char *path;
+00034         FileDesc *bdtfd;
+00035 
+00036 public:
+00037   
+00038     
+00039         RawGenBook (const char *ipath, const char *iname = 0, const char *idesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
+00040         virtual ~ RawGenBook ();
+00041         virtual char *getRawEntry ();
+00042 #ifdef _MSC_VER
+00043         virtual SWModule & operator = (SW_POSITION);
+00044 #else
+00045         virtual RawGenBook & operator = (SW_POSITION);
+00046 #endif
+00047         // write interface ----------------------------
+00048         virtual bool isWritable () { return ((bdtfd->getFd() > 0) && ((bdtfd->mode & O_RDWR) == O_RDWR)); }
+00049         static char createModule (const char *ipath);
+00050         virtual SWModule & setentry (const char *inbuf, long len);      // Modify current module entry
+00051         virtual SWModule & operator << (const char *inbuf);     // Modify current module entry
+00052         virtual SWModule & operator << (const SWKey * linkKey); // Link current module entry to other module entry
+00053         virtual void deleteEntry ();    // Delete current module entry
+00054         virtual SWKey *CreateKey ();
+00055         // end write interface ------------------------
+00056 };
+00057 
+00058 
+00059 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawld4_8h-source.html b/doc/api-documentation/html/rawld4_8h-source.html new file mode 100644 index 0000000..f06f0da --- /dev/null +++ b/doc/api-documentation/html/rawld4_8h-source.html @@ -0,0 +1,78 @@ + + +rawld4.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawld4.h

00001 /******************************************************************************
+00002  *  rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and
+00003  *                              dictionary files: *.dat *.idx
+00004  *
+00005  * $Id: rawld4_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWLD4_H
+00024 #define RAWLD4_H
+00025 
+00026 #include <rawstr4.h>
+00027 #include <swld.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 class SWDLLEXPORT RawLD4:public RawStr4, public SWLD
+00032 {
+00033   void strongsPad (char *buf);
+00034   char getEntry (long away = 0);
+00035 
+00036 public:
+00037   
+00038     
+00039     RawLD4(const char *ipath, const char *iname = 0, const char *idesc =
+00040            0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00041            const char* ilang = 0);
+00042     virtual ~RawLD4();
+00043   virtual char *getRawEntry();
+00044 
+00045   virtual SWModule & operator =(SW_POSITION pos);
+00046   virtual SWModule & operator +=(int increment);
+00047   virtual SWModule & operator -=(int decrement) {
+00048     return this->operator +=(-decrement);
+00049   }
+00050   // write interface ----------------------------
+00051         virtual bool isWritable () { return ((idxfd->getFd() > 0) && ((idxfd->mode & O_RDWR) == O_RDWR)); }
+00052         static char createModule (const char *path) {
+00053                 return RawStr4::createModule (path);
+00054         }
+00055 
+00056   virtual SWModule & setentry (const char *inbuf, long len);    // Modify current module entry
+00057   virtual SWModule & operator << (const char *inbuf);   // Modify current module entry
+00058   virtual SWModule & operator << (const SWKey * linkKey);       // Link current module entry to other module entry
+00059   virtual void deleteEntry ();  // Delete current module entry
+00060   // end write interface ------------------------
+00061 };
+00062 
+00063 
+00064 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawld_8h-source.html b/doc/api-documentation/html/rawld_8h-source.html new file mode 100644 index 0000000..857fd37 --- /dev/null +++ b/doc/api-documentation/html/rawld_8h-source.html @@ -0,0 +1,80 @@ + + +rawld.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawld.h

00001 /******************************************************************************
+00002  *  rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and
+00003  *                              dictionary files: *.dat *.idx
+00004  *
+00005  * $Id: rawld_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWLD_H
+00024 #define RAWLD_H
+00025 
+00026 #include <rawstr.h>
+00027 #include <swld.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 class SWDLLEXPORT RawLD:public RawStr, public SWLD
+00032 {
+00033   void strongsPad (char *buf);
+00034   char getEntry (long away = 0);
+00035 
+00036 public:
+00037   
+00038     
+00039     RawLD (const char *ipath, const char *iname = 0, const char *idesc =
+00040            0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00041            const char* ilang = 0);
+00042     virtual ~ RawLD ();
+00043   virtual char *getRawEntry ();
+00044 
+00045   virtual SWModule & operator = (SW_POSITION pos);
+00046   virtual SWModule & operator += (int increment);
+00047   virtual SWModule & operator -= (int decrement)
+00048   {
+00049     return this->operator += (-decrement);
+00050   }
+00051   // write interface ----------------------------
+00052         virtual bool isWritable () { return ((idxfd->getFd() > 0) && ((idxfd->mode & O_RDWR) == O_RDWR)); }
+00053   static char createModule (const char *path)
+00054   {
+00055     return RawStr::createModule (path);
+00056   }
+00057   
+00058   virtual SWModule & setentry (const char *inbuf, long len);    // Modify current module entry
+00059   virtual SWModule & operator << (const char *inbuf);   // Modify current module entry
+00060   virtual SWModule & operator << (const SWKey * linkKey);       // Link current module entry to other module entry
+00061   virtual void deleteEntry ();  // Delete current module entry
+00062   // end write interface ------------------------
+00063 };
+00064 
+00065 
+00066 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawstr4_8h-source.html b/doc/api-documentation/html/rawstr4_8h-source.html new file mode 100644 index 0000000..df8bf4e --- /dev/null +++ b/doc/api-documentation/html/rawstr4_8h-source.html @@ -0,0 +1,70 @@ + + +rawstr4.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawstr4.h

00001 /*****************************************************************************
+00002  * rawstr.h   - code for class 'RawStr'- a module that reads raw text
+00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *                      and provides lookup and parsing functions based on
+00005  *                      class StrKey
+00006  *
+00007  * $Id: rawstr4_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00008  *
+00009  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00010  *      CrossWire Bible Society
+00011  *      P. O. Box 2528
+00012  *      Tempe, AZ  85280-2528
+00013  *
+00014  * This program is free software; you can redistribute it and/or modify it
+00015  * under the terms of the GNU General Public License as published by the
+00016  * Free Software Foundation version 2.
+00017  *
+00018  * This program is distributed in the hope that it will be useful, but
+00019  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00021  * General Public License for more details.
+00022  *
+00023  */
+00024 
+00025 #ifndef RAWSTR4_H
+00026 #define RAWSTR4_H
+00027 
+00028 #include <filemgr.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT RawStr4
+00033 {
+00034   static int instance;          // number of instantiated RawStr4 objects or derivitives
+00035   char *path;
+00036   long lastoff;
+00037 
+00038 protected:
+00039   FileDesc *idxfd;
+00040   FileDesc *datfd;
+00041   void preptext (char *buf);
+00042   void settext (const char *key, const char *buf, long len = 0);
+00043   void linkentry (const char *destkey, const char *srckey);
+00044 public:
+00045   char nl;
+00046     RawStr4(const char *ipath, int fileMode = -1);
+00047     virtual ~ RawStr4();
+00048   void getidxbuf (long ioffset, char **buf);
+00049   void getidxbufdat (long ioffset, char **buf);
+00050   signed char findoffset (const char *key, long *start, unsigned long *size,
+00051                    long away = 0, long *idxoff = 0);
+00052   void gettext (long start, unsigned long size, char *idxbuf, char *buf);
+00053   static signed char createModule (const char *path);
+00054 };
+00055 
+00056 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawstr_8h-source.html b/doc/api-documentation/html/rawstr_8h-source.html new file mode 100644 index 0000000..c6c17c9 --- /dev/null +++ b/doc/api-documentation/html/rawstr_8h-source.html @@ -0,0 +1,68 @@ + + +rawstr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawstr.h

00001 /*****************************************************************************
+00002  * rawstr.h   - code for class 'RawStr'- a module that reads raw text
+00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *                      and provides lookup and parsing functions based on
+00005  *                      class StrKey
+00006  *
+00007  * $Id: rawstr_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00008  *
+00009  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00010  *      CrossWire Bible Society
+00011  *      P. O. Box 2528
+00012  *      Tempe, AZ  85280-2528
+00013  *
+00014  * This program is free software; you can redistribute it and/or modify it
+00015  * under the terms of the GNU General Public License as published by the
+00016  * Free Software Foundation version 2.
+00017  *
+00018  * This program is distributed in the hope that it will be useful, but
+00019  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00021  * General Public License for more details.
+00022  *
+00023  */
+00024 
+00025 #ifndef RAWSTR_H
+00026 #define RAWSTR_H
+00027 
+00028 #include <filemgr.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT RawStr {
+00033         static int instance;            // number of instantiated RawStr objects or derivitives
+00034         char *path;
+00035         long lastoff;
+00036 
+00037 protected:
+00038         FileDesc *idxfd;
+00039         FileDesc *datfd;
+00040         void settext(const char *key, const char *buf, long len = 0);
+00041         void linkentry(const char *destkey, const char *srckey);
+00042 public:
+00043         static void preptext(char *buf);
+00044         static char nl;
+00045         RawStr(const char *ipath, int fileMode = -1);
+00046         virtual ~RawStr ();
+00047         void getidxbuf(long ioffset, char **buf);
+00048         void getidxbufdat(long ioffset, char **buf);
+00049         signed char findoffset(const char *key, long *start, unsigned short *size, long away = 0, long *idxoff = 0);
+00050         void gettext(long start, unsigned short size, char *idxbuf, char *buf);
+00051         static signed char createModule(const char *path);
+00052 };
+00053 
+00054 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawtext_8h-source.html b/doc/api-documentation/html/rawtext_8h-source.html new file mode 100644 index 0000000..042fe1b --- /dev/null +++ b/doc/api-documentation/html/rawtext_8h-source.html @@ -0,0 +1,78 @@ + + +rawtext.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawtext.h

00001 /******************************************************************************
+00002  *  rawtext.h   - code for class 'RawText'- a module that reads raw text files:
+00003  *                ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *
+00005  * $Id: rawtext_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef RAWTEXT_H
+00024 #define RAWTEXT_H
+00025 
+00026 #include <rawverse.h>
+00027 #include <rawstr.h>
+00028 #include <swtext.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT RawText:public SWText, public RawVerse {
+00033         RawStr *fastSearch[2];
+00034 
+00035 public:
+00036   
+00037     
+00038         RawText (const char *ipath, const char *iname = 0, const char *idesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00039         const char* ilang = 0);
+00040         virtual ~ RawText ();
+00041         virtual char *getRawEntry ();
+00042      virtual SWModule & operator += (int increment);
+00043      virtual SWModule & operator -= (int decrement) { return this->operator += (-decrement); }
+00044         virtual signed char createSearchFramework ();
+00045         virtual bool hasSearchFramework () { return true; }
+00046 #ifdef _MSC_VER
+00047         virtual SWModule & operator = (SW_POSITION);
+00048 #else
+00049         virtual RawText & operator = (SW_POSITION);
+00050 #endif
+00051         virtual ListKey & Search (const char *istr, int searchType = 0, int flags = 0, SWKey * scope = 0, bool * justCheckIfSupported = 0, void (*percent) (char, void *) = &SWModule::nullPercent, void *percentUserData = 0);
+00052 
+00053         // write interface ----------------------------
+00054         virtual bool isWritable () { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
+00055         static char createModule (const char *path) { return RawVerse::createModule (path); }
+00056         virtual SWModule & setentry (const char *inbuf, long len);      // Modify current module entry
+00057         virtual SWModule & operator << (const char *inbuf);     // Modify current module entry
+00058         virtual SWModule & operator << (const SWKey * linkKey); // Link current module entry to other module entry
+00059         virtual void deleteEntry ();    // Delete current module entry
+00060         // end write interface ------------------------
+00061 };
+00062 
+00063 
+00064 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rawverse_8h-source.html b/doc/api-documentation/html/rawverse_8h-source.html new file mode 100644 index 0000000..d247400 --- /dev/null +++ b/doc/api-documentation/html/rawverse_8h-source.html @@ -0,0 +1,52 @@ + + +rawverse.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rawverse.h

00001 /******************************************************************************
+00002  *  rawverse.h   - code for class 'RawVerse'- a module that reads raw text
+00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *                      and provides lookup and parsing functions based on
+00005  *                      class VerseKey
+00006  */
+00007 
+00008 #ifndef RAWVERSE_H
+00009 #define RAWVERSE_H
+00010 
+00011 #include <filemgr.h>
+00012 #include <fcntl.h>
+00013 
+00014 #include <defs.h>
+00015 
+00016 class SWDLLEXPORT RawVerse {
+00017   static int instance;          // number of instantiated RawVerse objects or derivitives
+00018 protected:
+00019   FileDesc *idxfp[2];
+00020   FileDesc *textfp[2];
+00021 
+00022   char *path;
+00023   void preptext (char *buf);
+00024   void settext (char testmt, long idxoff, const char *buf, long len = 0);
+00025   void linkentry (char testmt, long destidxoff, long srcidxoff);
+00026 
+00027 public:
+00028   char nl;
+00029     RawVerse (const char *ipath, int fileMode = -1);
+00030     virtual ~ RawVerse ();
+00031   void findoffset (char testmt, long idxoff, long *start,
+00032                    unsigned short *end);
+00033   void gettext (char testmt, long start, unsigned short size, char *buf);
+00034   static char createModule (const char *path);
+00035 };
+00036 
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/roman_8h-source.html b/doc/api-documentation/html/roman_8h-source.html new file mode 100644 index 0000000..87dac78 --- /dev/null +++ b/doc/api-documentation/html/roman_8h-source.html @@ -0,0 +1,39 @@ + + +roman.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

roman.h

00001 /******************************************************************************
+00002  *  roman.h     - roman numeral functions
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 #ifndef ROMAN_H
+00020 #define ROMAN_H
+00021 char isroman(const char *);
+00022 /* char* to_rom(int num, char *p); */
+00023 int from_rom(const char *s);
+00024 
+00025 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rtfhtml_8h-source.html b/doc/api-documentation/html/rtfhtml_8h-source.html new file mode 100644 index 0000000..4e2fde5 --- /dev/null +++ b/doc/api-documentation/html/rtfhtml_8h-source.html @@ -0,0 +1,49 @@ + + +rtfhtml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rtfhtml.h

00001 /***************************************************************************
+00002                           rtfhtml.h  -  description                              
+00003                              -------------------                                         
+00004     begin                : Wed Oct 13 1999                                           
+00005     copyright            : (C) 1999 by The team of BibleTime                         
+00006     email                : info@bibletime.de                                     
+00007  ***************************************************************************/
+00008 
+00009 /***************************************************************************
+00010  *                                                                         *
+00011  *   This program is free software; you can redistribute it and/or modify  *
+00012  *   it under the terms of the GNU General Public License as published by  *
+00013  *   the Free Software Foundation; either version 2 of the License, or     *
+00014  *   (at your option) any later version.                                   * 
+00015  *                                                                         *
+00016  ***************************************************************************/
+00017 
+00018 /* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rtfhtml_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $ */
+00019 /* $Revision: 1.7 $ */
+00020 
+00021 #ifndef RTFHTML_H
+00022 #define RTFHTML_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT RTFHTML:public SWFilter
+00031 {
+00032 public:
+00033   RTFHTML ();
+00034   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rwphtml_8h-source.html b/doc/api-documentation/html/rwphtml_8h-source.html new file mode 100644 index 0000000..0912f77 --- /dev/null +++ b/doc/api-documentation/html/rwphtml_8h-source.html @@ -0,0 +1,50 @@ + + +rwphtml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rwphtml.h

00001 /***************************************************************************
+00002                           rwphtml.h  -  description
+00003                              -------------------
+00004     begin                : Tue Jun 15 15:34:26 CEST 1999
+00005 
+00006     copyright            : (C) 1999 by Torsten Uhlmann
+00007     email                : TUhlmann@gmx.de
+00008  ***************************************************************************/
+00009 
+00010 /***************************************************************************
+00011  *                                                                         *
+00012  *   This program is free software; you can redistribute it and/or modify  *
+00013  *   it under the terms of the GNU General Public License as published by  *
+00014  *   the Free Software Foundation; either version 2 of the License, or     *
+00015  *   (at your option) any later version.                                   *
+00016  *                                                                         *
+00017  ***************************************************************************/
+00018 
+00019 /* $Header: /usr/local/cvsroot/sword/doc/api-documentation/html/rwphtml_8h-source.html,v 1.7 2002/06/20 20:23:09 mgruner Exp $ */
+00020 /* $Revision: 1.7 $ */
+00021 
+00022 #ifndef RWPHTML_H
+00023 #define RWPHTML_H
+00024 
+00025 #include <swfilter.h>
+00026 
+00027 #include <defs.h>
+00028 
+00031 class SWDLLEXPORT RWPHTML:public SWFilter
+00032 {
+00033 public:
+00034   RWPHTML ();
+00035   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00036 };
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/rwprtf_8h-source.html b/doc/api-documentation/html/rwprtf_8h-source.html new file mode 100644 index 0000000..dcee3df --- /dev/null +++ b/doc/api-documentation/html/rwprtf_8h-source.html @@ -0,0 +1,52 @@ + + +rwprtf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

rwprtf.h

00001 /******************************************************************************
+00002  *  rwprtf.h   - definition of Class RWPRTF, an SWFilter used to convert
+00003  *                              special tags in Robertsons Word Pictures commentary into
+00004  *                              Rich Text Format tags
+00005  *
+00006  * $Id: rwprtf_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef RWPRTF_H
+00025 #define RWPRTF_H
+00026 
+00027 #include <swfilter.h>
+00028 
+00029 #include <defs.h>
+00030 
+00033 class SWDLLEXPORT RWPRTF:public SWFilter
+00034 {
+00035 public:
+00036   RWPRTF ();
+00037   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00038 };
+00039 
+00040 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/sapphire_8h-source.html b/doc/api-documentation/html/sapphire_8h-source.html new file mode 100644 index 0000000..f36c275 --- /dev/null +++ b/doc/api-documentation/html/sapphire_8h-source.html @@ -0,0 +1,67 @@ + + +sapphire.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

sapphire.h

00001 /* sapphire.h -- Interface for the Saphire II stream cipher.
+00002 
+00003    Dedicated to the Public Domain the author and inventor
+00004    (Michael Paul Johnson).  This code comes with no warranty.
+00005    Use it at your own risk.
+00006    Ported from the Pascal implementation of the Sapphire Stream
+00007    Cipher 9 December 1994.
+00008    Added hash-specific functions 27 December 1994.
+00009    Made index variable initialization key-dependent,
+00010    made the output function more resistant to cryptanalysis,
+00011    and renamed to Sapphire II Stream Cipher 2 January 1995.
+00012 
+00013    unsigned char is assumed to be 8 bits.  If it is not, the
+00014    results of assignments need to be reduced to 8 bits with
+00015    & 0xFF or % 0x100, whichever is faster.
+00016 */  
+00017   
+00018 #ifndef NULL
+00019 #define NULL 0
+00020 #endif  /*  */
+00021   class sapphire 
+00022 {
+00023   
+00024     // These variables comprise the state of the state machine.
+00025   unsigned char cards[256];     // A permutation of 0-255.
+00026   unsigned char rotor,          // Index that rotates smoothly
+00027     ratchet,                    // Index that moves erratically
+00028     avalanche,                  // Index heavily data dependent
+00029     last_plain,                 // Last plain text byte
+00030     last_cipher;                // Last cipher text byte
+00031   
+00032     // This function is used by initialize(), which is called by the
+00033     // constructor.
+00034   unsigned char keyrand (int limit, unsigned char *user_key,
+00035                           unsigned char keysize, unsigned char *rsum,
+00036 unsigned *keypos); public:sapphire (unsigned char
+00037                                       *key = NULL,      // Calls initialize if a real
+00038                                       unsigned char keysize = 0);       // key is provided.  If none
+00039   // is provided, call initialize
+00040   // before encrypt or decrypt.
+00041   ~sapphire ();                 // Destroy cipher state information.
+00042   void initialize (unsigned char *key,  // User key is used to set
+00043                    unsigned char keysize);      // up state information.
+00044   void hash_init (void);        // Set up default hash.
+00045   unsigned char encrypt (unsigned char b = 0);  // Encrypt byte
+00046   // or get a random byte.
+00047   unsigned char decrypt (unsigned char b);      // Decrypt byte.
+00048   void hash_final (unsigned char *hash, // Copy hash value to hash
+00049                    unsigned char hashlength = 20);      // Hash length (16-32)
+00050   void burn (void);             // Destroy cipher state information.
+00051 };
+00052 
+00053 
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/scsuutf8_8h-source.html b/doc/api-documentation/html/scsuutf8_8h-source.html new file mode 100644 index 0000000..b01f044 --- /dev/null +++ b/doc/api-documentation/html/scsuutf8_8h-source.html @@ -0,0 +1,53 @@ + + +scsuutf8.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

scsuutf8.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef SCSUUTF8_H
+00021 #define SCSUUTF8_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT SCSUUTF8:public SWFilter {
+00030  private:
+00031   unsigned char* UTF8Output(unsigned long, unsigned char* text);
+00032   
+00033   unsigned long c, d;
+00034   
+00035 
+00036  public:
+00037   SCSUUTF8();
+00038   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00039 };
+00040 
+00041 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/strkey_8h-source.html b/doc/api-documentation/html/strkey_8h-source.html new file mode 100644 index 0000000..c9ab793 --- /dev/null +++ b/doc/api-documentation/html/strkey_8h-source.html @@ -0,0 +1,58 @@ + + +strkey.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

strkey.h

00001 /******************************************************************************
+00002  *  strkey.h - code for class 'strkey'- a standard Biblical verse key
+00003  *
+00004  * $Id: strkey_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 
+00023 #ifndef STRKEY_H
+00024 #define STRKEY_H
+00025 
+00026 #include <swkey.h>
+00027 #include <swmacs.h>
+00028 
+00029 #include <defs.h>
+00030 
+00035 class SWDLLEXPORT StrKey:public SWKey
+00036 {
+00037   static SWClass classdef;
+00038   void init ();
+00039 public:
+00044   StrKey (const char *ikey = 0);
+00047   virtual ~ StrKey ();
+00048 
+00049   SWKEY_OPERATORS
+00050 
+00051 };
+00052 
+00053 
+00054 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swbasicfilter_8h-source.html b/doc/api-documentation/html/swbasicfilter_8h-source.html new file mode 100644 index 0000000..6732ca5 --- /dev/null +++ b/doc/api-documentation/html/swbasicfilter_8h-source.html @@ -0,0 +1,99 @@ + + +swbasicfilter.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swbasicfilter.h

00001 /******************************************************************************
+00002  *  swbasicfilter.h     - definition of class SWBasicFilter.  An SWFilter
+00003  *                              impl that provides some basic methods that
+00004  *                              many filter will need and can use as a starting
+00005  *                              point. 
+00006  *
+00007  * $Id: swbasicfilter_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00008  *
+00009  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00010  *      CrossWire Bible Society
+00011  *      P. O. Box 2528
+00012  *      Tempe, AZ  85280-2528
+00013  *
+00014  * This program is free software; you can redistribute it and/or modify it
+00015  * under the terms of the GNU General Public License as published by the
+00016  * Free Software Foundation version 2.
+00017  *
+00018  * This program is distributed in the hope that it will be useful, but
+00019  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00021  * General Public License for more details.
+00022  *
+00023  */
+00024 
+00025 #ifndef SWBASICFILTER_H
+00026 #define SWBASICFILTER_H
+00027 
+00028 #include <swfilter.h>
+00029 
+00030 #include <defs.h>
+00031 #include <map>
+00032 using namespace std;
+00033 
+00045 class SWDLLEXPORT SWBasicFilter : public SWFilter {
+00046 
+00047         char *tokenStart;
+00048         char *tokenEnd;
+00049         char *escStart;
+00050         char *escEnd;
+00051         bool escStringCaseSensitive;
+00052         bool tokenCaseSensitive;
+00053         bool passThruUnknownToken;
+00054         bool passThruUnknownEsc;
+00055 
+00056 public:
+00057         SWBasicFilter();
+00058         virtual char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0);
+00059         virtual ~SWBasicFilter();
+00060 
+00061 protected:
+00062         const SWModule *module;
+00063         const SWKey *key;
+00064         char *resultBuffer;
+00065         typedef map<string, string> DualStringMap;
+00066         DualStringMap tokenSubMap;
+00067         DualStringMap escSubMap;
+00068 
+00070         void setEscapeStart(const char *escStart);
+00071 
+00073         void setEscapeEnd(const char *escEnd);
+00074 
+00076         void setTokenStart(const char *tokenStart);
+00077 
+00079         void setTokenEnd(const char *tokenEnd);
+00080 
+00083         void setPassThruUnknownToken(bool val);
+00084 
+00087         void setPassThruUnknownEscapeString(bool val);
+00088 
+00089         void setTokenCaseSensitive(bool val);
+00090         void setEscapeStringCaseSensitive(bool val);
+00091 
+00092         void addTokenSubstitute(const char *findString, const char *replaceString);
+00093         void addEscapeStringSubstitute(const char *findString, const char *replaceString);
+00094         bool substituteToken(char **buf, const char *token);
+00095         bool substituteEscapeString(char **buf, const char *escString);
+00096 
+00098         void pushString(char **buf, const char *format, ...);
+00099 
+00106         virtual bool handleToken(char **buf, const char *token, DualStringMap &userData);
+00107 
+00114         virtual bool handleEscapeString(char **buf, const char *escString, DualStringMap &userData);
+00115 };
+00116 
+00117 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swcacher_8h-source.html b/doc/api-documentation/html/swcacher_8h-source.html new file mode 100644 index 0000000..de6b15b --- /dev/null +++ b/doc/api-documentation/html/swcacher_8h-source.html @@ -0,0 +1,51 @@ + + +swcacher.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swcacher.h

00001 /******************************************************************************
+00002  *  swcacher.h  - definition of class SWCacher used to provide an interface for
+00003  *      objects that cache and want a standard interface for cleaning up.
+00004  *
+00005  * $Id: swcacher_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWCACHER_H
+00024 #define SWCACHER_H
+00025 
+00026 #include <defs.h>
+00027 
+00028 class SWDLLEXPORT  SWCacher {
+00029 public:
+00030         SWCacher();
+00031         virtual ~SWCacher();
+00032         virtual void flush();
+00033         virtual long resourceConsumption();
+00034         virtual long lastAccess();
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swcipher_8h-source.html b/doc/api-documentation/html/swcipher_8h-source.html new file mode 100644 index 0000000..0f54984 --- /dev/null +++ b/doc/api-documentation/html/swcipher_8h-source.html @@ -0,0 +1,63 @@ + + +swcipher.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swcipher.h

00001 /******************************************************************************
+00002  *  swcipher.h   - definition of Class SWCipher used for data cipher/decipher
+00003  *
+00004  * $Id: swcipher_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1999 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef SWCIPHER_H
+00023 #define SWCIPHER_H
+00024 
+00025 #include "sapphire.h"
+00026 
+00027 #include <defs.h>
+00028 
+00029 class SWDLLEXPORT SWCipher
+00030 {
+00031 
+00032   sapphire master;
+00033   sapphire work;
+00034 
+00035   char *buf;
+00036   bool cipher;
+00037   int len;
+00038 protected:
+00039 public:
+00040     SWCipher (unsigned char *key);
+00041   virtual void setCipherKey (const char *key);
+00042     virtual ~ SWCipher ();
+00043   virtual char *Buf (const char *buf = 0, unsigned int len = 0);
+00044   virtual char *cipherBuf (unsigned int *len, const char *buf = 0);
+00045   virtual void Encode (void);
+00046   virtual void Decode (void);
+00047 };
+00048 
+00049 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swcom_8h-source.html b/doc/api-documentation/html/swcom_8h-source.html new file mode 100644 index 0000000..c587ca9 --- /dev/null +++ b/doc/api-documentation/html/swcom_8h-source.html @@ -0,0 +1,57 @@ + + +swcom.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swcom.h

00001 /******************************************************************************
+00002  *  swcom.h   - code for base class 'SWCom'.  SWCom is the basis for all
+00003  *               types of commentary modules
+00004  *
+00005  * $Id: swcom_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWCOM_H
+00024 #define SWCOM_H
+00025 
+00026 #include <swmodule.h>
+00027 #include <versekey.h>
+00028 
+00029 #include <defs.h>
+00030 
+00033 class SWDLLEXPORT SWCom : public SWModule {
+00034 public:
+00035 
+00042   SWCom(const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, SWTextEncoding enc = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup mark = FMT_UNKNOWN, const char* ilang = 0);
+00043   virtual ~SWCom();
+00044   virtual SWKey *CreateKey()
+00045   {
+00046     return new VerseKey();
+00047   }
+00048 };
+00049 
+00050 
+00051 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swcomprs_8h-source.html b/doc/api-documentation/html/swcomprs_8h-source.html new file mode 100644 index 0000000..31e5934 --- /dev/null +++ b/doc/api-documentation/html/swcomprs_8h-source.html @@ -0,0 +1,59 @@ + + +swcomprs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swcomprs.h

00001 /******************************************************************************
+00002  *  swcomprs.h   - definition of Class SWCompress used for data compression
+00003  *
+00004  * $Id: swcomprs_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef SWCOMPRS_H
+00023 #define SWCOMPRS_H
+00024 
+00025 #include <defs.h>
+00026 
+00027 class SWDLLEXPORT SWCompress
+00028 {
+00029   void Init ();
+00030   void cycleStream ();
+00031 protected:
+00032   char *buf, *zbuf, direct;     // 0 - encode; 1 - decode
+00033   unsigned long zlen, zpos, pos, slen;
+00034 public:
+00035     SWCompress ();
+00036     virtual ~ SWCompress ();
+00037   virtual char *Buf (const char *buf = 0, unsigned long *len = 0);
+00038   virtual char *zBuf (unsigned long *len, char *buf = 0);
+00039   virtual unsigned long GetChars (char *buf, unsigned long len);        // override for other than buffer compression
+00040   virtual unsigned long SendChars (char *buf, unsigned long len);       // override for other than buffer compression
+00041   virtual void Encode (void);   // override to provide compression algorythm
+00042   virtual void Decode (void);   // override to provide compression algorythm
+00043 };
+00044 
+00045 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swconfig_8h-source.html b/doc/api-documentation/html/swconfig_8h-source.html new file mode 100644 index 0000000..13ed4f7 --- /dev/null +++ b/doc/api-documentation/html/swconfig_8h-source.html @@ -0,0 +1,75 @@ + + +swconfig.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swconfig.h

00001 /******************************************************************************
+00002  *  swconfig.h   - definition of Class SWConfig used for saving and retrieval
+00003  *                              of configuration information
+00004  *
+00005  * $Id: swconfig_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWCONFIG_H
+00024 #define SWCONFIG_H
+00025 
+00026 #include <stdio.h>
+00027 
+00028 #include <string>
+00029 #include <map>
+00030 
+00031 #include <defs.h>
+00032 #include <multimapwdef.h>
+00033 
+00034 using namespace std;
+00035 
+00036 
+00037 
+00038 typedef multimapwithdefault < string, string, less < string > >ConfigEntMap;
+00039 typedef map < string, ConfigEntMap, less < string > >SectionMap;
+00040 
+00044 class SWDLLEXPORT SWConfig
+00045 {
+00046 private:
+00047   char getline (FILE * fp, string & line);
+00048 public:
+00052   string filename;
+00056   SectionMap Sections;
+00057 
+00061   SWConfig (const char *ifilename);
+00062   virtual ~ SWConfig ();
+00063 
+00067   virtual void Load ();
+00068 
+00072   virtual void Save ();
+00073 
+00077   virtual SWConfig & operator += (SWConfig & addFrom);
+00078 
+00088   virtual ConfigEntMap & operator [] (const char *section);
+00089 };
+00090 
+00091 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swdisp_8h-source.html b/doc/api-documentation/html/swdisp_8h-source.html new file mode 100644 index 0000000..dc69e95 --- /dev/null +++ b/doc/api-documentation/html/swdisp_8h-source.html @@ -0,0 +1,51 @@ + + +swdisp.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swdisp.h

00001 /******************************************************************************
+00002  *  swdisp.h  - code for base class 'swdisp'.  swdisp is the basis for all
+00003  *              types of displays (e.g. raw textout, curses, xwindow, etc.)
+00004  *
+00005  * $Id: swdisp_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWDISP_H
+00024 #define SWDISP_H
+00025 
+00026 #include <swobject.h>
+00027 #include <defs.h>
+00028 
+00029 class SWModule;
+00030 
+00034 class SWDLLEXPORT SWDisplay : public SWObject {
+00035   static SWClass classdef;
+00036 public:
+00037   SWDisplay () { myclass = &classdef; };
+00045   virtual char Display (SWModule & imodule);
+00046 };
+00047 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swdisprtf_8h-source.html b/doc/api-documentation/html/swdisprtf_8h-source.html new file mode 100644 index 0000000..9c34102 --- /dev/null +++ b/doc/api-documentation/html/swdisprtf_8h-source.html @@ -0,0 +1,116 @@ + + +swdisprtf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swdisprtf.h

00001 /******************************************************************************
+00002  *  swdisprtf.h   - definition of Class SWDispRTF-- an SWDisplay used to display
+00003  *                              a verse in Rich Text Format.
+00004  *
+00005  * $Id: swdisprtf_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 //---------------------------------------------------------------------------
+00024 #ifndef SWDispRTFH
+00025 #define SWDispRTFH
+00026 //---------------------------------------------------------------------------
+00027 #include <vcl\SysUtils.hpp>
+00028 #include <vcl\Controls.hpp>
+00029 #include <vcl\Classes.hpp>
+00030 #include <vcl\Forms.hpp>
+00031 #include <vcl\ComCtrls.hpp>
+00032 #include <vcl\StdCtrls.hpp>
+00033 #include <swtext.h>
+00034 #ifndef USEOLDRTF
+00035 #include <RxRichEdit.hpp>
+00036 #endif
+00037 //---------------------------------------------------------------------------
+00038 
+00039 #define defRTFHeader          "{\\rtf1\\ansi{\\fonttbl{\\f0\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f1\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f2\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f3\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f4\\froman\\fcharset0\\fprq2 Times New Roman;}{\\f7\\froman\\fcharset2\\fprq2 Symbol;}{\\f8\\froman\\fcharset2\\fprq2 Symbol;}}{\\colortbl;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red0\\green200\\blue50;\\red0\\green0\\blue255;\\red255\\green0\\blue0;} "
+00040 #define defRTFHeadMargin          "{\\fs8\\cf1\\par\\pard} "
+00041 #define defRTFTrailer         "{\\fs%d \\par }}"        // 24
+00042 
+00043 #define defRTFChapterMarkPre  "\\pard \\qc\\nowidctlpar{\\f1\\cf7\\fs%d\\b Chapter "    // 30
+00044 #define defRTFChapterMarkPost "\\par\\fs%d\\par}"       // 10
+00045 
+00046 #define defRTFVerseMarkPre    "{\\fs%d\\cf1\\super "    //20
+00047 #define defRTFVerseMarkPost   "}"
+00048 
+00049 #define defRTFVersePre        "{\\fs%d" // 24
+00050 #define defRTFVersePost       " }"
+00051 
+00052 #ifndef USEOLDRTF
+00053 class SWDispRTF:public TRxRichEdit
+00054 #else
+00055 class SWDispRTF:public TRichEdit
+00056 #endif
+00057 {
+00058 protected:
+00059 
+00060   System::AnsiString FRTFHeader;
+00061   System::AnsiString FRTFHeadMargin;
+00062   System::AnsiString FRTFTrailer;
+00063   System::AnsiString FRTFChapterMarkPre;
+00064   System::AnsiString FRTFChapterMarkPost;
+00065   System::AnsiString FRTFVerseMarkPre;
+00066   System::AnsiString FRTFVerseMarkPost;
+00067   System::AnsiString FRTFVersePre;
+00068   System::AnsiString FRTFVersePost;
+00069   bool FExpandNewLine;
+00070   CHARRANGE FCharRange;
+00071   int fontSize;
+00072 
+00073   int __fastcall GetMySelStart ();
+00074   void __fastcall SetMySelStart (int iselstart);
+00075   int __fastcall getFontSize ();
+00076   void __fastcall setFontSize (int iFontSize);
+00077   void recalcHeaders ();
+00078 protected:
+00079     TMemoryStream * RTFStream;
+00080 
+00081   virtual void __fastcall Loaded (void);
+00082 public:
+00083     __fastcall SWDispRTF (TComponent * Owner);
+00084     __fastcall ~ SWDispRTF ();
+00085 
+00086   virtual char Display (SWModule & imodule);
+00087 __published:
+00088   __property System::AnsiString RTFHeader = { read = FRTFHeader, write = FRTFHeader};
+00089   __property System::AnsiString RTFHeadMargin = { read = FRTFHeadMargin, write = FRTFHeadMargin };
+00090   __property System::AnsiString RTFChapterMarkPre = { read = FRTFChapterMarkPre, write = FRTFChapterMarkPre };
+00091   __property System::AnsiString RTFChapterMarkPost = { read = FRTFChapterMarkPost, write = FRTFChapterMarkPost };
+00092   __property System::AnsiString RTFVerseMarkPre = { read = FRTFVerseMarkPre, write = FRTFVerseMarkPre };
+00093   __property System::AnsiString RTFVerseMarkPost = { read = FRTFVerseMarkPost, write = FRTFVerseMarkPost };
+00094   __property System::AnsiString RTFVersePre = { read = FRTFVersePre, write = FRTFVersePre };
+00095   __property System::AnsiString RTFVersePost = { read = FRTFVersePost, write = FRTFVersePost };
+00096   __property System::AnsiString RTFTrailer = { read = FRTFTrailer, write = FRTFTrailer };
+00097   __property bool ExpandNewLine = { read = FExpandNewLine, write = FExpandNewLine };
+00098   __property int FontSize = { read = getFontSize, write = setFontSize };
+00099 };
+00100 
+00101 //---------------------------------------------------------------------------
+00102 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swdisprtfchap_8h-source.html b/doc/api-documentation/html/swdisprtfchap_8h-source.html new file mode 100644 index 0000000..97b7023 --- /dev/null +++ b/doc/api-documentation/html/swdisprtfchap_8h-source.html @@ -0,0 +1,80 @@ + + +swdisprtfchap.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swdisprtfchap.h

00001 /******************************************************************************
+00002  *  swdisprtfchap.h     - definition of class SWDispRTFChap, an SWDisplay used to
+00003  *                              display an entire chapter in Rich Text Format
+00004  *
+00005  * $Id: swdisprtfchap_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 //---------------------------------------------------------------------------
+00024 #ifndef swdisprtfchapH
+00025 #define swdisprtfchapH
+00026 //---------------------------------------------------------------------------
+00027 #include <vcl\SysUtils.hpp>
+00028 #include <vcl\Controls.hpp>
+00029 #include <vcl\Classes.hpp>
+00030 #include <vcl\Forms.hpp>
+00031 #include <vcl\ComCtrls.hpp>
+00032 #include <vcl\StdCtrls.hpp>
+00033 #include <swtext.h>
+00034 #include <swdisprtf.h>
+00035 //---------------------------------------------------------------------------
+00036 
+00037 class SWDispRTFChap:public SWDispRTF
+00038 {
+00039 protected:
+00040 
+00041   bool FCurVerseMrk;
+00042   bool FCurVersePos;
+00043   bool FMarkCurrentVerse;
+00044   bool FAutoPosition;
+00045   
+00046   char platformID;
+00047 
+00048   virtual void __fastcall Loaded (void);
+00049 public:
+00050     __fastcall SWDispRTFChap (TComponent * Owner);
+00051     __fastcall ~ SWDispRTFChap ();
+00052 
+00053   virtual char Display (SWModule & imodule);
+00054     __published:__property bool CurVersePos =
+00055   {
+00056   read = FCurVersePos, write = FCurVersePos, default = true};
+00057     __property bool CurVerseMrk = { read = FCurVerseMrk, write =
+00058       FCurVerseMrk, default = true };
+00059   __property bool MarkCurrentVerse = { read = FMarkCurrentVerse, write =
+00060       FMarkCurrentVerse, default = true };
+00061   __property bool AutoPosition = { read = FAutoPosition, write =
+00062       FAutoPosition, default = true };
+00063 };
+00064 
+00065 //---------------------------------------------------------------------------
+00066 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swfilter_8h-source.html b/doc/api-documentation/html/swfilter_8h-source.html new file mode 100644 index 0000000..76f7525 --- /dev/null +++ b/doc/api-documentation/html/swfilter_8h-source.html @@ -0,0 +1,84 @@ + + +swfilter.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swfilter.h

00001 /******************************************************************************
+00002  *  swfilter.h  - definition of class SWFilter used to filter text between
+00003  *                              different formats
+00004  *
+00005  * $Id: swfilter_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWFILTER_H
+00024 #define SWFILTER_H
+00025 #include <string>
+00026 #include <list>
+00027 #include <swkey.h>
+00028 
+00029 #include <defs.h>
+00030 
+00034 typedef std::list < std::string > OptionsList;
+00035 
+00036 
+00041 class SWModule;
+00042 
+00043 class SWDLLEXPORT  SWFilter {
+00044 public:
+00045        virtual ~SWFilter() {}
+00049 //  typedef std::list < std::string > OptionsList;
+00053   virtual const char * getOptionName ()
+00054   {
+00055     return 0;
+00056   }
+00061   virtual const char * getOptionTip ()
+00062   {
+00063     return 0;
+00064   }
+00069   virtual OptionsList getOptionValues ()
+00070   {
+00071     OptionsList options;
+00072     return options;
+00073   }
+00080   virtual void setOptionValue (const char *)
+00081   {
+00082   }
+00083   virtual const char * getOptionValue ()
+00084   {
+00085     return 0;
+00086   }
+00093   virtual char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0)
+00094   {
+00095     return ProcessText(text, maxlen);
+00096   }
+00102   virtual char ProcessText(char *text, int maxlen = -1)
+00103   {
+00104     return ProcessText(text, maxlen, 0);
+00105   }
+00106 };
+00107 
+00108 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swfiltermgr_8h-source.html b/doc/api-documentation/html/swfiltermgr_8h-source.html new file mode 100644 index 0000000..2adf1ec --- /dev/null +++ b/doc/api-documentation/html/swfiltermgr_8h-source.html @@ -0,0 +1,76 @@ + + +swfiltermgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swfiltermgr.h

00001 /******************************************************************************
+00002  *  swfiltermgr.h   - definition of class SWFilterMgr used as an interface to
+00003  *                              manage filters on a module
+00004  *
+00005  * $Id: swfiltermgr_8h-source.html,v 1.5 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWFILTERMGR_H
+00024 #define SWFILTERMGR_H
+00025 
+00026 #include <sys/types.h>
+00027 #include <swmodule.h>
+00028 #include <swconfig.h>
+00029 #include <swlog.h>
+00030 
+00031 #include <defs.h>
+00032 
+00033 class SWMgr;
+00034 
+00035 
+00036 class SWDLLEXPORT SWFilterMgr {
+00037 
+00038 private:
+00039         SWMgr *parentMgr;
+00040 
+00041 public:
+00042   SWFilterMgr ();
+00043   virtual ~SWFilterMgr ();
+00044 
+00045   virtual void setParentMgr(SWMgr *parentMgr);
+00046   virtual SWMgr *getParentMgr();
+00047 
+00048   virtual void AddGlobalOptions (SWModule * module, ConfigEntMap & section,
+00049                                  ConfigEntMap::iterator start,
+00050                                  ConfigEntMap::iterator end);
+00051   virtual void AddLocalOptions (SWModule * module, ConfigEntMap & section,
+00052                                 ConfigEntMap::iterator start,
+00053                                 ConfigEntMap::iterator end);
+00054 
+00060   virtual void AddEncodingFilters (SWModule * module, ConfigEntMap & section);
+00066   virtual void AddRenderFilters (SWModule * module, ConfigEntMap & section);
+00072   virtual void AddStripFilters (SWModule * module, ConfigEntMap & section);
+00078   virtual void AddRawFilters (SWModule * module, ConfigEntMap & section);
+00079 
+00080 };
+00081 
+00082 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swgenbook_8h-source.html b/doc/api-documentation/html/swgenbook_8h-source.html new file mode 100644 index 0000000..4793ace --- /dev/null +++ b/doc/api-documentation/html/swgenbook_8h-source.html @@ -0,0 +1,56 @@ + + +swgenbook.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swgenbook.h

00001 /******************************************************************************
+00002 *  swld.h   - code for base class 'SWLD'.  SWLD is the basis for all
+00003 *                               types of Lexicon and Dictionary modules (hence the 'LD').
+00004 *
+00005 * $Id: swgenbook_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00006 *
+00007 * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008 *       CrossWire Bible Society
+00009 *       P. O. Box 2528
+00010 *       Tempe, AZ  85280-2528
+00011 *
+00012 * This program is free software; you can redistribute it and/or modify it
+00013 * under the terms of the GNU General Public License as published by the
+00014 * Free Software Foundation version 2.
+00015 *
+00016 * This program is distributed in the hope that it will be useful, but
+00017 * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019 * General Public License for more details.
+00020 *
+00021 */
+00022 
+00023 #ifndef SWGENBOOK_H
+00024 #define SWGENBOOK_H
+00025 
+00026 #include <swmodule.h>
+00027 #include <treekeyidx.h>
+00028 
+00029 #include <defs.h>
+00030 
+00034 class SWDLLEXPORT SWGenBook:public SWModule {
+00035 
+00036 protected:
+00037         char *entkeytxt;
+00038 
+00039 public:
+00046         SWGenBook(const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
+00047         virtual ~SWGenBook();
+00048         virtual SWKey *CreateKey() = 0;
+00049 };
+00050 
+00051 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swinputmeth_8h-source.html b/doc/api-documentation/html/swinputmeth_8h-source.html new file mode 100644 index 0000000..053fbc0 --- /dev/null +++ b/doc/api-documentation/html/swinputmeth_8h-source.html @@ -0,0 +1,36 @@ + + +swinputmeth.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swinputmeth.h

00001 
+00010 #ifndef SWINPUTMETHOD_H
+00011 #define SWINPUTMETHOD_H
+00012 
+00013 class SWInputMethod {
+00014 
+00015 private:
+00016     int state;
+00017 
+00018 protected:
+00019     virtual void setState(int state);
+00020 
+00021 public:
+00022     SWInputMethod();
+00023     virtual ~SWInputMethod() {}
+00024 
+00025     virtual int *translate(char in) = 0;
+00026     virtual int getState();
+00027     virtual void clearState();
+00028 };
+00029 
+00030 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swkey_8h-source.html b/doc/api-documentation/html/swkey_8h-source.html new file mode 100644 index 0000000..ca6c283 --- /dev/null +++ b/doc/api-documentation/html/swkey_8h-source.html @@ -0,0 +1,142 @@ + + +swkey.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swkey.h

00001 /******************************************************************************
+00002  *  swkey.h     - code for base class 'swkey'.  swkey is the basis for all
+00003  *                              types of keys for indexing into modules (e.g. verse, word,
+00004  *                              place, etc.)
+00005  *
+00006  * $Id: swkey_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef SWKEY_H
+00025 #define SWKEY_H
+00026 
+00027 #include <swobject.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 #define KEYERR_OUTOFBOUNDS 1
+00032 
+00033 #define SWKEY_OPERATORS \
+00034   SWKey & operator = (const char *ikey) { setText(ikey); return *this; } \
+00035   SWKey & operator = (const SWKey &ikey) { copyFrom(ikey); return *this; } \
+00036   SWKey & operator = (SW_POSITION pos) { setPosition(pos); return *this; } \
+00037   operator const char *() const { return getText(); } \
+00038   bool operator == (const SWKey & ikey) { return equals(ikey); } \
+00039   bool operator != (const SWKey & ikey) { return !equals(ikey); } \
+00040   virtual bool operator > (const SWKey & ikey) { return (compare (ikey) > 0); } \
+00041   virtual bool operator < (const SWKey & ikey) { return (compare (ikey) < 0); } \
+00042   virtual bool operator >= (const SWKey & ikey) { return (compare (ikey) > -1); }  \
+00043   virtual bool operator <= (const SWKey & ikey) { return (compare (ikey) < 1); } \
+00044   SWKey & operator -= (int steps) { decrement(steps); return *this; } \
+00045   SWKey & operator += (int steps) { increment(steps); return *this; } \
+00046   SWKey & operator++ (int) { return *this += 1; } \
+00047   SWKey & operator-- (int) { return *this -= 1; }
+00048 
+00049 
+00050 // For use with = operator to position key.
+00051 
+00052 class SW_POSITION
+00053 {
+00054   char pos;
+00055 public:
+00056     SW_POSITION (char ipos)
+00057   {
+00058     pos = ipos;
+00059   }
+00060   operator char ()
+00061   {
+00062     return pos;
+00063   }
+00064 };
+00065 
+00066 #define POS_TOP ((char)1)
+00067 #define POS_BOTTOM ((char)2)
+00068 
+00069 #define TOP SW_POSITION(POS_TOP)
+00070 #define BOTTOM SW_POSITION(POS_BOTTOM)
+00071 
+00076 class SWDLLEXPORT SWKey : public SWObject {
+00077   long index;
+00078   static SWClass classdef;
+00079   void init ();
+00080 
+00081 protected:
+00082   char *keytext;
+00083   char persist;
+00084   char error;
+00085 
+00086 public:
+00087 
+00088   // misc pointer for whatever
+00089   void *userData;
+00090 
+00095   SWKey (const char *ikey = 0);
+00096 
+00100   SWKey (SWKey const &k);
+00101 
+00104   virtual ~ SWKey ();
+00105 
+00110   virtual SWKey *clone () const;
+00111 
+00118   char Persist () const;
+00119 
+00128   char Persist (signed char ikey);
+00129 
+00134   virtual char Error ();
+00135 
+00140   virtual void setText(const char *ikey);
+00141 
+00146   virtual void copyFrom(const SWKey &ikey);
+00147 
+00150   virtual const char *getText() const;
+00151   virtual const char *getShortText() const { return getText(); }
+00152 
+00160   virtual int compare (const SWKey & ikey);
+00161 
+00167   virtual bool equals(const SWKey &ikey) { return !compare(ikey); }
+00168 
+00169   virtual void setPosition(SW_POSITION);
+00170 
+00176   virtual void decrement(int steps = 1);
+00177 
+00183   virtual void increment(int steps = 1);
+00184 
+00185   virtual char Traversable () { return 0; }
+00186 
+00208   virtual long Index () const { return index; }
+00209   virtual long Index (long iindex) { index = iindex; return index; }
+00210 
+00211   SWKEY_OPERATORS
+00212 
+00213 };
+00214 
+00215 
+00216 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swld_8h-source.html b/doc/api-documentation/html/swld_8h-source.html new file mode 100644 index 0000000..2a78c27 --- /dev/null +++ b/doc/api-documentation/html/swld_8h-source.html @@ -0,0 +1,60 @@ + + +swld.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swld.h

00001 /******************************************************************************
+00002  *  swld.h   - code for base class 'SWLD'.  SWLD is the basis for all
+00003  *                              types of Lexicon and Dictionary modules (hence the 'LD').
+00004  *
+00005  * $Id: swld_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWLD_H
+00024 #define SWLD_H
+00025 
+00026 #include <swmodule.h>
+00027 #include <strkey.h>
+00028 
+00029 #include <defs.h>
+00030 
+00034 class SWDLLEXPORT SWLD:public SWModule
+00035 {
+00036 protected:
+00037   char *entkeytxt;
+00038 public:
+00045   SWLD (const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
+00046   virtual ~ SWLD ();
+00047   virtual SWKey *CreateKey ()
+00048   {
+00049     return new StrKey ();
+00050   }
+00057   virtual const char *KeyText (const char *ikeytext);
+00058 };
+00059 
+00060 
+00061 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swlocale_8h-source.html b/doc/api-documentation/html/swlocale_8h-source.html new file mode 100644 index 0000000..f77bdf1 --- /dev/null +++ b/doc/api-documentation/html/swlocale_8h-source.html @@ -0,0 +1,74 @@ + + +swlocale.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swlocale.h

00001 /******************************************************************************
+00002  *  swlocale.h   - definition of Class SWLocale used for retrieval
+00003  *                              of locale lookups
+00004  *
+00005  * $Id: swlocale_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 2000 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWLOCALE_H
+00024 #define SWLOCALE_H
+00025 
+00026 #include <string>
+00027 #include <map>
+00028 
+00029 #include <swconfig.h>
+00030 #include <versekey.h>
+00031 
+00032 #include <defs.h>
+00033 
+00034 using namespace std;
+00035 
+00036 typedef map < string, string, less < string > >LookupMap;
+00037 
+00044 class SWDLLEXPORT SWLocale
+00045 {
+00046   LookupMap lookupTable;
+00047   SWConfig *localeSource;
+00048   char *name;
+00049   char *description;
+00050   struct abbrev *bookAbbrevs;
+00051   char *BMAX;
+00052   struct sbook **books;
+00053 
+00054 public:
+00055   SWLocale (const char *ifilename);
+00056   virtual ~ SWLocale ();
+00057 
+00062   virtual const char *getName ();
+00066   virtual const char *getDescription ();
+00067   virtual const char *translate (const char *text);
+00068   virtual SWLocale & operator += (SWLocale & addFrom);
+00069   virtual const struct abbrev *getBookAbbrevs ();
+00070   virtual void getBooks (char **iBMAX, struct sbook ***ibooks);
+00071 };
+00072 
+00073 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swlog_8h-source.html b/doc/api-documentation/html/swlog_8h-source.html new file mode 100644 index 0000000..a0dbf30 --- /dev/null +++ b/doc/api-documentation/html/swlog_8h-source.html @@ -0,0 +1,60 @@ + + +swlog.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swlog.h

00001 /******************************************************************************
+00002  *  swlog.h     - definition of class SWLog used for logging messages
+00003  *
+00004  * $Id: swlog_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 //---------------------------------------------------------------------------
+00023 #ifndef swlogH
+00024 #define swlogH
+00025 //---------------------------------------------------------------------------
+00026 
+00027 #include <defs.h>
+00028 
+00029 class SWDLLEXPORT SWLog
+00030 {
+00031 public:
+00032   static SWLog *systemlog;
+00033 
+00034   bool log;
+00035     SWLog ()
+00036   {
+00037     log = true;
+00038   }
+00039   virtual void LogWarning (char *fmt, ...);
+00040   virtual void LogError (char *fmt, ...);
+00041   virtual void LogTimedInformation (char *fmt, ...);
+00042   virtual void LogInformation (char *fmt, ...);
+00043 };
+00044 
+00045 
+00046 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swmacs_8h-source.html b/doc/api-documentation/html/swmacs_8h-source.html new file mode 100644 index 0000000..ea6ac63 --- /dev/null +++ b/doc/api-documentation/html/swmacs_8h-source.html @@ -0,0 +1,44 @@ + + +swmacs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swmacs.h

00001 /******************************************************************************
+00002  *  swmacs.h    - generic macros
+00003  *
+00004  * $Id: swmacs_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef SWMACS_H
+00023 #define SWMACS_H
+00024 
+00025 
+00026 // Maximum positive value of a signed numeric type
+00027 #define MAXPOS(x) ((x)((unsigned x)(1L << (sizeof(x)*8-1)) - 1))
+00028 
+00029 
+00030 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swmgr_8h-source.html b/doc/api-documentation/html/swmgr_8h-source.html new file mode 100644 index 0000000..b70e2c0 --- /dev/null +++ b/doc/api-documentation/html/swmgr_8h-source.html @@ -0,0 +1,117 @@ + + +swmgr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swmgr.h

00001 /******************************************************************************
+00002  *  swmgr.h   - definition of class SWMgr used to interact with an install
+00003  *                              base of sword modules.
+00004  *
+00005  * $Id: swmgr_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00039 #ifndef SWMGR_H
+00040 #define SWMGR_H
+00041 
+00042 #include <sys/types.h>
+00043 #include <string>
+00044 #include <map>
+00045 #include <list>
+00046 #include <swmodule.h>
+00047 #include <swconfig.h>
+00048 #include <swlog.h>
+00049 #include <swfiltermgr.h>
+00050 
+00051 #include <defs.h>
+00052 
+00053 using namespace std;
+00054 
+00055 typedef map < string, SWModule *, less < string > >ModMap;
+00056 typedef list < string > OptionsList;
+00057 typedef map < string, SWFilter * >FilterMap;
+00058 
+00069 class SWDLLEXPORT SWMgr {
+00070 
+00071 private:
+00072   void commonInit(SWConfig * iconfig, SWConfig * isysconfig, bool autoload, SWFilterMgr *filterMgr);
+00073 
+00074 protected:
+00075   SWFilterMgr *filterMgr;               //made protected because because BibleTime needs it
+00076   SWConfig * myconfig;          //made protected because because BibleTime needs it
+00077   SWConfig *mysysconfig;
+00078   SWConfig *homeConfig;
+00079   void CreateMods ();
+00080   SWModule *CreateMod (string name, string driver, ConfigEntMap & section);
+00081   void DeleteMods ();
+00082   char configType;              // 0 = file; 1 = directory
+00083   FilterMap optionFilters;
+00084   FilterMap cipherFilters;
+00085   SWFilter *gbfplain;
+00086   SWFilter *thmlplain;
+00087   FilterList cleanupFilters;
+00088   OptionsList options;
+00089   virtual void init (); // use to initialize before loading modules
+00090   virtual char AddModToConfig (int conffd, const char *fname);
+00091   virtual void loadConfigDir (const char *ipath);
+00092   virtual void AddGlobalOptions (SWModule * module, ConfigEntMap & section,
+00093                                  ConfigEntMap::iterator start,
+00094                                  ConfigEntMap::iterator end);
+00095   virtual void AddLocalOptions (SWModule * module, ConfigEntMap & section,
+00096                                 ConfigEntMap::iterator start,
+00097                                 ConfigEntMap::iterator end);
+00098 
+00104   virtual void AddEncodingFilters (SWModule * module, ConfigEntMap & section);
+00110   virtual void AddRenderFilters (SWModule * module, ConfigEntMap & section);
+00116   virtual void AddStripFilters (SWModule * module, ConfigEntMap & section);
+00122   virtual void AddRawFilters (SWModule * module, ConfigEntMap & section);
+00123 
+00124 public:
+00125 
+00130   static bool debug;
+00131   static const char *globalConfPath;
+00135   static void findConfig (char *configType, char **prefixPath,
+00136                           char **configPath);
+00145   SWConfig *config;
+00149   SWConfig *sysconfig;
+00172   ModMap Modules;
+00176   char *prefixPath;
+00180   char *configPath;
+00181 
+00189   SWMgr (SWConfig * iconfig = 0, SWConfig * isysconfig = 0, bool autoload = true, SWFilterMgr *filterMgr = 0);
+00194   SWMgr (SWFilterMgr *filterMgr);
+00204   SWMgr (const char *iConfigPath, bool autoload = true, SWFilterMgr *filterMgr = 0);
+00210   virtual ~SWMgr ();
+00214   virtual void InstallScan (const char *dir);
+00219   virtual signed char Load ();
+00227   virtual void setGlobalOption (const char *option, const char *value);
+00232   virtual const char *getGlobalOption (const char *option);
+00238   virtual const char *getGlobalOptionTip (const char *option);
+00242   virtual OptionsList getGlobalOptions ();
+00246   virtual OptionsList getGlobalOptionValues (const char *option);
+00288   virtual signed char setCipherKey (const char *modName, const char *key);
+00289 };
+00290 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swmodule_8h-source.html b/doc/api-documentation/html/swmodule_8h-source.html new file mode 100644 index 0000000..30dbe9e --- /dev/null +++ b/doc/api-documentation/html/swmodule_8h-source.html @@ -0,0 +1,283 @@ + + +swmodule.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swmodule.h

00001 /******************************************************************************
+00002  *  swmodule.h  - code for base class 'module'.  Module is the basis for all
+00003  *                types of modules (e.g. texts, commentaries, maps, lexicons,
+00004  *                etc.)
+00005  *
+00006  * $Id: swmodule_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef SWMODULE_H
+00025 #define SWMODULE_H
+00026 
+00027 #include <swdisp.h>
+00028 #include <swkey.h>
+00029 #include <listkey.h>
+00030 #include <swfilter.h>
+00031 #include <swconfig.h>
+00032 #include <swcacher.h>
+00033 #include <list>
+00034 
+00035 #include <defs.h>
+00036 #include <multimapwdef.h>
+00037 
+00038 #define FILTERPAD 80
+00039 
+00040 using namespace std;
+00041 
+00042 typedef list < SWFilter * >FilterList;
+00043 
+00044 typedef map < string, string, less < string > > AttributeValue;
+00045 typedef map < string, AttributeValue, less < string > > AttributeList;
+00046 typedef map < string, AttributeList, less < string > > AttributeTypeList;
+00047 
+00048 #define SWTextDirection char
+00049 #define SWTextEncoding char
+00050 #define SWTextMarkup char
+00051 
+00052 enum {DIRECTION_LTR = 0, DIRECTION_RTL, DIRECTION_BIDI};
+00053 enum {FMT_UNKNOWN = 0, FMT_PLAIN, FMT_THML, FMT_GBF, FMT_HTML, FMT_HTMLHREF, FMT_RTF, FMT_OSIS};
+00054 enum {ENC_UNKNOWN = 0, ENC_LATIN1, ENC_UTF8, ENC_SCSU, ENC_UTF16, ENC_RTF, ENC_HTML};
+00055 
+00064 class SWDLLEXPORT SWModule : public SWCacher {
+00065 
+00066 protected:
+00067 
+00068   ConfigEntMap ownConfig;
+00069   ConfigEntMap *config;
+00070   mutable AttributeTypeList entryAttributes;
+00071   mutable bool procEntAttr;
+00072 
+00073   char error;
+00074   bool skipConsecutiveLinks;
+00075 
+00077   SWKey *key;
+00078 
+00079   ListKey listkey;
+00080   char *modname;
+00081   char *moddesc;
+00082   char *modtype;
+00083   char *modlang;  
+00084 
+00085   char direction;
+00086   char markup;
+00087   char encoding;
+00088 
+00090   SWDisplay *disp;
+00091 
+00092   static SWDisplay rawdisp;
+00093   char *entrybuf;
+00094   unsigned long entrybufallocsize;
+00095 
+00097   FilterList *stripFilters;
+00098 
+00100   FilterList *rawFilters;
+00101 
+00103   FilterList *renderFilters;
+00104 
+00106   FilterList *optionFilters;
+00107 
+00109   FilterList *encodingFilters;
+00110 
+00111   int entrySize;
+00112 
+00113 public:
+00120   static void nullPercent (char percent, void *userData);
+00125   bool terminateSearch;
+00138   SWModule (const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, char *imodtype = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* modlang = 0);
+00141   virtual ~ SWModule ();
+00146   virtual char Error ();
+00150   virtual const bool isUnicode() const {return (encoding == (char)ENC_UTF8 || encoding == (char)ENC_SCSU);}
+00151 
+00152   // These methods are useful for modules that come from a standard SWORD install (most do).
+00153   // SWMgr will call setConfig.  The user may use getConfig and getConfigEntry (if they
+00154   // are not comfortable with, or don't wish to use  stl maps).
+00155   virtual const ConfigEntMap &getConfig() const { return *config; }
+00156   virtual void setConfig(ConfigEntMap *config);
+00157   virtual const char *getConfigEntry(const char *key) const;
+00158 
+00162   virtual const int getEntrySize() const {return entrySize;}
+00170   virtual char SetKey (const SWKey *ikey);
+00176   virtual char SetKey (const SWKey &ikey);
+00180   virtual SWKey & Key () const {
+00181     return *key;
+00182   }
+00189   virtual char Key (const SWKey & ikey) {
+00190     return SetKey (ikey);
+00191   }
+00198   virtual const char *KeyText (const char *imodtype = 0);
+00203   virtual char Display ();
+00210   virtual SWDisplay *Disp (SWDisplay * idisp = 0);
+00217   virtual char *Name (const char *imodname = 0);
+00224   virtual char *Description (const char *imoddesc = 0);
+00231   virtual char *Type (const char *imodtype = 0);
+00238   virtual char Direction(signed char newdir = -1);
+00245   virtual char Encoding(signed char enc = -1);
+00252   virtual char Markup(signed char enc = -1);
+00259   virtual char *Lang (const char *imodlang = 0);
+00260 
+00261   // search methods
+00262 
+00274   virtual ListKey & Search (const char *istr, int searchType = 0, int flags = 0,
+00275                   SWKey * scope = 0,
+00276                   bool * justCheckIfSupported = 0,
+00277                   void (*percent) (char, void *) = &nullPercent,
+00278                   void *percentUserData = 0);
+00282   virtual signed char createSearchFramework () {
+00283     return 0;
+00284   }                             // special search framework
+00288   virtual bool hasSearchFramework () {
+00289     return false;
+00290   }                             // special search framework
+00295   virtual bool isSearchOptimallySupported (const char *istr, int searchType,
+00296                                            int flags, SWKey * scope) {
+00297       bool retVal = false;
+00298       Search (istr, searchType, flags, scope, &retVal);
+00299       return retVal;
+00300   }
+00307   virtual SWKey *CreateKey ();
+00311   virtual operator const char *();
+00316   virtual char *getRawEntry () = 0;
+00322   virtual operator SWKey & () {
+00323     return *key;
+00324   }
+00333   virtual operator SWKey *() {
+00334     return key;
+00335   }
+00336 
+00337 
+00338   // write interface ----------------------------
+00342   virtual bool isWritable () {
+00343     return false;
+00344   }
+00349   static signed char createModule (const char *) {
+00350     return -1;
+00351   }
+00356   virtual SWModule & setentry (const char *inbuf, long len) {
+00357     return *this;
+00358   }
+00363   virtual SWModule & operator << (const char *) {
+00364     return *this;
+00365   }
+00370   virtual SWModule & operator << (const SWKey *) {
+00371     return *this;
+00372   }
+00376   virtual void deleteEntry () {
+00377   }
+00378   // end write interface ------------------------
+00379 
+00385   virtual SWModule & operator -= (int decrement);
+00391   virtual SWModule & operator += (int increment);
+00395   virtual SWModule & operator++ (int) {
+00396     return *this += 1;
+00397   }
+00401   virtual SWModule & operator-- (int) {
+00402     return *this -= 1;
+00403   }
+00409   virtual SWModule & operator = (SW_POSITION p);
+00414   virtual SWModule & AddRenderFilter (SWFilter * newfilter) {
+00415     renderFilters->push_back (newfilter);
+00416     return *this;
+00417   }
+00422   virtual SWModule & RemoveRenderFilter (SWFilter * oldfilter) {
+00423     renderFilters->remove (oldfilter);
+00424     return *this;
+00425   }
+00431   virtual SWModule & ReplaceRenderFilter (SWFilter * oldfilter, SWFilter * newfilter) {
+00432     FilterList::iterator iter;
+00433     for (iter = renderFilters->begin(); iter != renderFilters->end(); iter++)
+00434         if (*iter == oldfilter)
+00435                 *iter = newfilter;
+00436     return *this;
+00437   }
+00444   virtual void renderFilter (char *buf, long size, SWKey *key) {
+00445         filterBuffer(renderFilters, buf, size, key);
+00446   }
+00451   virtual SWModule & AddEncodingFilter (SWFilter * newfilter) {
+00452     encodingFilters->push_back (newfilter);
+00453     return *this;
+00454   }
+00459   virtual SWModule & RemoveEncodingFilter (SWFilter * oldfilter) {
+00460     encodingFilters->remove (oldfilter);
+00461     return *this;
+00462   }
+00468   virtual SWModule & ReplaceEncodingFilter (SWFilter * oldfilter, SWFilter * newfilter) {
+00469     FilterList::iterator iter;
+00470     for (iter = encodingFilters->begin(); iter != encodingFilters->end(); iter++)
+00471         if (*iter == oldfilter)
+00472                 *iter = newfilter;
+00473     return *this;
+00474   }
+00481   virtual void encodingFilter (char *buf, long size, SWKey *key) {
+00482         filterBuffer(encodingFilters, buf, size, key);
+00483   }
+00488   virtual SWModule & AddStripFilter (SWFilter * newfilter) {
+00489     stripFilters->push_back (newfilter);
+00490     return *this;
+00491   }
+00498   virtual void stripFilter (char *buf, long size, SWKey *key) {
+00499         filterBuffer(stripFilters, buf, size, key);
+00500   }
+00505   virtual SWModule & AddRawFilter (SWFilter * newfilter) {
+00506     rawFilters->push_back (newfilter);
+00507     return *this;
+00508   }
+00516   virtual void filterBuffer (FilterList *filters, char *buf, long size, SWKey *key) {
+00517         FilterList::iterator it;
+00518         for (it = filters->begin(); it != filters->end(); it++) {
+00519                 (*it)->ProcessText(buf, size, key, this);
+00520         }
+00521   }
+00528   virtual void rawFilter (char *buf, long size, SWKey *key) {
+00529         buf[size] = 0;
+00530         filterBuffer(rawFilters, buf, size, key);
+00531   }
+00536   virtual SWModule & AddOptionFilter (SWFilter * newfilter) {
+00537     optionFilters->push_back (newfilter);
+00538     return *this;
+00539   }
+00546   virtual void optionFilter (char *buf, long size, SWKey *key) {
+00547         filterBuffer(optionFilters, buf, size, key);
+00548   }
+00556   virtual const char *StripText (char *buf = 0, int len = -1);
+00564   virtual const char *RenderText (char *buf = 0, int len = -1, bool render = true);
+00570   virtual const char *StripText (SWKey * tmpKey);
+00576   virtual const char *RenderText (SWKey * tmpKey);
+00577 
+00584   virtual void setSkipConsecutiveLinks(bool val) { skipConsecutiveLinks = val; }
+00585   virtual bool getSkipConsecutiveLinks() { return skipConsecutiveLinks; }
+00586   virtual AttributeTypeList &getEntryAttributes() const { return entryAttributes; }
+00587   virtual void processEntryAttributes(bool val) const { procEntAttr = val; }
+00588   virtual bool isProcessEntryAttributes() const { return procEntAttr; }
+00589 };
+00590 
+00591 
+00592 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swobject_8h-source.html b/doc/api-documentation/html/swobject_8h-source.html new file mode 100644 index 0000000..785840c --- /dev/null +++ b/doc/api-documentation/html/swobject_8h-source.html @@ -0,0 +1,57 @@ + + +swobject.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swobject.h

00001 #ifndef SWOBJECT_H
+00002 #define SWOBJECT_H
+00003 
+00004 #include <utilfuns.h>
+00005 #if !defined(__GNUC__) && !defined(_WIN32_WCE)
+00006 #else
+00007 #include <unixstr.h>
+00008 #endif
+00009 
+00010 #include <defs.h>
+00011 #include <string.h>
+00012 
+00013 #define SWDYNAMIC_CAST(className, object) (className *)((object)?((object->getClass()->isAssignableFrom(#className))?object:0):0)
+00014 
+00018 class SWDLLEXPORT SWClass {
+00019 private:
+00020         const char **descends;
+00021 
+00022 public:
+00023         SWClass(const char **descends) {
+00024                 this->descends = descends;
+00025         }
+00026 
+00027         bool isAssignableFrom(const char *className) const {
+00028                 for (int i = 0; descends[i]; i++) {
+00029                         if (!stricmp(descends[i], className))
+00030                                 return true;
+00031                 }
+00032                 return false;
+00033         }
+00034 };
+00035 
+00041 class SWObject {
+00042 protected:
+00043         SWClass * myclass;
+00044      
+00045 public:
+00049         const SWClass *getClass () const {
+00050                 return myclass;
+00051         }
+00052 };
+00053 
+00054 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swtext_8h-source.html b/doc/api-documentation/html/swtext_8h-source.html new file mode 100644 index 0000000..0695cc7 --- /dev/null +++ b/doc/api-documentation/html/swtext_8h-source.html @@ -0,0 +1,55 @@ + + +swtext.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swtext.h

00001 /******************************************************************************
+00002  *  swtext.h   - code for base class 'SWText'.  SWText is the basis for all
+00003  *               types of text modules
+00004  *
+00005  * $Id: swtext_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef SWTEXT_H
+00024 #define SWTEXT_H
+00025 
+00026 #include <swmodule.h>
+00027 #include <versekey.h>
+00028 #include <listkey.h>
+00029 
+00030 #include <defs.h>
+00031 
+00034 class SWDLLEXPORT SWText:public SWModule
+00035 {
+00036 public:
+00043   SWText (const char *imodname = 0, const char *imoddesc = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0);
+00044   virtual ~ SWText ();
+00047   virtual SWKey *CreateKey ();
+00048 };
+00049 
+00050 
+00051 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swunicod_8h-source.html b/doc/api-documentation/html/swunicod_8h-source.html new file mode 100644 index 0000000..ebc5c9e --- /dev/null +++ b/doc/api-documentation/html/swunicod_8h-source.html @@ -0,0 +1,42 @@ + + +swunicod.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swunicod.h

00001 /*
+00002  *
+00003  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 
+00019 
+00020 #ifndef SWUNICOD_H
+00021 #define SWUNICOD_H
+00022 
+00028 unsigned char* UTF32to8 (unsigned long utf32, unsigned char * utf8);
+00029 
+00030 
+00036 unsigned long UTF8to32 (unsigned char * utf8, unsigned long utf32);
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swversion_8h-source.html b/doc/api-documentation/html/swversion_8h-source.html new file mode 100644 index 0000000..ec751f7 --- /dev/null +++ b/doc/api-documentation/html/swversion_8h-source.html @@ -0,0 +1,59 @@ + + +swversion.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swversion.h

00001 /******************************************************************************
+00002  *  swversion.h   - definition of class SWVersion used to compare version info
+00003  *
+00004  * $Id: swversion_8h-source.html,v 1.5 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef SWORDVER
+00023 #define SWORDVER "1.5.3"
+00024 #endif
+00025 
+00026 #ifndef SWVERSION_H
+00027 #define SWVERSION_H
+00028 
+00029 class SWVersion {
+00030         public:
+00031         int major, minor, minor2, minor3;
+00032         
+00033         SWVersion(const char *version = "0.0");
+00034         int compare(const SWVersion &vi) const;
+00035         operator const char *() const;
+00036         bool operator>(const SWVersion &vi) const {return (compare(vi) > 0);}
+00037         bool operator<(const SWVersion &vi) const {return (compare(vi) < 0);}
+00038         bool operator==(const SWVersion &vi) const {return (compare(vi) == 0);}
+00039 
+00040         // current sword library version
+00041         static SWVersion currentVersion;
+00042 };
+00043 
+00044 #endif
+00045 
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/swwinlog_8h-source.html b/doc/api-documentation/html/swwinlog_8h-source.html new file mode 100644 index 0000000..678d80f --- /dev/null +++ b/doc/api-documentation/html/swwinlog_8h-source.html @@ -0,0 +1,56 @@ + + +swwinlog.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

swwinlog.h

00001 /******************************************************************************
+00002  *  swwinlog.h   - definition of SWWinLog-- a derivitive of SWLog used to
+00003  *                      handle logging in the MSWindows environment
+00004  *
+00005  * $Id: swwinlog_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 //---------------------------------------------------------------------------
+00024 #ifndef swwinlogH
+00025 #define swwinlogH
+00026 //---------------------------------------------------------------------------
+00027 
+00028 #include <swlog.h>
+00029 
+00030 class SWWinLog:public SWLog
+00031 {
+00032   HWND parent;
+00033 public:
+00034     SWWinLog (HWND iparent);
+00035   virtual void LogWarning (char *fmt, ...);
+00036   virtual void LogError (char *fmt, ...);
+00037   virtual void LogTimedInformation (char *fmt, ...);
+00038   virtual void LogInformation (char *fmt, ...);
+00039 };
+00040 
+00041 
+00042 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/sysdata_8h-source.html b/doc/api-documentation/html/sysdata_8h-source.html new file mode 100644 index 0000000..62f4c93 --- /dev/null +++ b/doc/api-documentation/html/sysdata_8h-source.html @@ -0,0 +1,90 @@ + + +sysdata.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

sysdata.h

00001 #ifndef SIZEDTYPES_H
+00002 #define SIZEDTYPES_H
+00003 /*
+00004  * __xx is ok: it doesn't pollute the POSIX namespace. Use these in the
+00005  * header files exported to user space
+00006  */
+00007 #ifdef USE_AUTOTOOLS
+00008 #include "config.h"
+00009 #endif
+00010 
+00011 typedef signed char __s8;
+00012 typedef unsigned char __u8;
+00013 
+00014 typedef signed short __s16;
+00015 typedef unsigned short __u16;
+00016 
+00017 typedef signed int __s32;
+00018 typedef unsigned int __u32;
+00019 
+00020 #if defined(__GNUC__) && !defined(__STRICT_ANSI__)
+00021 //typedef __signed__ long long __s64;
+00022 //typedef unsigned long long __u64;
+00023 #endif
+00024 
+00025 
+00026 #define __swap16(x) \
+00027         ((__u16)( \
+00028                 (((__u16)(x) & (__u16)0x00ffU) << 8) | \
+00029                 (((__u16)(x) & (__u16)0xff00U) >> 8) ))
+00030 
+00031                 
+00032 #define __swap32(x) \
+00033         ((__u32)( \
+00034                 (((__u32)(x) & (__u32)0x000000ffUL) << 24) | \
+00035                 (((__u32)(x) & (__u32)0x0000ff00UL) <<  8) | \
+00036                 (((__u32)(x) & (__u32)0x00ff0000UL) >>  8) | \
+00037                 (((__u32)(x) & (__u32)0xff000000UL) >> 24) ))
+00038 
+00039                 
+00040 #define __swap64(x) \
+00041         ((__u64)( \
+00042                 (__u64)(((__u64)(x) & (__u64)0x00000000000000ffULL) << 56) | \
+00043                 (__u64)(((__u64)(x) & (__u64)0x000000000000ff00ULL) << 40) | \
+00044                 (__u64)(((__u64)(x) & (__u64)0x0000000000ff0000ULL) << 24) | \
+00045                 (__u64)(((__u64)(x) & (__u64)0x00000000ff000000ULL) <<  8) | \
+00046                    (__u64)(((__u64)(x) & (__u64)0x000000ff00000000ULL) >>  8) | \
+00047                 (__u64)(((__u64)(x) & (__u64)0x0000ff0000000000ULL) >> 24) | \
+00048                 (__u64)(((__u64)(x) & (__u64)0x00ff000000000000ULL) >> 40) | \
+00049                 (__u64)(((__u64)(x) & (__u64)0xff00000000000000ULL) >> 56) ))
+00050                 
+00051 
+00052 
+00053 
+00054 #ifndef WORDS_BIGENDIAN
+00055 
+00056 #define swordtoarch16(x) (x)
+00057 #define swordtoarch32(x) (x)
+00058 #define swordtoarch64(x) (x)
+00059 #define archtosword16(x) (x)
+00060 #define archtosword32(x) (x)
+00061 #define archtosword64(x) (x)
+00062 
+00063 #else 
+00064 
+00065 #define swordtoarch16(x) __swap16(x)
+00066 #define swordtoarch32(x) __swap32(x)
+00067 #define swordtoarch64(x) __swap64(x)
+00068 #define archtosword16(x) __swap16(x)
+00069 #define archtosword32(x) __swap32(x)
+00070 #define archtosword64(x) __swap64(x)
+00071 
+00072 
+00073 #endif
+00074 
+00075 
+00076 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/tbdisp_8h-source.html b/doc/api-documentation/html/tbdisp_8h-source.html new file mode 100644 index 0000000..703e11e --- /dev/null +++ b/doc/api-documentation/html/tbdisp_8h-source.html @@ -0,0 +1,53 @@ + + +tbdisp.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

tbdisp.h

00001 /******************************************************************************
+00002  *  tbdisp.cpp  - code for class 'tbdisp'.  tbdisp writes module output to a
+00003  *                      MSWindows TextBox (or any other control that takes a
+00004  *                      SetDialogItemText
+00005  *
+00006  * $Id: tbdisp_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00007  *
+00008  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00009  *      CrossWire Bible Society
+00010  *      P. O. Box 2528
+00011  *      Tempe, AZ  85280-2528
+00012  *
+00013  * This program is free software; you can redistribute it and/or modify it
+00014  * under the terms of the GNU General Public License as published by the
+00015  * Free Software Foundation version 2.
+00016  *
+00017  * This program is distributed in the hope that it will be useful, but
+00018  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00020  * General Public License for more details.
+00021  *
+00022  */
+00023 
+00024 #ifndef TBDISP_H
+00025 #define TBDISP_H
+00026 
+00027 #include <windows.h>
+00028 class SWModule;
+00029 
+00030 class TBDisp:public SWDisplay
+00031 {
+00032 protected:
+00033   HWND wnd;
+00034   int ctrlid;
+00035 public:
+00036     TBDisp (HWND iwnd, int ictrlid);
+00037   virtual char Display (SWModule & imodule);
+00038 };
+00039 #endif
+
Generated on Thu Jun 20 22:13:00 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlfootnotes_8h-source.html b/doc/api-documentation/html/thmlfootnotes_8h-source.html new file mode 100644 index 0000000..7576f78 --- /dev/null +++ b/doc/api-documentation/html/thmlfootnotes_8h-source.html @@ -0,0 +1,70 @@ + + +thmlfootnotes.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlfootnotes.h

00001 /*
+00002  *
+00003  * $Id:
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLFOOTNOTES_H
+00022 #define THMLFOOTNOTES_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLFootnotes:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039   ThMLFootnotes ();
+00040   virtual ~ ThMLFootnotes ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlgbf_8h-source.html b/doc/api-documentation/html/thmlgbf_8h-source.html new file mode 100644 index 0000000..9ba1622 --- /dev/null +++ b/doc/api-documentation/html/thmlgbf_8h-source.html @@ -0,0 +1,49 @@ + + +thmlgbf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlgbf.h

00001 /*
+00002  *
+00003  * thmlgbf.h
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLGBF_H
+00022 #define THMLGBF_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLGBF:public SWFilter
+00031 {
+00032 public:
+00033   ThMLGBF ();
+00034   virtual char ProcessText (char *text, int maxlen = -1);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlheadings_8h-source.html b/doc/api-documentation/html/thmlheadings_8h-source.html new file mode 100644 index 0000000..6a2df61 --- /dev/null +++ b/doc/api-documentation/html/thmlheadings_8h-source.html @@ -0,0 +1,70 @@ + + +thmlheadings.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlheadings.h

00001 /*
+00002  *
+00003  * $Id: 
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLHEADINGS_H
+00022 #define THMLHEADINGS_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLHeadings:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039   ThMLHeadings ();
+00040   virtual ~ ThMLHeadings ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlhtml_8h-source.html b/doc/api-documentation/html/thmlhtml_8h-source.html new file mode 100644 index 0000000..184142b --- /dev/null +++ b/doc/api-documentation/html/thmlhtml_8h-source.html @@ -0,0 +1,47 @@ + + +thmlhtml.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlhtml.h

00001 /***************************************************************************
+00002                           thmlhtml.h  -  description
+00003                              -------------------
+00004     begin                : 1999-10-28
+00005 
+00006     copyright            : 1999 by Chris Little
+00007     email                : chrislit@chiasma.org
+00008  ***************************************************************************/
+00009 
+00010 /***************************************************************************
+00011  *                                                                         *
+00012  *   This program is free software; you can redistribute it and/or modify  *
+00013  *   it under the terms of the GNU General Public License as published by  *
+00014  *   the Free Software Foundation; either version 2 of the License, or     *
+00015  *   (at your option) any later version.                                   *
+00016  *                                                                         *
+00017  ***************************************************************************/
+00018 
+00019 #ifndef THMLHTML_H
+00020 #define THMLHTML_H
+00021 
+00022 #include <swbasicfilter.h>
+00023 
+00024 #include <defs.h>
+00025 
+00028 class SWDLLEXPORT ThMLHTML : public SWBasicFilter {
+00029 protected:
+00030         virtual bool handleToken(char **buf, const char *token, DualStringMap &userData);
+00031 public:
+00032         ThMLHTML();
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlhtmlhref_8h-source.html b/doc/api-documentation/html/thmlhtmlhref_8h-source.html new file mode 100644 index 0000000..b151b17 --- /dev/null +++ b/doc/api-documentation/html/thmlhtmlhref_8h-source.html @@ -0,0 +1,45 @@ + + +thmlhtmlhref.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlhtmlhref.h

00001 /***************************************************************************
+00002                           thmlhtmlhref.h  -  description
+00003                              -------------------
+00004     begin                : 2001-09-03
+00005     copyright            : 2001 by CrossWire Bible Society
+00006  ***************************************************************************/
+00007 
+00008 /***************************************************************************
+00009  *                                                                         *
+00010  *   This program is free software; you can redistribute it and/or modify  *
+00011  *   it under the terms of the GNU General Public License as published by  *
+00012  *   the Free Software Foundation; either version 2 of the License, or     *
+00013  *   (at your option) any later version.                                   *
+00014  *                                                                         *
+00015  ***************************************************************************/
+00016 
+00017 #ifndef _THMLHTMLHREF_H
+00018 #define _THMLHTMLHREF_H
+00019 
+00020 #include <swbasicfilter.h>
+00021 
+00022 #include <defs.h>
+00023 
+00026 class SWDLLEXPORT ThMLHTMLHREF : public SWBasicFilter {
+00027 protected:
+00028         virtual bool handleToken(char **buf, const char *token, DualStringMap &userData);
+00029 public:
+00030         ThMLHTMLHREF();
+00031 };
+00032 
+00033 #endif /* _THMLHTMLHREF_H */
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmllemma_8h-source.html b/doc/api-documentation/html/thmllemma_8h-source.html new file mode 100644 index 0000000..cff85fb --- /dev/null +++ b/doc/api-documentation/html/thmllemma_8h-source.html @@ -0,0 +1,70 @@ + + +thmllemma.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmllemma.h

00001 /*
+00002  *
+00003  * $Id: 
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLLEMMA_H
+00022 #define THMLLEMMA_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLLemma:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039     ThMLLemma ();
+00040     virtual ~ ThMLLemma ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlmorph_8h-source.html b/doc/api-documentation/html/thmlmorph_8h-source.html new file mode 100644 index 0000000..533af3c --- /dev/null +++ b/doc/api-documentation/html/thmlmorph_8h-source.html @@ -0,0 +1,69 @@ + + +thmlmorph.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlmorph.h

00001 /*
+00002  * $Id:
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef THMLMORPH_H
+00021 #define THMLMORPH_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT ThMLMorph:public SWFilter
+00030 {
+00031   bool option;
+00032   static const char on[];
+00033   static const char off[];
+00034   static const char optName[];
+00035   static const char optTip[];
+00036   OptionsList options;
+00037 public:
+00038     ThMLMorph ();
+00039     virtual ~ ThMLMorph ();
+00040   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00041   virtual const char *getOptionName ()
+00042   {
+00043     return optName;
+00044   }
+00045   virtual const char *getOptionTip ()
+00046   {
+00047     return optTip;
+00048   }
+00049   virtual void setOptionValue (const char *ival);
+00050   virtual const char *getOptionValue ();
+00051   virtual OptionsList getOptionValues ()
+00052   {
+00053     return options;
+00054   }
+00055 };
+00056 
+00057 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlolb_8h-source.html b/doc/api-documentation/html/thmlolb_8h-source.html new file mode 100644 index 0000000..0561fb6 --- /dev/null +++ b/doc/api-documentation/html/thmlolb_8h-source.html @@ -0,0 +1,49 @@ + + +thmlolb.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlolb.h

00001 /*
+00002  *
+00003  * thmlolb.h
+00004  *
+00005  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLOLB_H
+00022 #define THMLOLB_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLOLB:public SWFilter
+00031 {
+00032 public:
+00033   ThMLOLB ();
+00034   virtual char ProcessText (char *text, int maxlen = -1);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlosis_8h-source.html b/doc/api-documentation/html/thmlosis_8h-source.html new file mode 100644 index 0000000..863d48e --- /dev/null +++ b/doc/api-documentation/html/thmlosis_8h-source.html @@ -0,0 +1,47 @@ + + +thmlosis.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlosis.h

00001 /***************************************************************************
+00002                           thmlosis.h  -  description
+00003                              -------------------
+00004     begin                : 2001-09-03
+00005     copyright            : 2001 by CrossWire Bible Society
+00006  ***************************************************************************/
+00007 
+00008 /***************************************************************************
+00009  *                                                                         *
+00010  *   This program is free software; you can redistribute it and/or modify  *
+00011  *   it under the terms of the GNU General Public License as published by  *
+00012  *   the Free Software Foundation; either version 2 of the License, or     *
+00013  *   (at your option) any later version.                                   *
+00014  *                                                                         *
+00015  ***************************************************************************/
+00016 
+00017 #ifndef THMLOSIS_H
+00018 #define THMLOSIS_H
+00019 
+00020 #include <defs.h>
+00021 #include <swfilter.h>
+00022 
+00025 class SWDLLEXPORT ThMLOSIS : public SWFilter {
+00026 protected:
+00027         virtual const char *convertToOSIS(const char *, const SWKey *key);
+00028         void pushString(char **buf, const char *format, ...);
+00029 public:
+00030         ThMLOSIS();
+00031         virtual ~ThMLOSIS();
+00032         char ProcessText(char *text, int maxlen, const SWKey *, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif /* THMLOSIS_H */
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlplain_8h-source.html b/doc/api-documentation/html/thmlplain_8h-source.html new file mode 100644 index 0000000..a0abf92 --- /dev/null +++ b/doc/api-documentation/html/thmlplain_8h-source.html @@ -0,0 +1,49 @@ + + +thmlplain.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlplain.h

00001 /*
+00002  *
+00003  * thmlplain.h
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLPLAIN_H
+00022 #define THMLPLAIN_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLPlain:public SWFilter
+00031 {
+00032 public:
+00033   ThMLPlain ();
+00034   virtual char ProcessText (char *text, int maxlen = -1);
+00035 };
+00036 
+00037 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlrtf_8h-source.html b/doc/api-documentation/html/thmlrtf_8h-source.html new file mode 100644 index 0000000..b98c878 --- /dev/null +++ b/doc/api-documentation/html/thmlrtf_8h-source.html @@ -0,0 +1,50 @@ + + +thmlrtf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlrtf.h

00001 /*
+00002  *
+00003  * thmlrtf.h
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLRTF_H
+00022 #define THMLRTF_H
+00023 
+00024 #include <swbasicfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLRTF:public SWBasicFilter
+00031 {
+00032 protected:
+00033   virtual bool handleToken(char **buf, const char *token, DualStringMap &userData);
+00034 public:
+00035   ThMLRTF ();
+00036 };
+00037 
+00038 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlscripref_8h-source.html b/doc/api-documentation/html/thmlscripref_8h-source.html new file mode 100644 index 0000000..d7effc5 --- /dev/null +++ b/doc/api-documentation/html/thmlscripref_8h-source.html @@ -0,0 +1,70 @@ + + +thmlscripref.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlscripref.h

00001 /*
+00002  *
+00003  * $Id: 
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLSCRIPREF_H
+00022 #define THMLSCRIPREF_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLScripref:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039   ThMLScripref ();
+00040   virtual ~ ThMLScripref ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlstrongs_8h-source.html b/doc/api-documentation/html/thmlstrongs_8h-source.html new file mode 100644 index 0000000..6f24332 --- /dev/null +++ b/doc/api-documentation/html/thmlstrongs_8h-source.html @@ -0,0 +1,70 @@ + + +thmlstrongs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlstrongs.h

00001 /*
+00002  *
+00003  * $Id:
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef THMLSTRONGS_H
+00022 #define THMLSTRONGS_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT ThMLStrongs:public SWFilter
+00031 {
+00032   bool option;
+00033   static const char on[];
+00034   static const char off[];
+00035   static const char optName[];
+00036   static const char optTip[];
+00037   OptionsList options;
+00038 public:
+00039     ThMLStrongs ();
+00040     virtual ~ ThMLStrongs ();
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042   virtual const char *getOptionName ()
+00043   {
+00044     return optName;
+00045   }
+00046   virtual const char *getOptionTip ()
+00047   {
+00048     return optTip;
+00049   }
+00050   virtual void setOptionValue (const char *ival);
+00051   virtual const char *getOptionValue ();
+00052   virtual OptionsList getOptionValues ()
+00053   {
+00054     return options;
+00055   }
+00056 };
+00057 
+00058 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/thmlvariants_8h-source.html b/doc/api-documentation/html/thmlvariants_8h-source.html new file mode 100644 index 0000000..3f06bbd --- /dev/null +++ b/doc/api-documentation/html/thmlvariants_8h-source.html @@ -0,0 +1,73 @@ + + +thmlvariants.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

thmlvariants.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 
+00019 #ifndef THMLVARIANTS_H
+00020 #define THMLVARIANTS_H
+00021 
+00022 #include <swfilter.h>
+00023 #include <swmodule.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT ThMLVariants : public SWFilter
+00030 {
+00031   char option;
+00032 
+00033   static const char primary[];
+00034   static const char secondary[];
+00035   static const char all[];
+00036 
+00037   static const char optName[];
+00038   static const char optTip[];
+00039   OptionsList options;
+00040 
+00041  public:
+00042   ThMLVariants ();
+00043   virtual ~ ThMLVariants ();
+00044   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00045   virtual const char *getOptionName ()
+00046     {
+00047       return optName;
+00048     }
+00049   virtual const char *getOptionTip ()
+00050     {
+00051       return optTip;
+00052     }
+00053   virtual void setOptionValue (const char *ival);
+00054   virtual const char *getOptionValue ();
+00055   virtual OptionsList getOptionValues ()
+00056     {
+00057       return options;
+00058     }
+00059 };
+00060 
+00061 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/treekey_8h-source.html b/doc/api-documentation/html/treekey_8h-source.html new file mode 100644 index 0000000..d7d6da7 --- /dev/null +++ b/doc/api-documentation/html/treekey_8h-source.html @@ -0,0 +1,99 @@ + + +treekey.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

treekey.h

00001 /******************************************************************************
+00002  *  versekey.h - code for class 'versekey'- a standard Biblical verse key
+00003  *
+00004  * $Id: treekey_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 
+00023 #ifndef TREEKEY_H
+00024 #define TREEKEY_H
+00025 
+00026 #include <swkey.h>
+00027 #include <swmacs.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 
+00036 class SWDLLEXPORT TreeKey : public SWKey {
+00037         static SWClass classdef;
+00038         void init();
+00039 
+00040 public:
+00041 //      TreeKey (const char *ikey = 0);
+00042 //      TreeKey (const SWKey * ikey);
+00043 //      TreeKey (TreeKey const &k);
+00044         TreeKey () { init(); };
+00045         ~TreeKey () {};
+00046 
+00047 
+00048         virtual const char *getLocalName() = 0;
+00049         virtual const char *setLocalName(const char *) = 0;
+00050 
+00051         virtual const char *getUserData(int *size = 0) = 0;
+00052         virtual void setUserData(const char *userData, int size = 0) = 0;
+00053 
+00054         virtual const char *getFullName() const = 0;
+00055 
+00056         virtual void root() = 0;
+00057         virtual bool parent() = 0;
+00058 
+00059         virtual bool firstChild() = 0;
+00060         virtual bool nextSibling() = 0;
+00061         virtual bool previousSibling() = 0;
+00062 
+00063         virtual bool hasChildren() = 0;
+00064 
+00065         virtual void append() = 0;
+00066         virtual void appendChild() = 0;
+00067         virtual void insertBefore() = 0;
+00068 
+00069         virtual void remove() = 0;
+00070 
+00071         virtual void setOffset(unsigned long offset) = 0;
+00072         virtual unsigned long getOffset() const = 0;
+00073 
+00074         virtual void setText(const char *ikey) = 0;
+00075         virtual void setPosition(SW_POSITION p) = 0;
+00076         virtual const char *getText() const = 0;
+00077         virtual int compare(const SWKey &ikey) = 0;
+00078         virtual void decrement(int steps = 1) = 0;
+00079         virtual void increment(int steps = 1) = 0;
+00080         virtual char Traversable () { return 1; }
+00081         virtual long Index () const { return getOffset(); }
+00082         virtual long Index (long iindex) { setOffset(iindex); return getOffset(); }
+00083 
+00084         SWKEY_OPERATORS
+00085 
+00086         };
+00087 
+00088 
+00089 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/treekeyidx_8h-source.html b/doc/api-documentation/html/treekeyidx_8h-source.html new file mode 100644 index 0000000..997f9c2 --- /dev/null +++ b/doc/api-documentation/html/treekeyidx_8h-source.html @@ -0,0 +1,126 @@ + + +treekeyidx.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

treekeyidx.h

00001 /******************************************************************************
+00002  *  versekey.h - code for class 'versekey'- a standard Biblical verse key
+00003  *
+00004  * $Id: treekeyidx_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 
+00023 #ifndef TREEKEYIDX_H
+00024 #define TREEKEYIDX_H
+00025 
+00026 #include <treekey.h>
+00027 #include <sysdata.h>
+00028 #include <filemgr.h>
+00029 
+00030 
+00035 class SWDLLEXPORT TreeKeyIdx : public TreeKey {
+00036 
+00037         class TreeNode {
+00038         public:
+00039                 TreeNode();
+00040                 ~TreeNode();
+00041                 void clear();
+00042                 __u32 offset;
+00043                 __s32 parent;
+00044                 __s32 next;
+00045                 __s32 firstChild;
+00046                 char *name;
+00047                 __u16 dsize;
+00048                 char *userData;
+00049         } currentNode;
+00050 
+00051         static SWClass classdef;
+00052 
+00053         char *path;
+00054 
+00055         FileDesc *idxfd;
+00056         FileDesc *datfd;
+00057 
+00058         void getTreeNodeFromDatOffset(long ioffset, TreeNode *buf) const;
+00059         char getTreeNodeFromIdxOffset(long ioffset, TreeNode *node) const;
+00060         void saveTreeNode(TreeNode *node);
+00061         void saveTreeNodeOffsets(TreeNode *node);
+00062         void init();
+00063 
+00064 public:
+00065         TreeKeyIdx(const TreeKeyIdx &ikey);
+00066         TreeKeyIdx (const char *idxPath, int fileMode = -1);
+00067         ~TreeKeyIdx ();
+00068 
+00069 
+00070         virtual const char *getLocalName();
+00071         virtual const char *setLocalName(const char *);
+00072 
+00073         virtual const char *getUserData(int *size = 0);
+00074         virtual void setUserData(const char *userData, int size = 0);
+00075 
+00076         virtual const char *getFullName() const;
+00077 
+00078         virtual void root();
+00079         virtual bool parent();
+00080 
+00081         virtual bool firstChild();
+00082         virtual bool nextSibling();
+00083         virtual bool previousSibling();
+00084 
+00085         virtual bool hasChildren();
+00086 
+00087         virtual void append();
+00088         virtual void appendChild();
+00089         virtual void insertBefore();
+00090 
+00091         virtual void remove();
+00092         virtual void save();
+00093 
+00094         virtual void copyFrom(const TreeKeyIdx &ikey);
+00095         virtual void copyFrom(const SWKey & ikey);
+00096 
+00097         virtual SWKey &operator = (const TreeKeyIdx &ikey) { copyFrom(ikey); return *this; }
+00098         void setOffset(unsigned long offset);
+00099         unsigned long getOffset() const;
+00100 
+00101         SWKEY_OPERATORS
+00102 
+00103         virtual void setText(const char *ikey);
+00104         virtual void setPosition(SW_POSITION p);
+00105         virtual const char *getText() const;
+00106         virtual int _compare (const TreeKeyIdx & ikey);
+00107         virtual int compare(const SWKey &ikey);
+00108         virtual void decrement(int steps = 1);
+00109         virtual void increment(int steps = 1);
+00110         virtual char Traversable () { return 1; }
+00111 
+00112         static signed char create(const char *path);
+00113 };
+00114 
+00115 
+00116 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/unicodertf_8h-source.html b/doc/api-documentation/html/unicodertf_8h-source.html new file mode 100644 index 0000000..9bad1ef --- /dev/null +++ b/doc/api-documentation/html/unicodertf_8h-source.html @@ -0,0 +1,48 @@ + + +unicodertf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

unicodertf.h

00001 /*
+00002  *
+00003  * $Id: unicodertf_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00004  *
+00005  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00006  *      CrossWire Bible Society
+00007  *      P. O. Box 2528
+00008  *      Tempe, AZ  85280-2528
+00009  *
+00010  * This program is free software; you can redistribute it and/or modify it
+00011  * under the terms of the GNU General Public License as published by the
+00012  * Free Software Foundation version 2.
+00013  *
+00014  * This program is distributed in the hope that it will be useful, but
+00015  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00017  * General Public License for more details.
+00018  *
+00019  */
+00020 
+00021 #ifndef UNICODERTF_H
+00022 #define UNICODERTF_H
+00023 
+00024 #include <swfilter.h>
+00025 
+00026 #include <defs.h>
+00027 
+00030 class SWDLLEXPORT UnicodeRTF:public SWFilter {
+00031 public:
+00032   UnicodeRTF();
+00033   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00034 };
+00035 
+00036 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/unixstr_8h-source.html b/doc/api-documentation/html/unixstr_8h-source.html new file mode 100644 index 0000000..2536d91 --- /dev/null +++ b/doc/api-documentation/html/unixstr_8h-source.html @@ -0,0 +1,42 @@ + + +unixstr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

unixstr.h

00001 // Include only if your UNIX compiler does not include stricmp but does include strcasecmp
+00002 /*
+00003  *
+00004  * $Id: unixstr_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef UNIXSTR_H
+00023 #define UNIXSTR_H
+00024 #include <string.h>
+00025 
+00026 int stricmp (const char *s1, const char *s2);
+00027 
+00028 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/untgz_8h-source.html b/doc/api-documentation/html/untgz_8h-source.html new file mode 100644 index 0000000..a209cf7 --- /dev/null +++ b/doc/api-documentation/html/untgz_8h-source.html @@ -0,0 +1,23 @@ + + +untgz.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

untgz.h

00001 #ifndef UNTGZ_H
+00002 #define UNTGZ_H
+00003 
+00004 #include "zlib.h"
+00005 
+00006 int untargz(int fd, const char *dest);
+00007 int untar(gzFile in, const char *dest);
+00008 
+00009 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf16utf8_8h-source.html b/doc/api-documentation/html/utf16utf8_8h-source.html new file mode 100644 index 0000000..b858631 --- /dev/null +++ b/doc/api-documentation/html/utf16utf8_8h-source.html @@ -0,0 +1,47 @@ + + +utf16utf8.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf16utf8.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF16UTF8_H
+00021 #define UTF16UTF8_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF16UTF8:public SWFilter {
+00030 public:
+00031   UTF16UTF8();
+00032   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8arshaping_8h-source.html b/doc/api-documentation/html/utf8arshaping_8h-source.html new file mode 100644 index 0000000..24fcb47 --- /dev/null +++ b/doc/api-documentation/html/utf8arshaping_8h-source.html @@ -0,0 +1,60 @@ + + +utf8arshaping.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8arshaping.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 #ifdef _ICU_
+00019 
+00020 #ifndef UTF8ARSHAPING_H
+00021 #define UTF8ARSHAPING_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <unicode/utypes.h>
+00026 #include <unicode/ucnv.h>
+00027 #include <unicode/uchar.h>
+00028 #include <unicode/ushape.h>
+00029 
+00030 #include <defs.h>
+00031 
+00034 class SWDLLEXPORT UTF8arShaping : public SWFilter
+00035 {
+00036  private:
+00037   UConverter* conv;
+00038   UErrorCode err;
+00039  public:
+00040   UTF8arShaping();
+00041   ~UTF8arShaping();  
+00042   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00043 };
+00044 
+00045 #endif
+00046 
+00047 #endif
+00048 
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8bidireorder_8h-source.html b/doc/api-documentation/html/utf8bidireorder_8h-source.html new file mode 100644 index 0000000..4afc19c --- /dev/null +++ b/doc/api-documentation/html/utf8bidireorder_8h-source.html @@ -0,0 +1,60 @@ + + +utf8bidireorder.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8bidireorder.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 #ifdef _ICU_
+00019 
+00020 #ifndef UTF8BIDIREORDER_H
+00021 #define UTF8BIDIREORDER_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <unicode/utypes.h>
+00026 #include <unicode/ucnv.h>
+00027 #include <unicode/uchar.h>
+00028 #include <unicode/bidi.h>
+00029 
+00030 #include <defs.h>
+00031 
+00034 class SWDLLEXPORT UTF8BiDiReorder : public SWFilter
+00035 {
+00036  private:
+00037   UConverter* conv;
+00038   UErrorCode err;
+00039  public:
+00040   UTF8BiDiReorder();
+00041   ~UTF8BiDiReorder();  
+00042   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00043 };
+00044 
+00045 #endif
+00046 
+00047 #endif
+00048 
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8cantillation_8h-source.html b/doc/api-documentation/html/utf8cantillation_8h-source.html new file mode 100644 index 0000000..8bf7e06 --- /dev/null +++ b/doc/api-documentation/html/utf8cantillation_8h-source.html @@ -0,0 +1,69 @@ + + +utf8cantillation.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8cantillation.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8CANTILLATION_H
+00021 #define UTF8CANTILLATION_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8Cantillation:public SWFilter
+00030 {
+00031   bool option;
+00032   static const char on[];
+00033   static const char off[];
+00034   static const char optName[];
+00035   static const char optTip[];
+00036   OptionsList options;
+00037 public:
+00038     UTF8Cantillation ();
+00039     virtual ~ UTF8Cantillation ();
+00040   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00041   virtual const char *getOptionName ()
+00042   {
+00043     return optName;
+00044   }
+00045   virtual const char *getOptionTip ()
+00046   {
+00047     return optTip;
+00048   }
+00049   virtual void setOptionValue (const char *ival);
+00050   virtual const char *getOptionValue ();
+00051   virtual OptionsList getOptionValues ()
+00052   {
+00053     return options;
+00054   }
+00055 };
+00056 
+00057 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8greekaccents_8h-source.html b/doc/api-documentation/html/utf8greekaccents_8h-source.html new file mode 100644 index 0000000..c9ac492 --- /dev/null +++ b/doc/api-documentation/html/utf8greekaccents_8h-source.html @@ -0,0 +1,69 @@ + + +utf8greekaccents.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8greekaccents.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8GREEKACCENTS_H
+00021 #define UTF8GREEKACCENTS_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8GreekAccents:public SWFilter
+00030 {
+00031   bool option;
+00032   static const char on[];
+00033   static const char off[];
+00034   static const char optName[];
+00035   static const char optTip[];
+00036   OptionsList options;
+00037 public:
+00038     UTF8GreekAccents ();
+00039     virtual ~ UTF8GreekAccents ();
+00040   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00041   virtual const char *getOptionName ()
+00042   {
+00043     return optName;
+00044   }
+00045   virtual const char *getOptionTip ()
+00046   {
+00047     return optTip;
+00048   }
+00049   virtual void setOptionValue (const char *ival);
+00050   virtual const char *getOptionValue ();
+00051   virtual OptionsList getOptionValues ()
+00052   {
+00053     return options;
+00054   }
+00055 };
+00056 
+00057 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8hebrewpoints_8h-source.html b/doc/api-documentation/html/utf8hebrewpoints_8h-source.html new file mode 100644 index 0000000..26459cc --- /dev/null +++ b/doc/api-documentation/html/utf8hebrewpoints_8h-source.html @@ -0,0 +1,69 @@ + + +utf8hebrewpoints.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8hebrewpoints.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8HEBREWPOINTS_H
+00021 #define UTF8HEBREWPOINTS_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8HebrewPoints:public SWFilter
+00030 {
+00031   bool option;
+00032   static const char on[];
+00033   static const char off[];
+00034   static const char optName[];
+00035   static const char optTip[];
+00036   OptionsList options;
+00037 public:
+00038     UTF8HebrewPoints ();
+00039     virtual ~ UTF8HebrewPoints ();
+00040   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00041   virtual const char *getOptionName ()
+00042   {
+00043     return optName;
+00044   }
+00045   virtual const char *getOptionTip ()
+00046   {
+00047     return optTip;
+00048   }
+00049   virtual void setOptionValue (const char *ival);
+00050   virtual const char *getOptionValue ();
+00051   virtual OptionsList getOptionValues ()
+00052   {
+00053     return options;
+00054   }
+00055 };
+00056 
+00057 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8html_8h-source.html b/doc/api-documentation/html/utf8html_8h-source.html new file mode 100644 index 0000000..7552d51 --- /dev/null +++ b/doc/api-documentation/html/utf8html_8h-source.html @@ -0,0 +1,47 @@ + + +utf8html.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8html.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8HTML_H
+00021 #define UTF8HTML_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8HTML:public SWFilter {
+00030 public:
+00031   UTF8HTML();
+00032   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8latin1_8h-source.html b/doc/api-documentation/html/utf8latin1_8h-source.html new file mode 100644 index 0000000..9799eb7 --- /dev/null +++ b/doc/api-documentation/html/utf8latin1_8h-source.html @@ -0,0 +1,48 @@ + + +utf8latin1.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8latin1.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8Latin1_H
+00021 #define UTF8Latin1_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8Latin1:public SWFilter {
+00030   char replacementChar;
+00031 public:
+00032   UTF8Latin1(char rchar = '?');
+00033   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00034 };
+00035 
+00036 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8nfc_8h-source.html b/doc/api-documentation/html/utf8nfc_8h-source.html new file mode 100644 index 0000000..da2c7eb --- /dev/null +++ b/doc/api-documentation/html/utf8nfc_8h-source.html @@ -0,0 +1,60 @@ + + +utf8nfc.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8nfc.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 #ifdef _ICU_
+00019 
+00020 #ifndef UTF8NFC_H
+00021 #define UTF8NFC_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <unicode/utypes.h>
+00026 #include <unicode/ucnv.h>
+00027 #include <unicode/uchar.h>
+00028 #include <unicode/unorm.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT UTF8NFC : public SWFilter
+00033 {
+00034  private:
+00035   UConverter* conv;
+00036   UChar *source, *target;
+00037   UErrorCode err;
+00038  public:
+00039   UTF8NFC();
+00040   ~UTF8NFC();  
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042 };
+00043 
+00044 #endif
+00045 
+00046 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8nfkd_8h-source.html b/doc/api-documentation/html/utf8nfkd_8h-source.html new file mode 100644 index 0000000..f07bd90 --- /dev/null +++ b/doc/api-documentation/html/utf8nfkd_8h-source.html @@ -0,0 +1,60 @@ + + +utf8nfkd.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8nfkd.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 #ifdef _ICU_
+00019 
+00020 #ifndef UTF8NFKD_H
+00021 #define UTF8NFKD_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <unicode/utypes.h>
+00026 #include <unicode/ucnv.h>
+00027 #include <unicode/uchar.h>
+00028 #include <unicode/unorm.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT UTF8NFKD : public SWFilter
+00033 {
+00034  private:
+00035   UConverter* conv;
+00036   UChar *source, *target;
+00037   UErrorCode err;
+00038  public:
+00039   UTF8NFKD();
+00040   ~UTF8NFKD();  
+00041   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00042 };
+00043 
+00044 #endif
+00045 
+00046 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8transliterator_8h-source.html b/doc/api-documentation/html/utf8transliterator_8h-source.html new file mode 100644 index 0000000..4b377f1 --- /dev/null +++ b/doc/api-documentation/html/utf8transliterator_8h-source.html @@ -0,0 +1,85 @@ + + +utf8transliterator.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8transliterator.h

00001 /*
+00002  *
+00003  * Copyright 2001 CrossWire Bible Society (http://www.crosswire.org)
+00004  *      CrossWire Bible Society
+00005  *      P. O. Box 2528
+00006  *      Tempe, AZ  85280-2528
+00007  *
+00008  * This program is free software; you can redistribute it and/or modify it
+00009  * under the terms of the GNU General Public License as published by the
+00010  * Free Software Foundation version 2.
+00011  *
+00012  * This program is distributed in the hope that it will be useful, but
+00013  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00015  * General Public License for more details.
+00016  *
+00017  */
+00018 #ifdef _ICU_
+00019 
+00020 #ifndef UTF8TRANSLITERATOR_H
+00021 #define UTF8TRANSLITERATOR_H
+00022 
+00023 enum scriptEnum {SE_OFF, SE_LATIN, /*one-way (to) transliterators*/ SE_BASICLATIN, SE_BETA, SE_BGREEK, /*two-way transliterators*/ SE_GREEK, SE_HEBREW, SE_CYRILLIC, SE_ARABIC, SE_SYRIAC, SE_KATAKANA, SE_HIRAGANA, SE_JAMO, SE_HANGUL, SE_DEVANAGARI, SE_TAMIL, SE_BENGALI, SE_GURMUKHI, SE_GUJARATI, SE_ORIYA, SE_TELUGU, SE_KANNADA, SE_MALAYALAM, SE_THAI, SE_GEORGIAN, SE_ARMENIAN, SE_ETHIOPIC, SE_GOTHIC, SE_UGARITIC, SE_COPTIC, /*one-way (from) transliterators*/ SE_HAN, SE_KANJI};
+00024 #define NUMSCRIPTS 32
+00025 #define NUMTARGETSCRIPTS 5
+00026 
+00027 #include <swfilter.h>
+00028 #include <swmodule.h>
+00029 
+00030 #include <unicode/utypes.h>
+00031 #include <unicode/ucnv.h>
+00032 #include <unicode/ustring.h>
+00033 #include <unicode/uchar.h>
+00034 
+00035 #include <unicode/unistr.h>
+00036 #include <unicode/translit.h>
+00037 
+00038 #include <defs.h>
+00039 
+00042 class SWDLLEXPORT UTF8Transliterator : public SWFilter
+00043 {
+00044   char option;
+00045 
+00046   static const char optionstring[NUMTARGETSCRIPTS][16];
+00047 
+00048   static const char optName[];
+00049   static const char optTip[];
+00050   OptionsList options;
+00051 
+00052  public:
+00053   UTF8Transliterator ();
+00054   virtual char ProcessText (char *text, int maxlen, const SWKey * key, const SWModule * = 0);
+00055   virtual const char *getOptionName ()
+00056     {
+00057       return optName;
+00058     }
+00059   virtual const char *getOptionTip ()
+00060     {
+00061       return optTip;
+00062     }
+00063   virtual void setOptionValue (const char *ival);
+00064   virtual const char *getOptionValue ();
+00065   virtual OptionsList getOptionValues ()
+00066     {
+00067       return options;
+00068     }
+00069 };
+00070 
+00071 #endif
+00072 
+00073 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utf8utf16_8h-source.html b/doc/api-documentation/html/utf8utf16_8h-source.html new file mode 100644 index 0000000..367fed1 --- /dev/null +++ b/doc/api-documentation/html/utf8utf16_8h-source.html @@ -0,0 +1,47 @@ + + +utf8utf16.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utf8utf16.h

00001 /*
+00002  *
+00003  *
+00004  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00005  *      CrossWire Bible Society
+00006  *      P. O. Box 2528
+00007  *      Tempe, AZ  85280-2528
+00008  *
+00009  * This program is free software; you can redistribute it and/or modify it
+00010  * under the terms of the GNU General Public License as published by the
+00011  * Free Software Foundation version 2.
+00012  *
+00013  * This program is distributed in the hope that it will be useful, but
+00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00016  * General Public License for more details.
+00017  *
+00018  */
+00019 
+00020 #ifndef UTF8UTF16_H
+00021 #define UTF8UTF16_H
+00022 
+00023 #include <swfilter.h>
+00024 
+00025 #include <defs.h>
+00026 
+00029 class SWDLLEXPORT UTF8UTF16:public SWFilter {
+00030 public:
+00031   UTF8UTF16();
+00032   virtual char ProcessText (char *text, int maxlen, const SWKey *key, const SWModule * = 0);
+00033 };
+00034 
+00035 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utilconf_8h-source.html b/doc/api-documentation/html/utilconf_8h-source.html new file mode 100644 index 0000000..235dcd2 --- /dev/null +++ b/doc/api-documentation/html/utilconf_8h-source.html @@ -0,0 +1,22 @@ + + +utilconf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utilconf.h

00001 #ifndef UTILCONF_H
+00002 #define UTILCONF_H
+00003 
+00004 
+00005 char getconfent (char *filename, char *entryname, char *buf, int len);
+00006 
+00007 
+00008 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utilfuns_8h-source.html b/doc/api-documentation/html/utilfuns_8h-source.html new file mode 100644 index 0000000..d5d569a --- /dev/null +++ b/doc/api-documentation/html/utilfuns_8h-source.html @@ -0,0 +1,43 @@ + + +utilfuns.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utilfuns.h

00001 /******************************************************************************
+00002  *  utilfuns.h  - utility function prototypes
+00003  *
+00004  * $Id: utilfuns_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 #ifndef UTILFUNS_H
+00022 #define UTILFUNS_H
+00023 
+00024 
+00025 #include <utilstr.h>
+00026 #include <utilconf.h>
+00027 
+00028 
+00029 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/utilstr_8h-source.html b/doc/api-documentation/html/utilstr_8h-source.html new file mode 100644 index 0000000..d274f7b --- /dev/null +++ b/doc/api-documentation/html/utilstr_8h-source.html @@ -0,0 +1,95 @@ + + +utilstr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

utilstr.h

00001 /******************************************************************************
+00002  *  utilstr.h   - prototypes for string utility functions
+00003  *
+00004  * $Id: utilstr_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef UTILSTR_H
+00023 #define UTILSTR_H
+00024 
+00027 char *stdstr (char **iistr, const char *istr);
+00028 char *strstrip (char *istr);
+00029 const char *stristr (const char *s1, const char *s2);
+00030 const char strnicmp(const char *s1, const char *s2, int len);
+00031 unsigned int strlenw(const char *s1);
+00032 char *toupperstr(char *buf);
+00033 
+00034 /*
+00035 extern "C" {
+00036 int stricmp(const char *s1, const char *s2);
+00037 }
+00038 */
+00039 
+00040 /******************************************************************************
+00041  * SW_toupper - array of uppercase values for any given Latin-1 value
+00042  *
+00043  * use this instead of toupper() for fast lookups on accented characters
+00044  */
+00045 static const unsigned char SW_toupper_array[256] =
+00046         {
+00047                 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+00048                 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
+00049                 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
+00050                 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
+00051                 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27,
+00052                 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
+00053                 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
+00054                 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
+00055                 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
+00056                 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+00057                 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
+00058                 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
+00059                 0x60, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
+00060                 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
+00061                 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
+00062                 0x58, 0x59, 0x5a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
+00063                 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
+00064                 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
+00065                 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
+00066                 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
+00067                 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7,
+00068                 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
+00069                 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
+00070                 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
+00071                 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
+00072                 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
+00073                 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
+00074                 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
+00075                 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
+00076                 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
+00077                 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xf7,
+00078                 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xff
+00079         };
+00080 
+00081 #define SW_toupper(c) SW_toupper_array[(unsigned char)c]
+00082 
+00083 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/versekey_8h-source.html b/doc/api-documentation/html/versekey_8h-source.html new file mode 100644 index 0000000..2b41b3e --- /dev/null +++ b/doc/api-documentation/html/versekey_8h-source.html @@ -0,0 +1,220 @@ + + +versekey.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

versekey.h

00001 /******************************************************************************
+00002  *      versekey.h - code for class 'versekey'- a standard Biblical verse key
+00003  *
+00004  * $Id: versekey_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ       85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 
+00023 #ifndef VERSEKEY_H
+00024 #define VERSEKEY_H
+00025 
+00026 #include <swkey.h>
+00027 #include <swmacs.h>
+00028 #include <listkey.h>
+00029 #include <ctype.h>
+00030 
+00031 #include <defs.h>
+00032 
+00033 #define POS_MAXVERSE ((char)3)
+00034 #define POS_MAXCHAPTER ((char)4)
+00035 #define POS_MAXBOOK ((char)5)
+00036 
+00037 #define MAXVERSE SW_POSITION(POS_MAXVERSE)
+00038 #define MAXCHAPTER SW_POSITION(POS_MAXCHAPTER)
+00039 #define MAXBOOK SW_POSITION(POS_MAXBOOK)
+00040 
+00041 struct sbook
+00042 {
+00045         const char *name;
+00046 
+00049         const char *prefAbbrev;
+00050 
+00053         unsigned char chapmax;
+00056         int *versemax;
+00057 };
+00058 
+00059 struct abbrev
+00060 {
+00061         const char *ab;
+00062         int book;
+00063 };
+00064 
+00065 
+00066 class SWLocale;
+00067 
+00072 class SWDLLEXPORT VerseKey:public SWKey
+00073 {
+00074         class LocaleCache
+00075         {
+00076         public:
+00077                 char *name;
+00078                 unsigned int abbrevsCnt;
+00079                 SWLocale *locale;
+00080                         LocaleCache()
+00081                 {
+00082                         name = 0;
+00083                         abbrevsCnt = 0;
+00084                         locale = 0;
+00085                 }
+00086                  virtual ~LocaleCache()
+00087                 {
+00088                         if (name)
+00089         delete[]name;
+00090                 }
+00091         };
+00092 
+00093         static SWClass classdef;
+00094 
+00095         static long *offsets[2][2];
+00096         static int offsize[2][2];
+00099         static int instance;
+00100         static struct sbook otbooks[];
+00101         static struct sbook ntbooks[];
+00102         static long otbks[];
+00103         static long otcps[];
+00104         static long ntbks[];
+00105         static long ntcps[];
+00106         static int vm[];
+00107         static LocaleCache localeCache;
+00108         ListKey internalListKey;
+00109 
+00110         const struct abbrev *abbrevs;
+00111         char *locale;
+00112         int abbrevsCnt;
+00115         signed char testament;
+00116         mutable signed char book;
+00117         mutable signed int chapter;
+00118         mutable signed int verse;
+00121         char autonorm;
+00124         char headings;
+00125 
+00126         int getBookAbbrev(const char *abbr);
+00127         void initBounds() const;
+00130         void initstatics();
+00133         void init();
+00138         void freshtext() const;
+00142         virtual char parse();
+00151         int findindex(long *array, int size, long value);
+00152         mutable VerseKey *lowerBound, *upperBound;
+00153 
+00154 public:
+00155         static const char builtin_BMAX[2];
+00156         static struct sbook *builtin_books[2];
+00157         static const struct abbrev builtin_abbrevs[];
+00158         const char *BMAX;
+00159         struct sbook **books;
+00160 
+00167         VerseKey(const char *ikey = 0);
+00168         
+00175         VerseKey(const SWKey * ikey);
+00176         
+00183         VerseKey(const char *min, const char *max);
+00184         
+00190         VerseKey(const VerseKey &k);
+00191         
+00195         virtual ~ VerseKey();
+00196 
+00203         VerseKey & LowerBound(const char *lb);
+00204         
+00210         VerseKey & UpperBound(const char *ub);
+00211         
+00215         VerseKey & LowerBound() const;
+00216         
+00220         VerseKey & UpperBound() const;
+00221         
+00224         void ClearBounds();
+00225         
+00229         virtual SWKey *clone() const;
+00230         
+00234         virtual const char *getText() const;
+00235         virtual const char *getShortText() const;
+00236         virtual void setText(const char *ikey) { SWKey::setText(ikey); parse (); }
+00237         virtual void copyFrom(const SWKey & ikey);
+00238         
+00241         virtual void copyFrom(const VerseKey & ikey);
+00242         
+00248         virtual void setPosition(SW_POSITION);
+00249         
+00255         virtual void decrement(int step);
+00256         
+00262         virtual void increment(int step);
+00263         virtual char Traversable() { return 1; }
+00264 
+00265         virtual const char *getBookName() const;
+00266         virtual const char *getBookAbbrev() const;
+00271         virtual char Testament() const;
+00272         
+00277         virtual char Book() const;
+00278         
+00283         virtual int Chapter() const;
+00284         
+00289         virtual int Verse() const;
+00290         
+00298         virtual char Testament(char itestament);
+00299         
+00307         virtual char Book(char ibook);
+00308         
+00316         virtual int Chapter(int ichapter);
+00317         
+00325         virtual int Verse(int iverse);
+00326         
+00333         virtual void Normalize(char autocheck = 0);
+00334         
+00343         virtual char AutoNormalize(char iautonorm = MAXPOS (char));
+00344         
+00353         virtual char Headings(char iheadings = MAXPOS (char));
+00354         
+00355         virtual long NewIndex() const;
+00356         
+00361         virtual long Index() const;
+00362         
+00368         virtual long Index(long iindex);
+00369 
+00370         virtual const char *getOSISRef() const;
+00371 
+00372         virtual ListKey ParseVerseList(const char *buf, const char *defaultKey = "Genesis 1:1", bool expandRange = false);
+00380         virtual int compare(const SWKey & ikey);
+00381         
+00389         virtual int _compare(const VerseKey & ikey);
+00390         
+00391         virtual void setBookAbbrevs(const struct abbrev *bookAbbrevs, unsigned int size = 0 /* default determine size */ );
+00392         virtual void setBooks(const char *iBMAX, struct sbook **ibooks);
+00393         virtual void setLocale(const char *name);
+00394         virtual const char *getLocale() const { return locale; }
+00395 
+00396         SWKEY_OPERATORS
+00397 
+00398         virtual SWKey & operator = (const VerseKey & ikey) { copyFrom(ikey); return *this; }
+00399 };
+00400 
+00401 
+00402 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zcom_8h-source.html b/doc/api-documentation/html/zcom_8h-source.html new file mode 100644 index 0000000..3f79593 --- /dev/null +++ b/doc/api-documentation/html/zcom_8h-source.html @@ -0,0 +1,83 @@ + + +zcom.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zcom.h

00001 /******************************************************************************
+00002  *  zcom.h   - code for class 'zCom'- a module that reads compressed text
+00003  *                              files: ot and nt using indexs ??.vss
+00004  *
+00005  * $Id: zcom_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef ZCOM_H
+00024 #define ZCOM_H
+00025 
+00026 #include <rawverse.h>
+00027 #include <swcom.h>
+00028 #include <swcomprs.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWDLLEXPORT zCom:public zVerse, public SWCom {
+00033   VerseKey *lastWriteKey;
+00034   bool sameBlock (VerseKey * lastWriteKey, VerseKey * key);
+00035   int blockType;
+00036 public:
+00037   
+00038     
+00039     zCom (const char *ipath, const char *iname = 0, const char *idesc =
+00040            0, int blockType = CHAPTERBLOCKS, SWCompress * icomp =
+00041            0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00042            const char* ilang = 0);
+00043     virtual ~ zCom ();
+00044   virtual char *getRawEntry ();
+00045   virtual SWModule & operator += (int increment);
+00046   virtual SWModule & operator -= (int decrement)
+00047   {
+00048     return this->operator += (-decrement);
+00049   }
+00050 
+00051   // write interface ----------------------------
+00052         virtual bool isWritable () { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
+00053   static char createModule (const char *path, int blockBound)
+00054   {
+00055     return zVerse::createModule (path, blockBound);
+00056   }
+00057   virtual SWModule & setentry (const char *inbuf, long len);    // Modify current module entry
+00058   virtual SWModule & operator << (const char *inbuf);   // Modify current module entry
+00059   virtual SWModule & operator << (const SWKey * linkKey);       // Link current module entry to other module entry
+00060   virtual void deleteEntry ();  // Delete current module entry
+00061   // end write interface ------------------------
+00062   
+00063   // swcacher interface ----------------------
+00064         virtual void flush() { flushCache(); }
+00065   // end swcacher interface ----------------------
+00066 };
+00067 
+00068 
+00069 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zconf_8h-source.html b/doc/api-documentation/html/zconf_8h-source.html new file mode 100644 index 0000000..be43e7a --- /dev/null +++ b/doc/api-documentation/html/zconf_8h-source.html @@ -0,0 +1,293 @@ + + +zconf.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zconf.h

00001 /* zconf.h -- configuration of the zlib compression library
+00002  * Copyright (C) 1995-1998 Jean-loup Gailly.
+00003  * For conditions of distribution and use, see copyright notice in zlib.h 
+00004  */
+00005 
+00006 /* @(#) $Id: zconf_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $ */
+00007 
+00008 #ifndef _ZCONF_H
+00009 #define _ZCONF_H
+00010 
+00011 /*
+00012  * If you *really* need a unique prefix for all types and library functions,
+00013  * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it.
+00014  */
+00015 #ifdef Z_PREFIX
+00016 #  define deflateInit_  z_deflateInit_
+00017 #  define deflate       z_deflate
+00018 #  define deflateEnd    z_deflateEnd
+00019 #  define inflateInit_  z_inflateInit_
+00020 #  define inflate       z_inflate
+00021 #  define inflateEnd    z_inflateEnd
+00022 #  define deflateInit2_ z_deflateInit2_
+00023 #  define deflateSetDictionary z_deflateSetDictionary
+00024 #  define deflateCopy   z_deflateCopy
+00025 #  define deflateReset  z_deflateReset
+00026 #  define deflateParams z_deflateParams
+00027 #  define inflateInit2_ z_inflateInit2_
+00028 #  define inflateSetDictionary z_inflateSetDictionary
+00029 #  define inflateSync   z_inflateSync
+00030 #  define inflateSyncPoint z_inflateSyncPoint
+00031 #  define inflateReset  z_inflateReset
+00032 #  define compress      z_compress
+00033 #  define compress2     z_compress2
+00034 #  define uncompress    z_uncompress
+00035 #  define adler32       z_adler32
+00036 #  define crc32         z_crc32
+00037 #  define get_crc_table z_get_crc_table
+00038 
+00039 #  define Byte          z_Byte
+00040 #  define uInt          z_uInt
+00041 #  define uLong         z_uLong
+00042 #  define Bytef         z_Bytef
+00043 #  define charf         z_charf
+00044 #  define intf          z_intf
+00045 #  define uIntf         z_uIntf
+00046 #  define uLongf        z_uLongf
+00047 #  define voidpf        z_voidpf
+00048 #  define voidp         z_voidp
+00049 #endif
+00050 
+00051 #if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)
+00052 #  define WIN32
+00053 #endif
+00054 #if defined(__GNUC__) || defined(WIN32) || defined(__386__) || defined(i386)
+00055 #  ifndef __32BIT__
+00056 #    define __32BIT__
+00057 #  endif
+00058 #endif
+00059 #if defined(__MSDOS__) && !defined(MSDOS)
+00060 #  define MSDOS
+00061 #endif
+00062 
+00063 /*
+00064  * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
+00065  * than 64k bytes at a time (needed on systems with 16-bit int).
+00066  */
+00067 #if defined(MSDOS) && !defined(__32BIT__)
+00068 #  define MAXSEG_64K
+00069 #endif
+00070 #ifdef MSDOS
+00071 #  define UNALIGNED_OK
+00072 #endif
+00073 
+00074 #if (defined(MSDOS) || defined(_WINDOWS) || defined(WIN32))  && !defined(STDC)
+00075 #  define STDC
+00076 #endif
+00077 #if defined(__STDC__) || defined(__cplusplus) || defined(__OS2__)
+00078 #  ifndef STDC
+00079 #    define STDC
+00080 #  endif
+00081 #endif
+00082 
+00083 #ifndef STDC
+00084 #  ifndef const /* cannot use !defined(STDC) && !defined(const) on Mac */
+00085 #    define const
+00086 #  endif
+00087 #endif
+00088 
+00089 /* Some Mac compilers merge all .h files incorrectly: */
+00090 #if defined(__MWERKS__) || defined(applec) ||defined(THINK_C) ||defined(__SC__)
+00091 #  define NO_DUMMY_DECL
+00092 #endif
+00093 
+00094 /* Old Borland C incorrectly complains about missing returns: */
+00095 #if defined(__BORLANDC__) && (__BORLANDC__ < 0x500)
+00096 #  define NEED_DUMMY_RETURN
+00097 #endif
+00098 
+00099 
+00100 /* Maximum value for memLevel in deflateInit2 */
+00101 #ifndef MAX_MEM_LEVEL
+00102 #  ifdef MAXSEG_64K
+00103 #    define MAX_MEM_LEVEL 8
+00104 #  else
+00105 #    define MAX_MEM_LEVEL 9
+00106 #  endif
+00107 #endif
+00108 
+00109 /* Maximum value for windowBits in deflateInit2 and inflateInit2.
+00110  * WARNING: reducing MAX_WBITS makes minigzip unable to extract .gz files
+00111  * created by gzip. (Files created by minigzip can still be extracted by
+00112  * gzip.)
+00113  */
+00114 #ifndef MAX_WBITS
+00115 #  define MAX_WBITS   15 /* 32K LZ77 window */
+00116 #endif
+00117 
+00118 /* The memory requirements for deflate are (in bytes):
+00119             (1 << (windowBits+2)) +  (1 << (memLevel+9))
+00120  that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
+00121  plus a few kilobytes for small objects. For example, if you want to reduce
+00122  the default memory requirements from 256K to 128K, compile with
+00123      make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
+00124  Of course this will generally degrade compression (there's no free lunch).
+00125 
+00126    The memory requirements for inflate are (in bytes) 1 << windowBits
+00127  that is, 32K for windowBits=15 (default value) plus a few kilobytes
+00128  for small objects.
+00129 */
+00130 
+00131                         /* Type declarations */
+00132 
+00133 #ifndef OF /* function prototypes */
+00134 #  ifdef STDC
+00135 #    define OF(args)  args
+00136 #  else
+00137 #    define OF(args)  ()
+00138 #  endif
+00139 #endif
+00140 
+00141 /* The following definitions for FAR are needed only for MSDOS mixed
+00142  * model programming (small or medium model with some far allocations).
+00143  * This was tested only with MSC; for other MSDOS compilers you may have
+00144  * to define NO_MEMCPY in zutil.h.  If you don't need the mixed model,
+00145  * just define FAR to be empty.
+00146  */
+00147 #if (defined(M_I86SM) || defined(M_I86MM)) && !defined(__32BIT__)
+00148    /* MSC small or medium model */
+00149 #  define SMALL_MEDIUM
+00150 #  ifdef _MSC_VER
+00151 #    define FAR _far
+00152 #  else
+00153 #    define FAR far
+00154 #  endif
+00155 #endif
+00156 #if defined(__BORLANDC__) && (defined(__SMALL__) || defined(__MEDIUM__))
+00157 #  ifndef __32BIT__
+00158 #    define SMALL_MEDIUM
+00159 #    define FAR _far
+00160 #  endif
+00161 #endif
+00162 
+00163 /* Compile with -DZLIB_DLL for Windows DLL support */
+00164 #if defined(ZLIB_DLL)
+00165 #  if defined(_WINDOWS) || defined(WINDOWS)
+00166 #    ifdef FAR
+00167 #      undef FAR
+00168 #    endif
+00169 #    include <windows.h>
+00170 #    define ZEXPORT  WINAPI
+00171 #    ifdef WIN32
+00172 #      define ZEXPORTVA  WINAPIV
+00173 #    else
+00174 #      define ZEXPORTVA  FAR _cdecl _export
+00175 #    endif
+00176 #  endif
+00177 #  if defined (__BORLANDC__)
+00178 #    if (__BORLANDC__ >= 0x0500) && defined (WIN32)
+00179 #      include <windows.h>
+00180 #      define ZEXPORT __declspec(dllexport) WINAPI
+00181 #      define ZEXPORTRVA __declspec(dllexport) WINAPIV
+00182 #    else
+00183 #      if defined (_Windows) && defined (__DLL__)
+00184 #        define ZEXPORT _export
+00185 #        define ZEXPORTVA _export
+00186 #      endif
+00187 #    endif
+00188 #  endif
+00189 #endif
+00190 
+00191 #if defined (__BEOS__)
+00192 #  if defined (ZLIB_DLL)
+00193 #    define ZEXTERN extern __declspec(dllexport)
+00194 #  else
+00195 #    define ZEXTERN extern __declspec(dllimport)
+00196 #  endif
+00197 #endif
+00198 
+00199 #ifndef ZEXPORT
+00200 #  define ZEXPORT
+00201 #endif
+00202 #ifndef ZEXPORTVA
+00203 #  define ZEXPORTVA
+00204 #endif
+00205 #ifndef ZEXTERN
+00206 #  define ZEXTERN extern
+00207 #endif
+00208 
+00209 #ifndef FAR
+00210 #   define FAR
+00211 #endif
+00212 
+00213 #if !defined(MACOS) && !defined(TARGET_OS_MAC) && !defined(VCL)
+00214 typedef unsigned char  Byte;  /* 8 bits */
+00215 #endif
+00216 typedef unsigned int   uInt;  /* 16 bits or more */
+00217 typedef unsigned long  uLong; /* 32 bits or more */
+00218 
+00219 #ifdef SMALL_MEDIUM
+00220    /* Borland C/C++ and some old MSC versions ignore FAR inside typedef */
+00221 #  define Bytef Byte FAR
+00222 #else
+00223    typedef Byte  FAR Bytef;
+00224 #endif
+00225 typedef char  FAR charf;
+00226 typedef int   FAR intf;
+00227 typedef uInt  FAR uIntf;
+00228 typedef uLong FAR uLongf;
+00229 
+00230 #ifdef STDC
+00231    typedef void FAR *voidpf;
+00232    typedef void     *voidp;
+00233 #else
+00234    typedef Byte FAR *voidpf;
+00235    typedef Byte     *voidp;
+00236 #endif
+00237 
+00238 #ifdef HAVE_UNISTD_H
+00239 #  include <sys/types.h> /* for off_t */
+00240 #  include <unistd.h>    /* for SEEK_* and off_t */
+00241 #  define z_off_t  off_t
+00242 #endif
+00243 #ifndef SEEK_SET
+00244 #  define SEEK_SET        0       /* Seek from beginning of file.  */
+00245 #  define SEEK_CUR        1       /* Seek from current position.  */
+00246 #  define SEEK_END        2       /* Set file pointer to EOF plus "offset" */
+00247 #endif
+00248 #ifndef z_off_t
+00249 #  define  z_off_t long
+00250 #endif
+00251 
+00252 /* MVS linker does not support external names larger than 8 bytes */
+00253 #if defined(__MVS__)
+00254 #   pragma map(deflateInit_,"DEIN")
+00255 #   pragma map(deflateInit2_,"DEIN2")
+00256 #   pragma map(deflateEnd,"DEEND")
+00257 #   pragma map(inflateInit_,"ININ")
+00258 #   pragma map(inflateInit2_,"ININ2")
+00259 #   pragma map(inflateEnd,"INEND")
+00260 #   pragma map(inflateSync,"INSY")
+00261 #   pragma map(inflateSetDictionary,"INSEDI")
+00262 #   pragma map(inflate_blocks,"INBL")
+00263 #   pragma map(inflate_blocks_new,"INBLNE")
+00264 #   pragma map(inflate_blocks_free,"INBLFR")
+00265 #   pragma map(inflate_blocks_reset,"INBLRE")
+00266 #   pragma map(inflate_codes_free,"INCOFR")
+00267 #   pragma map(inflate_codes,"INCO")
+00268 #   pragma map(inflate_fast,"INFA")
+00269 #   pragma map(inflate_flush,"INFLU")
+00270 #   pragma map(inflate_mask,"INMA")
+00271 #   pragma map(inflate_set_dictionary,"INSEDI2")
+00272 #   pragma map(inflate_copyright,"INCOPY")
+00273 #   pragma map(inflate_trees_bits,"INTRBI")
+00274 #   pragma map(inflate_trees_dynamic,"INTRDY")
+00275 #   pragma map(inflate_trees_fixed,"INTRFI")
+00276 #   pragma map(inflate_trees_free,"INTRFR")
+00277 #endif
+00278 
+00279 #endif /* _ZCONF_H */
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zipcomprs_8h-source.html b/doc/api-documentation/html/zipcomprs_8h-source.html new file mode 100644 index 0000000..04fdcdb --- /dev/null +++ b/doc/api-documentation/html/zipcomprs_8h-source.html @@ -0,0 +1,53 @@ + + +zipcomprs.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zipcomprs.h

00001 /******************************************************************************
+00002  *  swcomprs.h   - definition of Class SWCompress used for data compression
+00003  *
+00004  * $Id: zipcomprs_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00005  *
+00006  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00007  *      CrossWire Bible Society
+00008  *      P. O. Box 2528
+00009  *      Tempe, AZ  85280-2528
+00010  *
+00011  * This program is free software; you can redistribute it and/or modify it
+00012  * under the terms of the GNU General Public License as published by the
+00013  * Free Software Foundation version 2.
+00014  *
+00015  * This program is distributed in the hope that it will be useful, but
+00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00018  * General Public License for more details.
+00019  *
+00020  */
+00021 
+00022 #ifndef ZIPCOMPRS_H
+00023 #define ZIPCOMPRS_H
+00024 
+00025 #include <swcomprs.h>
+00026 
+00027 #include <defs.h>
+00028 
+00029 class SWDLLEXPORT ZipCompress:public SWCompress
+00030 {
+00031 protected:
+00032 public:
+00033   ZipCompress ();
+00034   virtual ~ ZipCompress ();
+00035   virtual void Encode (void);
+00036   virtual void Decode (void);
+00037 };
+00038 
+00039 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zld_8h-source.html b/doc/api-documentation/html/zld_8h-source.html new file mode 100644 index 0000000..59646d1 --- /dev/null +++ b/doc/api-documentation/html/zld_8h-source.html @@ -0,0 +1,81 @@ + + +zld.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zld.h

00001 /******************************************************************************
+00002  *  zld.cpp - code for class 'zLD'- a module that reads compressed lexicon and
+00003  *                              dictionary files.
+00004  *
+00005  * $Id: zld_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef ZLD_H
+00024 #define ZLD_H
+00025 
+00026 #include <zstr.h>
+00027 #include <swld.h>
+00028 
+00029 #include <defs.h>
+00030 
+00031 class SWDLLEXPORT zLD:public zStr, public SWLD {
+00032 
+00033         void strongsPad (char *buf);
+00034         char getEntry (long away = 0);
+00035 
+00036 public:
+00037 
+00038 
+00039         zLD(const char *ipath, const char *iname = 0, const char *idesc = 0, long blockCount = 200, SWCompress *icomp = 0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00040         const char* ilang = 0);
+00041         virtual ~zLD();
+00042         virtual char *getRawEntry();
+00043 
+00044         virtual SWModule & operator =(SW_POSITION pos);
+00045         virtual SWModule & operator +=(int increment);
+00046         virtual SWModule & operator -=(int decrement) {
+00047                 return this->operator +=(-decrement);
+00048         }
+00049         // write interface ----------------------------
+00050         virtual bool isWritable () { return ((idxfd->getFd() > 0) && ((idxfd->mode & O_RDWR) == O_RDWR)); }
+00051         static char createModule (const char *path) {
+00052                 return zStr::createModule (path);
+00053         }
+00054 
+00055         virtual SWModule & setentry (const char *inbuf, long len);      // Modify current module entry
+00056         virtual SWModule & operator << (const char *inbuf);     // Modify current module entry
+00057         virtual SWModule & operator << (const SWKey * linkKey); // Link current module entry to other module entry
+00058         virtual void deleteEntry ();    // Delete current module entry
+00059         // end write interface ------------------------
+00060   
+00061         // swcacher interface ----------------------
+00062         virtual void flush() { flushCache(); }
+00063         // end swcacher interface ----------------------
+00064 };
+00065 
+00066 
+00067 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zstr_8h-source.html b/doc/api-documentation/html/zstr_8h-source.html new file mode 100644 index 0000000..47bf10b --- /dev/null +++ b/doc/api-documentation/html/zstr_8h-source.html @@ -0,0 +1,86 @@ + + +zstr.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zstr.h

00001 /*****************************************************************************
+00002  * zstr.h   - code for class 'zStr'- a module that reads compressed text
+00003  *                      files.
+00004  *                      and provides lookup and parsing functions based on
+00005  *                      class StrKey
+00006  *
+00007  * $Id: zstr_8h-source.html,v 1.3 2002/06/20 20:23:10 mgruner Exp $
+00008  *
+00009  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00010  *      CrossWire Bible Society
+00011  *      P. O. Box 2528
+00012  *      Tempe, AZ  85280-2528
+00013  *
+00014  * This program is free software; you can redistribute it and/or modify it
+00015  * under the terms of the GNU General Public License as published by the
+00016  * Free Software Foundation version 2.
+00017  *
+00018  * This program is distributed in the hope that it will be useful, but
+00019  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00021  * General Public License for more details.
+00022  *
+00023  */
+00024 
+00025 #ifndef ZSTR_H
+00026 #define ZSTR_H
+00027 
+00028 #include <filemgr.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 class SWCompress;
+00033 class EntriesBlock;
+00034 
+00035 class SWDLLEXPORT zStr {
+00036 
+00037 private:
+00038         static int instance;            // number of instantiated zStr objects or derivitives
+00039         EntriesBlock *cacheBlock;
+00040         long cacheBlockIndex;
+00041         bool cacheDirty;
+00042         char *path;
+00043         long lastoff;
+00044         long blockCount;
+00045         SWCompress *compressor;
+00046 
+00047 protected:
+00048         FileDesc *idxfd;
+00049         FileDesc *datfd;
+00050         FileDesc *zdxfd;
+00051         FileDesc *zdtfd;
+00052         static const int IDXENTRYSIZE;
+00053         static const int ZDXENTRYSIZE;
+00054 
+00055         void getCompressedText(long block, long entry, char **buf);
+00056         void flushCache();
+00057         void prepText(char *buf);
+00058         void getKeyFromDatOffset(long ioffset, char **buf);
+00059         void getKeyFromIdxOffset(long ioffset, char **buf);
+00060 
+00061 public:
+00062         char nl;
+00063         zStr(const char *ipath, int fileMode = -1, long blockCount = 100, SWCompress *icomp = 0);
+00064         virtual ~zStr();
+00065         signed char findKeyIndex(const char *ikey, long *idxoff, long away = 0);
+00066         void getText(long index, char **idxbuf, char **buf);
+00067         void setText(const char *ikey, const char *buf, long len = 0);
+00068         void linkEntry(const char *destkey, const char *srckey);
+00069         static signed char createModule (const char *path);
+00070 };
+00071 
+00072 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/ztext_8h-source.html b/doc/api-documentation/html/ztext_8h-source.html new file mode 100644 index 0000000..255a71f --- /dev/null +++ b/doc/api-documentation/html/ztext_8h-source.html @@ -0,0 +1,84 @@ + + +ztext.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

ztext.h

00001 /******************************************************************************
+00002  *  ztext.h   - code for class 'zText'- a module that reads compressed text
+00003  *                              files: ot and nt using indexs ??.vss
+00004  *
+00005  * $Id: ztext_8h-source.html,v 1.7 2002/06/20 20:23:10 mgruner Exp $
+00006  *
+00007  * Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
+00008  *      CrossWire Bible Society
+00009  *      P. O. Box 2528
+00010  *      Tempe, AZ  85280-2528
+00011  *
+00012  * This program is free software; you can redistribute it and/or modify it
+00013  * under the terms of the GNU General Public License as published by the
+00014  * Free Software Foundation version 2.
+00015  *
+00016  * This program is distributed in the hope that it will be useful, but
+00017  * WITHOUT ANY WARRANTY; without even the implied warranty of
+00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+00019  * General Public License for more details.
+00020  *
+00021  */
+00022 
+00023 #ifndef ZTEXT_H
+00024 #define ZTEXT_H
+00025 
+00026 #include <zverse.h>
+00027 #include <swtext.h>
+00028 //#include <swcomprs.h>
+00029 
+00030 #include <defs.h>
+00031 
+00032 /*** SWModule implementation for compressed modules
+00033 * This class handles compressed modules.
+00034 * It should not be used in frontends, unless you are doing very special things.
+00035 */
+00036 class SWDLLEXPORT zText:public zVerse, public SWText {
+00037      VerseKey *lastWriteKey;
+00038      bool sameBlock (VerseKey * lastWriteKey, VerseKey * key);
+00039         int blockType;
+00040 public:
+00041   
+00042     
+00043         zText(const char *ipath, const char *iname = 0, const char *idesc =
+00044            0, int blockType = CHAPTERBLOCKS, SWCompress * icomp =
+00045            0, SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN, SWTextDirection dir = DIRECTION_LTR, SWTextMarkup markup = FMT_UNKNOWN,
+00046            const char* ilang = 0);
+00047         virtual ~zText ();
+00048         virtual char *getRawEntry();
+00049 
+00050      virtual SWModule & operator += (int increment);
+00051      virtual SWModule & operator -= (int decrement) { return this->operator += (-decrement); }
+00052 
+00053   // write interface ----------------------------
+00054         virtual bool isWritable () { return ((idxfp[0]->getFd() > 0) && ((idxfp[0]->mode & O_RDWR) == O_RDWR)); }
+00055         static char createModule (const char *path, int blockBound) {
+00056                 return zVerse::createModule (path, blockBound);
+00057         }
+00058 
+00059      virtual SWModule & setentry (const char *inbuf, long len); // Modify current module entry
+00060      virtual SWModule & operator << (const char *inbuf);        // Modify current module entry
+00061      virtual SWModule & operator << (const SWKey * linkKey);    // Link current module entry to other module entry
+00062      virtual void deleteEntry ();       // Delete current module entry
+00063   // end write interface ------------------------
+00064   
+00065         // swcacher interface ----------------------
+00066         virtual void flush() { flushCache(); }
+00067         // end swcacher interface ----------------------
+00068 };
+00069 
+00070 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + diff --git a/doc/api-documentation/html/zverse_8h-source.html b/doc/api-documentation/html/zverse_8h-source.html new file mode 100644 index 0000000..5620f71 --- /dev/null +++ b/doc/api-documentation/html/zverse_8h-source.html @@ -0,0 +1,70 @@ + + +zverse.h Source File + + + +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  
+

zverse.h

00001 /******************************************************************************
+00002  *  rawverse.h   - code for class 'RawVerse'- a module that reads raw text
+00003  *                      files:  ot and nt using indexs ??.bks ??.cps ??.vss
+00004  *                      and provides lookup and parsing functions based on
+00005  *                      class VerseKey
+00006  */
+00007 
+00008 #ifndef ZVERSE_H
+00009 #define ZVERSE_H
+00010 
+00011 #include <filemgr.h>
+00012 #include <fcntl.h>
+00013 #include <rawverse.h>
+00014 #include <swcomprs.h>
+00015 
+00016 #include <defs.h>
+00017 
+00018 class SWDLLEXPORT zVerse {
+00019         SWCompress *compressor;
+00020 
+00021 protected:
+00022         static int instance;            // number of instantiated RawVerse objects or derivitives
+00023 
+00024         FileDesc *idxfp[2];
+00025         FileDesc *textfp[2];
+00026         FileDesc *compfp[2];
+00027         char *path;
+00028         void preptext (char *buf);
+00029         void settext (char testmt, long idxoff, const char *buf, long len = 0);
+00030         void linkentry (char testmt, long destidxoff, long srcidxoff);
+00031         void flushCache ();
+00032         //RawVerse();
+00033         char *cacheBuf;
+00034         char cacheTestament;
+00035         long cacheBufIdx;
+00036         bool dirtyCache;
+00037 
+00038 public:
+00039 
+00040 #define VERSEBLOCKS 2
+00041 #define CHAPTERBLOCKS 3
+00042 #define BOOKBLOCKS 4
+00043 
+00044         static const char uniqueIndexID[];
+00045         char nl;
+00046 
+00047 
+00048         zVerse (const char *ipath, int fileMode = O_RDONLY, int blockType = CHAPTERBLOCKS, SWCompress * icomp = 0);
+00049         virtual ~ zVerse ();
+00050         void findoffset (char testmt, long idxoff, long *start, unsigned short *end);
+00051         void swgettext (char testmt, long start, unsigned short size, char *buf);
+00052         static char createModule (const char *path, int blockBound);
+00053 };
+00054 
+00055 
+00056 #endif
+
Generated on Thu Jun 20 22:13:01 2002 for The Sword Project by + +doxygen1.2.15
+ + -- cgit