#include <thmlwebif.h>

Inheritance diagram for ThMLWEBIF:

Collaboration diagram for ThMLWEBIF:

Public Member Functions
virtual const char *	getHeader () const

virtual const char *	getImagePrefix ()

virtual char	processText (SWBuf &text, const SWKey key=0, const SWModule module=0)

virtual void	setImagePrefix (const char *newImgPrefix)

void	setRenderNoteNumbers (bool val=true)

	ThMLWEBIF ()

Protected Member Functions
void	addAllowedEscapeString (const char *findString)

void	addEscapeStringSubstitute (const char findString, const char replaceString)

void	addTokenSubstitute (const char findString, const char replaceString)

void	appendEscapeString (SWBuf &buf, const char *escString)

virtual BasicFilterUserData *	createUserData (const SWModule module, const SWKey key)

virtual bool	handleEscapeString (SWBuf &buf, const char escString, BasicFilterUserData userData)

virtual bool	handleNumericEscapeString (SWBuf &buf, const char *escString)

virtual bool	handleToken (SWBuf &buf, const char token, BasicFilterUserData userData)

bool	passAllowedEscapeString (SWBuf &buf, const char *escString)

virtual bool	processStage (char, SWBuf &, char &, BasicFilterUserData )

void	removeAllowedEscapeString (const char *findString)

void	removeEscapeStringSubstitute (const char *findString)

void	removeTokenSubstitute (const char *findString)

void	setEscapeEnd (const char *escEnd)

void	setEscapeStart (const char *escStart)

void	setEscapeStringCaseSensitive (bool val)

void	setPassThruNumericEscapeString (bool val)

void	setPassThruUnknownEscapeString (bool val)

void	setPassThruUnknownToken (bool val)

virtual void	setStageProcessing (char stages)

void	setTokenCaseSensitive (bool val)

void	setTokenEnd (const char *tokenEnd)

void	setTokenStart (const char *tokenStart)

bool	substituteEscapeString (SWBuf &buf, const char *escString)

bool	substituteToken (SWBuf &buf, const char *token)

Static Protected Attributes
static const char	FINALIZE = 8

static const char	INITIALIZE = 1

static const char	POSTCHAR = 4

static const char	PRECHAR = 2

Private Attributes
const SWBuf	baseURL

const SWBuf	passageStudyURL

Detailed Description

this filter converts ThML text to HTML text with hrefs

Definition at line 33 of file thmlwebif.h.

Constructor & Destructor Documentation

SWORD_NAMESPACE_START ThMLWEBIF::ThMLWEBIF ( )

Definition at line 33 of file thmlwebif.cpp.

33 : baseURL(""), passageStudyURL(baseURL + "passagestudy.jsp") {

34 }

ThMLWEBIF::baseURL

const SWBuf baseURL

Definition: thmlwebif.h:36

ThMLWEBIF::passageStudyURL

const SWBuf passageStudyURL

Definition: thmlwebif.h:37

Member Function Documentation

void SWBasicFilter::addAllowedEscapeString ( const char * findString )

protectedinherited

Registers an esc control sequence that can pass unchanged

Definition at line 156 of file swbasicfilter.cpp.

                                                                  {
     char *buf = 0;
 
     if (!escStringCaseSensitive) {
         stdstr(&buf, findString);
         toupperstr(buf);
         p->escPassSet.insert(StringSet::value_type(buf));
         delete [] buf;
     }
     else p->escPassSet.insert(StringSet::value_type(findString));
 }

void SWBasicFilter::addEscapeStringSubstitute	(	const char *	findString,
		const char *	replaceString
	)

protectedinherited

Registers an esc control sequence

Definition at line 176 of file swbasicfilter.cpp.

                                                                                                {
     char *buf = 0;
 
     if (!escStringCaseSensitive) {
         stdstr(&buf, findString);
         toupperstr(buf);
         p->escSubMap.insert(DualStringMap::value_type(buf, replaceString));
         delete [] buf;
     }
     else p->escSubMap.insert(DualStringMap::value_type(findString, replaceString));
 }

void SWBasicFilter::addTokenSubstitute	(	const char *	findString,
		const char *	replaceString
	)

protectedinherited

Registers a simple token substitutions. Usually called from the c-tor of a subclass

Definition at line 136 of file swbasicfilter.cpp.

                                                                                         {
     char *buf = 0;
 
     if (!tokenCaseSensitive) {
         stdstr(&buf, findString);
         toupperstr(buf);
         p->tokenSubMap[buf] = replaceString;
         delete [] buf;
     }
     else p->tokenSubMap[findString] = replaceString;
 }

