OSISReferenceLinks Class Reference

#include <osisreferencelinks.h>

Inheritance diagram for OSISReferenceLinks:

Collaboration diagram for OSISReferenceLinks:

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 ()
	OSISReferenceLinks (const char *optionName, const char *optionTip, const char *type, const char *subType=0, const char *defaultValue="On")
virtual char	processText (SWBuf &text, const SWKey *key=0, const SWModule *module=0)
virtual void	setOptionValue (const char *ival)
virtual	~OSISReferenceLinks ()

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

Private Attributes
SWBuf	optionName
SWBuf	optionTip
SWBuf	subType
SWBuf	type

Detailed Description

This Filter hides reference links with a particular type/subtype in an OSIS text

Definition at line 35 of file osisreferencelinks.h.

Constructor & Destructor Documentation

OSISReferenceLinks::OSISReferenceLinks	(	const char *	optionName,
		const char *	optionTip,
		const char *	type,
		const char *	subType = 0,
		const char *	defaultValue = "On"
	)

Parameters

optionName	- name of this option
optionTip	- user help tip for this option
type	- which reference types to hide
subType	- which reference subTypes to hide (optional)
defaultValue	- default value of option "On" or "Off" (optional)

Definition at line 43 of file osisreferencelinks.cpp.

        : SWOptionFilter(),
          optionName(optionName),
          optionTip(optionTip),
          type(type),
          subType(subType) {

    optName   = this->optionName.c_str();
    optTip    = this->optionTip.c_str();
    optValues = oValues();
    setOptionValue(defaultValue);
}

OSISReferenceLinks::~OSISReferenceLinks ( )

virtual

Definition at line 57 of file osisreferencelinks.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 OSISReferenceLinks::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 osisreferencelinks.cpp.

                                                                                          {
    if (option) return 0;
       
    SWBuf token;
    bool intoken        = false;
    bool stripThisToken = false;

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

    for (text = ""; *from; ++from) {
        if (*from == '<') {
            intoken = true;
            token = "";
            continue;
        }
        else if (*from == '>') {    // process tokens
            intoken = false;
            if (strncmp(token, "reference", 9) && strncmp(token.c_str(), "/reference", 10)) {
                text.append('<');
                text.append(token);
                text.append('>');
            }
            else {
                XMLTag tag;
                tag = token;
                if (!tag.isEndTag() && type == tag.getAttribute("type") && (!subType.size() || subType == tag.getAttribute("subType"))) {
                    stripThisToken = true;
                    continue;
                }
                else if (tag.isEndTag() && stripThisToken) {
                    stripThisToken = false;
                    continue;
                }
                text.append('<');
                text.append(token);
                text.append('>');
            }
            continue;
        }
           
        if (intoken) { //copy token
            token.append(*from);
        }
        else { //copy text which is not inside a token
            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 OSISReferenceLinks::optionName

private

Definition at line 36 of file osisreferencelinks.h.

SWBuf OSISReferenceLinks::optionTip

private

Definition at line 37 of file osisreferencelinks.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.

SWBuf OSISReferenceLinks::subType

private

Definition at line 39 of file osisreferencelinks.h.

SWBuf OSISReferenceLinks::type

private

Definition at line 38 of file osisreferencelinks.h.

---

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

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