#include <osishtmlhref.h>

Inheritance diagram for OSISHTMLHREF:

Collaboration diagram for OSISHTMLHREF:

Classes
class	MyUserData

class	TagStacks

Public Member Functions
virtual const char *	getHeader () const

	OSISHTMLHREF ()

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

void	setMorphFirst (bool val=true)

void	setRenderNoteNumbers (bool val=true)

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
bool	morphFirst

bool	renderNoteNumbers

Detailed Description

this filter converts OSIS text to HTML text with hrefs

Definition at line 33 of file osishtmlhref.h.

Constructor & Destructor Documentation

OSISHTMLHREF::OSISHTMLHREF ( )

Definition at line 133 of file osishtmlhref.cpp.

                            {
     setTokenStart("<");
     setTokenEnd(">");
 
     setEscapeStart("&");
     setEscapeEnd(";");
 
     setEscapeStringCaseSensitive(true);
     setPassThruNumericEscapeString(true);
 
     addAllowedEscapeString("quot");
     addAllowedEscapeString("apos");
     addAllowedEscapeString("amp");
     addAllowedEscapeString("lt");
     addAllowedEscapeString("gt");
 
     setTokenCaseSensitive(true);
     
     //  addTokenSubstitute("lg",  "<br />");
     //  addTokenSubstitute("/lg", "<br />");
 
     morphFirst = false;
     renderNoteNumbers = false;
 }

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* OSISHTMLHREF::createUserData	(	const SWModule *	module,
		const SWKey *	key
	)

inlineprotectedvirtual

Reimplemented from SWBasicFilter.

Definition at line 58 of file osishtmlhref.h.

                                                                                           {
         return new MyUserData(module, key);
     }

virtual const char* SWFilter::getHeader ( ) const

inlinevirtualinherited

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 in OSISLaTeX, OSISXHTML, ThMLLaTeX, ThMLXHTML, TEIXHTML, GBFLaTeX, and GBFXHTML.

Definition at line 62 of file swfilter.h.

62 { return ""; }

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 OSISHTMLHREF::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 SWBasicFilter.

