OSISWordJS Class Reference

#include <osiswordjs.h>

Inheritance diagram for OSISWordJS:

Collaboration diagram for OSISWordJS:

Public Member Functions
virtual const char *	getHeader () const
virtual const char *	getOptionName ()
virtual const char *	getOptionTip ()
virtual const char *	getOptionValue ()
virtual StringList	getOptionValues ()
bool	isBoolean ()
	OSISWordJS ()
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	~OSISWordJS ()

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 inject JavaScript proving onclick events for modules marked up in OSIS

Definition at line 36 of file osiswordjs.h.

Constructor & Destructor Documentation

OSISWordJS::OSISWordJS

(

)

Definition at line 49 of file osiswordjs.cpp.

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

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

OSISWordJS::~OSISWordJS ( )

virtual

Definition at line 59 of file osiswordjs.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 OSISWordJS::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 63 of file osiswordjs.cpp.

                                                                                  {
    if (option) {
        char token[2112]; // cheese.  Fix.
        int tokpos = 0;
        bool intoken = false;
        int wordNum = 1;
        char wordstr[11];
        SWBuf modName = (module)?module->getName():"";
        // add TR to w src in KJV then remove this next line
        SWBuf wordSrcPrefix = (modName == "KJV")?SWBuf("TR"):modName;

        const VerseKey *vkey = 0;
        if (key) {
            vkey = SWDYNAMIC_CAST(const VerseKey, key);
        }
        
        const SWBuf orig = text;
        const char * from = orig.c_str();

        for (text = ""; *from; ++from) {
            if (*from == '<') {
                intoken = true;
                tokpos = 0;
                token[0] = 0;
                token[1] = 0;
                token[2] = 0;
                continue;
            }
            if (*from == '>') { // process tokens
                intoken = false;
                if ((*token == 'w') && (token[1] == ' ')) { // Word
                    XMLTag wtag(token);
                    sprintf(wordstr, "%03d", wordNum);
                    SWBuf lemmaClass;
                    SWBuf lemma;
                    SWBuf morph;
                    SWBuf page;
                    SWBuf src;
                    char gh = 0;
                    page = module->getEntryAttributes()["Word"][wordstr]["Page"].c_str();
                    if (page.length()) page = (SWBuf)"p:" + page;
                    int count = atoi(module->getEntryAttributes()["Word"][wordstr]["PartCount"].c_str());
                    for (int i = 0; i < count; i++) {

                        // for now, lemma class can just be equal to last lemma class in multi part word
                        SWBuf tmp = "LemmaClass";
                        if (count > 1) tmp.appendFormatted(".%d", i+1);
                        lemmaClass = module->getEntryAttributes()["Word"][wordstr][tmp];

                        tmp = "Lemma";
                        if (count > 1) tmp.appendFormatted(".%d", i+1);
                        tmp = (module->getEntryAttributes()["Word"][wordstr][tmp].c_str());

                        // if we're strongs, 
                        if (lemmaClass == "strong") {
                            gh = tmp[0];
                            tmp << 1;
                        }
                        if (lemma.size()) lemma += "|";
                        lemma += tmp;

                        tmp = "Morph";
                        if (count > 1) tmp.appendFormatted(".%d", i+1);
                        tmp = (module->getEntryAttributes()["Word"][wordstr][tmp].c_str());
                        if (morph.size()) morph += "|";
                        morph += tmp;

                        tmp = "Src";
                        if (count > 1) tmp.appendFormatted(".%d", i+1);
                        tmp = (module->getEntryAttributes()["Word"][wordstr][tmp].c_str());
                        if (!tmp.length()) tmp.appendFormatted("%d", wordNum);
                        tmp.insert(0, wordSrcPrefix);
                        if (src.size()) src += "|";
                        src += tmp;
                    }

                    SWBuf lexName = "";
                    // we can pass the real lex name in, but we have some
                    // aliases in the javascript to optimize bandwidth
                    if ((gh == 'G') && (defaultGreekLex)) {
                        lexName = (!strcmp(defaultGreekLex->getName(), "StrongsGreek"))?"G":defaultGreekLex->getName();
                    }
                    else if ((gh == 'H') && (defaultHebLex)) {
                        lexName = (!strcmp(defaultHebLex->getName(), "StrongsHebrew"))?"H":defaultHebLex->getName();
                    }

                    SWBuf xlit = wtag.getAttribute("xlit");

                    if ((lemmaClass != "strong") && (xlit.startsWith("betacode:"))) {
                        lexName = "betacode";
//                      const char *m = strchr(xlit.c_str(), ':');
//                      strong = ++m;
                    }
                    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();
                    }
                    wordID.appendFormatted("_%s", src.c_str());
                    // clean up our word ID for XHTML
                    for (unsigned int i = 0; i < wordID.size(); i++) {
                        if ((!isdigit(wordID[i])) && (!isalpha(wordID[i]))) {
                            wordID[i] = '_';
                        }
                    }
                    // 'p' = 'fillpop' to save bandwidth
                    text.appendFormatted("<span class=\"clk\" onclick=\"p('%s','%s','%s','%s','%s','%s');\" >", lexName.c_str(), lemma.c_str(), wordID.c_str(), morph.c_str(), page.c_str(), modName.c_str());
                    wordNum++;

                    if (wtag.isEmpty()) {
                        text += "</w></span>";
                    }
                }
                if ((*token == '/') && (token[1] == 'w') && option) {   // Word
                    text += "</w></span>";
                    continue;
                }
                
                // if not a strongs token, keep token in text
                text.append('<');
                text.append(token);
                text.append('>');
                
                continue;
            }
            if (intoken) {
                if (tokpos < 2045) {
                    token[tokpos++] = *from;
                    token[tokpos+2] = 0;
                }
            }
            else    {
                text.append(*from);
            }
        }
    }
    return 0;
}

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

inline

Definition at line 47 of file osiswordjs.h.

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

void OSISWordJS::setMgr ( SWMgr *  mgr )

inline

Definition at line 53 of file osiswordjs.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* OSISWordJS::defaultGreekLex

private

Definition at line 37 of file osiswordjs.h.

SWModule* OSISWordJS::defaultGreekParse

private

Definition at line 39 of file osiswordjs.h.

SWModule* OSISWordJS::defaultHebLex

private

Definition at line 38 of file osiswordjs.h.

SWModule* OSISWordJS::defaultHebParse

private

Definition at line 40 of file osiswordjs.h.

bool SWOptionFilter::isBooleanVal

protectedinherited

Definition at line 55 of file swoptfilter.h.

SWMgr* OSISWordJS::mgr

private

Definition at line 41 of file osiswordjs.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/osiswordjs.h
• src/modules/filters/osiswordjs.cpp