OSISStrongs Class Reference

#include <osisstrongs.h>

Inheritance diagram for OSISStrongs:

Collaboration diagram for OSISStrongs:

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 ()
	OSISStrongs ()
virtual char	processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
virtual void	setOptionValue (const char *ival)
virtual	~OSISStrongs ()

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

Detailed Description

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

Definition at line 34 of file osisstrongs.h.

Constructor & Destructor Documentation

OSISStrongs::OSISStrongs

(

)

Definition at line 48 of file osisstrongs.cpp.

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

OSISStrongs::~OSISStrongs ( )

virtual

Definition at line 52 of file osisstrongs.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 OSISStrongs::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 56 of file osisstrongs.cpp.

                                                                                   {
    SWBuf token;
    bool intoken = false;
    int wordNum = 1;
    char wordstr[11];
    const char *wordStart = 0;
    SWBuf page = "";        // some modules include <seg> page info, so we add these to the words

    const SWBuf orig = text;
    const char * from = orig.c_str();

    for (text = ""; *from; ++from) {
        if (*from == '<') {
            intoken = true;
            token = "";
            continue;
        }
        if (*from == '>') { // process tokens
            intoken = false;

            // possible page seg --------------------------------
            if (token.startsWith("seg ")) {
                XMLTag stag(token);
                SWBuf type = stag.getAttribute("type");
                if (type == "page") {
                    SWBuf number = stag.getAttribute("subtype");
                    if (number.length()) {
                        page = number;
                    }
                }
            }
            // ---------------------------------------------------

            if (token.startsWith("w ")) {   // Word
                XMLTag wtag(token);

                // always save off lemma if we haven't yet
                if (!wtag.getAttribute("savlm")) {
                    const char *l = wtag.getAttribute("lemma");
                    if (l) {
                        wtag.setAttribute("savlm", l);
                    }
                }

                if (module->isProcessEntryAttributes()) {
                    wordStart = from+1;
                    char gh = 0;
                    const VerseKey *vkey = 0;
                    if (key) {
                        vkey = SWDYNAMIC_CAST(const VerseKey, key);
                    }
                    SWBuf lemma      = "";
                    SWBuf morph      = "";
                    SWBuf src        = "";
                    SWBuf morphClass = "";
                    SWBuf lemmaClass = "";

                    const char *attrib;
                    sprintf(wordstr, "%03d", wordNum);

                    // why is morph entry attribute processing done in here?  Well, it's faster.  It makes more local sense to place this code in osismorph.
                    // easier to keep lemma and morph in same wordstr number too maybe.
                    if ((attrib = wtag.getAttribute("morph"))) {
                        int count = wtag.getAttributePartCount("morph", ' ');
                        int i = (count > 1) ? 0 : -1;       // -1 for whole value cuz it's faster, but does the same thing as 0
                        do {
                            SWBuf mClass = "";
                            SWBuf mp = "";
                            attrib = wtag.getAttribute("morph", i, ' ');
                            if (i < 0) i = 0;   // to handle our -1 condition

                            const char *m = strchr(attrib, ':');
                            if (m) {
                                int len = (int)(m-attrib);
                                mClass.append(attrib, len);
                                attrib += (len+1);
                            }
                            if ((mClass == "x-Robinsons") || (mClass == "x-Robinson") || (mClass == "Robinson")) {
                                mClass = "robinson";
                            }
                            if (i) { morphClass += " "; morph += " "; }
                            mp += attrib;
                            morphClass += mClass;
                            morph += mp;
                            mp.replaceBytes("+", ' ');
                            SWBuf tmp;
                            tmp.setFormatted("Morph.%d", i+1);
                            module->getEntryAttributes()["Word"][wordstr][tmp] = mp;
                            tmp.setFormatted("MorphClass.%d", i+1);
                            module->getEntryAttributes()["Word"][wordstr][tmp] = mClass;
                        } while (++i < count);
                    }

                    if ((attrib = wtag.getAttribute("savlm"))) {
                        int count = wtag.getAttributePartCount("savlm", ' ');
                        int i = (count > 1) ? 0 : -1;       // -1 for whole value cuz it's faster, but does the same thing as 0
                        do {
                            gh = 0;
                            SWBuf lClass = "";
                            SWBuf l = "";
                            attrib = wtag.getAttribute("savlm", i, ' ');
                            if (i < 0) i = 0;   // to handle our -1 condition

                            const char *m = strchr(attrib, ':');
                            if (m) {
                                int len = (int)(m-attrib);
                                lClass.append(attrib, len);
                                attrib += (len+1);
                            }
                            if ((lClass == "x-Strongs") || (lClass == "strong") || (lClass == "Strong")) {
                                if (isdigit(attrib[0])) {
                                    if (vkey) {
                                        gh = vkey->getTestament() ? 'H' : 'G';
                                    }
                                }
                                else {
                                    gh = *attrib;
                                    attrib++;
                                }
                                lClass = "strong";
                            }
                            if (gh) l += gh;
                            l += attrib;
                            if (i) { lemmaClass += " "; lemma += " "; }
                            lemma += l;
                            l.replaceBytes("+", ' ');
                            lemmaClass += lClass;
                            SWBuf tmp;
                            tmp.setFormatted("Lemma.%d", i+1);
                            module->getEntryAttributes()["Word"][wordstr][tmp] = l;
                            tmp.setFormatted("LemmaClass.%d", i+1);
                            module->getEntryAttributes()["Word"][wordstr][tmp] = lClass;
                        } while (++i < count);
                        module->getEntryAttributes()["Word"][wordstr]["PartCount"].setFormatted("%d", count);
                    }

                    if ((attrib = wtag.getAttribute("src"))) {
                        int count = wtag.getAttributePartCount("src", ' ');
                        int i = (count > 1) ? 0 : -1;       // -1 for whole value cuz it's faster, but does the same thing as 0
                        do {
                            SWBuf mp = "";
                            attrib = wtag.getAttribute("src", i, ' ');
                            if (i < 0) i = 0;   // to handle our -1 condition

                            if (i) src += " ";
                            mp += attrib;
                            src += mp;
                            mp.replaceBytes("+", ' ');
                            SWBuf tmp;
                            tmp.setFormatted("Src.%d", i+1);
                            module->getEntryAttributes()["Word"][wordstr][tmp] = mp;
                        } while (++i < count);
                    }


                    if (lemma.length())
                        module->getEntryAttributes()["Word"][wordstr]["Lemma"] = lemma;
                    if (lemmaClass.length())
                        module->getEntryAttributes()["Word"][wordstr]["LemmaClass"] = lemmaClass;
                    if (morph.length())
                        module->getEntryAttributes()["Word"][wordstr]["Morph"] = morph;
                    if (morphClass.length())
                        module->getEntryAttributes()["Word"][wordstr]["MorphClass"] = morphClass;
                    if (src.length())
                        module->getEntryAttributes()["Word"][wordstr]["Src"] = src;
                    if (page.length())
                        module->getEntryAttributes()["Word"][wordstr]["Page"] = page;

                    if (wtag.isEmpty()) {
                        int j;
                        for (j = (int)token.length()-1; ((j>0) && (strchr(" /", token[j]))); j--);
                        token.size(j+1);
                    }
                    
                    token += " wn=\"";
                    token += wordstr;
                    token += "\"";

                    if (wtag.isEmpty()) {
                        token += "/";
                    }

                    wordNum++;
                }

                // if we won't want strongs, then lets get them out of lemma
                if (!option) {
                    int count = wtag.getAttributePartCount("lemma", ' ');
                    for (int i = 0; i < count; ++i) {
                        SWBuf a = wtag.getAttribute("lemma", i, ' ');
                        const char *prefix = a.stripPrefix(':');
                        if ((prefix) && (!strcmp(prefix, "x-Strongs") || !strcmp(prefix, "strong") || !strcmp(prefix, "Strong"))) {
                            // remove attribute part
                            wtag.setAttribute("lemma", 0, i, ' ');
                            --i;
                            --count;
                        }
                    }


                }
                token = wtag;
                token.trim();
                // drop <>
                token << 1;
                token--;
            }
            if (token.startsWith("/w")) {   // Word End
                if (module->isProcessEntryAttributes()) {
                    if (wordStart) {
                        SWBuf tmp;
                        tmp.append(wordStart, (from-wordStart)-3);
                        sprintf(wordstr, "%03d", wordNum-1);
                        module->getEntryAttributes()["Word"][wordstr]["Text"] = tmp;
                    }
                }
                wordStart = 0;
            }
            
            // keep token in text
            text.append('<');
            text.append(token);
            text.append('>');
            
            continue;
        }
        if (intoken) {
            token += *from;
        }
        else    {
            text.append(*from);
        }
    }
    return 0;
}

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

bool SWOptionFilter::isBooleanVal

protectedinherited

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