GBFWordJS Class Reference

#include <gbfwordjs.h>

Inheritance diagram for GBFWordJS:

Collaboration diagram for GBFWordJS:

Public Member Functions
	GBFWordJS ()
virtual const char *	getHeader () const
virtual const char *	getOptionName ()
virtual const char *	getOptionTip ()
virtual const char *	getOptionValue ()
virtual StringList	getOptionValues ()
bool	isBoolean ()
virtual char	processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
void	setDefaultModules (SWModule *defaultGreekLex=0, SWModule *defaultHebLex=0, SWModule *defaultGreekParse=0, SWModule *defaultHebParse=0)
void	setMgr (SWMgr *mgr)
virtual void	setOptionValue (const char *ival)
virtual	~GBFWordJS ()

Protected Attributes
bool	isBooleanVal
bool	option
SWBuf	optionValue
const char *	optName
const char *	optTip
const StringList *	optValues

Private Attributes
SWModule *	defaultGreekLex
SWModule *	defaultGreekParse
SWModule *	defaultHebLex
SWModule *	defaultHebParse
SWMgr *	mgr

Detailed Description

This Filter shows/hides strong's numbers in a GBF text

Definition at line 35 of file gbfwordjs.h.

Constructor & Destructor Documentation

GBFWordJS::GBFWordJS

(

)

Definition at line 47 of file gbfwordjs.cpp.

                     : SWOptionFilter(oName, oTip, oValues()) {

     defaultGreekLex   = 0;
     defaultHebLex     = 0;
     defaultGreekParse = 0;
     defaultHebParse   = 0;
     mgr               = 0;
}

GBFWordJS::~GBFWordJS ( )

virtual

Definition at line 57 of file gbfwordjs.cpp.

                      {
}

Member Function Documentation

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.

{ return ""; }

virtual const char* SWOptionFilter::getOptionName ( )

inlinevirtualinherited

gets the name of the option of this filter

Returns

option name

Reimplemented in UTF8Transliterator.

Definition at line 72 of file swoptfilter.h.

{ return optName; }

virtual const char* SWOptionFilter::getOptionTip ( )

inlinevirtualinherited

gets a short explanation of the option of this filter; it could be presented to the user in frontend programs

Returns

option tip/explanation

Reimplemented in UTF8Transliterator.

Definition at line 78 of file swoptfilter.h.

{ return optTip; }

const char * SWOptionFilter::getOptionValue ( )

virtualinherited

Returns

The value of the current option.

Reimplemented in UTF8Transliterator.

Definition at line 62 of file swoptfilter.cpp.

                                           {
    return optionValue;
}

virtual StringList SWOptionFilter::getOptionValues ( )

inlinevirtualinherited

returns a list of the possible option values

Returns

list of option values

Reimplemented in UTF8Transliterator.

Definition at line 84 of file swoptfilter.h.

{ return *optValues; }

bool SWOptionFilter::isBoolean ( )

inlineinherited

many options are simple Off/On boolean type, and frontends may wish to show these with checkmarks or the like to the end user. This is a convenience method to allow a frontend to check if this filter has only Off/On values

Definition at line 67 of file swoptfilter.h.

{ return isBooleanVal; }

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

virtual

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.