void SWBasicFilter::appendEscapeString	(	SWBuf &	buf,
		const char *	escString
	)

protectedinherited

This appends escString to buf as an entity

Definition at line 216 of file swbasicfilter.cpp.

                                                                         {
     buf += escStart;
     buf += escString;
     buf += escEnd;
 }

virtual BasicFilterUserData* ThMLXHTML::createUserData	(	const SWModule *	module,
		const SWKey *	key
	)

inlineprotectedvirtualinherited

Reimplemented from SWBasicFilter.

Definition at line 51 of file thmlxhtml.h.

                                                                                           {
         return new MyUserData(module, key);
     }

SWORD_NAMESPACE_START const char * ThMLXHTML::getHeader ( ) const

virtualinherited

This method can supply a header associated with the processing done with this filter. A typical example is a suggested CSS style block for classed containers.

Reimplemented from SWFilter.

Definition at line 34 of file thmlxhtml.cpp.

virtual const char* ThMLXHTML::getImagePrefix ( )

inlinevirtualinherited

Definition at line 59 of file thmlxhtml.h.

59 { return imgPrefix.c_str(); }

ThMLXHTML::imgPrefix

SWBuf imgPrefix

Definition: thmlxhtml.h:37

SWBuf::c_str

const char * c_str() const

Definition: swbuf.h:158

bool SWBasicFilter::handleEscapeString	(	SWBuf &	buf,
		const char *	escString,
		BasicFilterUserData *	userData
	)

protectedvirtualinherited

This function is called for every escape sequence encountered in the input text.

Parameters

buf	the output buffer
escString	the escape sequence (e.g. `"amp"` for &)
userData	user storage space for data transient to 1 full buffer parse

Returns: false if was not handled and should be handled in; subclasses should return true if they handled the esc seq, or false if they did not.

Definition at line 286 of file swbasicfilter.cpp.

                                                                                                        {
     return substituteEscapeString(buf, escString);
 }

bool SWBasicFilter::handleNumericEscapeString	(	SWBuf &	buf,
		const char *	escString
	)

protectedvirtualinherited

This function is called for all numeric escape sequences. If passThrough

Parameters

buf	the output buffer
escString	the escape sequence (e.g. `"#235"` for &235;)

Returns: subclasses should return true if they handled the esc seq, or false if they did not.

Definition at line 244 of file swbasicfilter.cpp.

                                                                                {
     if (passThruNumericEsc) {
         appendEscapeString(buf, escString);
         return true;
     }
     return false;
 }

bool ThMLWEBIF::handleToken	(	SWBuf &	buf,
		const char *	token,
		BasicFilterUserData *	userData
	)

protectedvirtual

This function is called for every token encountered in the input text.

Parameters

