OSISXHTML Class Reference

#include <osisxhtml.h>

Inheritance diagram for OSISXHTML:

Collaboration diagram for OSISXHTML:

Classes
class	MyUserData
class	TagStack

Public Member Functions
virtual const char *	getHeader () const
	OSISXHTML ()
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 classed XHTML

Definition at line 33 of file osisxhtml.h.

Constructor & Destructor Documentation

OSISXHTML::OSISXHTML

(

)

Definition at line 152 of file osisxhtml.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;
}

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

protectedvirtual

Reimplemented from SWBasicFilter.

Reimplemented in OSISWEBIF.

Definition at line 147 of file osisxhtml.cpp.

                                                                                       {
    return new MyUserData(module, key);
}

SWORD_NAMESPACE_START const char * OSISXHTML::getHeader ( ) const

virtual

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 36 of file osisxhtml.cpp.

                                       {
    const static char *header = "\
        .divineName { font-variant: small-caps; }\n\
        .wordsOfJesus { color: red; }\n\
        .transChange { font-style: italic; }\n\
        .transChange.transChange-supplied { font-style: italic; }\n\
        .transChange.transChange-added { font-style: italic; }\n\
        .transChange.transChange-tenseChange::before { content: '*'; }\n\
        .transChange.transChange-tenseChange { font-style: normal; }\n\
        .transChange:lang(zh) { font-style: normal; text-decoration: dotted underline; }\n\
        .overline { text-decoration: overline; }\n\
        .indent1 { margin-left: 1em; }\n\
        .indent2 { margin-left: 2em; }\n\
        .indent3 { margin-left: 3em; }\n\
        .indent4 { margin-left: 4em; }\n\
        abbr { &:hover{ &:before{ content: attr(title); } } }\n\
        .small-caps { font-variant: small-caps; }\n\
        .otPassage { font-variant: small-caps; }\n\
        .selah { text-align: right; width: 50%; margin: 0; padding: 0; }\n\
        .acrostic { text-align: center; }\n\
        .colophon {font-style: italic; font-size: small; display: block; }\n\
        .rdg { font-style: italic; }\n\
        .inscription {font-variant: small-caps; }\n\
        .catchWord {font-style: bold; }\n\
        .x-p-indent {text-indent: 1em; }\n\
    ";
    // Acrostic for things like the titles in Psalm 119
    return header;
}

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

Reimplemented in OSISWEBIF.