Definition at line 61 of file gbfwordjs.cpp.

                                                                                 {
    if (option) {
        char token[2112]; // cheese.  Fix.
        int tokpos = 0;
        bool intoken = false;
        int word = 1;
        char val[128];
        char wordstr[5];
        unsigned int textStart = 0, lastAppendLen = 0, textEnd = 0;
        SWBuf tmp;
        bool newText = false;
        bool needWordOut = false;
        AttributeValue *wordAttrs = 0;
        SWBuf modName = (module)?module->getName():"";
        SWBuf wordSrcPrefix = modName;
        
        const SWBuf orig = text;
        const char * from = orig.c_str();
        const VerseKey *vkey = 0;
        if (key) {
            vkey = SWDYNAMIC_CAST(const VerseKey, key);
        }

        for (text = ""; *from; from++) {
            if (*from == '<') {
                intoken = true;
                tokpos = 0;
                token[0] = 0;
                token[1] = 0;
                token[2] = 0;
                textEnd = (unsigned int)text.length();
                continue;
            }
            if (*from == '>') { // process tokens
                intoken = false;
                if (*token == 'W' && (token[1] == 'G' || token[1] == 'H')) {    // Strongs
                    strcpy(val,token+1);
                    if (atoi((!isdigit(*val))?val+1:val) < 5627) {
                        // normal strongs number
                        sprintf(wordstr, "%03d", word++);
                        needWordOut = (word > 2);
                        wordAttrs = &(module->getEntryAttributes()["Word"][wordstr]);
                        (*wordAttrs)["Lemma"] = val;
    //printf("Adding: [\"Word\"][%s][\"Strongs\"] = %s\n", wordstr, val);
                        tmp = "";
                        tmp.append(text.c_str()+textStart, (int)(textEnd - textStart));
                        (*wordAttrs)["Text"] = tmp;
                        text.append("</span>");
                        SWBuf ts;
                        ts.appendFormatted("%d", textStart);
                        (*wordAttrs)["TextStart"] = ts;
    //printf("Adding: [\"Word\"][%s][\"Text\"] = %s\n", wordstr, tmp.c_str());
                        newText = true;
                    }
                    else {
                        // verb morph
                        if (wordAttrs) {
                            (*wordAttrs)["Morph"] = val;
                        }
    //printf("Adding: [\"Word\"][%s][\"Morph\"] = %s\n", wordstr, val);
                    }

                }
                if (*token == 'W' && token[1] == 'T') { // Morph
                    if (token[2] == 'G' || token[2] == 'H') {
                        strcpy(val, token+2);
                    }
                    else strcpy(val, token+1);
                    if (wordAttrs) {
                        (*wordAttrs)["Morph"] = val;
                        (*wordAttrs)["MorphClass"] = "StrongsMorph";
                    }
                    newText = true;
                }
                // if not a strongs token, keep token in text
                text += '<';
                text += token;
                text += '>';
                if (needWordOut) {
                    char wstr[11];
                    sprintf(wstr, "%03d", word-2);
                    AttributeValue *wAttrs = &(module->getEntryAttributes()["Word"][wstr]);
                    needWordOut = false;
                    SWBuf strong = (*wAttrs)["Lemma"];
                    SWBuf morph = (*wAttrs)["Morph"];
                    SWBuf morphClass = (*wAttrs)["MorphClass"];
                    SWBuf wordText = (*wAttrs)["Text"];
                    SWBuf textSt = (*wAttrs)["TextStart"];
                    if (strong.size()) {
                        char gh = 0;
                        gh = isdigit(strong[0]) ? 0:strong[0];
                        if (!gh) {
                            if (vkey) {
                                gh = vkey->getTestament() ? 'H' : 'G';
                            }
                        }
                        else strong << 1;

                        SWModule *sLex = 0;
                        SWModule *sMorph = 0;
                        if (gh == 'G') {
                            sLex = defaultGreekLex;
                            sMorph = defaultGreekParse;
                        }
                        if (gh == 'H') {
                            sLex = defaultHebLex;
                            sMorph = defaultHebParse;
                        }
                        SWBuf lexName = "";
                        if (sLex) {
                            // we can pass the real lex name in, but we have some
                            // aliases in the javascript to optimize bandwidth
                            lexName = sLex->getName();
                            if (lexName == "StrongsGreek")
                                lexName = "G";
                            if (lexName == "StrongsHebrew")
                                lexName = "H";
                        }
                        SWBuf wordID;
                        if (vkey) {
                            // optimize for bandwidth and use only the verse as the unique entry id
                            wordID.appendFormatted("%d", vkey->getVerse());
                        }
                        else {
                            wordID = key->getText();
                        }
                        for (unsigned int i = 0; i < wordID.size(); i++) {
                            if ((!isdigit(wordID[i])) && (!isalpha(wordID[i]))) {
                                wordID[i] = '_';
                            }
                        }
                        wordID.appendFormatted("_%s%d", wordSrcPrefix.c_str(), atoi(wstr));
                        if (textSt.size()) {
                            int textStr = atoi(textSt.c_str());
                            textStr += lastAppendLen;
                            SWBuf spanStart = "";



                            if (!sMorph) sMorph = 0;    // to pass unused warning for now
/*
                            if (sMorph) {
                                SWBuf popMorph = "<a onclick=\"";
                                popMorph.appendFormatted("p(\'%s\',\'%s\','%s','');\" >%s</a>", sMorph->getName(), morph.c_str(), wordID.c_str(), morph.c_str());
                                morph = popMorph;
                            }
*/

                            // 'p' = 'fillpop' to save bandwidth
                            const char *m = strchr(morph.c_str(), ':');
                            if (m) m++;
                            else m = morph.c_str();
                            spanStart.appendFormatted("<span class=\"clk\" onclick=\"p('%s','%s','%s','%s','','%s');\" >", lexName.c_str(), strong.c_str(), wordID.c_str(), m, modName.c_str());
                            text.insert(textStr, spanStart);
                            lastAppendLen = (unsigned int)spanStart.length();
                        }
                    }

                }
                if (newText) {
                    textStart = (unsigned int)text.length(); newText = false;
                }
                continue;
            }
            if (intoken) {
                if (tokpos < 2045) {
                    token[tokpos++] = *from;
                    // TODO: why is this + 2 ?
                    token[tokpos+2] = 0;
                }
            }
            else {
                text += *from;
            }
        }

        char wstr[11];
        sprintf(wstr, "%03d", word-1);
        AttributeValue *wAttrs = &(module->getEntryAttributes()["Word"][wstr]);
        needWordOut = false;
        SWBuf strong = (*wAttrs)["Lemma"];
        SWBuf morph = (*wAttrs)["Morph"];
        SWBuf morphClass = (*wAttrs)["MorphClass"];
        SWBuf wordText = (*wAttrs)["Text"];
        SWBuf textSt = (*wAttrs)["TextStart"];
        if (strong.size()) {
            char gh = 0;
            gh = isdigit(strong[0]) ? 0:strong[0];
            if (!gh) {
                if (vkey) {
                    gh = vkey->getTestament() ? 'H' : 'G';
                }
            }
            else strong << 1;

            SWModule *sLex = 0;
            if (gh == 'G') {
                sLex = defaultGreekLex;
            }
            if (gh == 'H') {
                sLex = defaultHebLex;
            }
            SWBuf lexName = "";
            if (sLex) {
                // we can pass the real lex name in, but we have some
                // aliases in the javascript to optimize bandwidth
                lexName = sLex->getName();
                if (lexName == "StrongsGreek")
                    lexName = "G";
                if (lexName == "StrongsHebrew")
                    lexName = "H";
            }
            SWBuf wordID;
            if (vkey) {
                // optimize for bandwidth and use only the verse as the unique entry id
                wordID.appendFormatted("%d", vkey->getVerse());
            }
            else {
                wordID = key->getText();
            }
            for (unsigned int i = 0; i < wordID.size(); i++) {
                if ((!isdigit(wordID[i])) && (!isalpha(wordID[i]))) {
                    wordID[i] = '_';
                }
            }
            wordID.appendFormatted("_%s%d", wordSrcPrefix.c_str(), atoi(wstr));
            if (textSt.size()) {
                int textStr = atoi(textSt.c_str());
                textStr += lastAppendLen;
                SWBuf spanStart = "";
                // 'p' = 'fillpop' to save bandwidth
                const char *m = strchr(morph.c_str(), ':');
                if (m) m++;
                else m = morph.c_str();
                spanStart.appendFormatted("<span class=\"clk\" onclick=\"p('%s','%s','%s','%s','','%s');\" >", lexName.c_str(), strong.c_str(), wordID.c_str(), m, modName.c_str());
                text.insert(textStr, spanStart);
            }
        }
    }

    return 0;
}