Definition at line 159 of file osishtmlhref.cpp.

                                                                                            {
     MyUserData *u = (MyUserData *)userData;
     SWBuf scratch;
     bool sub = (u->suspendTextPassThru) ? substituteToken(scratch, token) : substituteToken(buf, token);
     if (!sub) {
   // manually process if it wasn't a simple substitution
         XMLTag tag(token);
         
         // <w> tag
         if (!strcmp(tag.getName(), "w")) {
  
             // start <w> tag
             if ((!tag.isEmpty()) && (!tag.isEndTag())) {
                 u->w = token;
             }
 
             // end or empty <w> tag
             else {
                 bool endTag = tag.isEndTag();
                 SWBuf lastText;
                 //bool show = true; // to handle unplaced article in kjv2003-- temporary till combined
 
                 if (endTag) {
                     tag = u->w.c_str();
                     lastText = u->lastTextNode.c_str();
                 }
                 else lastText = "stuff";
 
                 const char *attrib;
                 const char *val;
                 if ((attrib = tag.getAttribute("xlit"))) {
                     val = strchr(attrib, ':');
                     val = (val) ? (val + 1) : attrib;
                     outText(" ", buf, u);
                     outText(val, buf, u);
                 }
                 if ((attrib = tag.getAttribute("gloss"))) {
                     // I'm sure this is not the cleanest way to do it, but it gets the job done
                     // for rendering ruby chars properly ^_^
                     buf -= lastText.length();
                     
                     outText("<ruby><rb>", buf, u);
                     outText(lastText, buf, u);
                     outText("</rb><rp>(</rp><rt>", buf, u);
                     val = strchr(attrib, ':');
                     val = (val) ? (val + 1) : attrib;
                     outText(val, buf, u);
                     outText("</rt><rp>)</rp></ruby>", buf, u);
                 }
                 if (!morphFirst) {
                     processLemma(u->suspendTextPassThru, tag, buf);
                     processMorph(u->suspendTextPassThru, tag, buf);
                 }
                 else {
                     processMorph(u->suspendTextPassThru, tag, buf);
                     processLemma(u->suspendTextPassThru, tag, buf);
                 }
                 if ((attrib = tag.getAttribute("POS"))) {
                     val = strchr(attrib, ':');
                     val = (val) ? (val + 1) : attrib;
                     outText(" ", buf, u);
                     outText(val, buf, u);
                 }
 
                 /*if (endTag)
                     buf += "}";*/
             }
         }
 
         // <note> tag
         else if (!strcmp(tag.getName(), "note")) {
             if (!tag.isEndTag()) {
                 SWBuf type = tag.getAttribute("type");
                 bool strongsMarkup = (type == "x-strongsMarkup" || type == "strongsMarkup");    // the latter is deprecated
                 if (strongsMarkup) {
                     tag.setEmpty(false);    // handle bug in KJV2003 module where some note open tags were <note ... />
                 }
 
                 if (!tag.isEmpty()) {
 
                     if (!strongsMarkup) {   // leave strong's markup notes out, in the future we'll probably have different option filters to turn different note types on or off
                         SWBuf footnoteNumber = tag.getAttribute("swordFootnote");
                         SWBuf noteName = tag.getAttribute("n");
                         char ch = ((tag.getAttribute("type") && ((!strcmp(tag.getAttribute("type"), "crossReference")) || (!strcmp(tag.getAttribute("type"), "x-cross-ref")))) ? 'x':'n');
 
                         u->inXRefNote = true; // Why this change? Ben Morgan: Any note can have references in, so we need to set this to true for all notes
 //                      u->inXRefNote = (ch == 'x');
                         buf.appendFormatted("<a href=\"passagestudy.jsp?action=showNote&type=%c&value=%s&module=%s&passage=%s\"><small><sup class=\"%c\">*%c%s</sup></small></a>",
                                 ch, 
                             URL::encode(footnoteNumber.c_str()).c_str(), 
                             URL::encode(u->version.c_str()).c_str(), 
                             URL::encode(u->vkey ? u->vkey->getText() : u->key->getText()).c_str(), 
                             ch,
                             ch, 
                             (renderNoteNumbers ? noteName.c_str() : ""));
                     }
                 }
                 u->suspendTextPassThru = (++u->suspendLevel);
             }
             if (tag.isEndTag()) {
                 u->suspendTextPassThru = (--u->suspendLevel);
                 u->inXRefNote = false;
                 u->lastSuspendSegment = ""; // fix/work-around for nasb divineName in note bug
             }
         }
 
         // <p> paragraph and <lg> linegroup tags
         else if (!strcmp(tag.getName(), "p") || !strcmp(tag.getName(), "lg")) {
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {    // non-empty start tag
                 outText("<!P><br />", buf, u);
             }
             else if (tag.isEndTag()) {  // end tag
                 outText("<!/P><br />", buf, u);
                 userData->supressAdjacentWhitespace = true;
             }
             else {                  // empty paragraph break marker
                 outText("<!P><br />", buf, u);
                 userData->supressAdjacentWhitespace = true;
             }
         }
 
         // Milestoned paragraphs, created by osis2mod
         // <div type="paragraph" sID.../>
         // <div type="paragraph" eID.../>
         else if (tag.isEmpty() && !strcmp(tag.getName(), "div") && tag.getAttribute("type") && (!strcmp(tag.getAttribute("type"), "x-p") || !strcmp(tag.getAttribute("type"), "paragraph"))) {
             // <div type="paragraph"  sID... />
             if (tag.getAttribute("sID")) {  // non-empty start tag
                 outText("<!P><br />", buf, u);
             }
             // <div type="paragraph"  eID... />
             else if (tag.getAttribute("eID")) {
                 outText("<!/P><br />", buf, u);
                 userData->supressAdjacentWhitespace = true;
             }
         }
 
         // <reference> tag
         else if (!strcmp(tag.getName(), "reference")) { 
             if (!u->inXRefNote) {   // only show these if we're not in an xref note             
                 if (!tag.isEndTag()) {
                     SWBuf target;
                     SWBuf work;
                     SWBuf ref;
                     bool is_scripRef = false;
 
                     target = tag.getAttribute("osisRef");
                     const char* the_ref = strchr(target, ':');
                     
                     if(!the_ref) {
                         // No work
                         ref = target;
                         is_scripRef = true;
                     }
                     else {
                         // Compensate for starting :
                         ref = the_ref + 1;
 
                         int size = (int)(target.size() - ref.size() - 1);
                         work.setSize(size);
                         strncpy(work.getRawData(), target, size);
 
                         // For Bible:Gen.3.15 or Bible.vulgate:Gen.3.15
                         if(!strncmp(work, "Bible", 5))
                             is_scripRef = true;
                     }
 
                     if(is_scripRef)
                     {
                         buf.appendFormatted("<a href=\"passagestudy.jsp?action=showRef&type=scripRef&value=%s&module=\">",
                             URL::encode(ref.c_str()).c_str()
 //                          (work.size()) ? URL::encode(work.c_str()).c_str() : "")
                             );
                     }
                     else
                     {
                         // Dictionary link, or something
                         buf.appendFormatted("<a href=\"sword://%s/%s\">",
                             URL::encode(work.c_str()).c_str(),
                             URL::encode(ref.c_str()).c_str()
                             );
                     }
                 }
                 else {
                     outText("</a>", buf, u);
                 }
             }
         }
 
         // <l> poetry, etc
         else if (!strcmp(tag.getName(), "l")) {
             // end line marker
             if (tag.getAttribute("eID")) {
                 outText("<br />", buf, u);
             }
             // <l/> without eID or sID
             // Note: this is improper osis. This should be <lb/>
             else if (tag.isEmpty() && !tag.getAttribute("sID")) {
                 outText("<br />", buf, u);
             }
             // end of the line
             else if (tag.isEndTag()) {
                 outText("<br />", buf, u);
             }
         }
 
         // <lb.../>
         else if (!strcmp(tag.getName(), "lb") && (!tag.getAttribute("type") || strcmp(tag.getAttribute("type"), "x-optional"))) {
             outText("<br />", buf, u);
             userData->supressAdjacentWhitespace = true;
         }
         // <milestone type="line"/>
         // <milestone type="x-p"/>
         // <milestone type="cQuote" marker="x"/>
         else if ((!strcmp(tag.getName(), "milestone")) && (tag.getAttribute("type"))) {
             if (!strcmp(tag.getAttribute("type"), "line")) {
                 outText("<br />", buf, u);
                 if (tag.getAttribute("subType") && !strcmp(tag.getAttribute("subType"), "x-PM")) {
                     outText("<br />", buf, u);
                 }
                 userData->supressAdjacentWhitespace = true;
             }
             else if (!strcmp(tag.getAttribute("type"),"x-p"))  {
                 if (tag.getAttribute("marker"))
                     outText(tag.getAttribute("marker"), buf, u);
                 else outText("<!p>", buf, u);
             }
             else if (!strcmp(tag.getAttribute("type"), "cQuote")) {
                 const char *tmp = tag.getAttribute("marker");
                 bool hasMark    = tmp;
                 SWBuf mark      = tmp;
                 tmp             = tag.getAttribute("level");
                 int level       = (tmp) ? atoi(tmp) : 1;
 
                 // first check to see if we've been given an explicit mark
                 if (hasMark)
                     outText(mark, buf, u);
                 // finally, alternate " and ', if config says we should supply a mark
                 else if (u->osisQToTick)
                     outText((level % 2) ? '\"' : '\'', buf, u);
             }
         }
 
         // <title>
         else if (!strcmp(tag.getName(), "title")) {
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                 outText("<b>", buf, u);
             }
             else if (tag.isEndTag()) {
                 outText("</b><br />", buf, u);
             }
         }
         
         // <list>
         else if (!strcmp(tag.getName(), "list")) {
             if((!tag.isEndTag()) && (!tag.isEmpty())) {
                 outText("<ul>", buf, u);
             }
             else if (tag.isEndTag()) {
                 outText("</ul>", buf, u);
             }
         }
 
         // <item>
         else if (!strcmp(tag.getName(), "item")) {
             if((!tag.isEndTag()) && (!tag.isEmpty())) {
                 outText("<li>", buf, u);
             }
             else if (tag.isEndTag()) {
                 outText("</li>", buf, u);
             }
         }
         // <catchWord> & <rdg> tags (italicize)
         else if (!strcmp(tag.getName(), "rdg") || !strcmp(tag.getName(), "catchWord")) {
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                 outText("<i>", buf, u);
             }
             else if (tag.isEndTag()) {
                 outText("</i>", buf, u);
             }
         }
 
         // divineName  
         else if (!strcmp(tag.getName(), "divineName")) {
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                 u->suspendTextPassThru = (++u->suspendLevel);
             }
             else if (tag.isEndTag()) {
                 SWBuf lastText = u->lastSuspendSegment.c_str();
                 u->suspendTextPassThru = (--u->suspendLevel);
                 if (lastText.size()) {
                     lastText.toUpper();
                     scratch.setFormatted("%c<font size=\"-1\">%s</font>", lastText[0], lastText.c_str()+1);
 
                     const unsigned char *tmpBuf = (const unsigned char *)lastText.c_str();
                     getUniCharFromUTF8(&tmpBuf);
                     int char_length = (int)(tmpBuf - (const unsigned char *)lastText.c_str());
                     scratch.setFormatted("%.*s<font size=\"-1\">%s</font>", 
                         char_length, 
                         lastText.c_str(),
                         lastText.c_str() + char_length
                     );
                     
                     outText(scratch.c_str(), buf, u);
                 }               
             } 
         }
 
         // <hi> text highlighting
         else if (!strcmp(tag.getName(), "hi")) {
             SWBuf type = tag.getAttribute("type");
             // handle tei rend attribute
             if (!type.length()) type = tag.getAttribute("rend");
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                 if (type == "bold" || type == "b" || type == "x-b") {
                     outText("<b>", buf, u);
                 }
                 else if (type == "ol" || type == "overline" || type == "x-overline") {
                     outText("<span style=\"text-decoration:overline\">", buf, u);
                 }
                 else if (type == "super") {
                     outText("<sup>", buf, u);
                 }
                 else if (type == "sub") {
                     outText("<sub>", buf, u);
                 }
                 else {  // all other types
                     outText("<i>", buf, u);
                 }
                 u->tagStacks->hiStack.push(tag.toString());
             }
             else if (tag.isEndTag()) {
                 SWBuf type = "";
                 if (!u->tagStacks->hiStack.empty()) {
                     XMLTag tag(u->tagStacks->hiStack.top());
                     u->tagStacks->hiStack.pop();
                     type = tag.getAttribute("type");
                     if (!type.length()) type = tag.getAttribute("rend");
                 }
                 if (type == "bold" || type == "b" || type == "x-b") {
                     outText("</b>", buf, u);
                 }
                 else if (type == "ol") {
                     outText("</span>", buf, u);
                 }
                 else if (type == "super") {
                     outText("</sup>", buf, u);
                 }
                 else if (type == "sub") {
                     outText("</sub>", buf, u);
                 }
                 else {
                     outText("</i>", buf, u);
                 }
             }
         }
 
         // <q> quote
         // Rules for a quote element:
         // If the tag is empty with an sID or an eID then use whatever it specifies for quoting.
         //    Note: empty elements without sID or eID are ignored.
         // If the tag is <q> then use it's specifications and push it onto a stack for </q>
         // If the tag is </q> then use the pushed <q> for specification
         // If there is a marker attribute, possibly empty, this overrides osisQToTick.
         // If osisQToTick, then output the marker, using level to determine the type of mark.
         else if (!strcmp(tag.getName(), "q")) {
             SWBuf type      = tag.getAttribute("type");
             SWBuf who       = tag.getAttribute("who");
             const char *tmp = tag.getAttribute("level");
             int level       = (tmp) ? atoi(tmp) : 1;
             tmp             = tag.getAttribute("marker");
             bool hasMark    = tmp;
             SWBuf mark      = tmp;
 
             // open <q> or <q sID... />
             if ((!tag.isEmpty() && !tag.isEndTag()) || (tag.isEmpty() && tag.getAttribute("sID"))) {
                 // if <q> then remember it for the </q>
                 if (!tag.isEmpty()) {
                     u->tagStacks->quoteStack.push(tag.toString());
                 }
 
                 // Do this first so quote marks are included as WoC
                 if (who == "Jesus")
                     outText(u->wordsOfChristStart, buf, u);
 
                 // first check to see if we've been given an explicit mark
                 if (hasMark)
                     outText(mark, buf, u);
                 //alternate " and '
                 else if (u->osisQToTick)
                     outText((level % 2) ? '\"' : '\'', buf, u);
             }
             // close </q> or <q eID... />
             else if ((tag.isEndTag()) || (tag.isEmpty() && tag.getAttribute("eID"))) {
                 // if it is </q> then pop the stack for the attributes
                 if (tag.isEndTag() && !u->tagStacks->quoteStack.empty()) {
                     XMLTag qTag(u->tagStacks->quoteStack.top());
                     u->tagStacks->quoteStack.pop();
 
                     type    = qTag.getAttribute("type");
                     who     = qTag.getAttribute("who");
                     tmp     = qTag.getAttribute("level");
                     level   = (tmp) ? atoi(tmp) : 1;
                     tmp     = qTag.getAttribute("marker");
                     hasMark = tmp;
                     mark    = tmp;
                 }
 
                 // first check to see if we've been given an explicit mark
                 if (hasMark)
                     outText(mark, buf, u);
                 // finally, alternate " and ', if config says we should supply a mark
                 else if (u->osisQToTick)
                     outText((level % 2) ? '\"' : '\'', buf, u);
 
                 // Do this last so quote marks are included as WoC
                 if (who == "Jesus")
                     outText(u->wordsOfChristEnd, buf, u);
             }
         }
 
         // <transChange>
         else if (!strcmp(tag.getName(), "transChange")) {
             if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                 SWBuf type = tag.getAttribute("type");
                 u->lastTransChange = type;
 
                 // just do all transChange tags this way for now
                 if ((type == "added") || (type == "supplied"))
                     outText("<i>", buf, u);
                 else if (type == "tenseChange")
                     outText( "*", buf, u);
             }
             else if (tag.isEndTag()) {
                 SWBuf type = u->lastTransChange;
                 if ((type == "added") || (type == "supplied"))
                     outText("</i>", buf, u);
             }
             else {  // empty transChange marker?
             }
         }
 
         // image
         else if (!strcmp(tag.getName(), "figure")) {
             const char *src = tag.getAttribute("src");
             if (!src)       // assert we have a src attribute
                 return false;
 
             SWBuf filepath;
             if (userData->module) {
                 filepath = userData->module->getConfigEntry("AbsoluteDataPath");
                 if ((filepath.size()) && (filepath[filepath.size()-1] != '/') && (src[0] != '/'))
                     filepath += '/';
             }
             filepath += src;
 
             // images become clickable, if the UI supports showImage.
             outText("<a href=\"passagestudy.jsp?action=showImage&value=", buf, u);
             outText(URL::encode(filepath.c_str()).c_str(), buf, u);
             outText("&module=", buf, u);
             outText(URL::encode(u->version.c_str()).c_str(), buf, u);
             outText("\">", buf, u);
 
             outText("<img src=\"file:", buf, u);
             outText(filepath, buf, u);
             outText("\" border=\"0\" />", buf, u);
 
             outText("</a>", buf, u);
         }
 
         else {
               return false;  // we still didn't handle token
         }
     }
     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;
 }

void OSISHTMLHREF::setMorphFirst ( bool val = true )

inline

Definition at line 64 of file osishtmlhref.h.

64 { morphFirst = val; }

OSISHTMLHREF::morphFirst

bool morphFirst

Definition: osishtmlhref.h:35

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 OSISHTMLHREF::setRenderNoteNumbers ( bool val = true )

inline

Definition at line 65 of file osishtmlhref.h.

65 { renderNoteNumbers = val; }

OSISHTMLHREF::renderNoteNumbers

bool renderNoteNumbers

Definition: osishtmlhref.h:36

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 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.

bool OSISHTMLHREF::morphFirst

private

Definition at line 35 of file osishtmlhref.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.

bool OSISHTMLHREF::renderNoteNumbers

private

Definition at line 36 of file osishtmlhref.h.

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

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

Classes

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation