SWModule Class Reference

#include <swmodule.h>

Inheritance diagram for SWModule:

Collaboration diagram for SWModule:

Classes
class	StdOutDisplay

Public Member Functions
virtual SWModule &	addEncodingFilter (SWFilter *newFilter)
SWDEPRECATED SWModule &	AddEncodingFilter (SWFilter *newFilter)
virtual SWModule &	addOptionFilter (SWOptionFilter *newFilter)
SWDEPRECATED SWModule &	AddOptionFilter (SWOptionFilter *newFilter)
virtual SWModule &	addRawFilter (SWFilter *newFilter)
SWDEPRECATED SWModule &	AddRawFilter (SWFilter *newFilter)
virtual SWModule &	addRenderFilter (SWFilter *newFilter)
SWDEPRECATED SWModule &	AddRenderFilter (SWFilter *newFilter)
virtual SWModule &	addStripFilter (SWFilter *newFilter)
SWDEPRECATED SWModule &	AddStripFilter (SWFilter *newFilter)
virtual SWKey *	createKey () const
SWDEPRECATED SWKey *	CreateKey () const
virtual signed char	createSearchFramework (void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)
virtual void	decrement (int steps=1)
virtual void	deleteEntry ()
virtual void	deleteSearchFramework ()
SWDEPRECATED const char *	Description () const
SWDEPRECATED const char *	Description (const char *imoddesc)
SWDEPRECATED char	Direction (signed char newdir=-1)
SWDEPRECATED SWDisplay *	Disp (SWDisplay *idisp=0)
virtual char	display ()
SWDEPRECATED char	Display ()
SWDEPRECATED char	Encoding (signed char enc=-1)
virtual void	encodingFilter (SWBuf &buf, const SWKey *key) const
virtual SWDEPRECATED char	Error ()
virtual void	filterBuffer (OptionFilterList *filters, SWBuf &buf, const SWKey *key) const
virtual void	filterBuffer (FilterList *filters, SWBuf &buf, const SWKey *key) const
virtual void	flush ()
virtual SWBuf	getBibliography (unsigned char bibFormat=BIB_BIBTEX) const
virtual const ConfigEntMap &	getConfig () const
virtual const char *	getConfigEntry (const char *key) const
const char *	getDescription () const
virtual char	getDirection () const
virtual SWDisplay *	getDisplay () const
char	getEncoding () const
virtual AttributeTypeList &	getEntryAttributes () const
virtual int	getEntrySize () const
virtual long	getIndex () const
virtual SWKey *	getKey () const
virtual const char *	getKeyText () const
const char *	getLanguage () const
char	getMarkup () const
const char *	getName () const
virtual const OptionFilterList &	getOptionFilters () const
const char *	getRawEntry () const
virtual SWBuf &	getRawEntryBuf () const =0
virtual const FilterList &	getRenderFilters () const
virtual const char *	getRenderHeader () const
SWDEPRECATED bool	getSkipConsecutiveLinks ()
const char *	getType () const
virtual bool	hasEntry (const SWKey *) const
virtual bool	hasSearchFramework ()
virtual void	increment (int steps=1)
SWDEPRECATED long	Index () const
SWDEPRECATED long	Index (long iindex)
virtual bool	isLinked (const SWKey *, const SWKey *) const
virtual bool	isProcessEntryAttributes () const
virtual bool	isSearchOptimallySupported (const char *istr, int searchType, int flags, SWKey *scope)
virtual bool	isSkipConsecutiveLinks ()
virtual bool	isUnicode () const
virtual bool	isWritable () const
SWDEPRECATED char	Key (const SWKey &ikey)
SWDEPRECATED SWKey &	Key () const
SWDEPRECATED const char *	KeyText (const char *ikeytext=0)
SWDEPRECATED const char *	Lang (char *imodlang=0)
virtual long	lastAccess ()
virtual void	linkEntry (const SWKey *sourceKey)
SWDEPRECATED char	Markup (signed char imarkup=-1)
SWDEPRECATED const char *	Name () const
SWDEPRECATED const char *	Name (const char *imodname)
virtual void	optionFilter (SWBuf &buf, const SWKey *key) const
virtual char	popError ()
SWDEPRECATED void	processEntryAttributes (bool val) const
virtual void	rawFilter (SWBuf &buf, const SWKey *key) const
virtual SWModule &	removeEncodingFilter (SWFilter *oldFilter)
SWDEPRECATED SWModule &	RemoveEncodingFilter (SWFilter *oldFilter)
virtual SWModule &	removeRenderFilter (SWFilter *oldFilter)
SWDEPRECATED SWModule &	RemoveRenderFilter (SWFilter *oldFilter)
virtual void	renderFilter (SWBuf &buf, const SWKey *key) const
SWBuf	renderText (const char *buf, int len=-1, bool render=true) const
SWBuf	renderText ()
SWDEPRECATED const char *	RenderText (const char *buf=0, int len=-1, bool render=true)
SWBuf	renderText (const SWKey *tmpKey)
virtual SWModule &	replaceEncodingFilter (SWFilter *oldFilter, SWFilter *newFilter)
SWDEPRECATED SWModule &	ReplaceEncodingFilter (SWFilter *oldFilter, SWFilter *newFilter)
virtual SWModule &	replaceRenderFilter (SWFilter *oldFilter, SWFilter *newFilter)
SWDEPRECATED SWModule &	ReplaceRenderFilter (SWFilter *oldFilter, SWFilter *newFilter)
virtual long	resourceConsumption ()
virtual ListKey &	search (const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)
SWDEPRECATED ListKey &	Search (const char *istr, int searchType=0, int flags=0, SWKey *scope=0, bool *justCheckIfSupported=0, void(*percent)(char, void *)=&nullPercent, void *percentUserData=0)
virtual void	setConfig (ConfigEntMap *config)
virtual void	setDisplay (SWDisplay *idisp)
virtual void	setEntry (const char *inbuf, long len=-1)
virtual void	setIndex (long iindex)
virtual char	setKey (const SWKey *ikey)
char	setKey (const SWKey &ikey)
SWDEPRECATED char	SetKey (const SWKey *ikey)
SWDEPRECATED char	SetKey (const SWKey &ikey)
char	setKeyText (const char *keyText)
virtual void	setPosition (SW_POSITION pos)
virtual void	setProcessEntryAttributes (bool val) const
virtual void	setSkipConsecutiveLinks (bool val)
void	setType (const char *imodtype)
virtual void	stripFilter (SWBuf &buf, const SWKey *key) const
virtual const char *	stripText (const char *buf=0, int len=-1)
SWDEPRECATED const char *	StripText (const char *buf=0, int len=-1)
virtual const char *	stripText (const SWKey *tmpKey)
	SWModule (const char *imodname=0, const char *imoddesc=0, SWDisplay *idisp=0, const char *imodtype=0, SWTextEncoding encoding=ENC_UNKNOWN, SWTextDirection dir=DIRECTION_LTR, SWTextMarkup markup=FMT_UNKNOWN, const char *modlang=0)
SWDEPRECATED const char *	Type () const
SWDEPRECATED const char *	Type (const char *imodtype)
virtual	~SWModule ()

Static Public Member Functions
static signed char	createModule (const char *path)
static void	nullPercent (char percent, void *userData)

Public Attributes
bool	terminateSearch

Static Public Attributes
static const signed int	SEARCHFLAG_MATCHWHOLEENTRY = 4096
static const signed int	SEARCHFLAG_STRICTBOUNDARIES = 8192
static const signed int	SEARCHTYPE_ENTRYATTR = -3
static const signed int	SEARCHTYPE_EXTERNAL = -4
static const signed int	SEARCHTYPE_MULTIWORD = -2
static const signed int	SEARCHTYPE_PHRASE = -1
static const signed int	SEARCHTYPE_REGEX = 0

Static Protected Member Functions
static void	prepText (SWBuf &buf)

Protected Attributes
ConfigEntMap *	config
char	direction
SWDisplay *	disp
char	encoding
FilterList *	encodingFilters
AttributeTypeList	entryAttributes
SWBuf	entryBuf
long	entryIndex
int	entrySize
char	error
SWKey *	key
ListKey	listKey
char	markup
char *	moddesc
char *	modlang
char *	modname
char *	modtype
OptionFilterList *	optionFilters
ConfigEntMap	ownConfig
bool	procEntAttr
FilterList *	rawFilters
FilterList *	renderFilters
bool	skipConsecutiveLinks
FilterList *	stripFilters

Static Protected Attributes
static StdOutDisplay	rawdisp

Detailed Description

The class SWModule is the base class for all modules used in Sword. It provides functions to look up a text passage, to search in the module, to switch on/off the state of optional things like Strong's numbers or footnotes.

SWModule has also functions to write to the data files.

Definition at line 101 of file swmodule.h.

Constructor & Destructor Documentation

SWModule::SWModule	(	const char *	imodname = 0,
		const char *	imoddesc = 0,
		SWDisplay *	idisp = 0,
		const char *	imodtype = 0,
		SWTextEncoding	encoding = ENC_UNKNOWN,
		SWTextDirection	dir = DIRECTION_LTR,
		SWTextMarkup	markup = FMT_UNKNOWN,
		const char *	modlang = 0
	)

SWModule c-tor

Parameters

imodname	Internal name for module; see also getName()
imoddesc	Name to display to user for module; see also getDescription()
idisp	Display object to use for displaying; see also getDisplay()
imodtype	Type of module (e.g. Biblical Text, Commentary, etc.); see also getType()
encoding	Encoding of the module (e.g. UTF-8)
dir	Direction of text flow (e.g. Right to Left for Hebrew)
markup	Source Markup of the module (e.g. OSIS)
modlang	Language of the module (e.g. en)

Definition at line 104 of file swmodule.cpp.

                                                                                                                                                                                                    {
    key       = createKey();
    entryBuf  = "";
    config    = &ownConfig;
    modname   = 0;
    error     = 0;
    moddesc   = 0;
    modtype   = 0;
    modlang   = 0;
    this->encoding = encoding;
    this->direction = direction;
    this->markup  = markup;
    entrySize= -1;
    disp     = (idisp) ? idisp : &rawdisp;
    stdstr(&modname, imodname);
    stdstr(&moddesc, imoddesc);
    stdstr(&modtype, imodtype);
    stdstr(&modlang, imodlang);
    stripFilters = new FilterList();
    rawFilters = new FilterList();
    renderFilters = new FilterList();
    optionFilters = new OptionFilterList();
    encodingFilters = new FilterList();
    skipConsecutiveLinks = true;
    procEntAttr = true;
}

SWModule::~SWModule ( )

virtual

SWModule d-tor

Definition at line 136 of file swmodule.cpp.

{
    if (modname)
        delete [] modname;
    if (moddesc)
        delete [] moddesc;
    if (modtype)
        delete [] modtype;
    if (modlang)
        delete [] modlang;

    if (key) {
        if (!key->isPersist())
            delete key;
    }

    stripFilters->clear();
    rawFilters->clear();
    renderFilters->clear();
    optionFilters->clear();
    encodingFilters->clear();
    entryAttributes.clear();

    delete stripFilters;
    delete rawFilters;
    delete renderFilters;
    delete optionFilters;
    delete encodingFilters;
}

Member Function Documentation

virtual SWModule& SWModule::addEncodingFilter ( SWFilter *  newFilter )

inlinevirtual

Adds an EncodingFilter to this module's

See Also

encodingFilters queue. Encoding Filters are called immediately when the module is read from data source, to assure we have desired internal data stream (e.g. UTF-8 for text modules)

Parameters

newFilter

the filter to add

Returns

*this

Definition at line 627 of file swmodule.h.

                                                             {
        encodingFilters->push_back(newFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::AddEncodingFilter ( SWFilter *  newFilter )

inline

Deprecated:

Use addEncodingFilter

Definition at line 634 of file swmodule.h.

{ return addEncodingFilter(newFilter); }

virtual SWModule& SWModule::addOptionFilter ( SWOptionFilter *  newFilter )

inlinevirtual

Adds an OptionFilter to this module's optionFilters queue. Option Filters are used to turn options in the text on or off, or so some other state (e.g. Strong's Number, Footnotes, Cross References, etc.)

Parameters

newFilter

the filter to add

Returns

*this

Definition at line 727 of file swmodule.h.

                                                                 {
        optionFilters->push_back(newFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::AddOptionFilter ( SWOptionFilter *  newFilter )

inline

Deprecated:

Use addOptionFilter

Definition at line 734 of file swmodule.h.

{ return addOptionFilter(newFilter); }

virtual SWModule& SWModule::addRawFilter ( SWFilter *  newFilter )

inlinevirtual

Adds a RawFilter to this module's rawFilters queue

Parameters

newFilter

the filter to add

Returns

*this

Definition at line 694 of file swmodule.h.

                                                        {
        rawFilters->push_back(newFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::AddRawFilter ( SWFilter *  newFilter )

inline

Deprecated:

Use addRawFilter

Definition at line 701 of file swmodule.h.

{ return addRawFilter(newFilter); }

virtual SWModule& SWModule::addRenderFilter ( SWFilter *  newFilter )

inlinevirtual

Adds a RenderFilter to this module's renderFilters queue. Render Filters are called when the module is asked to produce renderable text.

Parameters

newFilter

the filter to add

Returns

*this

Definition at line 564 of file swmodule.h.

                                                           {
        renderFilters->push_back(newFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::AddRenderFilter ( SWFilter *  newFilter )

inline

Deprecated:

Use addRenderFilter

Definition at line 571 of file swmodule.h.

{ return addRenderFilter(newFilter); }

virtual SWModule& SWModule::addStripFilter ( SWFilter *  newFilter )

inlinevirtual

Adds a StripFilter to this module's stripFilters queue. Strip filters are called when a module is asked to render an entry without any markup (like when searching).

Parameters

newFilter

the filter to add

Returns

*this

Definition at line 681 of file swmodule.h.

                                                          {
        stripFilters->push_back(newFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::AddStripFilter ( SWFilter *  newFilter )

inline

Deprecated:

Use addStripFilter

Definition at line 688 of file swmodule.h.

{ return addStripFilter(newFilter); }

SWKey * SWModule::createKey ( ) const

virtual

Allocates a key of specific type for module The different reimplementations of SWModule (e.g. SWText) support SWKey implementations, which support special. This functions returns a SWKey object which works with the current implementation of SWModule. For example for the SWText class it returns a VerseKey object.

See Also

VerseKey, ListKey, SWText, SWLD, SWCom

Returns

pointer to allocated key. Caller is responsible for deleting the object

Reimplemented in SWCom, SWText, RawGenBook, SWGenBook, and SWLD.

Definition at line 173 of file swmodule.cpp.

{
    return new SWKey();
}

SWDEPRECATED SWKey* SWModule::CreateKey ( ) const

inline

Deprecated:

Use createKey

Definition at line 492 of file swmodule.h.

{ return createKey(); }

signed char SWModule::createModule ( const char *  path )

static

Creates a new, empty module

Parameters

path	path where to create the new module

Returns

error

Definition at line 1676 of file swmodule.cpp.

                                              {
    return -1;
}

signed char SWModule::createSearchFramework ( void(*)(char, void *)  percent = &nullPercent, void *  percentUserData = 0  )

virtual

ask the object to build any indecies it wants for optimal searching

Reimplemented from SWSearchable.

Definition at line 1193 of file swmodule.cpp.

                                                                                                {

#if defined USELUCENE || defined USEXAPIAN
    SWBuf target = getConfigEntry("AbsoluteDataPath");
    if (!target.endsWith("/") && !target.endsWith("\\")) {
        target.append('/');
    }
#if defined USEXAPIAN
    target.append("xapian");
#elif defined USELUCENE
    const int MAX_CONV_SIZE = 1024 * 1024;
    target.append("lucene");
#endif
    int status = FileMgr::createParent(target+"/dummy");
    if (status) return -1;

    SWKey *saveKey = 0;
    SWKey *searchKey = 0;
    SWKey textkey;
    SWBuf c;


    // turn all filters to default values
    StringList filterSettings;
    for (OptionFilterList::iterator filter = optionFilters->begin(); filter != optionFilters->end(); filter++) {
        filterSettings.push_back((*filter)->getOptionValue());
        (*filter)->setOptionValue(*((*filter)->getOptionValues().begin()));

        if ( (!strcmp("Greek Accents", (*filter)->getOptionName())) ||
            (!strcmp("Hebrew Vowel Points", (*filter)->getOptionName())) ||
            (!strcmp("Arabic Vowel Points", (*filter)->getOptionName()))
           ) {
            (*filter)->setOptionValue("Off");
        }
    }


    // be sure we give CLucene enough file handles
    FileMgr::getSystemFileMgr()->flush();

    // save key information so as not to disrupt original
    // module position
    if (!key->isPersist()) {
        saveKey = createKey();
        *saveKey = *key;
    }
    else    saveKey = key;

    searchKey = (key->isPersist())?key->clone():0;
    if (searchKey) {
        searchKey->setPersist(1);
        setKey(*searchKey);
    }

    bool includeKeyInSearch = getConfig().has("SearchOption", "IncludeKeyInSearch");

    // lets create or open our search index
#if defined USEXAPIAN
    Xapian::WritableDatabase database(target.c_str(), Xapian::DB_CREATE_OR_OPEN);
    Xapian::TermGenerator termGenerator;
    SWTRY {
        termGenerator.set_stemmer(Xapian::Stem(getLanguage()));
    } SWCATCH(...) {}

#elif defined USELUCENE
    RAMDirectory *ramDir = 0;
    IndexWriter *coreWriter = 0;
    IndexWriter *fsWriter = 0;
    Directory *d = 0;

    const TCHAR *stopWords[] = { 0 };
    standard::StandardAnalyzer *an = new standard::StandardAnalyzer(stopWords);

    ramDir = new RAMDirectory();
    coreWriter = new IndexWriter(ramDir, an, true);
    coreWriter->setMaxFieldLength(MAX_CONV_SIZE);
#endif




    char perc = 1;
    VerseKey *vkcheck = 0;
    vkcheck = SWDYNAMIC_CAST(VerseKey, key);
    VerseKey *chapMax = 0;
    if (vkcheck) chapMax = (VerseKey *)vkcheck->clone();

    TreeKeyIdx *tkcheck = 0;
    tkcheck = SWDYNAMIC_CAST(TreeKeyIdx, key);


    *this = BOTTOM;
    long highIndex = key->getIndex();
    if (!highIndex)
        highIndex = 1;      // avoid division by zero errors.

    bool savePEA = isProcessEntryAttributes();
    setProcessEntryAttributes(true);

    // prox chapter blocks
    // position module at the beginning
    *this = TOP;

    SWBuf proxBuf;
    SWBuf proxLem;
    SWBuf proxMorph;
    SWBuf strong;
    SWBuf morph;

    char err = popError();
    while (!err) {
        long mindex = key->getIndex();

        proxBuf = "";
        proxLem = "";
        proxMorph = "";

        // computer percent complete so we can report to our progress callback
        float per = (float)mindex / highIndex;
        // between 5%-98%
        per *= 93; per += 5;
        char newperc = (char)per;
        if (newperc > perc) {
            perc = newperc;
            (*percent)(perc, percentUserData);
        }

        // get "content" field
        const char *content = stripText();

        bool good = false;

        // start out entry
#if defined USEXAPIAN
        Xapian::Document doc;
        termGenerator.set_document(doc);
#elif defined USELUCENE
        Document *doc = new Document();
#endif
        // get "key" field
        SWBuf keyText = (vkcheck) ? vkcheck->getOSISRef() : getKeyText();
        if (content && *content) {
            good = true;


            // build "strong" field
            AttributeTypeList::iterator words;
            AttributeList::iterator word;
            AttributeValue::iterator strongVal;
            AttributeValue::iterator morphVal;

            strong="";
            morph="";
            words = getEntryAttributes().find("Word");
            if (words != getEntryAttributes().end()) {
                for (word = words->second.begin();word != words->second.end(); word++) {
                    int partCount = atoi(word->second["PartCount"]);
                    if (!partCount) partCount = 1;
                    for (int i = 0; i < partCount; i++) {
                        SWBuf tmp = "Lemma";
                        if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                        strongVal = word->second.find(tmp);
                        if (strongVal != word->second.end()) {
                            // cheeze.  skip empty article tags that weren't assigned to any text
                            if (strongVal->second == "G3588") {
                                if (word->second.find("Text") == word->second.end())
                                    continue;   // no text? let's skip
                            }
                            strong.append(strongVal->second);
                            morph.append(strongVal->second);
                            morph.append('@');
                            SWBuf tmp = "Morph";
                            if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                            morphVal = word->second.find(tmp);
                            if (morphVal != word->second.end()) {
                                morph.append(morphVal->second);
                            }
                            strong.append(' ');
                            morph.append(' ');
                        }
                    }
                }
            }

#if defined USEXAPIAN
            doc.set_data(keyText.c_str());
#elif defined USELUCENE
            doc->add(*_CLNEW Field(_T("key"), (wchar_t *)utf8ToWChar(keyText).getRawData(), Field::STORE_YES | Field::INDEX_UNTOKENIZED));
#endif

            if (includeKeyInSearch) {
                c = keyText;
                c += " ";
                c += content;
                content = c.c_str();
            }

#if defined USEXAPIAN
            termGenerator.index_text(content);
            termGenerator.index_text(content, 1, "C");
#elif defined USELUCENE
            doc->add(*_CLNEW Field(_T("content"), (wchar_t *)utf8ToWChar(content).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED));
#endif

            if (strong.length() > 0) {
#if defined USEXAPIAN
                termGenerator.index_text(strong.c_str(), 1, "L");
                termGenerator.index_text(morph.c_str(), 1, "M");
#elif defined USELUCENE
                doc->add(*_CLNEW Field(_T("lemma"), (wchar_t *)utf8ToWChar(strong).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED));
                doc->add(*_CLNEW Field(_T("morph"), (wchar_t *)utf8ToWChar(morph).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED));
#endif
//printf("setting fields (%s).\ncontent: %s\nlemma: %s\n", (const char *)*key, content, strong.c_str());
            }

//printf("setting fields (%s).\n", (const char *)*key);
//fflush(stdout);
        }
        // don't write yet, cuz we have to see if we're the first of a prox block (5:1 or chapter5/verse1

        // for VerseKeys use chapter
        if (vkcheck) {
            *chapMax = *vkcheck;
            // we're the first verse in a chapter
            if (vkcheck->getVerse() == 1) {
                *chapMax = MAXVERSE;
                VerseKey saveKey = *vkcheck;
                while ((!err) && (*vkcheck <= *chapMax)) {
//printf("building proxBuf from (%s).\nproxBuf.c_str(): %s\n", (const char *)*key, proxBuf.c_str());
//printf("building proxBuf from (%s).\n", (const char *)*key);

                    content = stripText();
                    if (content && *content) {
                        // build "strong" field
                        strong = "";
                        morph = "";
                        AttributeTypeList::iterator words;
                        AttributeList::iterator word;
                        AttributeValue::iterator strongVal;
                        AttributeValue::iterator morphVal;

                        words = getEntryAttributes().find("Word");
                        if (words != getEntryAttributes().end()) {
                            for (word = words->second.begin();word != words->second.end(); word++) {
                                int partCount = atoi(word->second["PartCount"]);
                                if (!partCount) partCount = 1;
                                for (int i = 0; i < partCount; i++) {
                                    SWBuf tmp = "Lemma";
                                    if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                                    strongVal = word->second.find(tmp);
                                    if (strongVal != word->second.end()) {
                                        // cheeze.  skip empty article tags that weren't assigned to any text
                                        if (strongVal->second == "G3588") {
                                            if (word->second.find("Text") == word->second.end())
                                                continue;   // no text? let's skip
                                        }
                                        strong.append(strongVal->second);
                                        morph.append(strongVal->second);
                                        morph.append('@');
                                        SWBuf tmp = "Morph";
                                        if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                                        morphVal = word->second.find(tmp);
                                        if (morphVal != word->second.end()) {
                                            morph.append(morphVal->second);
                                        }
                                        strong.append(' ');
                                        morph.append(' ');
                                    }
                                }
                            }
                        }
                        proxBuf += content;
                        proxBuf.append(' ');
                        proxLem += strong;
                        proxMorph += morph;
                        if (proxLem.length()) {
                            proxLem.append("\n");
                            proxMorph.append("\n");
                        }
                    }
                    (*this)++;
                    err = popError();
                }
                err = 0;
                *vkcheck = saveKey;
            }
        }

        // for TreeKeys use siblings if we have no children
        else if (tkcheck) {
            if (!tkcheck->hasChildren()) {
                if (!tkcheck->previousSibling()) {
                    do {
//printf("building proxBuf from (%s).\n", (const char *)*key);
//fflush(stdout);

                        content = stripText();
                        if (content && *content) {
                            // build "strong" field
                            strong = "";
                            morph = "";
                            AttributeTypeList::iterator words;
                            AttributeList::iterator word;
                            AttributeValue::iterator strongVal;
                            AttributeValue::iterator morphVal;

                            words = getEntryAttributes().find("Word");
                            if (words != getEntryAttributes().end()) {
                                for (word = words->second.begin();word != words->second.end(); word++) {
                                    int partCount = atoi(word->second["PartCount"]);
                                    if (!partCount) partCount = 1;
                                    for (int i = 0; i < partCount; i++) {
                                        SWBuf tmp = "Lemma";
                                        if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                                        strongVal = word->second.find(tmp);
                                        if (strongVal != word->second.end()) {
                                            // cheeze.  skip empty article tags that weren't assigned to any text
                                            if (strongVal->second == "G3588") {
                                                if (word->second.find("Text") == word->second.end())
                                                    continue;   // no text? let's skip
                                            }
                                            strong.append(strongVal->second);
                                            morph.append(strongVal->second);
                                            morph.append('@');
                                            SWBuf tmp = "Morph";
                                            if (partCount > 1) tmp.appendFormatted(".%d", i+1);
                                            morphVal = word->second.find(tmp);
                                            if (morphVal != word->second.end()) {
                                                morph.append(morphVal->second);
                                            }
                                            strong.append(' ');
                                            morph.append(' ');
                                        }
                                    }
                                }
                            }

                            proxBuf += content;
                            proxBuf.append(' ');
                            proxLem += strong;
                            proxMorph += morph;
                            if (proxLem.length()) {
                                proxLem.append("\n");
                                proxMorph.append("\n");
                            }
                        }
                    } while (tkcheck->nextSibling());
                    tkcheck->parent();
                    tkcheck->firstChild();
                }
                else tkcheck->nextSibling();    // reposition from our previousSibling test
            }
        }

        if (proxBuf.length() > 0) {

#if defined USEXAPIAN
            termGenerator.index_text(proxBuf.c_str(), 1, "P");
#elif defined USELUCENE
            doc->add(*_CLNEW Field(_T("prox"), (wchar_t *)utf8ToWChar(proxBuf).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED));
#endif
            good = true;
        }
        if (proxLem.length() > 0) {
#if defined USEXAPIAN
            termGenerator.index_text(proxLem.c_str(), 1, "PL");
            termGenerator.index_text(proxMorph.c_str(), 1, "PM");
#elif defined USELUCENE
            doc->add(*_CLNEW Field(_T("proxlem"), (wchar_t *)utf8ToWChar(proxLem).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED) );
            doc->add(*_CLNEW Field(_T("proxmorph"), (wchar_t *)utf8ToWChar(proxMorph).getRawData(), Field::STORE_NO | Field::INDEX_TOKENIZED) );
#endif
            good = true;
        }
        if (good) {
//printf("writing (%s).\n", (const char *)*key);
//fflush(stdout);
#if defined USEXAPIAN
            SWBuf idTerm;
            idTerm.setFormatted("Q%ld", key->getIndex());
            doc.add_boolean_term(idTerm.c_str());
            database.replace_document(idTerm.c_str(), doc);
#elif defined USELUCENE
            coreWriter->addDocument(doc);
#endif
        }
#if defined USEXAPIAN
#elif defined USELUCENE
        delete doc;
#endif

        (*this)++;
        err = popError();
    }

    // Optimizing automatically happens with the call to addIndexes
    //coreWriter->optimize();
#if defined USEXAPIAN
#elif defined USELUCENE
    coreWriter->close();

#ifdef CLUCENE2
    d = FSDirectory::getDirectory(target.c_str());
#endif
    if (IndexReader::indexExists(target.c_str())) {
#ifndef CLUCENE2
        d = FSDirectory::getDirectory(target.c_str(), false);
#endif
        if (IndexReader::isLocked(d)) {
            IndexReader::unlock(d);
        }
        fsWriter = new IndexWriter( d, an, false);
    }
    else {
#ifndef CLUCENE2
        d = FSDirectory::getDirectory(target.c_str(), true);
#endif
        fsWriter = new IndexWriter(d, an, true);
    }

    Directory *dirs[] = { ramDir, 0 };
#ifdef CLUCENE2
    lucene::util::ConstValueArray< lucene::store::Directory *>dirsa(dirs, 1);
    fsWriter->addIndexes(dirsa);
#else
    fsWriter->addIndexes(dirs);
#endif
    fsWriter->close();

    delete ramDir;
    delete coreWriter;
    delete fsWriter;
    delete an;
#endif

    // reposition module back to where it was before we were called
    setKey(*saveKey);

    if (!saveKey->isPersist())
        delete saveKey;

    if (searchKey)
        delete searchKey;

    delete chapMax;

    setProcessEntryAttributes(savePEA);

    // reset option filters back to original values
    StringList::iterator origVal = filterSettings.begin();
    for (OptionFilterList::iterator filter = optionFilters->begin(); filter != optionFilters->end(); filter++) {
        (*filter)->setOptionValue(*origVal++);
    }

    return 0;
#else
    return SWSearchable::createSearchFramework(percent, percentUserData);
#endif
}

void SWModule::decrement ( int  steps = 1 )

virtual

Decrements module key a number of entries

Parameters

steps

Number of entries to jump backward

Reimplemented in zText, zText4, zCom, zCom4, RawLD, RawLD4, RawCom, RawCom4, RawText4, zLD, and RawText.

Definition at line 369 of file swmodule.cpp.

                                  {
    (*key) -= steps;
    error = key->popError();
}

virtual void SWModule::deleteEntry ( )

inlinevirtual

Delete current module entry - only if module isWritable()

Reimplemented in RawFiles, zText, zText4, zCom, zCom4, RawLD, RawLD4, zLD, RawGenBook, RawCom, RawCom4, RawText4, and RawText.

Definition at line 525 of file swmodule.h.

{}

void SWModule::deleteSearchFramework ( )

virtual

Reimplemented from SWSearchable.

Definition at line 1178 of file swmodule.cpp.

                                     {
#ifdef USELUCENE
    SWBuf target = getConfigEntry("AbsoluteDataPath");
    if (!target.endsWith("/") && !target.endsWith("\\")) {
        target.append('/');
    }
    target.append("lucene");

    FileMgr::removeDir(target.c_str());
#else
    SWSearchable::deleteSearchFramework();
#endif
}

SWDEPRECATED const char* SWModule::Description ( ) const

inline

Deprecated:

Use getDescription

Definition at line 373 of file swmodule.h.

{ return getDescription(); }

SWDEPRECATED const char* SWModule::Description ( const char *  imoddesc )

inline

Sets module description

Deprecated:

Use getDescription

Parameters

imoddesc

Value which to set moddesc; [0]-only get

Returns

pointer to moddesc

Definition at line 381 of file swmodule.h.

{ stdstr(&moddesc, imoddesc); return getDescription(); }

SWDEPRECATED char SWModule::Direction ( signed char  newdir = -1 )

inline

Deprecated:

Use getDirection

Definition at line 411 of file swmodule.h.

{ char retVal = getDirection(); if (newdir != -1) return direction = newdir; return retVal; }

SWDEPRECATED SWDisplay* SWModule::Disp ( SWDisplay *  idisp = 0 )

inline

Deprecated:

Use get/setDisplay() instead.

Definition at line 345 of file swmodule.h.

{ if (idisp)    setDisplay(idisp); return getDisplay(); }

char SWModule::display ( )

virtual

Calls this module's display object and passes itself

Returns

error status

Definition at line 272 of file swmodule.cpp.

                       {
    disp->display(*this);
    return 0;
}

SWDEPRECATED char SWModule::Display ( )

inline

Deprecated:

Use display

Definition at line 328 of file swmodule.h.

{ return display(); }

SWDEPRECATED char SWModule::Encoding ( signed char  enc = -1 )

inline

Deprecated:

Use getEncoding

Definition at line 421 of file swmodule.h.

{ char retVal = getEncoding(); if (enc != -1) encoding = enc; return retVal; }

virtual void SWModule::encodingFilter ( SWBuf &  buf, const SWKey *  key  ) const

inlinevirtual

encodingFilter run a buf through this module's Encoding Filters

Parameters

buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 671 of file swmodule.h.

                                                                    {
        filterBuffer(encodingFilters, buf, key);
    }

virtual SWDEPRECATED char SWModule::Error ( )

inlinevirtual

Deprecated:

Use popError instead.

Definition at line 208 of file swmodule.h.

{ return popError(); }

void SWModule::filterBuffer ( OptionFilterList *  filters, SWBuf &  buf, const SWKey *  key  ) const

virtual

OptionFilterBuffer a text buffer

Parameters

filters	the FilterList of filters to iterate
buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 1657 of file swmodule.cpp.

                                                                                         {
    OptionFilterList::iterator it;
    for (it = filters->begin(); it != filters->end(); it++) {
        (*it)->processText(buf, key, this);
    }
}

void SWModule::filterBuffer ( FilterList *  filters, SWBuf &  buf, const SWKey *  key  ) const

virtual

FilterBuffer a text buffer

Parameters

filters	the FilterList of filters to iterate
buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 1669 of file swmodule.cpp.

                                                                                   {
    FilterList::iterator it;
    for (it = filters->begin(); it != filters->end(); it++) {
        (*it)->processText(buf, key, this);
    }
}

void SWCacher::flush ( )

virtualinherited

Reimplemented in FileMgr, zText, zText4, zCom, zCom4, and zLD.

Definition at line 39 of file swcacher.cpp.

                     {
}

SWBuf SWModule::getBibliography ( unsigned char  bibFormat = BIB_BIBTEX ) const

virtual

Returns bibliographic data for a module in the requested format

Parameters

bibFormat

format of the bibliographic data

Returns

bibliographic data in the requested format as a string (BibTeX by default)

Definition at line 1149 of file swmodule.cpp.

                                                             {
    SWBuf s;
    switch (bibFormat) {
    case BIB_BIBTEX:
        s.append("@Book {").append(modname).append(", Title = \"").append(moddesc).append("\", Publisher = \"CrossWire Bible Society\"}");
        break;
    }
    return s;
}

virtual const ConfigEntMap& SWModule::getConfig ( ) const

inlinevirtual

Definition at line 219 of file swmodule.h.

{ return *config; }

const char * SWModule::getConfigEntry ( const char *  key ) const

virtual

Gets a configuration property about a module. These entries are primarily pulled from the module's .conf file, but also includes some virtual entries such as: PrefixPath - the absolute filesystem path to the sword module repository location where this module is located. AbsoluteDataPath - the full path to the root folder where the module data is stored.

Definition at line 1159 of file swmodule.cpp.

                                                          {
    ConfigEntMap::iterator it = config->find(key);
    return (it != config->end()) ? it->second.c_str() : 0;
}

const char * SWModule::getDescription

(

)

const

Gets module description

Returns

pointer to moddesc

Definition at line 218 of file swmodule.cpp.

                                           {
    return moddesc;
}

char SWModule::getDirection ( ) const

virtual

Sets/gets module direction

Returns

new direction

Definition at line 244 of file swmodule.cpp.

                                  {
    return direction;
}

SWDisplay * SWModule::getDisplay ( ) const

virtual

Gets display driver

Returns

pointer to SWDisplay class for this module

Definition at line 258 of file swmodule.cpp.

                                      {
    return disp;
}

char SWModule::getEncoding ( ) const

inline

Gets module encoding

Returns

Encoding

Definition at line 417 of file swmodule.h.

{ return encoding; }

virtual AttributeTypeList& SWModule::getEntryAttributes ( ) const

inlinevirtual

Entry Attributes are special data pertaining to the current entry. To see what Entry Attributes exists for a specific entry of a module, the example examples/cmdline/lookup.cpp is a good utility which displays this information. It is also useful as an example of how to access such.

Definition at line 817 of file swmodule.h.

{ return entryAttributes; }

virtual int SWModule::getEntrySize ( ) const

inlinevirtual

Returns

The size of the text entry for the module's current key position.

Definition at line 243 of file swmodule.h.

{ return entrySize; }

virtual long SWModule::getIndex ( ) const

inlinevirtual

Reimplemented in SWCom, and SWText.

Definition at line 309 of file swmodule.h.

{ return entryIndex; }

SWKey * SWModule::getKey ( ) const

virtual

Gets the current module key

Returns

the current key of this module

Definition at line 284 of file swmodule.cpp.

                              {
    return key;
}

virtual const char* SWModule::getKeyText ( ) const

inlinevirtual

gets the key text for the module. do we really need this?

Reimplemented in SWLD.

Definition at line 304 of file swmodule.h.

                                           {
        return *getKey();
    }

const char* SWModule::getLanguage ( ) const

inline

Gets module language

Returns

pointer to modlang

Definition at line 437 of file swmodule.h.

{ return modlang; }

char SWModule::getMarkup ( ) const

inline

Gets module markup

Returns

Markup

Definition at line 427 of file swmodule.h.

{ return markup; }

const char * SWModule::getName

(

)

const

Gets module name

Returns

pointer to modname

Definition at line 204 of file swmodule.cpp.

                                    {
    return modname;
}

virtual const OptionFilterList& SWModule::getOptionFilters ( ) const

inlinevirtual

Definition at line 736 of file swmodule.h.

{ return *optionFilters; }

const char* SWModule::getRawEntry ( ) const

inline

Definition at line 500 of file swmodule.h.

{ return getRawEntryBuf().c_str(); }

virtual SWBuf& SWModule::getRawEntryBuf ( ) const

pure virtual

This function is reimplemented by the different kinds of module objects

Returns

the raw module text of the current entry

Implemented in zText, zText4, zCom, zCom4, RawGenBook, RawLD, RawLD4, RawFiles, HREFCom, RawCom, RawCom4, RawText4, zLD, RawText, and EchoMod.

virtual const FilterList& SWModule::getRenderFilters ( ) const

inlinevirtual

Retrieves a container of render filters associated with this module.

Returns

container of render filters

Definition at line 577 of file swmodule.h.

                                                       {
        return *renderFilters;
    }

const char * SWModule::getRenderHeader ( ) const

virtual

Produces any header data which might be useful which is associated with the processing done with this filter. A typical example is a suggested CSS style block for classed containers.

SWModule::getRenderHeader() - Produces any header data which might be useful which associated with the processing done with this filter. A typical example is a suggested CSS style block for classed containers.

Definition at line 1002 of file swmodule.cpp.

                                            {
    FilterList::const_iterator first = getRenderFilters().begin();
    if (first != getRenderFilters().end()) {
        return (*first)->getHeader();
    }
    return "";
}

SWDEPRECATED bool SWModule::getSkipConsecutiveLinks ( )

inline

Deprecated:

Use isSkipConsecutiveLinks

Definition at line 806 of file swmodule.h.

{ return isSkipConsecutiveLinks(); }

const char * SWModule::getType

(

)

const

Gets module type

Returns

pointer to modtype

Definition at line 232 of file swmodule.cpp.

                                    {
    return modtype;
}

virtual bool SWModule::hasEntry ( const SWKey *  ) const

inlinevirtual

Reimplemented in zText, zText4, zCom, zCom4, SWLD, RawGenBook, RawCom, RawCom4, RawText4, and RawText.

Definition at line 809 of file swmodule.h.

{ return false; }

bool SWModule::hasSearchFramework ( )

virtual

was SWORD compiled with code to optimize searching for this driver?

Reimplemented from SWSearchable.

Definition at line 1170 of file swmodule.cpp.

                                  {
#ifdef USELUCENE
    return true;
#else
    return SWSearchable::hasSearchFramework();
#endif
}

void SWModule::increment ( int  steps = 1 )

virtual

Increments module key a number of entries

Parameters

steps

Number of entries to jump forward

Reimplemented in zText, zText4, zCom, zCom4, RawLD, RawLD4, RawCom, RawCom4, RawText4, zLD, and RawText.

Definition at line 355 of file swmodule.cpp.

                                  {
    (*key) += steps;
    error = key->popError();
}

SWDEPRECATED long SWModule::Index ( ) const

inline

Deprecated:

Use getIndex()

Definition at line 314 of file swmodule.h.

{ return getIndex(); }

SWDEPRECATED long SWModule::Index ( long  iindex )

inline

Deprecated:

Use setIndex(...)

Definition at line 318 of file swmodule.h.

{ setIndex(iindex); return getIndex(); }

virtual bool SWModule::isLinked ( const SWKey *  , const SWKey *    ) const

inlinevirtual

Reimplemented in zText, zText4, zCom, zCom4, RawCom, RawCom4, RawText4, and RawText.

Definition at line 808 of file swmodule.h.

{ return false; }

virtual bool SWModule::isProcessEntryAttributes ( ) const

inlinevirtual

Whether or not we're processing Entry Attributes

Definition at line 832 of file swmodule.h.

{ return procEntAttr; }

bool SWSearchable::isSearchOptimallySupported ( const char *  istr, int  searchType, int  flags, SWKey *  scope  )

virtualinherited

Check if the search is optimally supported (e.g. if index files are presnt and working) This function checks whether the search framework may work in the best way.

Returns

true if the the search is optimally supported, false if it's not working in the best way.

Definition at line 52 of file swsearchable.cpp.

                                                                                                       {
    bool retVal = false;
    search(istr, searchType, flags, scope, &retVal);
    return retVal;
}

virtual bool SWModule::isSkipConsecutiveLinks ( )

inlinevirtual

Whether or not to only hit one entry when iterating encounters consecutive links when iterating

Definition at line 802 of file swmodule.h.

{ return skipConsecutiveLinks; }

virtual bool SWModule::isUnicode ( ) const

inlinevirtual

Returns

True if this module is encoded in Unicode, otherwise returns false.

Definition at line 213 of file swmodule.h.

{ return (encoding == (char)ENC_UTF8 || encoding == (char)ENC_SCSU); }

virtual bool SWModule::isWritable ( ) const

inlinevirtual

Is the module writable? :)

Returns

yes or no

Reimplemented in zText, zText4, zCom, zCom4, RawLD, RawLD4, RawFiles, RawGenBook, RawCom, RawCom4, zLD, RawText4, and RawText.

Definition at line 506 of file swmodule.h.

{ return false; }

SWDEPRECATED char SWModule::Key ( const SWKey &  ikey )

inline

Deprecated:

Use setKey() instead.

Definition at line 280 of file swmodule.h.

{ return setKey(ikey); }

SWDEPRECATED SWKey& SWModule::Key ( ) const

inline

Deprecated:

Use getKey() instead.

Definition at line 289 of file swmodule.h.

{ return *getKey(); }

SWDEPRECATED const char* SWModule::KeyText ( const char *  ikeytext = 0 )

inline

Sets/gets module KeyText

Deprecated:

Use getKeyText/setKey

Parameters

ikeytext

Value which to set keytext; [0]-only get

Returns

pointer to keytext

Definition at line 297 of file swmodule.h.

{ if (ikeytext) setKey(ikeytext); return *getKey(); }

SWDEPRECATED const char* SWModule::Lang ( char *  imodlang = 0 )

inline

Deprecated:

Use getLanguage

Definition at line 441 of file swmodule.h.

{ if (imodlang != 0) stdstr(&modlang, imodlang); return getLanguage(); }

long SWCacher::lastAccess ( )

virtualinherited

Definition at line 46 of file swcacher.cpp.

                          {
    return 0;
}

void SWModule::linkEntry ( const SWKey *  sourceKey )

virtual

Link the current module entry to another module entry - only if module isWritable()

Reimplemented in RawFiles, zText, zText4, zCom, zCom4, RawLD, RawLD4, zLD, RawGenBook, RawCom, RawCom4, RawText4, and RawText.

Definition at line 1683 of file swmodule.cpp.

                                     {
}

SWDEPRECATED char SWModule::Markup ( signed char  imarkup = -1 )

inline

Deprecated:

Use getMarkup

Definition at line 431 of file swmodule.h.

{ char retVal = getMarkup(); if (imarkup != -1) markup = imarkup; return retVal; }

SWDEPRECATED const char* SWModule::Name ( ) const

inline

Deprecated:

Use getName

Definition at line 355 of file swmodule.h.

{ return getName(); }

SWDEPRECATED const char* SWModule::Name ( const char *  imodname )

inline

Sets module name

Deprecated:

Use getName

Parameters

imodname

Value which to set modname; [0]-only get

Returns

pointer to modname

Definition at line 363 of file swmodule.h.

{ stdstr(&modname, imodname); return getName(); }

SWORD_NAMESPACE_START void SWSearchable::nullPercent ( char  percent, void *  userData  )

staticinherited

This is the default callback function for searching. This function is a placeholder and does nothing. You can define your own function for search progress evaluation, and pass it over to Search().

Definition at line 31 of file swsearchable.cpp.

{}

virtual void SWModule::optionFilter ( SWBuf &  buf, const SWKey *  key  ) const

inlinevirtual

OptionFilter a text buffer

Parameters

buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 742 of file swmodule.h.

                                                                  {
        filterBuffer(optionFilters, buf, key);
    }

char SWModule::popError ( )

virtual

Gets and clears error status

Returns

error status

Definition at line 185 of file swmodule.cpp.

{
    char retval = error;

    error = 0;
    if (!retval) retval = key->popError();
    return retval;
}

void SWModule::prepText ( SWBuf &  buf )

staticprotected

Definition at line 1695 of file swmodule.cpp.

                                  {
    unsigned int to, from; 
    char space = 0, cr = 0, realdata = 0, nlcnt = 0;
    char *rawBuf = buf.getRawData();
    for (to = from = 0; rawBuf[from]; from++) {
        switch (rawBuf[from]) {
        case 10:
            if (!realdata)
                continue;
            space = (cr) ? 0 : 1;
            cr = 0;
            nlcnt++;
            if (nlcnt > 1) {
//              *to++ = nl;
                rawBuf[to++] = 10;
//              *to++ = nl[1];
//              nlcnt = 0;
            }
            continue;
        case 13:
            if (!realdata)
                continue;
//          *to++ = nl[0];
            rawBuf[to++] = 10;
            space = 0;
            cr = 1;
            continue;
        }
        realdata = 1;
        nlcnt = 0;
        if (space) {
            space = 0;
            if (rawBuf[from] != ' ') {
                rawBuf[to++] = ' ';
                from--;
                continue;
            }
        }
        rawBuf[to++] = rawBuf[from];
    }
    buf.setSize(to);

    while (to > 1) {            // remove trailing excess
        to--;
        if ((rawBuf[to] == 10) || (rawBuf[to] == ' '))
            buf.setSize(to);
        else break;
    }
}

SWDEPRECATED void SWModule::processEntryAttributes ( bool  val ) const

inline

Deprecated:

Use setProcessEntryAttributes

Definition at line 828 of file swmodule.h.

{ setProcessEntryAttributes(val); }

virtual void SWModule::rawFilter ( SWBuf &  buf, const SWKey *  key  ) const

inlinevirtual

RawFilter a text buffer

Parameters

buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 716 of file swmodule.h.

                                                               {
        filterBuffer(rawFilters, buf, key);
    }

virtual SWModule& SWModule::removeEncodingFilter ( SWFilter *  oldFilter )

inlinevirtual

Removes an EncodingFilter from this module's encodingFilters queue

Parameters

oldFilter

the filter to remove

Returns

*this

Definition at line 640 of file swmodule.h.

                                                                {
        encodingFilters->remove(oldFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::RemoveEncodingFilter ( SWFilter *  oldFilter )

inline

Deprecated:

Use removeEncodingFilter

Definition at line 647 of file swmodule.h.

{ return removeEncodingFilter(oldFilter); }

virtual SWModule& SWModule::removeRenderFilter ( SWFilter *  oldFilter )

inlinevirtual

Removes a RenderFilter from this module's renderFilters queue

Parameters

oldFilter

the filter to remove

Returns

*this

Definition at line 585 of file swmodule.h.

                                                              {
        renderFilters->remove(oldFilter);
        return *this;
    }

SWDEPRECATED SWModule& SWModule::RemoveRenderFilter ( SWFilter *  oldFilter )

inline

Deprecated:

Use removeRenderFilter

Definition at line 592 of file swmodule.h.

{   return removeRenderFilter(oldFilter); }

virtual void SWModule::renderFilter ( SWBuf &  buf, const SWKey *  key  ) const

inlinevirtual

RenderFilter run a buf through this module's Render Filters

Parameters

buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 616 of file swmodule.h.

                                                                  {
        filterBuffer(renderFilters, buf, key);
    }

SWBuf SWModule::renderText	(	const char *	buf,
		int	len = -1,
		bool	render = true
	)		const

Produces renderable text of the current module entry or supplied text

Parameters

buf	buffer to massage instead of current module entry; if buf is 0, the current module position text will be used
len	max len to process
render	for internal use

Returns

result buffer

Definition at line 1038 of file swmodule.cpp.

                                                                      {
    bool savePEA = isProcessEntryAttributes();
    if (!buf) {
        entryAttributes.clear();
    }
    else {
        setProcessEntryAttributes(false);
    }

    SWBuf local;
    if (buf)
        local = buf;

    SWBuf &tmpbuf = (buf) ? local : getRawEntryBuf();
    SWKey *key = 0;
    static const char *null = "";

    if (tmpbuf) {
        unsigned long size = (len < 0) ? ((getEntrySize()<0) ? strlen(tmpbuf) : getEntrySize()) : len;
        if (size > 0) {
            key = this->getKey();

            optionFilter(tmpbuf, key);
    
            if (render) {
                renderFilter(tmpbuf, key);
                encodingFilter(tmpbuf, key);
            }
            else    stripFilter(tmpbuf, key);
        }
    }
    else {
        tmpbuf = null;
    }

    setProcessEntryAttributes(savePEA);

    return tmpbuf;
}

SWBuf SWModule::renderText

(

)

Definition at line 1017 of file swmodule.cpp.

                           {
    return renderText((const char *)0);
}

SWDEPRECATED const char* SWModule::RenderText ( const char *  buf = 0, int  len = -1, bool  render = true  )

inline

Deprecated:

Use renderText

Definition at line 773 of file swmodule.h.

{ return renderText(buf, len, render); }

SWBuf SWModule::renderText

(

const SWKey *

tmpKey

)

Produces renderable text of the module entry at the supplied key

Parameters

tmpKey

key to use to grab text

Returns

this module's text at specified key location massaged by Render filters

Definition at line 1087 of file swmodule.cpp.

                                              {
    SWKey *saveKey;
    const char *retVal;

    if (!key->isPersist()) {
        saveKey = createKey();
        *saveKey = *key;
    }
    else    saveKey = key;

    setKey(*tmpKey);

    retVal = renderText();

    setKey(*saveKey);

    if (!saveKey->isPersist())
        delete saveKey;

    return retVal;
}

virtual SWModule& SWModule::replaceEncodingFilter ( SWFilter *  oldFilter, SWFilter *  newFilter  )

inlinevirtual

Replaces an EncodingFilter in this module's encodingfilters queue

Parameters

oldFilter	the filter to remove
newFilter	the filter to add in its place

Returns

*this

Definition at line 654 of file swmodule.h.

                                                                                      {
        FilterList::iterator iter;
        for (iter = encodingFilters->begin(); iter != encodingFilters->end(); iter++) {
            if (*iter == oldFilter)
                *iter = newFilter;
        }
        return *this;
    }

SWDEPRECATED SWModule& SWModule::ReplaceEncodingFilter ( SWFilter *  oldFilter, SWFilter *  newFilter  )

inline

Deprecated:

Use replaceEncodingFilter

Definition at line 665 of file swmodule.h.

{ return replaceEncodingFilter(oldFilter, newFilter); }

virtual SWModule& SWModule::replaceRenderFilter ( SWFilter *  oldFilter, SWFilter *  newFilter  )

inlinevirtual

Replaces a RenderFilter in this module's renderfilters queue

Parameters

oldFilter	the filter to remove
newFilter	the filter to add in its place

Returns

*this

Definition at line 599 of file swmodule.h.

                                                                                    {
        FilterList::iterator iter;
        for (iter = renderFilters->begin(); iter != renderFilters->end(); iter++) {
            if (*iter == oldFilter)
                *iter = newFilter;
        }
        return *this;
    }

SWDEPRECATED SWModule& SWModule::ReplaceRenderFilter ( SWFilter *  oldFilter, SWFilter *  newFilter  )

inline

Deprecated:

Use replaceRenderFilter

Definition at line 610 of file swmodule.h.

{ return replaceRenderFilter(oldFilter, newFilter); }

long SWCacher::resourceConsumption ( )

virtualinherited

Reimplemented in FileMgr.

Definition at line 42 of file swcacher.cpp.

                                   {
    return 0;
}

ListKey & SWModule::search ( const char *  istr, int  searchType = 0, int  flags = 0, SWKey *  scope = 0, bool *  justCheckIfSupported = 0, void(*)(char, void *)  percent = &nullPercent, void *  percentUserData = 0  )

virtual

Searches a module

Parameters

istr	string for which to search
searchType	type of search to perform SEARCHTYPE_REGEX - regex; (for backward compat, if > 0 then used as additional REGEX FLAGS) SEARCHTYPE_PHRASE - phrase SEARCHTYPE_MULTIWORD - multiword SEARCHTYPE_ENTRYATTR - entryAttrib (eg. Word//Lemma./G1234/) (Lemma with dot means check components (Lemma.[1-9]) also) SEARCHTYPE_EXTERNAL - Use External Search Framework (CLucene, Xapian, etc.) -5 - multilemma window; set 'flags' param to window size (NOT DONE)
flags	bitwise options flags for search. Each search type supports different options. REG_ICASE - perform case insensitive search. Supported by most all search types SEARCHFLAG_* - SWORD-specific search flags for various search types. See SWModule::SEARCHFLAG_ consts
scope	Key containing the scope. VerseKey or ListKey are useful here.
justCheckIfSupported	If set, don't search but instead set this variable to true/false if the requested search is supported,
percent	Callback function to get the current search status in %.
percentUserData	Anything that you might want to send to the precent callback function.

Returns

ListKey set to entry keys that match

Implements SWSearchable.

Definition at line 397 of file swmodule.cpp.

                                                                                                                                                                     {

    listKey.clear();
    SWBuf term = istr;
    bool includeComponents = false; // for entryAttrib e.g., /Lemma.1/ 

    // this only works for 1 or 2 verses right now, and for some search types (regex and multi word).
    // future plans are to extend functionality
    // By default SWORD defaults to allowing searches to cross the artificial boundaries of verse markers
    // Searching are done in a sliding window of 2 verses right now.
    // To turn this off, include SEARCHFLAG_STRICTBOUNDARIES in search flags
    int windowSize = 2;
    if ((flags & SEARCHFLAG_STRICTBOUNDARIES) && (searchType == SEARCHTYPE_MULTIWORD || searchType > 0)) {
        // remove custom SWORD flag to prevent possible overlap with unknown regex option
        flags ^= SEARCHFLAG_STRICTBOUNDARIES;
        windowSize = 1;
    }

    SWBuf target = getConfigEntry("AbsoluteDataPath");
    if (!target.endsWith("/") && !target.endsWith("\\")) {
        target.append('/');
    }
#if defined USEXAPIAN
    target.append("xapian");
#elif defined USELUCENE
    target.append("lucene");
#endif
    if (justCheckIfSupported) {
        *justCheckIfSupported = (searchType >= SEARCHTYPE_ENTRYATTR);
#if defined USEXAPIAN
        if ((searchType == SEARCHTYPE_EXTERNAL) && (FileMgr::existsDir(target))) {
            *justCheckIfSupported = true;
        }
#elif defined USELUCENE
        if ((searchType == SEARCHTYPE_EXTERNAL) && (IndexReader::indexExists(target.c_str()))) {
            *justCheckIfSupported = true;
        }
#endif
        return listKey;
    }
    
    SWKey *saveKey   = 0;
    SWKey *searchKey = 0;
    SWKey *resultKey = createKey();
    SWKey *lastKey   = createKey();
    VerseKey *vkCheck = SWDYNAMIC_CAST(VerseKey, resultKey);
    SWBuf lastBuf = "";

#ifdef USECXX11REGEX
    std::locale oldLocale;
    std::locale::global(std::locale("en_US.UTF-8"));

    std::regex preg;
#elif defined(USEICUREGEX)
    icu::RegexMatcher *matcher = 0;
#else
    regex_t preg;
#endif

    vector<SWBuf> words;
    vector<SWBuf> window;
    const char *sres;
    terminateSearch = false;
    char perc = 1;
    bool savePEA = isProcessEntryAttributes();

    // determine if we might be doing special strip searches.  useful for knowing if we can use shortcuts
    bool specialStrips = (getConfigEntry("LocalStripFilter")
            || (getConfig().has("GlobalOptionFilter", "UTF8GreekAccents"))
            || (getConfig().has("GlobalOptionFilter", "UTF8HebrewPoints"))
            || (getConfig().has("GlobalOptionFilter", "UTF8ArabicPoints"))
            || (strchr(istr, '<')));

    setProcessEntryAttributes(searchType == SEARCHTYPE_ENTRYATTR);
    

    if (!key->isPersist()) {
        saveKey = createKey();
        *saveKey = *key;
    }
    else    saveKey = key;

    searchKey = (scope)?scope->clone():(key->isPersist())?key->clone():0;
    if (searchKey) {
        searchKey->setPersist(true);
        setKey(*searchKey);
    }

    (*percent)(perc, percentUserData);

    *this = BOTTOM;
    long highIndex = key->getIndex();
    if (!highIndex)
        highIndex = 1;      // avoid division by zero errors.
    *this = TOP;
    if (searchType >= 0) {
#ifdef USECXX11REGEX
        preg = std::regex((SWBuf(".*")+istr+".*").c_str(), std::regex_constants::extended | searchType | flags);
#elif defined(USEICUREGEX)
        UErrorCode        status    = U_ZERO_ERROR;
        matcher = new icu::RegexMatcher(istr, searchType | flags, status);
        if (U_FAILURE(status)) {
            SWLog::getSystemLog()->logError("Error compiling Regex: %d", status);
            return listKey;
        }

#else
        flags |=searchType|REG_NOSUB|REG_EXTENDED;
        int err = regcomp(&preg, istr, flags);
        if (err) {
            SWLog::getSystemLog()->logError("Error compiling Regex: %d", err);
            return listKey;
        }
#endif
    }

    (*percent)(++perc, percentUserData);


#if defined USEXAPIAN || defined USELUCENE
    (*percent)(10, percentUserData);
    if (searchType == SEARCHTYPE_EXTERNAL) {    // indexed search
#if defined USEXAPIAN
        SWTRY {
            Xapian::Database database(target.c_str());
            Xapian::QueryParser queryParser;
            queryParser.set_default_op(Xapian::Query::OP_AND);
            SWTRY {
                queryParser.set_stemmer(Xapian::Stem(getLanguage()));
            } SWCATCH(...) {}
            queryParser.set_stemming_strategy(queryParser.STEM_SOME);
            queryParser.add_prefix("content", "C");
            queryParser.add_prefix("lemma", "L");
            queryParser.add_prefix("morph", "M");
            queryParser.add_prefix("prox", "P");
            queryParser.add_prefix("proxlem", "PL");
            queryParser.add_prefix("proxmorph", "PM");

#elif defined USELUCENE
        
        lucene::index::IndexReader    *ir = 0;
        lucene::search::IndexSearcher *is = 0;
        Query                         *q  = 0;
        Hits                          *h  = 0;
        SWTRY {
            ir = IndexReader::open(target);
            is = new IndexSearcher(ir);
            const TCHAR *stopWords[] = { 0 };
            standard::StandardAnalyzer analyzer(stopWords);
#endif

            // parse the query
#if defined USEXAPIAN
            Xapian::Query q = queryParser.parse_query(istr);
            Xapian::Enquire enquire = Xapian::Enquire(database);
#elif defined USELUCENE
            q = QueryParser::parse((wchar_t *)utf8ToWChar(istr).getRawData(), _T("content"), &analyzer);
#endif
            (*percent)(20, percentUserData);

            // perform the search
#if defined USEXAPIAN
            enquire.set_query(q);
            Xapian::MSet h = enquire.get_mset(0, 99999);
#elif defined USELUCENE
            h = is->search(q);
#endif
            (*percent)(80, percentUserData);

            // iterate thru each good module position that meets the search
            bool checkBounds = getKey()->isBoundSet();
#if defined USEXAPIAN
            Xapian::MSetIterator i;
            for (i = h.begin(); i != h.end(); ++i) {
//              cout << "Document ID " << *i << "\t";
                SW_u64 score = i.get_percent();
                Xapian::Document doc = i.get_document();
                *resultKey = doc.get_data().c_str();
#elif defined USELUCENE
            for (unsigned long i = 0; i < (unsigned long)h->length(); i++) {
                Document &doc = h->doc(i);
                // set a temporary verse key to this module position
                *resultKey = wcharToUTF8(doc.get(_T("key"))); //TODO Does a key always accept utf8?
                SW_u64 score = (SW_u64)((SW_u32)(h->score(i) * 100));
#endif

                // check to see if it sets ok (within our bounds) and if not, skip
                if (checkBounds) {
                    *getKey() = *resultKey;
                    if (*getKey() != *resultKey) {
                        continue;
                    }
                }
                listKey << *resultKey;
                listKey.getElement()->userData = score;
            }
            (*percent)(98, percentUserData);
        }
        SWCATCH (...) {
#if defined USEXAPIAN
#elif defined USELUCENE
            q = 0;
#endif
            // invalid clucene query
        }
#if defined USEXAPIAN
#elif defined USELUCENE
        delete h;
        delete q;

        delete is;
        if (ir) {
            ir->close();
        }
#endif
    }
#endif

    // some pre-loop processing
    switch (searchType) {

    case SEARCHTYPE_PHRASE:
        // let's see if we're told to ignore case.  If so, then we'll touppstr our term
        if ((flags & REG_ICASE) == REG_ICASE) term.toUpper();
        break;

    case SEARCHTYPE_MULTIWORD:
    case -5:
        // let's break the term down into our words vector
        while (1) {
            const char *word = term.stripPrefix(' ');
            if (!word) {
                words.push_back(term);
                break;
            }
            words.push_back(word);
        }
        if ((flags & REG_ICASE) == REG_ICASE) {
            for (unsigned int i = 0; i < words.size(); i++) {
                words[i].toUpper();
            }
        }
        break;

    // entry attributes
    case SEARCHTYPE_ENTRYATTR:
        // let's break the attribute segs down.  We'll reuse our words vector for each segment
        while (1) {
            const char *word = term.stripPrefix('/');
            if (!word) {
                words.push_back(term);
                break;
            }
            words.push_back(word);
        }
        if ((words.size()>2) && words[2].endsWith(".")) {
            includeComponents = true;
            words[2]--;
        }
        break;
    }


    // our main loop to iterate the module and find the stuff
    perc = 5;
    (*percent)(perc, percentUserData);

    
    while ((searchType != SEARCHTYPE_EXTERNAL) && !popError() && !terminateSearch) {
        long mindex = key->getIndex();
        float per = (float)mindex / highIndex;
        per *= 93;
        per += 5;
        char newperc = (char)per;
        if (newperc > perc) {
            perc = newperc;
            (*percent)(perc, percentUserData);
        }
        else if (newperc < perc) {
            SWLog::getSystemLog()->logError(
                "Serious error: new percentage complete is less than previous value\nindex: %d\nhighIndex: %d\nnewperc == %d%% is smaller than\nperc == %d%%",
                key->getIndex(), highIndex, (int)newperc, (int )perc);
        }

        // regex
        if (searchType >= 0) {
            SWBuf textBuf = stripText();
#ifdef USECXX11REGEX
            if (std::regex_match(std::string(textBuf.c_str()), preg)) {
#elif defined(USEICUREGEX)
            icu::UnicodeString stringToTest = textBuf.c_str();
            matcher->reset(stringToTest);

            if (matcher->find()) {
#else
            if (!regexec(&preg, textBuf, 0, 0, 0)) {
#endif
                *resultKey = *getKey();
                resultKey->clearBounds();
                listKey << *resultKey;
                lastBuf = "";
            }
#ifdef USECXX11REGEX
            else if (std::regex_match(std::string((lastBuf + ' ' + textBuf).c_str()), preg)) {
#elif defined(USEICUREGEX)
            else {
                stringToTest = (lastBuf + ' ' + textBuf).c_str();
                matcher->reset(stringToTest);

                if (matcher->find()) {
#else
            else if (!regexec(&preg, lastBuf + ' ' + textBuf, 0, 0, 0)) {
#endif
                lastKey->clearBounds();
                if (vkCheck) {
                    resultKey->clearBounds();
                    *resultKey = *getKey();
                    vkCheck->setUpperBound(resultKey);
                    vkCheck->setLowerBound(lastKey);
                }
                else {
                    *resultKey = *lastKey;
                    resultKey->clearBounds();
                }
                listKey << *resultKey;
                lastBuf = (windowSize > 1) ? textBuf.c_str() : "";
            }
            else {
                lastBuf = (windowSize > 1) ? textBuf.c_str() : "";
            }
#if defined(USEICUREGEX)
            }
#endif
        }

        else {
            SWBuf textBuf;
            switch (searchType) {

            case SEARCHTYPE_PHRASE: {
                textBuf = stripText();
                if ((flags & REG_ICASE) == REG_ICASE) textBuf.toUpper();
                sres = strstr(textBuf.c_str(), term.c_str());
                if (sres) { //it's also in the stripText(), so we have a valid search result item now
                    *resultKey = *getKey();
                    resultKey->clearBounds();
                    listKey << *resultKey;
                }
                break;
            }

            case SEARCHTYPE_MULTIWORD: { // enclose our allocations
                int stripped = 0;
                int multiVerse = 0;
                unsigned int foundWords = 0;
                textBuf = getRawEntry();
                SWBuf testBuf;

                // Here we loop twice, once for the current verse, to see if we have a simple match within our verse.
                // This always takes precedence over a windowed search.  If we match a window, but also one verse within
                // our window matches by itself, prefer the single verse as the hit address-- the larger window is not needed.
                //
                // The second loop includes our current verse within the context of the sliding window
                // Currrently that window size is set to 2 verses, but future plans include allowing this to be configurable
                // 
                do {
                    // Herein lies optimization.
                    //
                    // First we check getRawEntry because it's the fastest;
                    // it might return false positives because all the markup is include, but is the quickest
                    // way to eliminate a verse. If it passes, then we do the real work to strip the markup and 
                    // really test the verse for our keywords.
                    //
                    stripped = 0;
                    do {
                        if (stripped||specialStrips||multiVerse) {
                            testBuf = multiVerse ? lastBuf + ' ' + textBuf : textBuf;
                            if (stripped) testBuf = stripText(testBuf);
                        }
                        else testBuf.setSize(0);
                        foundWords = 0;

                        if ((flags & REG_ICASE) == REG_ICASE) testBuf.size() ? testBuf.toUpper() : textBuf.toUpper();
                        for (unsigned int i = 0; i < words.size(); i++) {
                            sres = strstr(testBuf.size() ? testBuf.c_str() : textBuf.c_str(), words[i].c_str());
                            if (!sres) {
                                break; //for loop
                            }
                            foundWords++;
                        }

                        ++stripped;
                    } while ( (stripped < 2) && (foundWords == words.size()));
                    ++multiVerse;
                } while ((windowSize > 1) && (multiVerse < 2) && (stripped != 2 || foundWords != words.size()));

                if ((stripped == 2) && (foundWords == words.size())) { //we found the right words in both raw and stripped text, which means it's a valid result item
                    lastKey->clearBounds();
                    resultKey->clearBounds();
                    *resultKey = (multiVerse > 1 && !vkCheck) ? *lastKey : *getKey();
                    if (multiVerse > 1 && vkCheck) {
                        vkCheck->setUpperBound(resultKey);
                        vkCheck->setLowerBound(lastKey);
                    }
                    else {
                        resultKey->clearBounds();
                    }
                    listKey << *resultKey;
                    lastBuf = "";
                    // if we're searching windowSize > 1 and we had a hit which required the current verse
                    // let's start the next window with our current verse in case we have another hit adjacent
                    if (multiVerse == 2) {
                        lastBuf = textBuf;
                    }
                }
                else {
                    lastBuf = (windowSize > 1) ? textBuf.c_str() : "";
                }
            }
            break;

            case SEARCHTYPE_ENTRYATTR: {
                renderText();   // force parse
                AttributeTypeList &entryAttribs = getEntryAttributes();
                AttributeTypeList::iterator i1Start, i1End;
                AttributeList::iterator i2Start, i2End;
                AttributeValue::iterator i3Start, i3End;

                if ((words.size()) && (words[0].length())) {
// cout << "Word: " << words[0] << endl;
                for (i1Start = entryAttribs.begin(); i1Start != entryAttribs.end(); ++i1Start) {
// cout << "stuff: " << i1Start->first.c_str() << endl;
                }
                    i1Start = entryAttribs.find(words[0]);
                    i1End = i1Start;
                    if (i1End != entryAttribs.end()) {
                        i1End++;
                    }
                }
                else {
                    i1Start = entryAttribs.begin();
                    i1End   = entryAttribs.end();
                }
                for (;i1Start != i1End; i1Start++) {
                    if ((words.size()>1) && (words[1].length())) {
                        i2Start = i1Start->second.find(words[1]);
                        i2End = i2Start;
                        if (i2End != i1Start->second.end())
                            i2End++;
                    }
                    else {
                        i2Start = i1Start->second.begin();
                        i2End   = i1Start->second.end();
                    }
                    for (;i2Start != i2End; i2Start++) {
                        if ((words.size()>2) && (words[2].length()) && (!includeComponents)) {
                            i3Start = i2Start->second.find(words[2]);
                            i3End = i3Start;
                            if (i3End != i2Start->second.end())
                                i3End++;
                        }
                        else {
                            i3Start = i2Start->second.begin();
                            i3End   = i2Start->second.end();
                        }
                        for (;i3Start != i3End; i3Start++) {
                            if ((words.size()>3) && (words[3].length())) {
                                if (includeComponents) {
                                    SWBuf key = i3Start->first.c_str();
                                    key = key.stripPrefix('.', true);
                                    // we're iterating all 3 level keys, so be sure we match our
                                    // prefix (e.g., Lemma, Lemma.1, Lemma.2, etc.)
                                    if (key != words[2]) continue;
                                }
                                if (flags & SEARCHFLAG_MATCHWHOLEENTRY) {
                                    bool found = !(((flags & REG_ICASE) == REG_ICASE) ? sword::stricmp(i3Start->second.c_str(), words[3]) : strcmp(i3Start->second.c_str(), words[3]));
                                    sres = (found) ? i3Start->second.c_str() : 0;
                                }
                                else {
                                    sres = ((flags & REG_ICASE) == REG_ICASE) ? stristr(i3Start->second.c_str(), words[3]) : strstr(i3Start->second.c_str(), words[3]);
                                }
                                if (sres) {
                                    *resultKey = *getKey();
                                    resultKey->clearBounds();
                                    listKey << *resultKey;
                                    break;
                                }
                            }
                        }
                        if (i3Start != i3End)
                            break;
                    }
                    if (i2Start != i2End)
                        break;
                }
                break;
            }
            // NOT DONE
            case -5:
                AttributeList &words = getEntryAttributes()["Word"];
                SWBuf kjvWord = "";
                SWBuf bibWord = "";
                for (AttributeList::iterator it = words.begin(); it != words.end(); it++) {
                    int parts = atoi(it->second["PartCount"]);
                    SWBuf lemma = "";
                    SWBuf morph = "";
                    for (int i = 1; i <= parts; i++) {
                        SWBuf key = "";
                        key = (parts == 1) ? "Lemma" : SWBuf().setFormatted("Lemma.%d", i).c_str();
                        AttributeValue::iterator li = it->second.find(key);
                        if (li != it->second.end()) {
                            if (i > 1) lemma += " ";
                            key = (parts == 1) ? "LemmaClass" : SWBuf().setFormatted("LemmaClass.%d", i).c_str();
                            AttributeValue::iterator lci = it->second.find(key);
                            if (lci != it->second.end()) {
                                lemma += lci->second + ":";
                            }
                            lemma += li->second;
                        }
                        key = (parts == 1) ? "Morph" : SWBuf().setFormatted("Morph.%d", i).c_str();
                        li = it->second.find(key);
                        // silly.  sometimes morph counts don't equal lemma counts
                        if (i == 1 && parts != 1 && li == it->second.end()) {
                            li = it->second.find("Morph");
                        }
                        if (li != it->second.end()) {
                            if (i > 1) morph += " ";
                            key = (parts == 1) ? "MorphClass" : SWBuf().setFormatted("MorphClass.%d", i).c_str();
                            AttributeValue::iterator lci = it->second.find(key);
                            // silly.  sometimes morph counts don't equal lemma counts
                            if (i == 1 && parts != 1 && lci == it->second.end()) {
                                lci = it->second.find("MorphClass");
                            }
                            if (lci != it->second.end()) {
                                morph += lci->second + ":";
                            }
                            morph += li->second;
                        }
                        // TODO: add src tags and maybe other attributes
                    }
                    while (window.size() < (unsigned)flags) {
                        
                    }
                }
                break;
            } // end switch
        }
        *lastKey = *getKey();
        (*this)++;
    }
    

    // cleaup work
    if (searchType >= 0) {
#ifdef USECXX11REGEX
        std::locale::global(oldLocale);
#elif defined(USEICUREGEX)
        delete matcher;
#else
        regfree(&preg);
#endif
    }

    setKey(*saveKey);

    if (!saveKey->isPersist())
        delete saveKey;

    if (searchKey)
        delete searchKey;
    delete resultKey;
    delete lastKey;

    listKey = TOP;
    setProcessEntryAttributes(savePEA);


    (*percent)(100, percentUserData);


    return listKey;
}

SWDEPRECATED ListKey& SWModule::Search ( const char *  istr, int  searchType = 0, int  flags = 0, SWKey *  scope = 0, bool *  justCheckIfSupported = 0, void(*)(char, void *)  percent = &nullPercent, void *  percentUserData = 0  )

inline

Deprecated:

Use search

Definition at line 478 of file swmodule.h.

{   return search(istr, searchType, flags, scope, justCheckIfSupported, percent, percentUserData);  }

void SWModule::setConfig ( ConfigEntMap *  config )

virtual

Definition at line 1165 of file swmodule.cpp.

                                             {
    this->config = config;
}

void SWModule::setDisplay ( SWDisplay *  idisp )

virtual

Sets display driver

Parameters

idisp

pointer to SWDisplay class to assign to this module

Definition at line 262 of file swmodule.cpp.

                                          {
    disp = idisp;
}

void SWModule::setEntry ( const char *  inbuf, long  len = -1  )

virtual

Modify the current module entry text - only if module isWritable()

Reimplemented in zText, zText4, RawFiles, zCom, zCom4, RawLD, RawLD4, zLD, RawGenBook, RawCom, RawCom4, RawText4, and RawText.

Definition at line 1680 of file swmodule.cpp.

                                         {
}

virtual void SWModule::setIndex ( long  iindex )

inlinevirtual

Reimplemented in SWCom, and SWText.

Definition at line 310 of file swmodule.h.

{ entryIndex = iindex; }

char SWModule::setKey ( const SWKey *  ikey )

virtual

Sets a key to this module for position to a particular record

Parameters

ikey	key with which to set this module

Returns

error status

Definition at line 298 of file swmodule.cpp.

                                       {
    SWKey *oldKey = 0;

    if (key) {
        if (!key->isPersist())  // if we have our own copy
            oldKey = key;
    }

    if (!ikey->isPersist()) {       // if we are to keep our own copy
         key = createKey();
        *key = *ikey;
    }
    else     key = (SWKey *)ikey;       // if we are to just point to an external key

    if (oldKey)
        delete oldKey;

    return error = key->getError();
}

char SWModule::setKey ( const SWKey &  ikey )

inline

Sets a key to this module for position to a particular record

Parameters

ikey	The SWKey which should be used as new key.

Returns

Error status

Definition at line 267 of file swmodule.h.

{ return setKey(&ikey); }

SWDEPRECATED char SWModule::SetKey ( const SWKey *  ikey )

inline

Deprecated:

Use setKey() instead.

Definition at line 272 of file swmodule.h.

{ return setKey(ikey); }

SWDEPRECATED char SWModule::SetKey ( const SWKey &  ikey )

inline

Deprecated:

Use setKey() instead.

Definition at line 276 of file swmodule.h.

{ return setKey(ikey); }

char SWModule::setKeyText ( const char *  keyText )

inline

Sets this module's key to provided keyText without disturbing any settings on the a key itself This is simply a shortcut for the common module->getKey()->setText(keyText);

Parameters

keyText

key with which to set this module

Returns

error status

Definition at line 260 of file swmodule.h.

{ getKey()->setText(keyText); return key->getError(); }

void SWModule::setPosition ( SW_POSITION  pos )

virtual

Positions this modules to a logical position entry

Parameters

pos	position (e.g. TOP, BOTTOM)

Reimplemented in SWLD.

Definition at line 327 of file swmodule.cpp.

                                        {
    *key = p;
    char saveError = key->popError();

    switch (p) {
    case POS_TOP:
        this->increment();
        this->decrement();
        break;

    case POS_BOTTOM:
        this->decrement();
        this->increment();
        break;
    }

    error = saveError;
}

virtual void SWModule::setProcessEntryAttributes ( bool  val ) const

inlinevirtual

Processing Entry Attributes can be expensive. This method allows turning the processing off if they are not desired. Some internal engine processing turns them off (like searching) temporarily for optimization.

Definition at line 824 of file swmodule.h.

{ procEntAttr = val; }

virtual void SWModule::setSkipConsecutiveLinks ( bool  val )

inlinevirtual

Whether or not to only hit one entry when iterating encounters consecutive links when iterating

Parameters

val	= true means only include entry once in iteration

Definition at line 797 of file swmodule.h.

{ skipConsecutiveLinks = val; }

void SWModule::setType ( const char *  imodtype )

inline

Sets module type

Parameters

imodtype

Value which to set modtype; [0]-only get

Definition at line 397 of file swmodule.h.

{ stdstr(&modtype, imodtype); }

virtual void SWModule::stripFilter ( SWBuf &  buf, const SWKey *  key  ) const

inlinevirtual

StripFilter run a buf through this module's Strip Filters

Parameters

buf	the buffer to filter
key	key location from where this buffer was extracted

Definition at line 707 of file swmodule.h.

                                                                 {
        filterBuffer(stripFilters, buf, key);
    }

const char * SWModule::stripText ( const char *  buf = 0, int  len = -1  )

virtual

Produces plain text, without markup, of the current module entry, or supplied text

Parameters

buf	buf to massage instead of current module entry; if buf is 0, the current text will be used
len	max len to process

Returns

result buffer

Definition at line 990 of file swmodule.cpp.

                                                        {
    static SWBuf local;
    local = renderText(buf, len, false);
    return local.c_str();
}

SWDEPRECATED const char* SWModule::StripText ( const char *  buf = 0, int  len = -1  )

inline

Deprecated:

Use stripText

Definition at line 758 of file swmodule.h.

{ return stripText(buf, len); }

const char * SWModule::stripText ( const SWKey *  tmpKey )

virtual

Produces plain text, without markup, of the module entry at the supplied key

Parameters

tmpKey

desired module entry

Returns

result buffer

Definition at line 1118 of file swmodule.cpp.

                                                   {
    SWKey *saveKey;
    const char *retVal;

    if (!key->isPersist()) {
        saveKey = createKey();
        *saveKey = *key;
    }
    else    saveKey = key;

    setKey(*tmpKey);

    retVal = stripText();

    setKey(*saveKey);

    if (!saveKey->isPersist())
        delete saveKey;

    return retVal;
}

SWDEPRECATED const char* SWModule::Type ( ) const

inline

Deprecated:

Use getType

Definition at line 391 of file swmodule.h.

{ return getType(); }

SWDEPRECATED const char* SWModule::Type ( const char *  imodtype )

inline

Deprecated:

Use setType / getType

Definition at line 401 of file swmodule.h.

{ setType(imodtype); return getType(); }

Member Data Documentation

ConfigEntMap* SWModule::config

protected

Definition at line 116 of file swmodule.h.

char SWModule::direction

protected

Definition at line 132 of file swmodule.h.

SWDisplay* SWModule::disp

protected

this module's display object

Definition at line 137 of file swmodule.h.

char SWModule::encoding

protected

Definition at line 134 of file swmodule.h.

FilterList* SWModule::encodingFilters

protected

filters to be executed to decode text for display

Definition at line 155 of file swmodule.h.

AttributeTypeList SWModule::entryAttributes

mutableprotected

Definition at line 117 of file swmodule.h.

SWBuf SWModule::entryBuf

mutableprotected

Definition at line 140 of file swmodule.h.

long SWModule::entryIndex

mutableprotected

Definition at line 158 of file swmodule.h.

int SWModule::entrySize

mutableprotected

Definition at line 157 of file swmodule.h.

char SWModule::error

mutableprotected

Definition at line 120 of file swmodule.h.

SWKey* SWModule::key

protected

the current key

Definition at line 124 of file swmodule.h.

ListKey SWModule::listKey

protected

Definition at line 126 of file swmodule.h.

char SWModule::markup

protected

Definition at line 133 of file swmodule.h.

char* SWModule::moddesc

protected

Definition at line 128 of file swmodule.h.

char* SWModule::modlang

protected

Definition at line 130 of file swmodule.h.

char* SWModule::modname

protected

Definition at line 127 of file swmodule.h.

char* SWModule::modtype

protected

Definition at line 129 of file swmodule.h.

OptionFilterList* SWModule::optionFilters

protected

filters to be executed to change markup to user prefs

Definition at line 152 of file swmodule.h.

ConfigEntMap SWModule::ownConfig

protected

Definition at line 115 of file swmodule.h.

bool SWModule::procEntAttr

mutableprotected

Definition at line 118 of file swmodule.h.

SWORD_NAMESPACE_START SWModule::StdOutDisplay SWModule::rawdisp

staticprotected

Definition at line 139 of file swmodule.h.

FilterList* SWModule::rawFilters

protected

filters to be executed immediately upon fileread

Definition at line 146 of file swmodule.h.

FilterList* SWModule::renderFilters

protected

filters to be executed to format for display

Definition at line 149 of file swmodule.h.

const signed int SWModule::SEARCHFLAG_MATCHWHOLEENTRY = 4096

static

Definition at line 165 of file swmodule.h.

const signed int SWModule::SEARCHFLAG_STRICTBOUNDARIES = 8192

static

Definition at line 169 of file swmodule.h.

const signed int SWModule::SEARCHTYPE_ENTRYATTR = -3

static

Definition at line 174 of file swmodule.h.

const signed int SWModule::SEARCHTYPE_EXTERNAL = -4

static

Definition at line 175 of file swmodule.h.

const signed int SWModule::SEARCHTYPE_MULTIWORD = -2

static

Definition at line 173 of file swmodule.h.

const signed int SWModule::SEARCHTYPE_PHRASE = -1

static

Definition at line 172 of file swmodule.h.

const signed int SWModule::SEARCHTYPE_REGEX = 0

static

Definition at line 171 of file swmodule.h.

bool SWModule::skipConsecutiveLinks

protected

Definition at line 121 of file swmodule.h.

FilterList* SWModule::stripFilters

protected

filters to be executed to remove all markup (for searches)

Definition at line 143 of file swmodule.h.

bool SWModule::terminateSearch

Set this bool to false to terminate the search which is executed by this module (search()). This is useful for threaded applications to terminate the search from another thread.

Definition at line 181 of file swmodule.h.

---

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

• include/swmodule.h
• src/modules/swmodule.cpp