void GBFWordJS::setDefaultModules ( SWModule *  defaultGreekLex = 0, SWModule *  defaultHebLex = 0, SWModule *  defaultGreekParse = 0, SWModule *  defaultHebParse = 0  )

inline

Definition at line 46 of file gbfwordjs.h.

                                                                                                                                                       {
        this->defaultGreekLex   = defaultGreekLex;
        this->defaultHebLex     = defaultHebLex;
        this->defaultGreekParse = defaultGreekParse;
        this->defaultHebParse   = defaultHebParse;
    }

void GBFWordJS::setMgr ( SWMgr *  mgr )

inline

Definition at line 52 of file gbfwordjs.h.

{ this->mgr = mgr; }

void SWOptionFilter::setOptionValue ( const char *  ival )

virtualinherited

sets the value of the option of this filter, e.g maybe a strong's filter might be set to "On" / "Off" - that would mean to show or not to show the strongs in the text, see also getOptionValues()

Parameters

ival	the new option value

Reimplemented in UTF8Transliterator.

Definition at line 52 of file swoptfilter.cpp.

                                                    {
    for (StringList::const_iterator loop = optValues->begin(); loop != optValues->end(); loop++) {
        if (!stricmp(loop->c_str(), ival)) {
            optionValue = *loop;
            option = (!strnicmp(ival, "On", 2));    // convenience for boolean filters
            break;
        }
    }
}

Member Data Documentation

SWModule* GBFWordJS::defaultGreekLex

private

Definition at line 36 of file gbfwordjs.h.

SWModule* GBFWordJS::defaultGreekParse

private

Definition at line 38 of file gbfwordjs.h.

SWModule* GBFWordJS::defaultHebLex

private

Definition at line 37 of file gbfwordjs.h.

SWModule* GBFWordJS::defaultHebParse

private

Definition at line 39 of file gbfwordjs.h.

bool SWOptionFilter::isBooleanVal

protectedinherited

Definition at line 55 of file swoptfilter.h.

SWMgr* GBFWordJS::mgr

private

Definition at line 40 of file gbfwordjs.h.

bool SWOptionFilter::option

protectedinherited

Definition at line 54 of file swoptfilter.h.

SWBuf SWOptionFilter::optionValue

protectedinherited

Definition at line 50 of file swoptfilter.h.

const char* SWOptionFilter::optName

protectedinherited

Definition at line 51 of file swoptfilter.h.

const char* SWOptionFilter::optTip

protectedinherited

Definition at line 52 of file swoptfilter.h.

const StringList* SWOptionFilter::optValues

protectedinherited

Definition at line 53 of file swoptfilter.h.

---

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

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