Definition at line 218 of file osisxhtml.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)
                    outText( "}", buf, u);*/
            }
        }

        // <note> tag
        else if (!strcmp(tag.getName(), "note")) {
            if (!tag.isEndTag()) {
                SWBuf type = tag.getAttribute("type");

                // for backward compatibility
                if (type == "strongsMarkup") type = "x-strongsMarkup";
                if (type == "x-cross-ref") type = "crossReference";

                SWBuf subType = tag.getAttribute("subType");
                SWBuf classExtras = "";

                if (type.size()) {
                    classExtras.append(" ").append(type);
                }
                if (subType.size()) {
                                        classExtras.append(" ").append(subType);
                                }

                bool strongsMarkup = type == "x-strongsMarkup";
                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 = (type == "crossReference" ? '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');

                        if (u->vkey) {
                            //printf("URL = %s\n",URL::encode(u->vkey->getText()).c_str());
                            buf.appendFormatted("<a class=\"noteMarker%s\" href=\"passagestudy.jsp?action=showNote&type=%c&value=%s&module=%s&passage=%s\"><small><sup class=\"%c\">*%c%s</sup></small></a>",
                                classExtras.c_str(),
                                ch, 
                                URL::encode(footnoteNumber.c_str()).c_str(), 
                                URL::encode(u->version.c_str()).c_str(), 
                                URL::encode(u->vkey->getText()).c_str(), 
                                ch,
                                ch, 
                                (renderNoteNumbers ? noteName.c_str() : ""));
                        }
                        else {
                            buf.appendFormatted("<a class=\"noteMarker%s\" href=\"passagestudy.jsp?action=showNote&type=%c&value=%s&module=%s&passage=%s\"><small><sup class=\"%c\">*%c%s</sup></small></a>",
                                classExtras.c_str(),
                                ch, 
                                URL::encode(footnoteNumber.c_str()).c_str(), 
                                URL::encode(u->version.c_str()).c_str(), 
                                URL::encode(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 except newline at start of verse (immediately after verse number)
        else if (!strcmp(tag.getName(), "p") || !strcmp(tag.getName(), "lg")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {    // non-empty start tag
                u->outputNewline(buf);
            }
            else if (tag.isEndTag()) {  // end tag
                u->outputNewline(buf);
            }
            else {                  // empty paragraph break marker
                u->outputNewline(buf);
            }
        }

        // 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") || !strcmp(tag.getAttribute("type"), "colophon"))) {
            // <div type="paragraph"  sID... />
            if (tag.getAttribute("sID")) {  // non-empty start tag
                u->outputNewline(buf);
                // safe because we've verified type is present from if statement above
                if (!strcmp(tag.getAttribute("type"), "colophon")) {
                    outText("<div class=\"colophon\">", buf, u);
                }
                
            }
            // <div type="paragraph"  eID... />
            else if (tag.getAttribute("eID")) {
                u->outputNewline(buf);
                // safe because we've verified type is present from if statement above
                if (!strcmp(tag.getAttribute("type"), "colophon")) {
                    outText("</div>", buf, u);
                }
                
            }
        }

        // <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;
                    SWBuf type;
                    SWBuf classes = "";
                    
                    bool is_scripRef = false;

                    target = tag.getAttribute("osisRef");
                    const char* the_ref = strchr(target, ':');
                    type = tag.getAttribute("type");
                    
                    if (type.size()) {
                        classes.append(type);
                    }
                    
                    if(!the_ref) {
                        // No work
                        ref = target;
                        is_scripRef = true;
                    }
                    else {
                        // Compensate for starting :
                        ref = the_ref + 1;

                        int size = 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 class=\"%s\" href=\"passagestudy.jsp?action=showRef&type=scripRef&value=%s&module=\">",
                            classes.c_str(),
                            URL::encode(ref.c_str()).c_str()
//                          (work.size()) ? URL::encode(work.c_str()).c_str() : "")
                            );
                    }
                    else
                    {
                        // Dictionary link, or something
                        buf.appendFormatted(u->interModuleLinkStart,
                            classes.c_str(), 
                            URL::encode(work.c_str()).c_str(),
                            URL::encode(ref.c_str()).c_str()
                            );
                    }
                }
                else {
                    outText(u->interModuleLinkEnd, buf, u);
                }
            }
        }

        // <l> poetry, etc
        else if (!strcmp(tag.getName(), "l")) {
            // start line marker
            if (tag.getAttribute("sID") || (!tag.isEndTag() && !tag.isEmpty())) {
                SWBuf type = tag.getAttribute("type");
                if (type == "selah") {
                    outText("<p class=\"selah\">", buf, u);
                } else {
                    // nested lines plus if the line itself has an x-indent type attribute value
                    outText(SWBuf("<span class=\"line indent").appendFormatted("%d\">", u->lineStack->size() + (SWBuf("x-indent") == tag.getAttribute("type")?1:0)).c_str(), buf, u);
                }
                u->lineStack->push(tag.toString());
            }
            // end line marker
            else if (tag.getAttribute("eID") || tag.isEndTag()) {
                SWBuf type = "";
                if (!u->lineStack->empty()) {
                    XMLTag startTag(u->lineStack->top());
                    type = startTag.getAttribute("type");
                }
                if (type == "selah") {
                    outText("</p>", buf, u);
                } else {
                    outText("</span>", buf, u);
                    u->outputNewline(buf);
                }
                if (u->lineStack->size()) u->lineStack->pop();
            }
            // <l/> without eID or sID
            // Note: this is improper osis. This should be <lb/>
            else if (tag.isEmpty() && !tag.getAttribute("sID")) {
                u->outputNewline(buf);
            }
        }

        // <lb.../>
        else if (!strcmp(tag.getName(), "lb") && (!tag.getAttribute("type") || strcmp(tag.getAttribute("type"), "x-optional"))) {
                u->outputNewline(buf);
        }
        // <milestone type="line"/>
        // <milestone type="x-p"/>
        // <milestone type="cQuote" marker="x"/>
        else if ((!strcmp(tag.getName(), "milestone")) && (tag.getAttribute("type"))) {
            // safe because we've verified type is present from if statement above
            const char *type = tag.getAttribute("type");
            if (!strcmp(type, "line")) {
                u->outputNewline(buf);
                if (tag.getAttribute("subType") && !strcmp(tag.getAttribute("subType"), "x-PM")) {
                    u->outputNewline(buf);
                }
            }
            else if (!strcmp(type,"x-p"))  {
                if (tag.getAttribute("marker"))
                    outText(tag.getAttribute("marker"), buf, u);
                else outText("<!p>", buf, u);
            }
            else if (!strcmp(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);
            }
            else if (!strcmp(type, "x-importer")) {
                //drop tag as not relevant
            } 
            
            
            else {
                SWBuf attVal = tag.getAttribute("type");
                outText(SWBuf("<span class=\"") + attVal + "\"", buf,u);
                StringList attributes =  tag.getAttributeNames();
                for (StringList::const_iterator it = attributes.begin(); it != attributes.end(); ++it) {
                    attVal = tag.getAttribute(*it);
                    outText(SWBuf(" data-") + *it + "=\"" + attVal + "\"", buf,u);
                }
                outText(SWBuf("></span>"), buf,u);
                
            }
        }

        // <title>
        else if (!strcmp(tag.getName(), "title")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                SWBuf type = tag.getAttribute("type");
                SWBuf canonical = tag.getAttribute("canonical");
                
                SWBuf classExtras = "";

                if (type.size()) {
                    classExtras.append(" ").append(type);
                }
                if (canonical.size() && !strcmp(canonical,"true")) {
                    classExtras.append(" canonical");
                } 
                if (u->vkey && !u->vkey->getVerse()) {
                    if (!u->vkey->getChapter()) {
                        if (!u->vkey->getBook()) {
                            if (!u->vkey->getTestament()) {
                                outText(SWBuf("<h1 class=\"moduleHeader") + classExtras + "\">",  buf, u);
                                tag.setAttribute("pushed", "h1");
                            }
                            else {
                                outText(SWBuf("<h1 class=\"testamentHeader") + classExtras + "\">", buf, u);
                                tag.setAttribute("pushed", "h1");
                            }
                        }
                        else {
                            outText(SWBuf("<h1 class=\"bookHeader") + classExtras + "\">", buf, u);
                            tag.setAttribute("pushed", "h1");
                        }
                    }
                    else {
                        outText(SWBuf("<h2 class=\"chapterHeader") + classExtras + "\">", buf, u);
                        tag.setAttribute("pushed", "h2");
                    }
                }
                else {
                    outText(SWBuf("<h3 class=\"title") + classExtras + "\">", buf, u);
                    tag.setAttribute("pushed", "h3");
                }
                u->titleStack->push(tag.toString());
            }
            else if (tag.isEndTag()) {
                if (!u->titleStack->empty()) {
                    XMLTag tag(u->titleStack->top());
                    if (u->titleStack->size()) u->titleStack->pop();
                    SWBuf pushed = tag.getAttribute("pushed");
                    if (pushed.size()) {
                        outText((SWBuf)"</" + pushed + ">\n\n", buf, u);
                    }
                    else {
                        outText( "</h3>\n\n", buf, u);
                    }
                    ++u->consecutiveNewlines;
                    u->supressAdjacentWhitespace = true;
                }
            }
        }
        
        // <list>
        else if (!strcmp(tag.getName(), "list")) {
            if((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText("<ul>\n", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</ul>\n", buf, u);
                ++u->consecutiveNewlines;
                u->supressAdjacentWhitespace = true;
            }
        }

        // <item>
        else if (!strcmp(tag.getName(), "item")) {
            if((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText("\t<li>", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</li>\n", buf, u);
                ++u->consecutiveNewlines;
                u->supressAdjacentWhitespace = true;
            }
        }
        // <catchWord> & <rdg> tags (italicize)
        else if (!strcmp(tag.getName(), "rdg") || !strcmp(tag.getName(), "catchWord") || !strcmp(tag.getName(), "inscription")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText("<span class=\"", buf, u);
                outText(tag.getName(), buf, u);
                outText("\">", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</span>", buf, u);
            }
        }
        // <seg>
        else if (!strcmp(tag.getName(), "seg")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                SWBuf type = tag.getAttribute("type");
                outText("<span class=\"", buf, u);
                outText(type, buf, u);
                outText("\">", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</span>", 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()) {
                    scratch.setFormatted("<span class=\"divineName\">%s</span>", lastText.c_str());
                    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 doesn't exist
            if (!type.length()) type = tag.getAttribute("rend");

            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                if (type == "bold" || type == "b" || type == "x-b") {
                    outText("<b>", buf, u);
                }

                // there is no officially supported OSIS overline attribute,
                // thus either TEI overline or OSIS x-overline would be best,
                // but we have used "ol" in the past, as well.  Once a valid
                // OSIS overline attribute is made available, these should all
                // eventually be deprecated and never documented that they are supported.
                else if (type == "ol" || type == "overline" || type == "x-overline") {
                    outText("<span class=\"overline\">", buf, u);
                }

                else if (type == "super") {
                    outText("<sup>", buf, u);
                }
                else if (type == "sub") {
                    outText("<sub>", buf, u);
                }
                else if (type == "i" || type == "italic") {
                    outText("<i>", buf, u);
                } else {    // all other types
                    if (type.startsWith("x-")) type << 2;
                    outText(SWBuf("<span class=\"") + type + SWBuf("\">"), buf, u);
                }
                u->hiStack->push(tag.toString());
            }
            else if (tag.isEndTag()) {
                SWBuf type = "";
                if (!u->hiStack->empty()) {
                    XMLTag tag(u->hiStack->top());
                    if (u->hiStack->size()) u->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 if (type == "i" || type == "italic") {
                    outText("</i>", buf, u);
                } else {
                    outText("</span>", 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->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->quoteStack->empty()) {
                    XMLTag qTag(u->quoteStack->top());
                    if (u->quoteStack->size()) u->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;
                
                outText("<span class=\"transChange", buf, u);
                if (type.length()) {
                    outText(" transChange-", buf, u);
                    outText(type, buf, u);
                }
                outText("\">", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</span>", 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 
                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);
            }
        }

        // ok to leave these in
        else if (!strcmp(tag.getName(), "div")) {
            SWBuf type = tag.getAttribute("type");
            if (type == "bookGroup") {
            }
            else if (type == "book") {
            }
            else if (type == "section") {
            }
            else if (type == "majorSection") {
            }
            else if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                SWBuf type = tag.getAttribute("type");
                outText("<div class=\"", buf, u);
                outText(type, buf, u);
                outText("\">", buf, u);
                 }
                 else if (tag.isEndTag()) {
                    outText("</div>", buf, u);
            }
            else if (!(type == "colophon")) {
                if (tag.getAttribute("sID")) tag.setEmpty(false);
                if (tag.getAttribute("eID")) tag.setEndTag(true);
                outText(tag, buf, u);
            }
            
        }
        else if (!strcmp(tag.getName(), "span")) {
            outText(tag, buf, u);
        }
        else if (!strcmp(tag.getName(), "abbr")) {
            if (!tag.isEndTag()) {
                SWBuf title = tag.getAttribute("expansion");
                outText("<abbr title=\"", buf, u);
                outText(title, buf, u); 
                outText("\">", buf, u);
            }
            else if (tag.isEndTag()) {
                outText("</abbr>", buf, u);
            }
        
        }
        else if (!strcmp(tag.getName(), "br")) {
            outText( tag, buf, u);
        }
        else if (!strcmp(tag.getName(), "table")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText( "<table><tbody>\n", buf, u);
            }
            else if (tag.isEndTag()) {
                outText( "</tbody></table>\n", buf, u);
                ++u->consecutiveNewlines;
                u->supressAdjacentWhitespace = true;
            }
            
        }
        else if (!strcmp(tag.getName(), "row")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText( "\t<tr>", buf, u);
            }
            else if (tag.isEndTag()) {
                outText( "</tr>\n", buf, u);
            }
            
        }
        else if (!strcmp(tag.getName(), "cell")) {
            if ((!tag.isEndTag()) && (!tag.isEmpty())) {
                outText( "<td>", buf, u);
            }
            else if (tag.isEndTag()) {
                outText( "</td>", buf, u);
            }
        }
        else {
            if (!u->supressAdjacentWhitespace) u->consecutiveNewlines = 0;
            return false;  // we still didn't handle token
        }
    }
    if (!u->supressAdjacentWhitespace) u->consecutiveNewlines = 0;
    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.

{ 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 OSISXHTML::setMorphFirst ( bool  val = true )

inline

Definition at line 72 of file osisxhtml.h.

{ morphFirst = val; }

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

inline

Definition at line 73 of file osisxhtml.h.

{ renderNoteNumbers = val; }

virtual void SWBasicFilter::setStageProcessing ( char  stages )

inlineprotectedvirtualinherited

Definition at line 186 of file swbasicfilter.h.

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

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 OSISXHTML::morphFirst

private

Definition at line 36 of file osisxhtml.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 OSISXHTML::renderNoteNumbers

private

Definition at line 37 of file osisxhtml.h.

---

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

• include/osisxhtml.h
• src/modules/filters/osisxhtml.cpp