OSISFootnotes Class Reference

#include <osisfootnotes.h>

Inheritance diagram for OSISFootnotes:

Collaboration diagram for OSISFootnotes:

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

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

Detailed Description

This Filter shows/hides footnotes in a OSIS text

Definition at line 33 of file osisfootnotes.h.

Constructor & Destructor Documentation

OSISFootnotes::OSISFootnotes

(

)

Definition at line 49 of file osisfootnotes.cpp.

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

OSISFootnotes::~OSISFootnotes ( )

virtual

Definition at line 53 of file osisfootnotes.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 OSISFootnotes::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 57 of file osisfootnotes.cpp.

                                                                                     {
    SWBuf token;
    bool intoken    = false;
    bool hide       = false;
    SWBuf tagText;
    XMLTag startTag;
    SWBuf refs = "";
    int footnoteNum = 1;
    char buf[254];
    SWKey *p = (module) ? module->createKey() : (key) ? key->clone() : new VerseKey();
        VerseKey *parser = SWDYNAMIC_CAST(VerseKey, p);
        if (!parser) {
            delete p;
                parser = new VerseKey();
        }
        *parser = key->getText();

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

    XMLTag tag;
    bool strongsMarkup = false;


    for (text = ""; *from; ++from) {

        // remove all newlines temporarily to fix kjv2003 module
        if ((*from == 10) || (*from == 13)) {
            if ((text.length()>1) && (text[text.length()-2] != ' ') && (*(from+1) != ' '))
                text.append(' ');
            continue;
        }


        if (*from == '<') {
            intoken = true;
            token = "";
            continue;
        }



        if (*from == '>') { // process tokens
            intoken = false;
            if (!strncmp(token, "note", 4) || !strncmp(token.c_str(), "/note", 5)) {
                tag = token;

                if (!tag.isEndTag()) {
                    if (tag.getAttribute("type") && (!strcmp("x-strongsMarkup", tag.getAttribute("type"))
                                            || !strcmp("strongsMarkup", tag.getAttribute("type")))  // deprecated
                            ) {
                        tag.setEmpty(false);  // handle bug in KJV2003 module where some note open tags were <note ... />
                        strongsMarkup = true;
                    }

                    if (!tag.isEmpty()) {
//                  if ((!tag.isEmpty()) || (SWBuf("strongsMarkup") == tag.getAttribute("type"))) {
                        refs = "";
                        startTag = tag;
                        hide = true;
                        tagText = "";
                        continue;
                    }
                }
                if (hide && tag.isEndTag()) {
                    if (module->isProcessEntryAttributes() && !strongsMarkup) { //don`t parse strongsMarkup to EntryAttributes as Footnote
                        sprintf(buf, "%i", footnoteNum++);
                        StringList attributes = startTag.getAttributeNames();
                        for (StringList::const_iterator it = attributes.begin(); it != attributes.end(); it++) {
                            module->getEntryAttributes()["Footnote"][buf][it->c_str()] = startTag.getAttribute(it->c_str());
                        }
                        module->getEntryAttributes()["Footnote"][buf]["body"] = tagText;
                        startTag.setAttribute("swordFootnote", buf);
                        if ((startTag.getAttribute("type")) && (!strcmp(startTag.getAttribute("type"), "crossReference"))) {
                            if (!refs.length())
                                refs = parser->parseVerseList(tagText.c_str(), *parser, true).getRangeText();
                            module->getEntryAttributes()["Footnote"][buf]["refList"] = refs.c_str();
                        }
                    }
                    hide = false;
                    if (option || (startTag.getAttribute("type") && !strcmp(startTag.getAttribute("type"), "crossReference"))) {    // we want the tag in the text; crossReferences are handled by another filter
                        text.append(startTag);
//                      text.append(tagText);   // we don't put the body back in because it is retrievable from EntryAttributes["Footnotes"][]["body"].
                    }
                    else    continue;
                }
                strongsMarkup = false;
            }

            // if not a heading token, keep token in text
            //if ((!strcmp(tag.getName(), "reference")) && (!tag.isEndTag())) {
            //  SWBuf osisRef = tag.getAttribute("osisRef");
            if (!strncmp(token, "reference", 9)) {
                if (refs.length()) {
                    refs.append("; ");
                }

                const char* attr = strstr(token.c_str() + 9, "osisRef=\"");
                const char* end  = attr ? strchr(attr+9, '"') : 0;

                if (attr && end) {
                    refs.append(attr+9, end-(attr+9));
                }
            }
            if (!hide) {
                text.append('<');
                text.append(token);
                text.append('>');
            }
            else {
                tagText.append('<');
                tagText.append(token);
                tagText.append('>');
            }
            continue;
        }
        if (intoken) { //copy token
            token.append(*from);
        }
        else if (!hide) { //copy text which is not inside a token
            text.append(*from);
        }
        else tagText.append(*from);
    }
        delete parser;
    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/osisfootnotes.h
• src/modules/filters/osisfootnotes.cpp