[sword-svn] r3786 - in trunk: include src/mgr src/modules/common
scribe at crosswire.org
scribe at crosswire.org
Sun Aug 30 07:35:14 EDT 2020
Author: scribe
Date: 2020-08-30 07:35:14 -0400 (Sun, 30 Aug 2020)
New Revision: 3786
Modified:
trunk/include/bz2comprs.h
trunk/include/cipherfil.h
trunk/include/curlftpt.h
trunk/include/curlhttpt.h
trunk/include/echomod.h
trunk/include/encfiltmgr.h
trunk/include/entriesblk.h
trunk/include/femain.h
trunk/include/filemgr.h
trunk/include/ftplibftpt.h
trunk/include/gbffootnotes.h
trunk/include/gbfheadings.h
trunk/include/gbfhtml.h
trunk/include/gbfhtmlhref.h
trunk/include/gbflatex.h
trunk/include/gbfmorph.h
trunk/include/gbfosis.h
trunk/include/gbfplain.h
trunk/include/gbfredletterwords.h
trunk/include/gbfrtf.h
trunk/include/gbfstrongs.h
trunk/include/gbfthml.h
trunk/include/gbfwebif.h
trunk/include/gbfwordjs.h
trunk/include/gbfxhtml.h
trunk/include/greeklexattribs.h
trunk/include/hebrewmcim.h
trunk/include/hrefcom.h
trunk/include/installmgr.h
trunk/include/latin1utf16.h
trunk/include/latin1utf8.h
trunk/include/listkey.h
trunk/include/localemgr.h
trunk/include/lzsscomprs.h
trunk/include/markupfiltmgr.h
trunk/include/multimapwdef.h
trunk/include/nullim.h
trunk/include/osisenum.h
trunk/include/osisfootnotes.h
trunk/include/osisglosses.h
trunk/include/osisheadings.h
trunk/include/osishtmlhref.h
trunk/include/osislatex.h
trunk/include/osislemma.h
trunk/include/osismorph.h
trunk/include/osismorphsegmentation.h
trunk/include/osisosis.h
trunk/include/osisplain.h
trunk/include/osisredletterwords.h
trunk/include/osisreferencelinks.h
trunk/include/osisrtf.h
trunk/include/osisscripref.h
trunk/include/osisstrongs.h
trunk/include/osisvariants.h
trunk/include/osiswebif.h
trunk/include/osiswordjs.h
trunk/include/osisxhtml.h
trunk/include/osisxlit.h
trunk/include/papyriplain.h
trunk/include/rawcom.h
trunk/include/rawcom4.h
trunk/include/rawfiles.h
trunk/include/rawgenbook.h
trunk/include/rawld.h
trunk/include/rawld4.h
trunk/include/rawstr.h
trunk/include/rawstr4.h
trunk/include/rawtext.h
trunk/include/rawtext4.h
trunk/include/rawverse.h
trunk/include/rawverse4.h
trunk/include/remotetrans.h
trunk/include/roman.h
trunk/include/rtfhtml.h
trunk/include/rtranspgdrive.h
trunk/include/sapphire.h
trunk/include/scsuutf8.h
trunk/include/stringmgr.h
trunk/include/strkey.h
trunk/include/swbasicfilter.h
trunk/include/swbuf.h
trunk/include/swcacher.h
trunk/include/swcipher.h
trunk/include/swcom.h
trunk/include/swcomprs.h
trunk/include/swconfig.h
trunk/include/swdisp.h
trunk/include/swfilter.h
trunk/include/swfiltermgr.h
trunk/include/swgenbook.h
trunk/include/swinputmeth.h
trunk/include/swkey.h
trunk/include/swld.h
trunk/include/swlocale.h
trunk/include/swlog.h
trunk/include/swmgr.h
trunk/include/swmodule.h
trunk/include/swobject.h
trunk/include/swoptfilter.h
trunk/include/swsearchable.h
trunk/include/swtext.h
trunk/include/sysdata.h
trunk/include/teihtmlhref.h
trunk/include/teilatex.h
trunk/include/teiplain.h
trunk/include/teirtf.h
trunk/include/teixhtml.h
trunk/include/thmlfootnotes.h
trunk/include/thmlgbf.h
trunk/include/thmlheadings.h
trunk/include/thmlhtml.h
trunk/include/thmlhtmlhref.h
trunk/include/thmllatex.h
trunk/include/thmllemma.h
trunk/include/thmlmorph.h
trunk/include/thmlosis.h
trunk/include/thmlplain.h
trunk/include/thmlrtf.h
trunk/include/thmlscripref.h
trunk/include/thmlstrongs.h
trunk/include/thmlvariants.h
trunk/include/thmlwebif.h
trunk/include/thmlwordjs.h
trunk/include/thmlxhtml.h
trunk/include/treekey.h
trunk/include/treekeyidx.h
trunk/include/unicodertf.h
trunk/include/url.h
trunk/include/utf16utf8.h
trunk/include/utf8arabicpoints.h
trunk/include/utf8arshaping.h
trunk/include/utf8bidireorder.h
trunk/include/utf8cantillation.h
trunk/include/utf8greekaccents.h
trunk/include/utf8hebrewpoints.h
trunk/include/utf8html.h
trunk/include/utf8latin1.h
trunk/include/utf8nfc.h
trunk/include/utf8nfkd.h
trunk/include/utf8scsu.h
trunk/include/utf8transliterator.h
trunk/include/utf8utf16.h
trunk/include/utilxml.h
trunk/include/versekey.h
trunk/include/versetreekey.h
trunk/include/versificationmgr.h
trunk/include/xzcomprs.h
trunk/include/zcom.h
trunk/include/zcom4.h
trunk/include/zipcomprs.h
trunk/include/zld.h
trunk/include/zstr.h
trunk/include/ztext.h
trunk/include/ztext4.h
trunk/include/zverse.h
trunk/include/zverse4.h
trunk/src/mgr/swmgr.cpp
trunk/src/modules/common/sapphire.cpp
Log:
Finalize refactoring for 1.9 release and clean up heading comments
Modified: trunk/include/bz2comprs.h
===================================================================
--- trunk/include/bz2comprs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/bz2comprs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * bz2comprs.h - Bzip2Compress, a driver class that provides bzip2
+ * bz2comprs.h - class Bzip2Compress, a driver class that provides bzip2
* compression (Burrows–Wheeler with Huffman coding)
*
* $Id$
Modified: trunk/include/cipherfil.h
===================================================================
--- trunk/include/cipherfil.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/cipherfil.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * cipherfil.h -
+ * cipherfil.h - class CipherFilter: an EncodingFilter which can
+ * encipher an decipher a text stream based on
+ * a CipherKey
*
* $Id$
*
@@ -29,7 +31,7 @@
class SWCipher;
-class SWDLLEXPORT CipherFilter:public SWFilter {
+class SWDLLEXPORT CipherFilter : public SWFilter {
SWCipher *cipher;
public:
CipherFilter(const char *key);
Modified: trunk/include/curlftpt.h
===================================================================
--- trunk/include/curlftpt.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/curlftpt.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * curlftpt.h - code for CURL impl of FTP Transport
+ * curlftpt.h - CURL FTP implementation of RemoteTransport
*
* $Id$
*
Modified: trunk/include/curlhttpt.h
===================================================================
--- trunk/include/curlhttpt.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/curlhttpt.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * curlhttpt.h - code for CURL impl of HTTP Transport
+ * curlhttpt.h - CURL HTTP(S) implementation of RemoteTransport
*
* $Id$
*
Modified: trunk/include/echomod.h
===================================================================
--- trunk/include/echomod.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/echomod.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * echomod.h - code for class 'EchoMod' - a test module that just echo back
+ * echomod.h - class 'EchoMod' - a test module driver that will just echo back
* text of key.
*
* $Id$
@@ -30,8 +30,7 @@
SWORD_NAMESPACE_START
-class SWDLLEXPORT EchoMod : public SWText
-{
+class SWDLLEXPORT EchoMod : public SWText {
public:
EchoMod();
virtual ~EchoMod();
Modified: trunk/include/encfiltmgr.h
===================================================================
--- trunk/include/encfiltmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/encfiltmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,8 @@
/******************************************************************************
*
- * encfiltmgr.h - definition of class SWEncodingMgr, subclass of
- * used to transcode all module text to a requested
- * markup
+ * encfiltmgr.h - class SWEncodingMgr: a FilterMgr which applies
+ * appropriate EncodingFilters to obtain a requested
+ * encoding
*
* $Id$
*
Modified: trunk/include/entriesblk.h
===================================================================
--- trunk/include/entriesblk.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/entriesblk.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * entriesblk.h - Definition of EntriesBlock
+ * entriesblk.h - class EntriesBlock: a helper class for module drivers
+ * which support compressed blocks of multiple entries
*
* $Id$
*
Modified: trunk/include/femain.h
===================================================================
--- trunk/include/femain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/femain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * femain.h - Definition of FEMain
+ * femain.h - class FEMain: a class which was meant to begin encapsulating
+ * frontend frameworks, but never really took off. Mostly unused.
*
* $Id$
*
@@ -23,12 +24,11 @@
#ifndef FEMAIN_H
#define FEMAIN_H
-class FEMain
-{
+class FEMain {
public:
FEMain();
virtual ~FEMain();
- list <SWDisplay *> displays; // so we can delete each display we create
+ list<SWDisplay *> displays; // so we can delete each display we create
};
#endif
Modified: trunk/include/filemgr.h
===================================================================
--- trunk/include/filemgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/filemgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * filemgr.h - definition of class FileMgr used for pooling file handles
+ * filemgr.h - class FileMgr: encapsulates all file IO and
+ * platform-specific eccentricities.
*
* $Id$
*
Modified: trunk/include/ftplibftpt.h
===================================================================
--- trunk/include/ftplibftpt.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/ftplibftpt.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,6 @@
/******************************************************************************
*
- * ftplibftpt.h - code for ftplib impl of FTP Transport
- * (FTPLibFTPTransport)
+ * ftplibftpt.h - Implementation of FTP RemoteTransport using FTPLib
*
* $Id$
*
Modified: trunk/include/gbffootnotes.h
===================================================================
--- trunk/include/gbffootnotes.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbffootnotes.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbffootnotes.h - Definition of GBFFootnotes
+ * gbffootnotes.h - class GBFFootnotes: an OptionFilter for handling
+ * footnotes in modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfheadings.h
===================================================================
--- trunk/include/gbfheadings.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfheadings.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfheadings.h - Definition of GBFHeadings
+ * gbfheadings.h - class GBFHeadings: an OptionFilter class for
+ * handling headings in modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfhtml.h
===================================================================
--- trunk/include/gbfhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * gbfhtml.h - Definition of GBFHTML
+ * gbfhtml.h - class GBFHTML: a RenderFilter for rendering HTML from
+ * modules marked up in GBF
*
* $Id$
*
@@ -31,11 +32,13 @@
*/
class SWDLLEXPORT GBFHTML : public SWBasicFilter {
protected:
+
class MyUserData : public BasicFilterUserData {
public:
MyUserData(const SWModule *module, const SWKey *key) : BasicFilterUserData(module, key) {}
bool hasFootnotePreTag;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
Modified: trunk/include/gbfhtmlhref.h
===================================================================
--- trunk/include/gbfhtmlhref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfhtmlhref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * gbfhtmlhref.h - Definition of GBFHTMLHREF
+ * gbfhtmlhref.h - class GBFHTMLHREF: a RenderFilter for rendering
+ * HTMLHREF from modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbflatex.h
===================================================================
--- trunk/include/gbflatex.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbflatex.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * gbflatex.h - Definition of GBFLaTeX
+ * gbflatex.h - class GBFLaTeX: a RenderFilter to render LaTeX from modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfmorph.h
===================================================================
--- trunk/include/gbfmorph.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfmorph.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfmorph.h - Definition of GBFMorph
+ * gbfmorph.h - class GBFMorph: an OptionFilter to handle morphology in
+ * modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfosis.h
===================================================================
--- trunk/include/gbfosis.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfosis.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfosis.h - Definition of GBFOSIS
+ * gbfosis.h - class GBFOSIS: a RenderFilter to render OSIS from modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfplain.h
===================================================================
--- trunk/include/gbfplain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfplain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/***************************************************************************
*
- * gbfplain.h - Definition of GBFPlain
+ * gbfplain.h - class GBFPlain: a StripFilter for modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfredletterwords.h
===================================================================
--- trunk/include/gbfredletterwords.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfredletterwords.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * gbfredletterwords.h - Definition of GBFRedLetterWords
+ * gbfredletterwords.h - class GBFRedLetterWords: an OptionFilter to
+ * handle Red Letter Words of Christ in modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfrtf.h
===================================================================
--- trunk/include/gbfrtf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfrtf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfrtf.h - Definition of GBFRTF
+ * gbfrtf.h - class GBFRTF: a RenderFilter to render RTF from modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfstrongs.h
===================================================================
--- trunk/include/gbfstrongs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfstrongs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfstrongs.h - Definition of GBFStrongs
+ * gbfstrongs.h - class GBFStrongs: an OptionFilter to handle Strongs
+ * numbers on each word for modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfthml.h
===================================================================
--- trunk/include/gbfthml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfthml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * gbfhtml.h - Definition of GBFHTML
+ * gbfhtml.h - class GBFHTML: a RenderFilter to render HTML from modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfwebif.h
===================================================================
--- trunk/include/gbfwebif.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfwebif.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * gbfwebif.h - Definition of GBFWEBIF
+ * gbfwebif.h - class GBFWEBIF: a RenderFilter to render WEBIF markup from
+ * modules marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfwordjs.h
===================================================================
--- trunk/include/gbfwordjs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfwordjs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * gbfwordjs.h - Definition of GBFWordJS
+ * gbfwordjs.h - class GBFWordJS: an OptionFilter to inject
+ * JavaScript (mostly onclick events) for modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/gbfxhtml.h
===================================================================
--- trunk/include/gbfxhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/gbfxhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * gbfxhtml.h - Definition of GBFXHTML
+ * gbfxhtml.h - class GBFXHTML: a RenderFilter to render XHTML from modules
+ * marked up in GBF
*
* $Id$
*
Modified: trunk/include/greeklexattribs.h
===================================================================
--- trunk/include/greeklexattribs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/greeklexattribs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * greeklexattribs.h - Definition of GreekLexAttribs
+ * greeklexattribs.h - class GreekLexAttribs: an OptionFilter to handle
+ * Greek Lexicon attributes for modules marked up
+ * in TEI
*
* $Id$
*
@@ -27,7 +29,7 @@
SWORD_NAMESPACE_START
-/** this filter converts ThML text to plain text
+/** an OptionFilter to handle Greek Lexicon attributes for modules marked up in TEI
*/
class SWDLLEXPORT GreekLexAttribs : public SWOptionFilter {
public:
Modified: trunk/include/hebrewmcim.h
===================================================================
--- trunk/include/hebrewmcim.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/hebrewmcim.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * hebrewmcim.h - Definition of HebrewMCIM
+ * hebrewmcim.h - class HebrewMCIM: a InputMethod for Hebrew
+ * Michigan / Claremont input standard
*
* $Id$
*
@@ -40,6 +41,7 @@
class SWDLLEXPORT HebrewMCIM : public SWInputMethod {
+private:
void init();
int subst[255];
map<int, int> subst2[12];
Modified: trunk/include/hrefcom.h
===================================================================
--- trunk/include/hrefcom.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/hrefcom.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,8 @@
/******************************************************************************
*
- * hrefcom.h - code for class 'HREFCom'- a module that produces HTML HREFs
- * pointing to actual text desired. Uses standard
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
+ * hrefcom.h - class HREFCom: a module driver that supports commentary
+ * entries which don't store their text body, but instead a URL
+ * where the text body can be retrieved.
*
* $Id$
*
@@ -32,21 +32,19 @@
SWORD_NAMESPACE_START
-class SWDLLEXPORT HREFCom:public RawVerse, public SWCom {
+class SWDLLEXPORT HREFCom : public RawVerse, public SWCom {
+
+private:
char *prefix;
public:
-
-
- HREFCom(const char *ipath, const char *prefix, const char *iname = 0,
- const char *idesc = 0, SWDisplay * idisp = 0);
+ HREFCom(const char *ipath, const char *prefix, const char *iname = 0, const char *idesc = 0, SWDisplay * idisp = 0);
virtual ~HREFCom();
virtual SWBuf &getRawEntryBuf() const;
// OPERATORS -----------------------------------------------------------------
SWMODULE_OPERATORS
-
};
SWORD_NAMESPACE_END
Modified: trunk/include/installmgr.h
===================================================================
--- trunk/include/installmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/installmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * installmgr.h - Definition of InstallMgr
+ * installmgr.h - class InstallMgr: primary class to access all
+ * module installation functionality
*
* $Id$
*
Modified: trunk/include/latin1utf16.h
===================================================================
--- trunk/include/latin1utf16.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/latin1utf16.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * latin1utf16.h - Definition of Latin1UTF16
+ * latin1utf16.h - class Latin1UTF16: an EncodingFilter to convert
+ * Latin1 text into UTF16
*
* $Id$
*
Modified: trunk/include/latin1utf8.h
===================================================================
--- trunk/include/latin1utf8.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/latin1utf8.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * latin1utf8.h - Definition of Latin1UTF8
+ * latin1utf8.h - class Latin1UTF8: an EncodingFilter to convert
+ * Latin1 text to UTF8
*
* $Id$
*
Modified: trunk/include/listkey.h
===================================================================
--- trunk/include/listkey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/listkey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,10 @@
/******************************************************************************
*
- * listkey.h - code for base class 'listkey'. listkey is the basis for all
- * types of keys for indexing into modules
- * (e.g. verse, word, place, etc.)
+ * listkey.h - class ListKey: a container Key which facilitates a list of
+ * SWKey objects. This is useful for search results or returning
+ * the result of parsing freetext verse ranges. The usefulness
+ * of having this container of keys itself be an SWKey is that it
+ * can be used natively by an SWModule to iterate the results.
*
* $Id$
*
@@ -31,9 +33,7 @@
SWORD_NAMESPACE_START
-/** ListKey is the basis for all
- * types of keys that have lists of specified indexes
- * (e.g. a list of verses, place, etc.)
+/** ListKey is a container SWKey which faciliates a list of SWKey objects
*/
class SWDLLEXPORT ListKey : public SWKey {
Modified: trunk/include/localemgr.h
===================================================================
--- trunk/include/localemgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/localemgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * localemgr.h - definition of class LocaleMgr used to interact with
- * registered locales for a sword installation
+ * localemgr.h - class LocaleMgr: used to interact with
+ * SWORD locales
*
* $Id$
*
@@ -35,9 +35,9 @@
class SWLocale;
typedef std::list<SWBuf> StringList;
-typedef std::map < SWBuf, SWLocale *, std::less < SWBuf > > LocaleMap;
+typedef std::map<SWBuf, SWLocale *, std::less<SWBuf> > LocaleMap;
/**
-* The LocaleMgr class handles all the different locales of Sword.
+* The LocaleMgr class handles all the different locales of SWORD.
* It provides functions to get a list of all available locales,
* to get the default locale name and to get it.
* The other functions are not interesting for frontend programmers.
@@ -48,11 +48,13 @@
* To get a list of availble locales use @see getAvailableLocales
*/
class SWDLLEXPORT LocaleMgr {
+
private:
void deleteLocales();
char *defaultLocaleName;
LocaleMgr(const LocaleMgr &);
friend class __staticsystemLocaleMgr;
+
protected:
LocaleMap *locales;
static LocaleMgr *systemLocaleMgr;
@@ -60,7 +62,7 @@
public:
/** Default constructor of LocaleMgr
- * You do normally not need this constructor, use LocaleMgr::getSystemLocaleMgr() instead.
+ * You do not normally need this constructor; use LocaleMgr::getSystemLocaleMgr() instead.
*/
LocaleMgr(const char *iConfigPath = 0);
@@ -69,7 +71,7 @@
*/
virtual ~LocaleMgr();
- /** Get the locale connected with the name "name".
+ /** Get a locale object by name
*
* @param name The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language.
* @return Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL.
@@ -86,7 +88,7 @@
* This function uses both parameters to return the translated version of the given text.
*
* @param text The text to translate into the language given by the first parameter.
- * @param localeName The name of the locale Sword should use
+ * @param localeName The name of the locale SWORD should use
* @return Returns the translated text.
*/
virtual const char *translate(const char *text, const char *localeName = 0);
@@ -97,19 +99,19 @@
*/
virtual const char *getDefaultLocaleName();
- /** Set the new standard locale of Sword.
+ /** Set the new standard locale of SWORD.
*
* @param name The name of the new default locale
*/
virtual void setDefaultLocaleName(const char *name);
- /** The LocaleMgr object used globally in the Sword world.
+ /** The LocaleMgr object used globally in the SWORD world.
* Do not create your own LocaleMgr, use this static object instead.
*/
static LocaleMgr *getSystemLocaleMgr();
static void setSystemLocaleMgr(LocaleMgr *newLocaleMgr);
- /** Augment this localmgr with all locale.conf files in a directory
+ /** Augment this LocalMgr object with all locale.conf files in a directory
*/
virtual void loadConfigDir(const char *ipath);
Modified: trunk/include/lzsscomprs.h
===================================================================
--- trunk/include/lzsscomprs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/lzsscomprs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * lzsscomprs.h - definition of Class SWCompress used for data
- * compression
+ * lzsscomprs.h - class LZSSCompress: SWCompress implementation
+ * using LZSS
*
* $Id$
*
Modified: trunk/include/markupfiltmgr.h
===================================================================
--- trunk/include/markupfiltmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/markupfiltmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,8 @@
/******************************************************************************
*
- * markupfiltmgr.h - definition of class SWMarkupMgr, subclass of
- * used to transcode all module text to a requested
- * markup
+ * markupfiltmgr.h - class SWMarkupMgr: a FilterManager which applied
+ * the appropriate Markup and Encoding filters to obtain
+ * a requested Render markup and encoding
*
* Copyright 2001-2013 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
Modified: trunk/include/multimapwdef.h
===================================================================
--- trunk/include/multimapwdef.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/multimapwdef.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,9 @@
/******************************************************************************
*
- * multimapwdef.h - Definition of multimapwithdefault
+ * multimapwdef.h - template multimapwithdefault: a template which extends
+ * multipmap with easy access operators to
+ * obtain entries which are not repeated, plus a few
+ * nice convenience methods
*
* $Id$
*
Modified: trunk/include/nullim.h
===================================================================
--- trunk/include/nullim.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/nullim.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * nullim.h - Definition of NullIM
+ * nullim.h - class NullIM: an InputMethod which simply returns the key typed
*
* $Id$
*
Modified: trunk/include/osisenum.h
===================================================================
--- trunk/include/osisenum.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisenum.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisenum.h - Definition of OSISEnum
+ * osisenum.h - class OSISEnum: an OptionFilter to handle n attibutes on words
+ * in an module marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides word n attributes in an OSIS text
*/
class SWDLLEXPORT OSISEnum : public SWOptionFilter {
public:
Modified: trunk/include/osisfootnotes.h
===================================================================
--- trunk/include/osisfootnotes.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisfootnotes.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisfootnotes.h - Definition of OSISFootnotes
+ * osisfootnotes.h - class OSISFootnotes: an OptionFilter which handles
+ * footnotes in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides footnotes in a OSIS text
*/
class SWDLLEXPORT OSISFootnotes : public SWOptionFilter {
public:
Modified: trunk/include/osisglosses.h
===================================================================
--- trunk/include/osisglosses.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisglosses.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisglosses.h - Definition of OSISGlosses
+ * osisglosses.h - class OSISGlosses: an OptionFilter which handles
+ * glosses in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides glosses in a OSIS text
*/
class SWDLLEXPORT OSISGlosses : public SWOptionFilter {
public:
Modified: trunk/include/osisheadings.h
===================================================================
--- trunk/include/osisheadings.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisheadings.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisheadings.h - Definition of OSISHeadings
+ * osisheadings.h - class OSISHeadings: an OptionFilter which handles
+ * headings in modules marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osishtmlhref.h
===================================================================
--- trunk/include/osishtmlhref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osishtmlhref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osishtmlhref.h - Definition of OSISHTMLHREF
+ * osishtmlhref.h - class OSISHTMLHREF: a RenderFilter to render HTMLHREF
+ * from modules marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osislatex.h
===================================================================
--- trunk/include/osislatex.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osislatex.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osislatex.h - Render filter for LaTeX of an OSIS module
+ * osislatex.h - class OSISLaTeX: a RenderFilter which renders LaTeX
+ * from a module marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** this filter converts OSIS text to classed XHTML
+/** this filter converts OSIS text to LaTeX
*/
class SWDLLEXPORT OSISLaTeX : public SWBasicFilter {
private:
Modified: trunk/include/osislemma.h
===================================================================
--- trunk/include/osislemma.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osislemma.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osislemma.h - Definition of OSISLemma
+ * osislemma.h - class OSISLemma: an OptionFilter to handle lemma
+ * entries on words in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides lemmata in an OSIS text
*/
class SWDLLEXPORT OSISLemma : public SWOptionFilter {
public:
Modified: trunk/include/osismorph.h
===================================================================
--- trunk/include/osismorph.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osismorph.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * osismorph.h - Definition of OSISMorph
+ * osismorph.h - class OSISMorph: an OptionFilter to handle morph
+ * information on words in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides morph tags in a OSIS text
+/** This Filter shows/hides morph tags in an OSIS text
*/
class SWDLLEXPORT OSISMorph : public SWOptionFilter {
public:
Modified: trunk/include/osismorphsegmentation.h
===================================================================
--- trunk/include/osismorphsegmentation.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osismorphsegmentation.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/******************************************************************************
*
- * osismorphsegmentation.h - Definition of OSISMorphSegmentation
+ * osismorphsegmentation.h - class OSISMorphSegmentation: and OptionFilter
+ * to hand word morpheme segmentation in modules
+ * marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osisosis.h
===================================================================
--- trunk/include/osisosis.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisosis.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisosis.h - Definition of OSISOSIS
+ * osisosis.h - class OSISOSIS: a RenderFilter to render OSIS from modules
+ * marked up in OSIS with SWORD markup extensions
*
* $Id$
*
Modified: trunk/include/osisplain.h
===================================================================
--- trunk/include/osisplain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisplain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisplain.h - Definition of OSISPlain
+ * osisplain.h - class OSISPlain: a StripFilter for modules marked up
+ * in OSIS
*
* $Id$
*
@@ -28,7 +29,7 @@
SWORD_NAMESPACE_START
-/** this filter converts OSIS text to plain text
+/** this filter converts OSIS text to plain text; primary stripFilter for OSIS
*/
class SWDLLEXPORT OSISPlain : public SWBasicFilter {
public:
Modified: trunk/include/osisredletterwords.h
===================================================================
--- trunk/include/osisredletterwords.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisredletterwords.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/******************************************************************************
*
- * osisredletterwords.h - Definition of OSISRedLetterWords
+ * osisredletterwords.h - class OSISRedLetterWords: an OptionFilter to
+ * handle Red Letter Words of Christ for modules
+ * marked up in OSIS
*
* $Id$
*
@@ -27,7 +29,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides red letters for words of Christ in an OSIS text
*/
class SWDLLEXPORT OSISRedLetterWords : public SWOptionFilter {
public:
Modified: trunk/include/osisreferencelinks.h
===================================================================
--- trunk/include/osisreferencelinks.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisreferencelinks.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,9 @@
/******************************************************************************
*
- * osisreferencelinks.h - SWFilter descendant to toggle OSIS reference
- * links with specified type/subType
+ * osisreferencelinks.h - class OSISReferenceLinks: an OptionFilter to
+ * handle reference links having
+ * specified type/subType in modules marked up
+ * in OSIS
*
* $Id$
*
Modified: trunk/include/osisrtf.h
===================================================================
--- trunk/include/osisrtf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisrtf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisrtf.h - Definition of OSISRTF
+ * osisrtf.h - class OSISRTF: a RenderFilter to render RTF from modules
+ * marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osisscripref.h
===================================================================
--- trunk/include/osisscripref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisscripref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisscripref.h - Definition of OSISScripRef
+ * osisscripref.h - class OSISScripRef: an OptionFilter to handle
+ * cross-references in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides cross-references in a OSIS text
*/
class SWDLLEXPORT OSISScripref : public SWOptionFilter {
public:
Modified: trunk/include/osisstrongs.h
===================================================================
--- trunk/include/osisstrongs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisstrongs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * osisstrongs.h - Definition of OSISStrongs
+ * osisstrongs.h - class OSISStrongs: an OptionFilter to handle
+ * Strongs numbers on words in modules marked up
+ * is OSIS
*
* $Id$
*
Modified: trunk/include/osisvariants.h
===================================================================
--- trunk/include/osisvariants.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisvariants.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisvariants.h - Definition of OSISVariants
+ * osisvariants.h - class OSISVariants: an OptionFilter to handle variants
+ * in modules marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osiswebif.h
===================================================================
--- trunk/include/osiswebif.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osiswebif.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osiswebif.h - Definition of OSISWEBIF
+ * osiswebif.h - class OSISWEBIF: a RenderFilter to render WEBIF markup
+ * from modules marked up in OSIS
*
* $Id$
*
Modified: trunk/include/osiswordjs.h
===================================================================
--- trunk/include/osiswordjs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osiswordjs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * osiswordjs.h - Definition of OSISWordJS
+ * osiswordjs.h - class OSISWordJS: an OptionFilter to inject
+ * JavaScript (mostly for onclick events) for modules
+ * marked up in OSIS
*
* $Id$
*
@@ -29,7 +31,7 @@
class SWMgr;
-/** This Filter shows/hides strong's numbers in a OSIS text
+/** This Filter inject JavaScript proving onclick events for modules marked up in OSIS
*/
class SWDLLEXPORT OSISWordJS : public SWOptionFilter {
SWModule *defaultGreekLex;
Modified: trunk/include/osisxhtml.h
===================================================================
--- trunk/include/osisxhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisxhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisxhtml.h - Render filter for classed XHTML of an OSIS module
+ * osisxhtml.h - class OSISXHTML: a RenderFilter to render classed XHTML
+ * markup for modules marked up in OSIS
*
* $Id$
*
@@ -30,11 +31,12 @@
/** this filter converts OSIS text to classed XHTML
*/
class SWDLLEXPORT OSISXHTML : public SWBasicFilter {
+
private:
bool morphFirst;
bool renderNoteNumbers;
+
protected:
-
class TagStack;
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key);
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
Modified: trunk/include/osisxlit.h
===================================================================
--- trunk/include/osisxlit.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/osisxlit.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * osisxlit.h - Definition of OSISXlit
+ * osisxlit.h - class OSISXlit: an OptionFilter to handle transliteration
+ * information on words in modules marked up in OSIS
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides headings in a OSIS text
+/** This Filter shows/hides transliterations in an OSIS text
*/
class SWDLLEXPORT OSISXlit : public SWOptionFilter {
public:
Modified: trunk/include/papyriplain.h
===================================================================
--- trunk/include/papyriplain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/papyriplain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/***************************************************************************
*
- * papyriplain.h - Definition of PapyriPlain
+ * papyriplain.h - class PapyriPlain: a StripFilter to remove Leiden
+ * markup from modules
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This filter converts Papyri text to plain text
+/** This filter converts Papyri text to plain text. stripFilter to remove Leiden markup from manuscript transcriptions
*/
class SWDLLEXPORT PapyriPlain : public SWOptionFilter {
public:
Modified: trunk/include/rawcom.h
===================================================================
--- trunk/include/rawcom.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawcom.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * rawcom.h - code for class 'RawCom'- a module that reads raw commentary
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawcom.h - class RawCom: a module driver that supports commentary
+ * modules uncompressed with entry size 2 bytes or less
*
* $Id$
*
Modified: trunk/include/rawcom4.h
===================================================================
--- trunk/include/rawcom4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawcom4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * rawcom4.h - code for class 'RawCom4'- a module that reads raw commentary
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawcom4.h - class RawCom4: a module driver that supports commentary
+ * modules uncompressed with entries requiring up to 4 bytes size
*
* $Id$
*
Modified: trunk/include/rawfiles.h
===================================================================
--- trunk/include/rawfiles.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawfiles.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,7 @@
/******************************************************************************
*
- * rawfiles.h - code for class 'RawFiles'- a module that produces HTML
- * HREFs pointing to actual text desired. Uses standard
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawfiles.h - class RawFiles: a module driver that reads and writes
+ * entries each to separate files on the filesystem
*
* $Id$
*
@@ -34,11 +33,10 @@
class SWDLLEXPORT RawFiles : public RawVerse, public SWCom {
+private:
const char *getNextFilename();
public:
-
-
RawFiles(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,
Modified: trunk/include/rawgenbook.h
===================================================================
--- trunk/include/rawgenbook.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawgenbook.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,7 @@
/******************************************************************************
*
- * rawgenbook.h - code for class 'RawGenBook'- a module that reads raw
- * text files:
- * ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawgenbook.h - class RawGenBook- a module driver that support
+ * Generic Books uncompressed
*
* $Id$
*
@@ -34,6 +33,8 @@
class FileDesc;
class SWDLLEXPORT RawGenBook : public SWGenBook {
+
+private:
char *path;
FileDesc *bdtfd;
bool verseKey;
Modified: trunk/include/rawld.h
===================================================================
--- trunk/include/rawld.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawld.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,8 @@
/******************************************************************************
*
- * rawld.cpp - code for class 'RawLD'- a module that reads raw lexicon and
- * dictionary files: *.dat *.idx
+ * rawld.cpp - class RawLD: a module driver that supports
+ * lexicon and dictionary files
+ * with entry sizes require up to 2 bytes
*
* $Id$
*
@@ -32,13 +33,13 @@
SWORD_NAMESPACE_START
class SWDLLEXPORT RawLD : public RawStr, public SWLD {
+
+private:
char getEntry(long away = 0) const;
public:
-
-
RawLD(const char *ipath, const char *iname = 0, const char *idesc = 0,
- SWDisplay * idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
+ SWDisplay *idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
SWTextDirection dir = DIRECTION_LTR,
SWTextMarkup markup = FMT_UNKNOWN, const char* ilang = 0, bool caseSensitive = false, bool strongsPadding = true);
Modified: trunk/include/rawld4.h
===================================================================
--- trunk/include/rawld4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawld4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,8 @@
/******************************************************************************
*
- * rawld4.cpp - code for class 'RawLD4'- a module that reads raw
- * lexicon and dictionary files: *.dat *.idx
+ * rawld4.cpp - class RawLD4: a module driver that supports
+ * lexicon and dictionary files
+ * with entry sizes requiring 4 bytes
*
* $Id$
*
@@ -32,11 +33,11 @@
SWORD_NAMESPACE_START
class SWDLLEXPORT RawLD4 : public RawStr4, public SWLD {
+
+private:
char getEntry(long away = 0) const;
public:
-
-
RawLD4(const char *ipath, const char *iname = 0, const char *idesc = 0,
SWDisplay *idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
SWTextDirection dir = DIRECTION_LTR,
Modified: trunk/include/rawstr.h
===================================================================
--- trunk/include/rawstr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawstr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,7 @@
/*****************************************************************************
*
- * rawstr.h - code for class 'RawStr'- a module that reads raw text
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
- * and provides lookup and parsing functions based on
- * class StrKey
+ * rawstr.h - class RawStr: a helper class for modules with string
+ * keys, uncompressed, with entry sizes specified by to 2 bytes
*
* $Id$
*
@@ -35,6 +33,8 @@
class FileDesc;
class SWDLLEXPORT RawStr {
+
+private:
static int instance; // number of instantiated RawStr objects or derivitives
char *path;
bool caseSensitive;
Modified: trunk/include/rawstr4.h
===================================================================
--- trunk/include/rawstr4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawstr4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,7 @@
/*****************************************************************************
*
- * rawstr4.h - code for class 'RawStr4'- a module that reads raw text
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
- * and provides lookup and parsing functions based on
- * class StrKey
+ * rawstr4.h - class RawStr4: a helper class for module drivers with string
+ * keys uncompressed requiring 4 bytes for their entry size
*
* $Id$
*
@@ -35,6 +33,8 @@
class SWBuf;
class SWDLLEXPORT RawStr4 {
+
+private:
static int instance; // number of instantiated RawStr4 objects or derivitives
char *path;
bool caseSensitive;
@@ -47,6 +47,7 @@
FileDesc *datfd;
void doSetText(const char *key, const char *buf, long len = -1);
void doLinkEntry(const char *destkey, const char *srckey);
+
public:
static const char nl;
RawStr4(const char *ipath, int fileMode = -1, bool caseSensitive = false);
Modified: trunk/include/rawtext.h
===================================================================
--- trunk/include/rawtext.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawtext.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * rawtext.h - code for class 'RawText'- a module that reads raw text files:
- * ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawtext.h - class RawText: a module driver for Bible modules stored
+ * uncompressed with entry sizes specified with 2 bytes
*
* $Id$
*
@@ -36,7 +36,7 @@
class SWDLLEXPORT RawText : public SWText, public RawVerse {
public:
- 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, const char* ilang = 0, const char *versification = "KJV");
+ 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, const char *ilang = 0, const char *versification = "KJV");
virtual ~RawText();
virtual SWBuf &getRawEntryBuf() const;
virtual void increment(int steps = 1);
Modified: trunk/include/rawtext4.h
===================================================================
--- trunk/include/rawtext4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawtext4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,8 @@
/******************************************************************************
*
- * rawtext4.h - code for class 'RawText4'- a module that reads raw
- * text files:
- * ot and nt using indexs ??.bks ??.cps ??.vss
+ * rawtext4.h - class RawText4: a module driver for Bible modules
+ * stored uncompressed and having entry sizes specified
+ * with 4 bytes
*
* $Id$
*
@@ -38,7 +38,7 @@
class SWDLLEXPORT RawText4 : public SWText, public RawVerse4 {
public:
- RawText4(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, const char *versification = "KJV");
+ RawText4(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, const char *versification = "KJV");
virtual ~RawText4();
virtual SWBuf &getRawEntryBuf() const;
virtual void increment(int steps = 1);
Modified: trunk/include/rawverse.h
===================================================================
--- trunk/include/rawverse.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawverse.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,8 @@
/******************************************************************************
*
- * rawverse.h - code for class 'RawVerse'- a module that reads raw text
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
- * and provides lookup and parsing functions based on
- * class VerseKey
+ * rawverse.h - class RawVerse: a helper class for module drivers
+ * which store their data uncompress and use a 2 byte
+ * entry size and a VerseKey key type
*
* $Id$
*
@@ -36,6 +35,7 @@
class SWDLLEXPORT RawVerse {
+private:
static int instance; // number of instantiated RawVerse objects or derivitives
protected:
Modified: trunk/include/rawverse4.h
===================================================================
--- trunk/include/rawverse4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rawverse4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,8 @@
/******************************************************************************
*
- * rawverse4.h - code for class 'RawVerse4'- a module that reads raw
- * text files: ot and nt using indexs ??.bks ??.cps
- * ??.vss and provides lookup and parsing functions based
- * on class VerseKey
+ * rawverse4.h - class RawVerse4: a helper class for module drivers
+ * which store uncompressed text, use 4 bytes entry size
+ * and use VerseKey as their keytype
*
* $Id$
*
@@ -37,6 +36,7 @@
class SWDLLEXPORT RawVerse4 {
+private:
static int instance; // number of instantiated RawVerse objects or derivitives
protected:
Modified: trunk/include/remotetrans.h
===================================================================
--- trunk/include/remotetrans.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/remotetrans.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * remotetrans.h - code for Remote Transport
+ * remotetrans.h - class RemoteTransport: the base for all communication
+ * transport drivers
*
* $Id$
*
Modified: trunk/include/roman.h
===================================================================
--- trunk/include/roman.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/roman.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -26,12 +26,12 @@
SWORD_NAMESPACE_START
/** Checks if a string is a roman numeral.
-*/
-char isRoman(const char *, int maxchars = 0);
+ */
+char isRoman(const char *s, int maxchars = 0);
/** Converts a roman numeral to a value.
-* @param s Roman numeral to convert.
-*/
+ * @param s Roman numeral to convert.
+ */
int fromRoman(const char *s);
SWORD_NAMESPACE_END
Modified: trunk/include/rtfhtml.h
===================================================================
--- trunk/include/rtfhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rtfhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * rtfhtml.h - Definition of RTFHTML
+ * rtfhtml.h - class RTFHTML: a RenderFilter to render HTML from
+ * a very limited subset of RTF
+ *
*
* $Id$
*
Modified: trunk/include/rtranspgdrive.h
===================================================================
--- trunk/include/rtranspgdrive.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/rtranspgdrive.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * rtranspgdrive.h - code for Google Drive impl of Remote Transport
+ * rtranspgdrive.h - class RTransportGDrive: Google Drive impl of Remote Transport
*
* $Id$
*
Modified: trunk/include/sapphire.h
===================================================================
--- trunk/include/sapphire.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/sapphire.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -46,35 +46,39 @@
SWORD_NAMESPACE_START
-class sapphire {
+class Sapphire {
+private:
// These variables comprise the state of the state machine.
unsigned char cards[256]; // A permutation of 0-255.
unsigned char rotor, // Index that rotates smoothly
- ratchet, // Index that moves erratically
- avalanche, // Index heavily data dependent
- last_plain, // Last plain text byte
- last_cipher; // Last cipher text byte
+ ratchet, // Index that moves erratically
+ avalanche, // Index heavily data dependent
+ last_plain, // Last plain text byte
+ last_cipher; // Last cipher text byte
// This function is used by initialize(), which is called by the
// constructor.
- unsigned char keyrand (int limit, unsigned char *user_key,
- unsigned char keysize, unsigned char *rsum,
- unsigned *keypos); public:sapphire (unsigned char
- *key = NULL, // Calls initialize if a real
+ unsigned char keyrand(int limit, unsigned char *user_key,
+ unsigned char keysize, unsigned char *rsum,
+ unsigned *keypos);
+public:
+ Sapphire(unsigned char *key = NULL, // Calls initialize if a real
unsigned char keysize = 0); // key is provided. If none
- // is provided, call initialize
- // before encrypt or decrypt.
- ~sapphire (); // Destroy cipher state information.
- void initialize (unsigned char *key, // User key is used to set
- unsigned char keysize); // up state information.
- void hash_init (void); // Set up default hash.
- unsigned char encrypt (unsigned char b = 0); // Encrypt byte
- // or get a random byte.
- unsigned char decrypt (unsigned char b); // Decrypt byte.
- void hash_final (unsigned char *hash, // Copy hash value to hash
+ // is provided, call initialize
+ // before encrypt or decrypt.
+
+ ~Sapphire(); // Destroy cipher state information.
+
+ void initialize(unsigned char *key, // User key is used to set
+ unsigned char keysize); // up state information.
+ void hash_init(void); // Set up default hash.
+ unsigned char encrypt(unsigned char b = 0); // Encrypt byte
+ // or get a random byte.
+ unsigned char decrypt(unsigned char b); // Decrypt byte.
+ void hash_final(unsigned char *hash, // Copy hash value to hash
unsigned char hashlength = 20); // Hash length (16-32)
- void burn (void); // Destroy cipher state information.
+ void burn(void); // Destroy cipher state information.
};
Modified: trunk/include/scsuutf8.h
===================================================================
--- trunk/include/scsuutf8.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/scsuutf8.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * scsuutf8.h - SWFilter descendant to convert a SCSU character to UTF-8
+ * scsuutf8.h - class SCSUUTF8: an Encoding filter which converts SCSU to UTF8
*
* $Id$
*
Modified: trunk/include/stringmgr.h
===================================================================
--- trunk/include/stringmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/stringmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,9 @@
/******************************************************************************
*
- * stringmgr.h - A class which provides string handling functions which
- * can be reimplemented by frontends
+ * stringmgr.h - class StringMgr: base of string functions. Can be
+ * subclassed and methods re-implemented your favorite
+ * String library with Unicode support, e.g, ICU,
+ * Qt, Java.
*
* $Id$
*
@@ -31,8 +33,8 @@
SWORD_NAMESPACE_START
-/** StringMgr is a way to provide UTf8 handling by the Sword frontend
- * Each platform, if it's up-to-date, should provide functions to handle unicode and utf8. This class makes it possible to implement Unicode support on the user-side and not in Sword itself.
+/** StringMgr provide UTF8 handling
+ * This class makes it possible to implement Unicode support on the client-side and not in SWORD itself.
*/
class SWDLLEXPORT StringMgr {
private:
Modified: trunk/include/strkey.h
===================================================================
--- trunk/include/strkey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/strkey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * strkey.h - code for class 'strkey'- a standard Biblical verse key
+ * strkey.h - class StrKey: a Key represented by a simple string
*
* $Id$
*
@@ -31,25 +31,24 @@
SWORD_NAMESPACE_START
/** a standard string key class (used
- * for modules that index on single strings (eg. cities,
- * names, words, etc.)
+ * for modules that index on single strings
+ * e.g., for lexicons and dictionaries
*/
-class SWDLLEXPORT StrKey:public SWKey {
+class SWDLLEXPORT StrKey : public SWKey {
+private:
static SWClass classdef;
- void init ();
+ void init();
public:
- /** initializes instance of StrKey
+ /** c-tor which initialized a StrKey object with a simple string
*
- * @param ikey text key (word, city, name, etc.)
+ * @param ikey text key
*/
- StrKey (const char *ikey = 0);
+ StrKey(const char *ikey = 0);
- /** cleans up instance of StrKey
- */
- virtual ~ StrKey ();
+ virtual ~StrKey();
SWKEY_OPERATORS
Modified: trunk/include/swbasicfilter.h
===================================================================
--- trunk/include/swbasicfilter.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swbasicfilter.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,10 @@
/******************************************************************************
*
- * swbasicfilter.h - definition of class SWBasicFilter. An SWFilter
- * impl that provides some basic methods that
- * many filter will need and can use as a starting
- * point
+ * swbasicfilter.h - class SWBasicFilter: a starting point SWFilter which
+ * provides a SAX-like processing features for more
+ * easily writing other filters.
+ * provides some basic methods that make filter writing
+ * easier
*
* $Id$
*
Modified: trunk/include/swbuf.h
===================================================================
--- trunk/include/swbuf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swbuf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * swbuf.h - code for SWBuf used as a transport and utility for data buffers
+ * swbuf.h - class SWBuf: a rich buffer / string class providing optimized
+ * implementations of many basic string operations
*
* $Id$
*
@@ -44,6 +45,8 @@
* it will crash your program. You need to perform the checks yourself!
*/
class SWDLLEXPORT SWBuf {
+
+private:
char *buf;
char *end;
char *endAlloc;
Modified: trunk/include/swcacher.h
===================================================================
--- trunk/include/swcacher.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swcacher.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swcacher.h - definition of class SWCacher used to provide an
+ * swcacher.h - class SWCacher: used to provide an
* interface for objects that cache and want a standard
* interface for cleaning up.
*
Modified: trunk/include/swcipher.h
===================================================================
--- trunk/include/swcipher.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swcipher.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,6 @@
/******************************************************************************
*
- * swcipher.h - definition of Class SWCipher used for data
- * cipher/decipher
+ * swcipher.h - class SWCipher: used for data cipher/decipher
*
* $Id$
*
@@ -33,8 +32,9 @@
class SWDLLEXPORT SWCipher {
- sapphire master;
- sapphire work;
+private:
+ Sapphire master;
+ Sapphire work;
char *buf;
bool cipher;
@@ -43,15 +43,15 @@
protected:
public:
- SWCipher (unsigned char *key);
- virtual void setCipherKey (const char *key);
- virtual ~ SWCipher ();
+ SWCipher(unsigned char *key);
+ virtual void setCipherKey(const char *key);
+ virtual ~SWCipher();
virtual void setUncipheredBuf(const char *buf = 0, unsigned long len = 0);
virtual char *getUncipheredBuf();
virtual void setCipheredBuf(unsigned long *len, const char *buf = 0);
virtual char *getCipheredBuf(unsigned long *len = 0);
- virtual void encode (void);
- virtual void decode (void);
+ virtual void encode(void);
+ virtual void decode(void);
static SWBuf personalize(const SWBuf &buf, bool encode);
};
Modified: trunk/include/swcom.h
===================================================================
--- trunk/include/swcom.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swcom.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,8 @@
/******************************************************************************
*
- * swcom.h - code for base class 'SWCom'. SWCom is the basis for all
- * types of commentary modules.
- * It is traditionally close to the same as the SWText
- * module type, but has defaults set which more
+ * swcom.h - class SWCom: the basis for all types of commentary modules.
+ * It is traditionally nearly the same as the SWText driver for
+ * Bible modules, but has defaults set which more
* closely represent how a commentary will be used and how
* the bulk of our commentaries expect to be used. For example,
* most commentaries consist of entries for a range of text
@@ -49,6 +48,7 @@
*/
class SWDLLEXPORT SWCom : public SWModule {
+private:
mutable VerseKey *tmpVK1;
mutable VerseKey *tmpVK2;
mutable bool tmpSecond;
Modified: trunk/include/swcomprs.h
===================================================================
--- trunk/include/swcomprs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swcomprs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swcomprs.h - definition of Class SWCompress used for data
+ * swcomprs.h - class SWCompress: used for data
* compression
*
* $Id$
Modified: trunk/include/swconfig.h
===================================================================
--- trunk/include/swconfig.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swconfig.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swconfig.h - definition of Class SWConfig used for saving and
+ * swconfig.h - class SWConfig: used for saving and
* retrieval of configuration information
*
* $Id$
Modified: trunk/include/swdisp.h
===================================================================
--- trunk/include/swdisp.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swdisp.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swdisp.h - code for base class 'swdisp'. swdisp is the basis for all
+ * swdisp.h - class SWDisplay: the basis for all
* types of displays (e.g. raw textout, curses, xwindow, etc.)
*
* $Id$
@@ -31,7 +31,7 @@
class SWModule;
-/** swdisp is the basis for all types of displays
+/** SWDisplay is the basis for all types of displays
* (e.g. raw textout, curses, xwindow, etc.)
*/
class SWDLLEXPORT SWDisplay : public SWObject {
Modified: trunk/include/swfilter.h
===================================================================
--- trunk/include/swfilter.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swfilter.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,10 @@
/******************************************************************************
*
- * swfilter.h - definition of class SWFilter used to filter text between
- * different formats
+ * swfilter.h - class SWFilter: the base for all Filters in SWORD
+ * a Filter manipulates the text stream in some way,
+ * usually converting text between different markups,
+ * encoding, to show or hide text features
+ * for the user, or to strip markup for searching
*
* $Id$
*
Modified: trunk/include/swfiltermgr.h
===================================================================
--- trunk/include/swfiltermgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swfiltermgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,6 @@
/******************************************************************************
*
- * swfiltermgr.h - definition of class SWFilterMgr used as an interface to
- * manage filters on a module
+ * swfiltermgr.h - class SWFilterMgr: used to manage filters on a module
*
* $Id$
*
@@ -32,7 +31,7 @@
class SWModule;
class SWMgr;
-/** Class to manage different kinds of filters.
+/** Class to apply appropriate filter to achieve a desired output
*/
class SWDLLEXPORT SWFilterMgr {
@@ -46,10 +45,8 @@
virtual void setParentMgr(SWMgr *parentMgr);
virtual SWMgr *getParentMgr();
- virtual void addGlobalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start,
- ConfigEntMap::iterator end);
- virtual void addLocalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start,
- ConfigEntMap::iterator end);
+ virtual void addGlobalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end);
+ virtual void addLocalOptions(SWModule *module, ConfigEntMap §ion, ConfigEntMap::iterator start, ConfigEntMap::iterator end);
/**
@@ -59,7 +56,6 @@
*/
virtual void addEncodingFilters(SWModule *module, ConfigEntMap §ion);
-
/**
* Adds the render filters which are defined in "section" to the SWModule object "module".
* @param module To this module the render filter(s) are added
@@ -67,7 +63,6 @@
*/
virtual void addRenderFilters(SWModule *module, ConfigEntMap §ion);
-
/**
* Adds the strip filters which are defined in "section" to the SWModule object "module".
* @param module To this module the strip filter(s) are added
@@ -75,7 +70,6 @@
*/
virtual void addStripFilters(SWModule *module, ConfigEntMap §ion);
-
/**
* Adds the raw filters which are defined in "section" to the SWModule object "module".
* @param module To this module the raw filter(s) are added
Modified: trunk/include/swgenbook.h
===================================================================
--- trunk/include/swgenbook.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swgenbook.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * swgenbook.h - Definition of SWGenBook
+ * swgenbook.h - class SWGenBook: representation of a General Book with
+ * a TreeKey table of contents for its keyset
*
* $Id$
*
Modified: trunk/include/swinputmeth.h
===================================================================
--- trunk/include/swinputmeth.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swinputmeth.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * swinputmeth.h - Definition of SWInputMethod
+ * swinputmeth.h - class SWInputMethod: the base for all InputMethods in
+ * SWORD
*
* $Id$
*
Modified: trunk/include/swkey.h
===================================================================
--- trunk/include/swkey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swkey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,7 @@
/******************************************************************************
*
- * swkey.h - code for base class 'swkey'. swkey is the basis for all
- * types of keys for indexing into modules (e.g. verse, word,
- * place, etc.)
+ * swkey.h - class SWKey: SWKey is the basis for all indexing into modules
+ * (e.g. verses, table of contents tree, strings, etc.)
*
* $Id$
*
Modified: trunk/include/swld.h
===================================================================
--- trunk/include/swld.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swld.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swld.h - code for base class 'SWLD'. SWLD is the basis for all
+ * swld.h - class SWLD: the basis for all
* types of Lexicon and Dictionary modules (hence the 'LD').
*
* $Id$
Modified: trunk/include/swlocale.h
===================================================================
--- trunk/include/swlocale.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swlocale.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,6 @@
/******************************************************************************
*
- * swlocale.h - definition of Class SWLocale used for retrieval
- * of locale lookups
+ * swlocale.h - class SWLocale: localization functionality
*
* $Id$
*
@@ -39,6 +38,8 @@
*/
class SWDLLEXPORT SWLocale {
+private:
+
class Private;
Private *p;
Modified: trunk/include/swlog.h
===================================================================
--- trunk/include/swlog.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swlog.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swlog.h - definition of class SWLog used for logging messages
+ * swlog.h - class SWLog: used for logging messages
*
* $Id$
*
@@ -29,7 +29,9 @@
SWORD_NAMESPACE_START
+
class SWDLLEXPORT SWLog {
+
protected:
char logLevel;
static SWLog *systemLog;
Modified: trunk/include/swmgr.h
===================================================================
--- trunk/include/swmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * swmgr.h - definition of class SWMgr used to interact with an install
- * base of sword modules.
+ * swmgr.h - class SWMgr: used to interact with an install
+ * base of SWORD modules.
*
* $Id$
*
Modified: trunk/include/swmodule.h
===================================================================
--- trunk/include/swmodule.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swmodule.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,7 @@
/******************************************************************************
*
- * swmodule.h - code for base class 'module'. Module is the basis for
- * all types of modules (e.g. texts, commentaries, maps,
- * lexicons, etc.)
+ * swmodule.h - class SWModule: the basis for all types of modules
+ * (e.g. Bibles, commentaries, maps, lexicons, general books, etc.)
*
* $Id$
*
@@ -97,6 +96,7 @@
class SWDLLEXPORT SWModule : public SWCacher, public SWSearchable {
+private:
class StdOutDisplay : public SWDisplay {
char display(SWModule &imodule) {
#ifndef _WIN32_WCE
Modified: trunk/include/swobject.h
===================================================================
--- trunk/include/swobject.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swobject.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * swobject.h - definition for SWObject used as lowest base class for
+ * swobject.h - class SWObject: used as lowest base class for
* many SWORD objects
*
* $Id$
@@ -33,6 +33,7 @@
* Class used for SWDYNAMIC_CAST to save the inheritance order.
*/
class SWDLLEXPORT SWClass {
+
private:
const char **descends;
Modified: trunk/include/swoptfilter.h
===================================================================
--- trunk/include/swoptfilter.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swoptfilter.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,13 @@
/***************************************************************************
*
- * swoptfilter.h - Definition of SWOptionFilter
+ * swoptfilter.h - class SWOptionFilter: the base for all OptionFilters
+ * in SWORD. An OptionFilter allows the user to turn
+ * on and off certain features they may wish to see or
+ * not see. Essentially, an OptionFilter is usually
+ * included in a choice for the end user and the result
+ * of being turned "Off" is that the filter will strip
+ * the markup for that feature from the text stream
+ * when it is processed.
*
* $Id$
*
@@ -32,12 +39,13 @@
/**
* The type definitoin for option types
*/
-typedef std::list < SWBuf > StringList;
+typedef std::list<SWBuf> StringList;
/** Base class for all option filters.
*/
class SWDLLEXPORT SWOptionFilter : public virtual SWFilter {
+
protected:
SWBuf optionValue;
const char *optName;
@@ -45,8 +53,8 @@
const StringList *optValues;
bool option;
bool isBooleanVal;
+
public:
-
SWOptionFilter();
SWOptionFilter(const char *oName, const char *oTip, const StringList *oValues);
virtual ~SWOptionFilter();
Modified: trunk/include/swsearchable.h
===================================================================
--- trunk/include/swsearchable.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swsearchable.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * swsearchable.h - definition of class SWSearchable used to provide an
- * interface for objects that be searched.
+ * swsearchable.h - class SWSearchable: used to provide an
+ * interface for objects that can be searched.
*
* $Id$
*
@@ -34,6 +34,7 @@
/** used to provide an interface for objects that be searched.
*/
class SWDLLEXPORT SWSearchable {
+
public:
SWSearchable();
virtual ~SWSearchable();
Modified: trunk/include/swtext.h
===================================================================
--- trunk/include/swtext.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/swtext.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,6 @@
/******************************************************************************
*
- * swtext.h - code for base class 'SWText'. SWText is the basis for all
- * types of text modules
+ * swtext.h - class SWText: the basis for all Bible modules
*
* $Id$
*
@@ -36,6 +35,7 @@
*/
class SWDLLEXPORT SWText : public SWModule {
+private:
// for conversion if we have been set with a different internal key type
mutable VerseKey *tmpVK1;
mutable VerseKey *tmpVK2;
Modified: trunk/include/sysdata.h
===================================================================
--- trunk/include/sysdata.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/sysdata.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * sysdata.h -
+ * sysdata.h - definitions that help SWORD work the same on different systems
*
* $Id$
*
Modified: trunk/include/teihtmlhref.h
===================================================================
--- trunk/include/teihtmlhref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/teihtmlhref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * teihtmlhref.h - Definition of TEIHTMLHREF
+ * teihtmlhref.h - class TEIHTMLHREF: a RenderFilter to render HTMLHREF
+ * markup from modules marked up in TEI
*
* $Id$
*
@@ -30,6 +31,7 @@
/** this filter converts TEI text to HTMLHREF text
*/
class SWDLLEXPORT TEIHTMLHREF : public SWBasicFilter {
+
private:
bool renderNoteNumbers;
Modified: trunk/include/teilatex.h
===================================================================
--- trunk/include/teilatex.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/teilatex.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * teilatex.h - Definition of TEILaTeX
+ * teilatex.h - class TEILaTeX: a RenderFilter to render LaTeX from modules
+ * marked up in TEI
*
* $Id$
*
@@ -30,6 +31,7 @@
/** this filter converts TEI text to LaTeX text
*/
class SWDLLEXPORT TEILaTeX : public SWBasicFilter {
+
private:
bool renderNoteNumbers;
Modified: trunk/include/teiplain.h
===================================================================
--- trunk/include/teiplain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/teiplain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * teiplain.h - Definition of TEIPlain
+ * teiplain.h - class TEIPlain: a StripFilter for modules marked up in TEI
*
* $Id$
*
@@ -31,7 +31,7 @@
/** this filter converts TEI text to plain text
*/
class SWDLLEXPORT TEIPlain : public SWBasicFilter {
-public:
+
protected:
class MyUserData : public BasicFilterUserData {
public:
Modified: trunk/include/teirtf.h
===================================================================
--- trunk/include/teirtf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/teirtf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * teirtf.h - Definition of TEIRTF
+ * teirtf.h - class TEIRTF: a RenderFilter to render RTF from modules marked
+ * up in TEI
*
* $Id$
*
@@ -30,6 +31,7 @@
/** this filter converts TEI text to RTF text
*/
class SWDLLEXPORT TEIRTF : public SWBasicFilter {
+
private:
protected:
@@ -45,6 +47,7 @@
return new MyUserData(module, key);
}
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
TEIRTF();
};
Modified: trunk/include/teixhtml.h
===================================================================
--- trunk/include/teixhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/teixhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * teixhtml.h - Definition of TEIXHTML
+ * teixhtml.h - class TEIXHTML: a RenderFilter to render XHTML from modules
+ * marked up in TEI
*
* $Id$
*
@@ -30,6 +31,7 @@
/** this filter converts TEI text to XHTML text
*/
class SWDLLEXPORT TEIXHTML : public SWBasicFilter {
+
private:
bool renderNoteNumbers;
@@ -42,6 +44,7 @@
SWBuf version;
MyUserData(const SWModule *module, const SWKey *key);
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
Modified: trunk/include/thmlfootnotes.h
===================================================================
--- trunk/include/thmlfootnotes.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlfootnotes.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlfootnotes.h - Definition of ThMLFootnotes
+ * thmlfootnotes.h - class ThMLFootnotes: an OptionFilter to handle
+ * footnotes in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlgbf.h
===================================================================
--- trunk/include/thmlgbf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlgbf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlgbf.h - Definition of ThMLGBF
+ * thmlgbf.h - class ThMLGBF: a RenderFilter to render GBF from modules
+ * marked up in ThML
*
* $Id$
*
@@ -30,8 +31,10 @@
/** this filter converts ThML text to GBF text
*/
class SWDLLEXPORT ThMLGBF : public SWFilter {
+
protected:
virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
+
public:
ThMLGBF();
};
Modified: trunk/include/thmlheadings.h
===================================================================
--- trunk/include/thmlheadings.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlheadings.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlheadings.h - Definition of ThMLHeadings
+ * thmlheadings.h - class ThMLHeadings: an OptionFilter to handle headings
+ * in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlhtml.h
===================================================================
--- trunk/include/thmlhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlhtml.h - Definition of ThMLHTML
+ * thmlhtml.h - class ThMLHTML: a RenderFilter to render HTML from modules
+ * marked up in ThML
*
* $Id$
*
@@ -30,16 +31,20 @@
/** this filter converts ThML text to HTML text
*/
class SWDLLEXPORT ThMLHTML : public SWBasicFilter {
+
protected:
class MyUserData : public BasicFilterUserData {
public:
MyUserData(const SWModule *module, const SWKey *key) : BasicFilterUserData(module, key), inSecHead(false) {}
bool inSecHead;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
+
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
ThMLHTML();
};
Modified: trunk/include/thmlhtmlhref.h
===================================================================
--- trunk/include/thmlhtmlhref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlhtmlhref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlhtmlhref.h - Definition of ThMLHTMLHREF
+ * thmlhtmlhref.h - class ThMLHTMLHREF: a RenderFilter to render HTMLHREF
+ * markup from modules marked up in ThML
*
* $Id$
*
@@ -20,8 +21,8 @@
*
*/
-#ifndef _THMLHTMLHREF_H
-#define _THMLHTMLHREF_H
+#ifndef THMLHTMLHREF_H
+#define THMLHTMLHREF_H
#include <swbasicfilter.h>
#include <utilxml.h>
@@ -31,8 +32,11 @@
/** this filter converts ThML text to HTML text with hrefs
*/
class SWDLLEXPORT ThMLHTMLHREF : public SWBasicFilter {
+
+private:
SWBuf imgPrefix;
bool renderNoteNumbers;
+
protected:
class MyUserData : public BasicFilterUserData {
public:
@@ -43,10 +47,13 @@
SWBuf version;
XMLTag startTag;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
+
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
ThMLHTMLHREF();
virtual const char *getImagePrefix() { return imgPrefix.c_str(); }
Modified: trunk/include/thmllatex.h
===================================================================
--- trunk/include/thmllatex.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmllatex.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmllatex.h - Definition of ThMLLaTeX
+ * thmllatex.h - class ThMLLaTeX: a RenderFilter to render LaTeX from
+ * modules marked up in ThML
*
* $Id$
*
@@ -31,8 +32,11 @@
/** this filter converts ThML text to LaTeX
*/
class SWDLLEXPORT ThMLLaTeX : public SWBasicFilter {
+
+private:
SWBuf imgPrefix;
bool renderNoteNumbers;
+
protected:
class MyUserData : public BasicFilterUserData {
public:
@@ -43,10 +47,13 @@
SWBuf version;
XMLTag startTag;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
+
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
ThMLLaTeX();
virtual const char *getImagePrefix() { return imgPrefix.c_str(); }
Modified: trunk/include/thmllemma.h
===================================================================
--- trunk/include/thmllemma.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmllemma.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmllemma.h - Definition of ThMLLemma
+ * thmllemma.h - class ThMLLemma: an OptionFilter to handle lemma
+ * information on words in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlmorph.h
===================================================================
--- trunk/include/thmlmorph.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlmorph.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlmorph.h - Definition of ThMLMorph
+ * thmlmorph.h - class ThMLMorph: an OptionFilter to handle morph
+ * information on words in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlosis.h
===================================================================
--- trunk/include/thmlosis.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlosis.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlosis.h - Definition of ThMLOSIS
+ * thmlosis.h - class ThMLOSIS: a RenderFilter to render OSIS from modules
+ * marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlplain.h
===================================================================
--- trunk/include/thmlplain.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlplain.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlplain.h - Definition of ThMLPlain
+ * thmlplain.h - class ThMLPlain: a StripFilter for modules marked up
+ * in ThML
*
* $Id$
*
Modified: trunk/include/thmlrtf.h
===================================================================
--- trunk/include/thmlrtf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlrtf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlrtf.h - Definition of ThMLRTF
+ * thmlrtf.h - class ThMLRTF: a RenderFilter to render RTF from modules
+ * marked up in ThML
*
* $Id$
*
@@ -31,6 +32,7 @@
/** this filter converts ThML text to RTF text
*/
class SWDLLEXPORT ThMLRTF : public SWBasicFilter {
+
protected:
class MyUserData : public BasicFilterUserData {
public:
@@ -40,11 +42,14 @@
bool isBiblicalText;
XMLTag startTag;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
+
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
+
public:
ThMLRTF();
};
Modified: trunk/include/thmlscripref.h
===================================================================
--- trunk/include/thmlscripref.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlscripref.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlscripref.h - Definition of ThMLScripRef
+ * thmlscripref.h - class ThMLScripRef: an OptionFilter to handle
+ * cross-references in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlstrongs.h
===================================================================
--- trunk/include/thmlstrongs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlstrongs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlstrongs.h - Definition of ThMLStrongs
+ * thmlstrongs.h - class ThMLStrongs: an OptionFilter to handle Strongs
+ * information on words in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlvariants.h
===================================================================
--- trunk/include/thmlvariants.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlvariants.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlvariants.h - Definition of ThMLVariants
+ * thmlvariants.h - class ThMLVariants: an OptionFilter to handle variants
+ * in modules marked up in ThML
*
* $Id$
*
Modified: trunk/include/thmlwebif.h
===================================================================
--- trunk/include/thmlwebif.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlwebif.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlwebif.h - Definition of ThMLWEBIF
+ * thmlwebif.h - class ThMLWEBIF: a RenderFilter to render WEBIF markup
+ * from modules marked up in ThML
*
* $Id$
*
@@ -30,11 +31,14 @@
/** this filter converts ThML text to HTML text with hrefs
*/
class SWDLLEXPORT ThMLWEBIF : public ThMLXHTML {
+
+private:
const SWBuf baseURL;
const SWBuf passageStudyURL;
protected:
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
ThMLWEBIF();
};
Modified: trunk/include/thmlwordjs.h
===================================================================
--- trunk/include/thmlwordjs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlwordjs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/***************************************************************************
*
- * thmlwordjs.h - Definition of ThMLWordJS
+ * thmlwordjs.h - class ThMLWordJS: an OptionFilter to inject
+ * JavaScript for mostly onclick events for modules
+ * marked up in ThML
*
* $Id$
*
@@ -28,10 +30,12 @@
SWORD_NAMESPACE_START
class SWMgr;
-/** This Filter shows/hides strong's numbers in a ThML text
+
+/** This Filter injects onclick JavaScript into the text stream for ThML modules
*/
class SWDLLEXPORT ThMLWordJS : public SWOptionFilter {
+private:
SWModule *defaultGreekLex;
SWModule *defaultHebLex;
SWModule *defaultGreekParse;
Modified: trunk/include/thmlxhtml.h
===================================================================
--- trunk/include/thmlxhtml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/thmlxhtml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * thmlxhtml.h - Definition of ThMLXHTML
+ * thmlxhtml.h - class ThMLXHTML: a RenderFilter to render XHTML from
+ * modules marked up in ThML
*
* $Id$
*
@@ -31,8 +32,11 @@
/** this filter converts ThML text to classed XHTML
*/
class SWDLLEXPORT ThMLXHTML : public SWBasicFilter {
+
+private:
SWBuf imgPrefix;
bool renderNoteNumbers;
+
protected:
class MyUserData : public BasicFilterUserData {
public:
@@ -43,10 +47,13 @@
SWBuf version;
XMLTag startTag;
};
+
virtual BasicFilterUserData *createUserData(const SWModule *module, const SWKey *key) {
return new MyUserData(module, key);
}
+
virtual bool handleToken(SWBuf &buf, const char *token, BasicFilterUserData *userData);
+
public:
ThMLXHTML();
virtual const char *getImagePrefix() { return imgPrefix.c_str(); }
Modified: trunk/include/treekey.h
===================================================================
--- trunk/include/treekey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/treekey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * treekey.h - code for class 'TreeKey'
+ * treekey.h - class TreeKey: an SWKey for traversing a table of contents
*
* $Id$
*
@@ -36,6 +36,8 @@
* The base class for all tree-based key implementations in Sword.
*/
class SWDLLEXPORT TreeKey : public SWKey {
+
+private:
static SWClass classdef;
void init();
@@ -50,7 +52,6 @@
void positionChanged() { if (posChangeListener) posChangeListener->positionChanged(); }
public:
-
class PositionChangeListener {
TreeKey *treeKey;
public:
@@ -66,8 +67,8 @@
// TreeKey (const char *ikey = 0);
// TreeKey (const SWKey * ikey);
// TreeKey (TreeKey const &k);
- TreeKey () { init(); };
- ~TreeKey () {};
+ TreeKey() { init(); };
+ ~TreeKey() {};
virtual const char *getLocalName() = 0;
Modified: trunk/include/treekeyidx.h
===================================================================
--- trunk/include/treekeyidx.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/treekeyidx.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * treekeyidx.h - code for class 'TreeKeyIdx'
+ * treekeyidx.h - class TreeKeyIdx: a TreeKey implementation which
+ * grabs its structure from an index data file
*
* $Id$
*
@@ -33,10 +34,11 @@
/**
* Class TreeKeyIdx
- * The TreeKey implementation used for all tree-based modules in Sword, such as GenBooks.
+ * The TreeKey implementation used for tree-based modules in SWORD, such as GenBooks.
*/
class SWDLLEXPORT TreeKeyIdx : public TreeKey {
+private:
class TreeNode {
public:
TreeNode();
@@ -65,7 +67,6 @@
void saveTreeNode(TreeNode *node);
void saveTreeNodeOffsets(TreeNode *node);
-
public:
TreeKeyIdx(const TreeKeyIdx &ikey);
TreeKeyIdx(const char *idxPath, int fileMode = -1);
@@ -113,7 +114,7 @@
virtual void setText(const char *ikey);
virtual void setPosition(SW_POSITION p);
virtual const char *getText() const;
- virtual int _compare (const TreeKeyIdx & ikey);
+ virtual int _compare(const TreeKeyIdx & ikey);
virtual int compare(const SWKey &ikey);
virtual void decrement(int steps = 1);
virtual void increment(int steps = 1);
Modified: trunk/include/unicodertf.h
===================================================================
--- trunk/include/unicodertf.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/unicodertf.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * unicodertf.h - Definition of UnicodeRTF
+ * unicodertf.h - class UnicodeRTF: an encoding filter which converts
+ * UTF8 into RTF Unicode tags
*
* $Id$
*
Modified: trunk/include/url.h
===================================================================
--- trunk/include/url.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/url.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * url.h - code for an URL parser utility class
+ * url.h - class URL: a URL parser utility class
*
* $Id$
*
Modified: trunk/include/utf16utf8.h
===================================================================
--- trunk/include/utf16utf8.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf16utf8.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf16utf8.h - Definition of UTF16UTF8
+ * utf16utf8.h - class UTF16UTF8: an EncodingFilter to convert
+ * UTF16 to UTF8
*
* $Id$
*
Modified: trunk/include/utf8arabicpoints.h
===================================================================
--- trunk/include/utf8arabicpoints.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8arabicpoints.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * utf8arabicpoints.h - SWFilter descendant to remove UTF-8 Arabic
- * vowel points
+ * utf8arabicpoints.h - class UTF8ArabicPoints: an SWFilter descendant
+ * to remove UTF-8 Arabic vowel points
*
* $Id$
*
Modified: trunk/include/utf8arshaping.h
===================================================================
--- trunk/include/utf8arshaping.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8arshaping.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/******************************************************************************
*
- * utf8arshaping.h - Definition of UTF8arShaping
+ * utf8arshaping.h - class UTF8arShaping: a Filter which can
+ * be used to improve Arabic shaping of character in a
+ * text stream
*
* $Id$
*
Modified: trunk/include/utf8bidireorder.h
===================================================================
--- trunk/include/utf8bidireorder.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8bidireorder.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8bidireorder.h - Definition of UTF8BiDiReorder
+ * utf8bidireorder.h - class UTF8BiDiReorder: an encoding filter which
+ * reorders UTF-8 according to Unicode BiDi rules
*
* $Id$
*
@@ -35,9 +36,11 @@
/** This Filter reorders UTF-8 text according to Unicode BiDi
*/
class SWDLLEXPORT UTF8BiDiReorder : public SWFilter {
+
private:
UConverter* conv;
UErrorCode err;
+
public:
UTF8BiDiReorder();
~UTF8BiDiReorder();
Modified: trunk/include/utf8cantillation.h
===================================================================
--- trunk/include/utf8cantillation.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8cantillation.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8cantillation.h - Definition of UTF8Cantillation
+ * utf8cantillation.h - class UTF8Cantillation: an OptionFilter to handle
+ * cantillation marks in UTF8 text
*
* $Id$
*
Modified: trunk/include/utf8greekaccents.h
===================================================================
--- trunk/include/utf8greekaccents.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8greekaccents.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8greekaccents.h - Definition of UTF8GreekAccents
+ * utf8greekaccents.h - class UTF8GreekAccents: an OptionFilter to handle
+ * Greek accents in UTF8 text
*
* $Id$
*
@@ -27,7 +28,7 @@
SWORD_NAMESPACE_START
-/** This Filter shows/hides Greek Accents marks in UTF8 text
+/** This Filter shows/hides Greek accents marks in UTF8 text
*/
class SWDLLEXPORT UTF8GreekAccents : public SWOptionFilter {
public:
Modified: trunk/include/utf8hebrewpoints.h
===================================================================
--- trunk/include/utf8hebrewpoints.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8hebrewpoints.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8hebrewpoints.h - Definition of UTF8HebrewPoints
+ * utf8hebrewpoints.h - class UTF8HebrewPoints: an OptionFilter to handle
+ * Hebrew vowel points in UTF8 text
*
* $Id$
*
Modified: trunk/include/utf8html.h
===================================================================
--- trunk/include/utf8html.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8html.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8html.h - Definition of UTF8HTML
+ * utf8html.h - class UTF8HTML: a Filter to convert UTF8 multi-byte characters
+ * into HTML escape sequences
*
* $Id$
*
Modified: trunk/include/utf8latin1.h
===================================================================
--- trunk/include/utf8latin1.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8latin1.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/******************************************************************************
*
- * utf8latin1.h - Definition of UTF8Latin1
+ * utf8latin1.h - class UTF8Latin1: an EncodingFilter to convert UTF8
+ * text into Latin1 where possible; otherwise show
+ * a replacement character
*
* $Id$
*
@@ -30,7 +32,10 @@
/** This filter converts UTF-8 encoded text to Latin-1
*/
class SWDLLEXPORT UTF8Latin1 : public SWFilter {
+
+private:
char replacementChar;
+
public:
UTF8Latin1(char rchar = '?');
virtual char processText(SWBuf &text, const SWKey *key = 0, const SWModule *module = 0);
Modified: trunk/include/utf8nfc.h
===================================================================
--- trunk/include/utf8nfc.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8nfc.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8nfc.h - Definition of UTF8NFC
+ * utf8nfc.h - class UTF8NFC: a Filter to normalize a UTF8 text stream into
+ * Normal Form Composed Unicode (NFC)
*
* $Id$
*
@@ -32,12 +33,14 @@
SWORD_NAMESPACE_START
-/** This filter normalizes UTF-8 encoded text
+/** This filter normalizes UTF-8 encoded text to NFC (Normal Form Composed)
*/
class SWDLLEXPORT UTF8NFC : public SWFilter {
+
private:
UConverter* conv;
UErrorCode err;
+
public:
UTF8NFC();
~UTF8NFC();
Modified: trunk/include/utf8nfkd.h
===================================================================
--- trunk/include/utf8nfkd.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8nfkd.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8nfkd.h - Definition of UTF8NFKD
+ * utf8nfkd.h - class UTF8NFKD: a Filter to normalize a UTF8 text stream to
+ * Unicode Normal Form Decomposed, Compatibility (NFKD)
*
* $Id$
*
@@ -28,9 +29,12 @@
SWORD_NAMESPACE_START
struct UTF8NFKDPrivate;
+
class SWDLLEXPORT UTF8NFKD : public SWFilter {
+
private:
struct UTF8NFKDPrivate *p;
+
public:
UTF8NFKD();
~UTF8NFKD();
Modified: trunk/include/utf8scsu.h
===================================================================
--- trunk/include/utf8scsu.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8scsu.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8scsu.h - Definition of UTF8SCSU
+ * utf8scsu.h - class UTF8SCSU: an EncodingFilter to convert UTF8 to
+ * Standard Compression Scheme for Unicode (SCSU)
*
* $Id$
*
@@ -35,10 +36,12 @@
/** This filter converts UTF-8 encoded text to SCSU
*/
class SWDLLEXPORT UTF8SCSU : public SWFilter {
+
private:
UConverter* scsuConv;
UConverter* utf8Conv;
UErrorCode err;
+
public:
UTF8SCSU();
~UTF8SCSU();
Modified: trunk/include/utf8transliterator.h
===================================================================
--- trunk/include/utf8transliterator.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8transliterator.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,8 @@
/******************************************************************************
*
- * utf8transliterator.h - Definition of UTF8Transliterator
+ * utf8transliterator.h - class UTF8Transliterator: a Filter to
+ * transliterate a UTF8 text stream into
+ * an alternate script. e.g., Hebrew to Latin
*
* $Id$
*
@@ -59,8 +61,8 @@
/** This Filter uses ICU for transliteration
*/
class SWDLLEXPORT UTF8Transliterator : public SWOptionFilter {
+
private:
-
unsigned char option;
static const char optionstring[NUMTARGETSCRIPTS][16];
Modified: trunk/include/utf8utf16.h
===================================================================
--- trunk/include/utf8utf16.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utf8utf16.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,7 @@
/******************************************************************************
*
- * utf8utf16.h - Definition of UTF8UTF16
+ * utf8utf16.h - class UTF8UTF16: an EncodingFilter to convert
+ * UTF8 to UTF16
*
* $Id$
*
Modified: trunk/include/utilxml.h
===================================================================
--- trunk/include/utilxml.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/utilxml.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * utilxml.h - definition of class that deal with xml constructs
+ * utilxml.h - class XMLTag: utility class which helps work with XML tags
*
* $Id$
*
@@ -36,6 +36,7 @@
/** Simple XML helper class.
*/
class SWDLLEXPORT XMLTag {
+
private:
mutable char *buf;
char *name;
Modified: trunk/include/versekey.h
===================================================================
--- trunk/include/versekey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/versekey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,9 @@
/******************************************************************************
*
- * versekey.h - code for class 'VerseKey'- a standard Biblical verse
- * key
+ * versekey.h - class 'VerseKey': an SWKey for biblical verses with a
+ * book ch:vs structure. Includes a freehand text
+ * parser for the many ways one might specify a biblical
+ * verse reference or reference range / list.
*
* $Id$
*
@@ -50,6 +52,7 @@
*/
class SWDLLEXPORT VerseKey : public SWKey {
+private:
static SWClass classdef;
/** number of instantiated VerseKey objects or derivitives
Modified: trunk/include/versetreekey.h
===================================================================
--- trunk/include/versetreekey.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/versetreekey.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,8 @@
/******************************************************************************
*
- * versetreekey.h - code for class 'VerseTreeKey'- a standard Biblical
- * verse key
+ * versetreekey.h - class VerseTreeKey: a specialized VerseKey which
+ * obtains its versification system from a module with
+ * a tree structure
*
* $Id$
*
@@ -40,6 +41,7 @@
*/
class SWDLLEXPORT VerseTreeKey : public VerseKey, public TreeKey::PositionChangeListener {
+private:
static SWClass classdef;
TreeKey *treeKey;
// vector<struct sbook> books;
Modified: trunk/include/versificationmgr.h
===================================================================
--- trunk/include/versificationmgr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/versificationmgr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,6 +1,6 @@
/******************************************************************************
*
- * versification.h - definition of class VersificationMgr used for managing
+ * versificationmgr.h - class VersificationMgr: used for managing
* versification systems
*
* $Id$
@@ -39,8 +39,7 @@
class TreeKey;
-struct abbrev
-{
+struct abbrev {
const char *ab;
const char *osis;
};
@@ -69,10 +68,6 @@
class SWDLLEXPORT VersificationMgr : public SWCacher {
-
-public:
- class System;
-
private:
friend class __staticsystemVersificationMgr;
@@ -85,7 +80,9 @@
static VersificationMgr *systemVersificationMgr;
public:
+ class System;
class SWDLLEXPORT Book {
+ private:
friend class System;
friend struct BookOffsetLess;
class Private;
@@ -125,6 +122,7 @@
};
class SWDLLEXPORT System {
+ private:
class Private;
Private *p;
SWBuf name;
@@ -149,6 +147,7 @@
long getNTStartOffset() const { return ntStartOffset; }
void translateVerse(const System *dstSys, const char **book, int *chapter, int *verse, int *verse_end) const;
};
+
VersificationMgr() { init(); }
~VersificationMgr();
static VersificationMgr *getSystemVersificationMgr();
Modified: trunk/include/xzcomprs.h
===================================================================
--- trunk/include/xzcomprs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/xzcomprs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * xzcomprs.h - XzCompress, a driver class that provides xz (LZMA2)
- * compression
+ * xzcomprs.h - class XzCompress: an SWCompress class which provides
+ * xz (LZMA2) compression
*
* $Id$
*
@@ -33,7 +33,9 @@
class SWDLLEXPORT XzCompress : public SWCompress {
-protected:
+private:
+ SW_u64 memlimit; // memory usage limit during decompression
+
public:
XzCompress();
virtual ~XzCompress();
@@ -41,8 +43,6 @@
virtual void encode(void);
virtual void decode(void);
virtual void setLevel(int l);
-private:
- SW_u64 memlimit; // memory usage limit during decompression
};
SWORD_NAMESPACE_END
Modified: trunk/include/zcom.h
===================================================================
--- trunk/include/zcom.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zcom.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * zcom.h - code for class 'zCom'- a module that reads compressed text
- * files: ot and nt using indexs ??.vss
+ * zcom.h - class zCom: a module driver for uncompressed commentaries
+ * with entries sizes stored at 2 bytes
*
* $Id$
*
@@ -32,6 +32,7 @@
class SWDLLEXPORT zCom : public zVerse, public SWCom {
+private:
VerseKey *lastWriteKey;
bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
int blockType;
Modified: trunk/include/zcom4.h
===================================================================
--- trunk/include/zcom4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zcom4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * zcom4.h - code for class 'zCom4'- a module that reads compressed text
- * files: ot and nt using indexs ??.vss
+ * zcom4.h - class zCom4: a module driver for compressed commentaries
+ * with long entries. Allows a 4 byte size entry
*
* $Id$
*
@@ -32,13 +32,13 @@
class SWDLLEXPORT zCom4 : public zVerse4, public SWCom {
+private:
VerseKey *lastWriteKey;
bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
int blockType;
public:
-
zCom4(const char *ipath, const char *iname = 0, const char *idesc = 0,
int blockType = CHAPTERBLOCKS, SWCompress *icomp = 0,
SWDisplay *idisp = 0, SWTextEncoding encoding = ENC_UNKNOWN,
Modified: trunk/include/zipcomprs.h
===================================================================
--- trunk/include/zipcomprs.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zipcomprs.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * zipcomprs.h - definition of Class ZipCompress used for data
- * compression
+ * zipcomprs.h - class ZipCompress: an SWCompress implemention which
+ * uses zip compression
*
* $Id$
*
@@ -34,7 +34,6 @@
class SWDLLEXPORT ZipCompress : public SWCompress {
-protected:
public:
ZipCompress();
virtual ~ZipCompress();
Modified: trunk/include/zld.h
===================================================================
--- trunk/include/zld.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zld.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * zld.cpp - code for class 'zLD'- a module that reads compressed lexicon
- * and dictionary files
+ * zld.cpp - class zLD: a module driver that supports compressed lexicon
+ * and dictionary data with entries less than 2 bytes size
*
* $Id$
*
@@ -32,11 +32,11 @@
SWORD_NAMESPACE_START
class SWDLLEXPORT zLD : public zStr, public SWLD {
+
+private:
char getEntry(long away = 0) const;
public:
-
-
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, const char* ilang = 0, bool caseSensitive = false, bool strongsPadding = true);
virtual ~zLD();
virtual SWBuf &getRawEntryBuf() const;
Modified: trunk/include/zstr.h
===================================================================
--- trunk/include/zstr.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zstr.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,8 +1,7 @@
/*****************************************************************************
*
- * zstr.h - code for class 'zStr'- a module that reads compressed text
- * files and provides lookup and parsing functions based on
- * class StrKey
+ * zstr.h - class zStr: a helper class which provides support for
+ * compressed module drivers which use a string for their key
*
* $Id$
*
Modified: trunk/include/ztext.h
===================================================================
--- trunk/include/ztext.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/ztext.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * ztext.h - code for class 'zText'- a module that reads compressed text
- * files: ot and nt using indexs ??.vss
+ * ztext.h - class zText: a module driver supporting compressed
+ * Bibles with common 2 byte size entries
*
* $Id$
*
@@ -38,6 +38,7 @@
*/
class SWDLLEXPORT zText:public zVerse, public SWText {
+private:
VerseKey *lastWriteKey;
bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
int blockType;
Modified: trunk/include/ztext4.h
===================================================================
--- trunk/include/ztext4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/ztext4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,7 +1,7 @@
/******************************************************************************
*
- * ztext4.h - code for class 'zText4'- a module that reads compressed text
- * files: ot and nt using indexs ??.vss
+ * ztext4.h - class zText4: a module driver which supports compressed
+ * Bibles supporting large 4 byte entry sizes
*
* $Id$
*
@@ -36,8 +36,9 @@
* This class handles compressed modules.
* It should not be used in frontends, unless you are doing very special things.
*/
-class SWDLLEXPORT zText4:public zVerse4, public SWText {
+class SWDLLEXPORT zText4 : public zVerse4, public SWText {
+private:
VerseKey *lastWriteKey;
bool sameBlock(VerseKey * lastWriteKey, VerseKey * key);
int blockType;
Modified: trunk/include/zverse.h
===================================================================
--- trunk/include/zverse.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zverse.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,8 @@
/******************************************************************************
*
- * zverse.h - code for class 'zVerse'- a module that reads raw text
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
- * and provides lookup and parsing functions based on
- * class VerseKey
+ * zverse.h - class 'zVerse'- a support class for module drivers
+ * which support a 2 byte entry size and use Versekey
+ * for their entry keys
*
* $Id$
*
Modified: trunk/include/zverse4.h
===================================================================
--- trunk/include/zverse4.h 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/include/zverse4.h 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1,9 +1,8 @@
/******************************************************************************
*
- * zverse4.h - code for class 'zVerse4'- a module that reads raw text
- * files: ot and nt using indexs ??.bks ??.cps ??.vss
- * and provides lookup and parsing functions based on
- * class VerseKey
+ * zverse4.h - class zVerse4: a helper class for module drivers
+ * which provide 4 byte size entries and use VerseKey
+ * for their entry keys
*
* $Id$
*
@@ -36,6 +35,8 @@
class SWBuf;
class SWDLLEXPORT zVerse4 {
+
+private:
SWCompress *compressor;
protected:
Modified: trunk/src/mgr/swmgr.cpp
===================================================================
--- trunk/src/mgr/swmgr.cpp 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/src/mgr/swmgr.cpp 2020-08-30 11:35:14 UTC (rev 3786)
@@ -1474,7 +1474,7 @@
// add all basic strip filters for for the modtype
// TODO: addStripFilters(newmod, section);
- AddStripFilters(newmod, section);
+ addStripFilters(newmod, section);
// Any module-specific processing specified in module config
// as entries LocalStripFilter=
@@ -1483,11 +1483,11 @@
AddStripFilters(newmod, section, section.lower_bound("LocalStripFilter"), section.upper_bound("LocalStripFilter"));
// TODO: addRawFilters(newmod, section);
- AddRawFilters(newmod, section);
+ addRawFilters(newmod, section);
// TODO: addRenderFilters(newmod, section);
- AddRenderFilters(newmod, section);
+ addRenderFilters(newmod, section);
// TODO: addEncodingFilters(newmod, section);
- AddEncodingFilters(newmod, section);
+ addEncodingFilters(newmod, section);
// place our module in module container, removing first if one
// already exists by our same name
Modified: trunk/src/modules/common/sapphire.cpp
===================================================================
--- trunk/src/modules/common/sapphire.cpp 2020-08-30 11:12:34 UTC (rev 3785)
+++ trunk/src/modules/common/sapphire.cpp 2020-08-30 11:35:14 UTC (rev 3786)
@@ -41,7 +41,7 @@
SWORD_NAMESPACE_START
-unsigned char sapphire::keyrand(int limit,
+unsigned char Sapphire::keyrand(int limit,
unsigned char *user_key,
unsigned char keysize,
unsigned char *rsum,
@@ -72,7 +72,7 @@
return u;
}
-void sapphire::initialize(unsigned char *key, unsigned char keysize)
+void Sapphire::initialize(unsigned char *key, unsigned char keysize)
{
// Key size may be up to 256 bytes.
// Pass phrases may be used directly, with longer length
@@ -127,7 +127,7 @@
keypos = 0;
}
-void sapphire::hash_init(void)
+void Sapphire::hash_init(void)
{
// This function is used to initialize non-keyed hash
// computation.
@@ -148,25 +148,25 @@
cards[i] = (unsigned char) j;
}
-sapphire::sapphire(unsigned char *key, unsigned char keysize)
+Sapphire::Sapphire(unsigned char *key, unsigned char keysize)
{
if (key && keysize)
initialize(key, keysize);
}
-void sapphire::burn(void)
+void Sapphire::burn(void)
{
// Destroy the key and state information in RAM.
memset(cards, 0, 256);
rotor = ratchet = avalanche = last_plain = last_cipher = 0;
}
-sapphire::~sapphire()
+Sapphire::~Sapphire()
{
burn();
}
-unsigned char sapphire::encrypt(unsigned char b)
+unsigned char Sapphire::encrypt(unsigned char b)
{
// Picture a single enigma rotor with 256 positions, rewired
// on the fly by card-shuffling.
@@ -197,7 +197,7 @@
return last_cipher;
}
-unsigned char sapphire::decrypt(unsigned char b)
+unsigned char Sapphire::decrypt(unsigned char b)
{
unsigned char swaptemp;
@@ -222,7 +222,7 @@
return last_plain;
}
-void sapphire::hash_final(unsigned char *hash, // Destination
+void Sapphire::hash_final(unsigned char *hash, // Destination
unsigned char hashlength) // Size of hash.
{
int i;
More information about the sword-cvs
mailing list