buf	the output buffer
token	the token (e.g. `"p align='left'"`
userData	user storage space for data transient to 1 full buffer parse

Returns: subclasses should return true if they handled the token, or false if they did not.

Reimplemented from ThMLXHTML.

Definition at line 37 of file thmlwebif.cpp.

                                                                                         {
 
     if (!substituteToken(buf, token)) { // manually process if it wasn't a simple substitution
         MyUserData *u = (MyUserData *)userData;
         XMLTag tag(token);
         SWBuf url;
         if (!strcmp(tag.getName(), "sync")) {
             const char* value = tag.getAttribute("value");
             url = value;
             if ((url.length() > 1) && strchr("GH", url[0])) {
                 if (isdigit(url[1]))
                     url = url.c_str()+1;
             }
 
             if(tag.getAttribute("type") && !strcmp(tag.getAttribute("type"), "morph")){
                 buf += "<small><em> (";
                 buf.appendFormatted("<a href=\"%s?showMorph=%s#cv\">", passageStudyURL.c_str(), URL::encode(url).c_str() );
             }
             else {
                 if (value) {
                     value++; //skip leading G, H or T
                     //url = value;
                 }
 
                 buf += "<small><em> &lt;";
                 buf.appendFormatted("<a href=\"%s?showStrong=%s#cv\">", passageStudyURL.c_str(), URL::encode(url).c_str() );
             }
 
             buf += value;
             buf += "</a>";
 
             if (tag.getAttribute("type") && !strcmp(tag.getAttribute("type"), "morph")) {
                 buf += ") </em></small>";
             }
             else {
                 buf += "&gt; </em></small>";
             }
         }
         else if (!strcmp(tag.getName(), "scripRef")) {
             if (tag.isEndTag()) {
                 if (u->inscriptRef) { // like  "<scripRef passage="John 3:16">John 3:16</scripRef>"
                     u->inscriptRef = false;
                     buf += "</a>";
                 }
                 else { // end of scripRef like "<scripRef>John 3:16</scripRef>"
                     url = u->lastTextNode;
                     buf.appendFormatted("<a href=\"%s?key=%s#cv\">", passageStudyURL.c_str(), URL::encode(url).c_str());
                     buf += u->lastTextNode.c_str();
                     buf += "</a>";
 
                     // let's let text resume to output again
                     u->suspendTextPassThru = false;
                 }
             }
             else if (tag.getAttribute("passage")) { //passage given
                 u->inscriptRef = true;
 
                 buf.appendFormatted("<a href=\"%s?key=%s#cv\">", passageStudyURL.c_str(), URL::encode(tag.getAttribute("passage")).c_str());
             }
             else { //no passage given
                 u->inscriptRef = false;
                 // let's stop text from going to output
                 u->suspendTextPassThru = true;
             }
         }
         else {
             return ThMLXHTML::handleToken(buf, token, userData);
         }
     }
     return true;
 }

bool SWBasicFilter::passAllowedEscapeString	(	SWBuf &	buf,
		const char *	escString
	)

protectedinherited

This passes allowed escapeStrings

Definition at line 223 of file swbasicfilter.cpp.

                                                                              {
     StringSet::iterator it;
 
     if (!escStringCaseSensitive) {
             char *tmp = 0;
         stdstr(&tmp, escString);
         toupperstr(tmp);
         it = p->escPassSet.find(tmp);
         delete [] tmp;
     } else 
         it = p->escPassSet.find(escString);
 
     if (it != p->escPassSet.end()) {
         appendEscapeString(buf, escString);
         return true;
     }
 
     return false;
 }

virtual bool SWBasicFilter::processStage	(	char	,
		SWBuf &	,
		char *&	,
		BasicFilterUserData *
	)

inlineprotectedvirtualinherited

Reimplemented in OSISPlain.

Definition at line 185 of file swbasicfilter.h.

185 { return false; }

char SWBasicFilter::processText	(	SWBuf &	text,
		const SWKey *	key = `0`,
		const SWModule *	module = `0`
	)

virtualinherited

This method processes and appropriately modifies the text given it for a particular filter task

Parameters

text	The text to be filtered/converted
key	Current key That was used.
module	Current module.

Returns: 0

Implements SWFilter.

Reimplemented in ThMLRTF, OSISOSIS, and OSISRTF.

Definition at line 315 of file swbasicfilter.cpp.

                                                                                      {
     char *from;
     char token[4096];
     int tokpos = 0;
     bool intoken = false;
     bool inEsc = false;
     int escStartPos = 0, escEndPos = 0;
     int tokenStartPos = 0, tokenEndPos = 0;
     SWBuf lastTextNode;
     BasicFilterUserData *userData = createUserData(module, key);
 
     SWBuf orig = text;
     from = orig.getRawData();
     text = "";
 
     if (processStages & INITIALIZE) {
         if (processStage(INITIALIZE, text, from, userData)) {   // processStage handled it all
             delete userData;
             return 0;
         }
     }
 
     for (;*from; from++) {
 
         if (processStages & PRECHAR) {
             if (processStage(PRECHAR, text, from, userData))    // processStage handled this char
                 continue;
         }
 
         if (*from == tokenStart[tokenStartPos]) {
             if (tokenStartPos == (tokenStartLen - 1)) {
                 intoken = true;
                 tokpos = 0;
                 token[0] = 0;
                 token[1] = 0;
                 token[2] = 0;
                 inEsc = false;
             }
             else tokenStartPos++;
             continue;
         }
 
         if (*from == escStart[escStartPos]) {
             if (escStartPos == (escStartLen - 1)) {
                 intoken = true;
                 tokpos = 0;
                 token[0] = 0;
                 token[1] = 0;
                 token[2] = 0;
                 inEsc = true;
             }
             else escStartPos++;
             continue;
         }
 
         if (inEsc) {
             if (*from == escEnd[escEndPos]) {
                 if (escEndPos == (escEndLen - 1)) {
                     intoken = inEsc = false;
                     userData->lastTextNode = lastTextNode;
                     
                     if (!userData->suspendTextPassThru)  { //if text through is disabled no tokens should pass, too
                         if ((!handleEscapeString(text, token, userData)) && (passThruUnknownEsc)) {
                             appendEscapeString(text, token);
                         }
                     }
                     escEndPos = escStartPos = tokenEndPos = tokenStartPos = 0;
                     lastTextNode = "";
                     continue;
                 }
             }
         }
 
         if (!inEsc) {
             if (*from == tokenEnd[tokenEndPos]) {
                 if (tokenEndPos == (tokenEndLen - 1)) {
                     intoken = false;
                     userData->lastTextNode = lastTextNode;
                     if ((!handleToken(text, token, userData)) && (passThruUnknownToken)) {
                         text += tokenStart;
                         text += token;
                         text += tokenEnd;
                     }
                     escEndPos = escStartPos = tokenEndPos = tokenStartPos = 0;
                     lastTextNode = "";
                     if (!userData->suspendTextPassThru) {
                         userData->lastSuspendSegment.size(0);
                     }
                     continue;
                 }
             }
         }
 
         if (intoken) {
             if (tokpos < 4090) {
                 token[tokpos++] = *from;
                 token[tokpos+2] = 0;
             }
         }
         else {
             if ((!userData->supressAdjacentWhitespace) || (*from != ' ')) {
                 if (!userData->suspendTextPassThru) {
                     text.append(*from);
                 }
                 else    userData->lastSuspendSegment.append(*from);
                 lastTextNode.append(*from);
             }
             userData->supressAdjacentWhitespace = false;
         }
 
         if (processStages & POSTCHAR)
             processStage(POSTCHAR, text, from, userData);
 
     }
 
     if (processStages & FINALIZE)
         processStage(FINALIZE, text, from, userData);
 
     delete userData;
     return 0;
 }

void SWBasicFilter::removeAllowedEscapeString ( const char * findString )

protectedinherited

Unregisters an esc control sequence that can pass unchanged

Definition at line 169 of file swbasicfilter.cpp.

                                                                     {
     if (p->escPassSet.find(findString) != p->escPassSet.end()) {
         p->escPassSet.erase( p->escPassSet.find(findString) );
     }
 }

void SWBasicFilter::removeEscapeStringSubstitute ( const char * findString )

protectedinherited

Unregisters an esc control sequence

Definition at line 189 of file swbasicfilter.cpp.

                                                                        {
     if (p->escSubMap.find(findString) != p->escSubMap.end()) {
         p->escSubMap.erase( p->escSubMap.find(findString) );
     }
 }

void SWBasicFilter::removeTokenSubstitute ( const char * findString )

protectedinherited

Unregisters a simple token substitute

Definition at line 149 of file swbasicfilter.cpp.

                                                                 {
     if (p->tokenSubMap.find(findString) != p->tokenSubMap.end()) {
         p->tokenSubMap.erase( p->tokenSubMap.find(findString) );
     }
 }

void SWBasicFilter::setEscapeEnd ( const char * escEnd )

protectedinherited

Sets the end of escape sequence (by default ";").

Definition at line 297 of file swbasicfilter.cpp.

                                                    {
     stdstr(&(this->escEnd), escEnd);
     escEndLen   = strlen(escEnd);
 }

void SWBasicFilter::setEscapeStart ( const char * escStart )

protectedinherited

Sets the beginning of escape sequence (by default "&").

Definition at line 291 of file swbasicfilter.cpp.

                                                        {
     stdstr(&(this->escStart), escStart);
     escStartLen = strlen(escStart);
 }

void SWBasicFilter::setEscapeStringCaseSensitive ( bool val )

protectedinherited

Are escapeStrings case sensitive or not? Call this function before addEscapeStingSubstitute()

Definition at line 131 of file swbasicfilter.cpp.

                                                          {
     escStringCaseSensitive = val;
 }

virtual void ThMLXHTML::setImagePrefix ( const char * newImgPrefix )

inlinevirtualinherited

Definition at line 60 of file thmlxhtml.h.

60 { imgPrefix = newImgPrefix; }

ThMLXHTML::imgPrefix

SWBuf imgPrefix

Definition: thmlxhtml.h:37

void SWBasicFilter::setPassThruNumericEscapeString ( bool val )

protectedinherited

Sets whether to pass thru a numeric escape sequence unchanged or allow it to be handled otherwise. Default is false.

Definition at line 121 of file swbasicfilter.cpp.

                                                            {
     passThruUnknownEsc = val;
 }

void SWBasicFilter::setPassThruUnknownEscapeString ( bool val )

protectedinherited

Sets whether to pass thru an unknown escape sequence unchanged or just remove it. Default is false.

Definition at line 116 of file swbasicfilter.cpp.

                                                            {
     passThruUnknownEsc = val;
 }

void SWBasicFilter::setPassThruUnknownToken ( bool val )

protectedinherited

Sets whether to pass thru an unknown token unchanged or just remove it. Default is false.

Definition at line 111 of file swbasicfilter.cpp.

                                                     {
     passThruUnknownToken = val;
 }

void ThMLXHTML::setRenderNoteNumbers ( bool val = true )

inlineinherited

Definition at line 62 of file thmlxhtml.h.

62 { renderNoteNumbers = val; }

ThMLXHTML::renderNoteNumbers

bool renderNoteNumbers

Definition: thmlxhtml.h:38

virtual void SWBasicFilter::setStageProcessing ( char stages )

inlineprotectedvirtualinherited

Definition at line 186 of file swbasicfilter.h.

186 { processStages = stages; } // see STATICs up above

SWBasicFilter::processStages

char processStages

Definition: swbasicfilter.h:79

void SWBasicFilter::setTokenCaseSensitive ( bool val )

protectedinherited

Are tokens case sensitive (like in GBF) or not? Call this function before addTokenSubstitute()

Definition at line 126 of file swbasicfilter.cpp.

                                                   {
     tokenCaseSensitive = val;
 }

void SWBasicFilter::setTokenEnd ( const char * tokenEnd )

protectedinherited

Sets the end of token start sequence (by default ">").

Definition at line 309 of file swbasicfilter.cpp.

                                                     {
     stdstr(&(this->tokenEnd), tokenEnd);
     tokenEndLen   = strlen(tokenEnd);
 }

void SWBasicFilter::setTokenStart ( const char * tokenStart )

protectedinherited

Sets the beginning of token start sequence (by default "<").

Definition at line 303 of file swbasicfilter.cpp.

                                                         {
     stdstr(&(this->tokenStart), tokenStart);
     tokenStartLen = strlen(tokenStart);
 }

bool SWBasicFilter::substituteEscapeString	(	SWBuf &	buf,
		const char *	escString
	)

protectedinherited

This function performs the substitution of escapeStrings

Definition at line 253 of file swbasicfilter.cpp.

                                                                             {
     DualStringMap::iterator it;
 
     if (*escString == '#') {
         return handleNumericEscapeString(buf, escString);
     }
 
     if (passAllowedEscapeString(buf, escString)) {
         return true;
     }
 
     if (!escStringCaseSensitive) {
             char *tmp = 0;
         stdstr(&tmp, escString);
         toupperstr(tmp);
         it = p->escSubMap.find(tmp);
         delete [] tmp;
     } else 
     it = p->escSubMap.find(escString);
 
     if (it != p->escSubMap.end()) {
         buf += it->second.c_str();
         return true;
     }
     return false;
 }

bool SWBasicFilter::substituteToken	(	SWBuf &	buf,
		const char *	token
	)

protectedinherited

This function performs the substitution of tokens

Definition at line 196 of file swbasicfilter.cpp.

                                                                  {
     DualStringMap::iterator it;
 
     if (!tokenCaseSensitive) {
             char *tmp = 0;
         stdstr(&tmp, token);
         toupperstr(tmp);
         it = p->tokenSubMap.find(tmp);
         delete [] tmp;
     } else
     it = p->tokenSubMap.find(token);
 
     if (it != p->tokenSubMap.end()) {
         buf += it->second.c_str();
         return true;
     }
     return false;
 }

Member Data Documentation

const SWBuf ThMLWEBIF::baseURL

private

Definition at line 36 of file thmlwebif.h.

const char SWBasicFilter::FINALIZE = 8

staticprotectedinherited

Definition at line 99 of file swbasicfilter.h.

const char SWBasicFilter::INITIALIZE = 1

staticprotectedinherited

Definition at line 96 of file swbasicfilter.h.

const SWBuf ThMLWEBIF::passageStudyURL

private

Definition at line 37 of file thmlwebif.h.

const char SWBasicFilter::POSTCHAR = 4

staticprotectedinherited

Definition at line 98 of file swbasicfilter.h.

const char SWBasicFilter::PRECHAR = 2

staticprotectedinherited

Definition at line 97 of file swbasicfilter.h.

The documentation for this class was generated from the following files:

include/thmlwebif.h
src/modules/filters/thmlwebif.cpp

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation