VerseTreeKey Class Reference

#include <versetreekey.h>

Inheritance diagram for VerseTreeKey:

[legend]

Collaboration diagram for VerseTreeKey:

[legend]

List of all members.

Public Member Functions
virtual int	_compare (const VerseKey &ikey)
SWDEPRECATED char	AutoNormalize () const
SWDEPRECATED char	AutoNormalize (char iautonorm)
SWDEPRECATED char	Book (char ibook)
SWDEPRECATED char	Book () const
SWDEPRECATED int	Chapter (int ichapter)
SWDEPRECATED int	Chapter () const
virtual void	clearBound () const
SWDEPRECATED void	ClearBounds ()
void	clearBounds ()
virtual SWKey *	clone () const
virtual int	compare (const SWKey &ikey)
virtual int	compare (const SWKey &ikey)
virtual void	copyFrom (const VerseKey &ikey)
virtual void	copyFrom (const SWKey &ikey)
virtual void	decrement (int steps=1)
virtual bool	equals (const SWKey &ikey)
SWDEPRECATED char	Error ()
virtual char	getBook () const
virtual const char *	getBookAbbrev () const
virtual int	getBookMax () const
virtual const char *	getBookName () const
virtual int	getChapter () const
virtual int	getChapterMax () const
const SWClass *	getClass () const
virtual long	getIndex () const
char *	getLocale () const
VerseKey &	getLowerBound () const
virtual const char *	getOSISBookName () const
virtual const char *	getOSISRef () const
virtual const char *	getOSISRefRangeText () const
virtual const char *	getRangeText () const
virtual const char *	getShortText () const
virtual char	getSuffix () const
virtual char	getTestament () const
virtual long	getTestamentIndex () const
virtual int	getTestamentMax () const
virtual const char *	getText () const
virtual TreeKey *	getTreeKey ()
VerseKey &	getUpperBound () const
virtual int	getVerse () const
virtual int	getVerseMax () const
virtual const char *	getVersificationSystem () const
SWDEPRECATED char	Headings (char iheadings=MAXPOS(char))
virtual void	increment (int steps=1)
virtual bool	isAutoNormalize () const
virtual bool	isBoundSet () const
virtual bool	isIntros () const
bool	isPersist () const
virtual bool	isTraversable () const
SWDEPRECATED VerseKey &	LowerBound () const
SWDEPRECATED VerseKey &	LowerBound (const VerseKey &lb)
virtual long	NewIndex () const
virtual void	normalize (bool autocheck=false)
virtual void	Normalize (char autocheck=0)
virtual SWKEY_OPERATORS SWKey &	operator= (const VerseKey &ikey)
SWDEPRECATED ListKey	ParseVerseList (const char *buf, const char *defaultKey=0, bool expandRange=false, bool useChapterAsVerse=false)
virtual ListKey	parseVerseList (const char *buf, const char *defaultKey=0, bool expandRange=false, bool useChapterAsVerse=false)
SWDEPRECATED char	Persist (signed char ipersist)
SWDEPRECATED char	Persist () const
virtual char	popError ()
virtual void	positionChanged ()
virtual void	positionFrom (const SWKey &ikey)
virtual void	positionFrom (const SWKey &ikey)
virtual void	setAutoNormalize (bool iautonorm)
virtual void	setBook (char ibook)
virtual void	setBookName (const char *bname)
virtual void	setChapter (int ichapter)
virtual void	setError (char err)
virtual void	setIndex (long iindex)
virtual void	setIntros (bool val)
void	setLocale (const char *name)
void	setLowerBound (const VerseKey &lb)
void	setPersist (bool ipersist)
virtual void	setPosition (SW_POSITION newpos)
virtual void	setSuffix (char isuffix)
virtual void	setTestament (char itestament)
virtual void	setText (const char *ikey)
virtual void	setText (const char *ikey, bool checkNormalize)
void	setTreeKey (TreeKey *tk)
void	setUpperBound (const VerseKey &ub)
virtual void	setVerse (int iverse)
virtual void	setVersificationSystem (const char *name)
SWDEPRECATED char	Testament (char itestament)
SWDEPRECATED char	Testament () const
SWDEPRECATED long	TestamentIndex () const
SWDEPRECATED VerseKey &	UpperBound () const
SWDEPRECATED VerseKey &	UpperBound (const VerseKey &ub)
void	validateCurrentLocale () const
SWDEPRECATED int	Verse (int iverse)
SWDEPRECATED int	Verse () const
	VerseTreeKey (const VerseTreeKey &k)
	VerseTreeKey (TreeKey *treeKey, const char *min, const char *max)
	VerseTreeKey (TreeKey *treeKey, const SWKey *ikey)
	VerseTreeKey (TreeKey *treeKey, const char *ikey=0)
virtual	~VerseTreeKey ()
Static Public Member Functions
static const char *	convertToOSIS (const char *inRef, const SWKey *defaultKey)
Public Attributes
int	BMAX [2]
bool	internalPosChange
__u64	userData
Protected Member Functions
void	freshtext () const
virtual int	getBookFromAbbrev (const char *abbr) const
SWLocale *	getPrivateLocale () const
virtual char	parse (bool checkNormalize=true)
Protected Attributes
signed char	book
bool	boundSet
signed int	chapter
char	error
char *	keytext
char *	localeName
SWClass *	myclass
bool	persist
char *	rangeText
signed char	suffix
signed char	testament
signed int	verse
Private Member Functions
void	init (TreeKey *treeKey)
void	syncVerseToTree ()
Private Attributes
long	lastGoodOffset
TreeKey *	treeKey
Static Private Attributes
static SWClass	classdef

---

Detailed Description

Class VerseKey The SWKey implementation used for verse based modules like Bibles or commentaries.

Definition at line 39 of file versetreekey.h.

---

Constructor & Destructor Documentation

VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const char *	ikey = 0
	)

VerseKey Constructor - initializes Instance of VerseKey

Parameters:

	treeKey	a TreeKey which will form the basis of this VerseTreeKey
	ikey	text key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

Definition at line 54 of file versetreekey.cpp.

                                                             : VerseKey(ikey)
{
    init(treeKey);
    if (ikey)
        parse();
}

VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const SWKey *	ikey
	)

VerseKey Constructor - initializes instance of VerseKey

Parameters:

	treeKey	a TreeKey which will form the basis of this VerseTreeKey
	ikey	base key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

Definition at line 39 of file versetreekey.cpp.

                                                              : VerseKey(ikey)
{
    init(treeKey);
    if (ikey)
        parse();
}

VerseTreeKey::VerseTreeKey	(	TreeKey *	treeKey,
		const char *	min,
		const char *	max
	)

VerseKey Constructor - initializes instance of VerseKey with boundariess - see also LowerBound() and UpperBound()

Parameters:

	treeKey	a TreeKey which will form the basis of this VerseTreeKey
	min	the lower boundary of the new VerseKey
	max	the upper boundary of the new VerseKey

Definition at line 68 of file versetreekey.cpp.

                                                                             : VerseKey(min, max)
{
    init(treeKey);
}

VerseTreeKey::VerseTreeKey

(

const VerseTreeKey &

k

)

VerseKey Copy Constructor - will create a new VerseKey based on an existing one

Parameters:

k

the VerseKey to copy from

Definition at line 62 of file versetreekey.cpp.

                                                : VerseKey(k)
{
    init(k.treeKey);
}

VerseTreeKey::~VerseTreeKey

(

)

[virtual]

VerseKey Destructor Cleans up an instance of VerseKey

Definition at line 122 of file versetreekey.cpp.

                            {
    delete treeKey;
}

---

Member Function Documentation

int VerseKey::_compare

(

const VerseKey &

ikey

)

[virtual, inherited]

Compares another VerseKey object

Parameters:

ikey

key to compare with this one

Returns:

>0 if this VerseKey is greater than compare VerseKey, <0 if this VerseKey is smaller than compare VerseKey, 0 if the keys are the same

Definition at line 1687 of file versekey.cpp.

{
    unsigned long keyval1 = 0;
    unsigned long keyval2 = 0;

    keyval1 += getTestament()       * 1000000000;
    keyval2 += ivkey.getTestament() * 1000000000;
    keyval1 += getBook()            * 10000000;
    keyval2 += ivkey.getBook()      * 10000000;
    keyval1 += getChapter()         * 10000;
    keyval2 += ivkey.getChapter()   * 10000;
    keyval1 += getVerse()           * 50;
    keyval2 += ivkey.getVerse()     * 50;
    keyval1 += (int)getSuffix();
    keyval2 += (int)ivkey.getSuffix();
    keyval1 = (keyval1 != keyval2) ? ((keyval1 > keyval2) ? 1 : -1) : 0; // -1 | 0 | 1
    return keyval1;
}

SWDEPRECATED char VerseKey::AutoNormalize

(

)

const [inline, inherited]

Deprecated:

Use isAutoNormalize() instead.

Definition at line 372 of file versekey.h.

{ return isAutoNormalize()?1:0; }   // deprecated

SWDEPRECATED char VerseKey::AutoNormalize

(

char

iautonorm

)

[inline, inherited]

Deprecated:

Use setAutoNormalize() instead.

Definition at line 368 of file versekey.h.

{ char retVal = isAutoNormalize()?1:0; setAutoNormalize(iautonorm); return retVal; }    // deprecated

SWDEPRECATED char VerseKey::Book

(

char

ibook

)

[inline, inherited]

Deprecated:

Use setBook() instead.

Definition at line 317 of file versekey.h.

{ char retVal = getBook(); setBook(ibook); return retVal; } // deprecated

SWDEPRECATED char VerseKey::Book

(

)

const [inline, inherited]

Deprecated:

Use getBook() instead.

Definition at line 268 of file versekey.h.

{ return getBook(); }   // deprecated

SWDEPRECATED int VerseKey::Chapter

(

int

ichapter

)

[inline, inherited]

Deprecated:

Use setChapter() instead.

Definition at line 327 of file versekey.h.

{ char retVal = getChapter(); setChapter(ichapter); return retVal; } // deprecated

SWDEPRECATED int VerseKey::Chapter

(

)

const [inline, inherited]

Deprecated:

Use getChapter() instead.

Definition at line 279 of file versekey.h.

{ return getChapter(); }    // deprecated

virtual void SWKey::clearBound

(

)

const [inline, virtual, inherited]

Definition at line 181 of file swkey.h.

{ boundSet = false; }

SWDEPRECATED void VerseKey::ClearBounds

(

)

[inline, inherited]

Definition at line 197 of file versekey.h.

{ clearBounds(); }

void VerseKey::clearBounds

(

)

[inherited]

clears the boundaries of this VerseKey

Definition at line 1109 of file versekey.cpp.

{
    delete tmpClone;
    tmpClone = 0;
    boundSet = false;
}

SWKey * VerseTreeKey::clone

(

)

const [virtual]

Creates a new SWKey based on the current VerseKey see also the Copy Constructor

Reimplemented from VerseKey.

Definition at line 83 of file versetreekey.cpp.

{
    return new VerseTreeKey(*this);
}

int SWKey::compare

(

const SWKey &

ikey

)

[virtual, inherited]

Compares this key object to another SWKey object

Parameters:

ikey

key to compare with this one

Returns:

>0 if this key is greater than compare key; <0 if this key is smaller than compare key; 0 if the keys are the same

Definition at line 217 of file swkey.cpp.

{
    return strcmp((const char *)*this, (const char *)ikey);
}

int VerseKey::compare

(

const SWKey &

ikey

)

[virtual, inherited]

Compares another SWKey object

Parameters:

ikey

key to compare with this one

Returns:

>0 if this VerseKey is greater than compare SWKey, <0 if this VerseKey is smaller than compare SWKey, 0 if the keys are the same

Definition at line 1665 of file versekey.cpp.

{
    const SWKey *testKey = &ikey;
    const VerseKey *vkey = (const VerseKey *)SWDYNAMIC_CAST(VerseKey, testKey);
    if (vkey) {
        return _compare(*vkey);
    }
    const VerseKey ivkey = (const char *)ikey;
    return _compare(ivkey);
}

const char * VerseKey::convertToOSIS	(	const char *	inRef,
		const SWKey *	defaultKey
	)			[static, inherited]

Tries to parse a string and convert it into an OSIS reference

Parameters:

	inRef	reference string to try to parse
	defaultKey

See also:

ParseVerseList(..., defaultKey, ...)

Definition at line 1759 of file versekey.cpp.

                                                                                {
    static SWBuf outRef;

    outRef = "";

    VerseKey defLanguage;
    ListKey verses = defLanguage.parseVerseList(inRef, (*lastKnownKey), true);
    const char *startFrag = inRef;
    for (int i = 0; i < verses.Count(); i++) {
        SWKey *element = verses.GetElement(i);
//      VerseKey *element = SWDYNAMIC_CAST(VerseKey, verses.GetElement(i));
        SWBuf buf;
        // TODO: This code really needs to not use fixed size arrays
        char frag[800];
        char preJunk[800];
        char postJunk[800];
        memset(frag, 0, 800);
        memset(preJunk, 0, 800);
        memset(postJunk, 0, 800);
        while ((*startFrag) && (strchr(" {};,()[].", *startFrag))) {
            outRef += *startFrag;
            startFrag++;
        }
        memmove(frag, startFrag, ((const char *)element->userData - startFrag) + 1);
        frag[((const char *)element->userData - startFrag) + 1] = 0;
        int j;
        for (j = strlen(frag)-1; j && (strchr(" {};,()[].", frag[j])); j--);
        if (frag[j+1])
            strcpy(postJunk, frag+j+1);
        frag[j+1]=0;
        startFrag += ((const char *)element->userData - startFrag) + 1;
        buf = "<reference osisRef=\"";
        buf += element->getOSISRefRangeText();
        buf += "\">";
        buf += frag;
        buf += "</reference>";
        buf += postJunk;

        outRef += buf;

    }
    if (startFrag < (inRef + strlen(inRef)))
        outRef += startFrag;
    return outRef.c_str();
}

void VerseKey::copyFrom

(

const VerseKey &

ikey

)

[virtual, inherited]

Equates this VerseKey to another VerseKey

Reimplemented from SWKey.

Definition at line 176 of file versekey.cpp.

                                            {
    autonorm = ikey.autonorm;
    intros = ikey.intros;
    testament = ikey.getTestament();
    book = ikey.getBook();
    chapter = ikey.getChapter();
    verse = ikey.getVerse();
    suffix = ikey.getSuffix();
    setLocale(ikey.getLocale());
    setVersificationSystem(ikey.getVersificationSystem());
    if (ikey.isBoundSet()) {
        setLowerBound(ikey.getLowerBound());
        setUpperBound(ikey.getUpperBound());
    }
}

void VerseKey::copyFrom

(

const SWKey &

ikey

)

[virtual, inherited]

Definition at line 197 of file versekey.cpp.

                                         {
    // check to see if we can do a more specific copy
    // plus some optimizations
    const SWKey *fromKey = &ikey;
    ListKey *tryList = SWDYNAMIC_CAST(ListKey, fromKey);
    if (tryList) {
        SWKey *k = tryList->getElement();
        if (k) fromKey = k;
    }
    VerseKey *tryVerse = SWDYNAMIC_CAST(VerseKey, fromKey);
    if (tryVerse) {
        copyFrom(*tryVerse);
    }
    else {
        SWKey::copyFrom(*fromKey);
        parse();
    }
}

void VerseTreeKey::decrement

(

int

steps = 1

)

[virtual]

Decrements key a number of verses

Parameters:

steps

Number of verses to jump backward

Returns:

*this

Reimplemented from VerseKey.

Definition at line 127 of file versetreekey.cpp.

                                      {
    int treeError = 0;
    if (!error) lastGoodOffset = getTreeKey()->getOffset();
    do {
        treeKey->decrement();
        treeError = treeKey->popError();
    // iterate until 3 levels and no versekey parse errors
    } while (!treeError && ((treeKey->getLevel() < 3) || error));
    if (error && !treeError) {
        int saveError = error;
        increment();
        error = saveError;
    }
    if (treeError) {
        treeKey->setOffset(lastGoodOffset);
        error = treeError;
    }
    if (_compare(getUpperBound()) > 0) {
        positionFrom(getUpperBound());
        error = KEYERR_OUTOFBOUNDS;
    }
    if (_compare(getLowerBound()) < 0) {
        positionFrom(getLowerBound());
        error = KEYERR_OUTOFBOUNDS;
    }
}

virtual bool SWKey::equals

(

const SWKey &

ikey

)

[inline, virtual, inherited]

test equality of this SWKey object's position with another SWKey

Parameters:

ikey

key to compare with this one

Returns:

true if the key positions are equal

Definition at line 195 of file swkey.h.

{ return !compare(ikey); }

SWDEPRECATED char SWKey::Error

(

)

[inline, inherited]

Gets and clears error status

Returns:

error status

Definition at line 159 of file swkey.h.

{ return popError(); }

void VerseKey::freshtext

(

)

const [protected, inherited]

Refresh keytext based on testament|book|chapter|verse default auto normalization to true default display headings option is false

Definition at line 313 of file versekey.cpp.

{
    char buf[2024];
    int realTest = testament;
    int realbook = book;

    if (book < 1) {
        if (testament < 1)
            sprintf(buf, "[ Module Heading ]");
        else sprintf(buf, "[ Testament %d Heading ]", (int)testament);
    }
    else {
        if (realbook > BMAX[realTest-1]) {
            realbook -= BMAX[realTest-1];
            if (realTest < 2)
                realTest++;
            if (realbook > BMAX[realTest-1])
                realbook = BMAX[realTest-1];
        }
        sprintf(buf, "%s %d:%d", getBookName(), chapter, verse);
        if (suffix) {
            buf[strlen(buf)+1] = 0;
            buf[strlen(buf)] = suffix;
        }
    }

    stdstr((char **)&keytext, buf);
}

char VerseKey::getBook

(

)

const [virtual, inherited]

Gets book

Returns:

value of book

Definition at line 1407 of file versekey.cpp.

{
    return book;
}

const char * VerseKey::getBookAbbrev

(

)

const [virtual, inherited]

Definition at line 1184 of file versekey.cpp.

                                          {
    return refSys->getBook(((testament>1)?BMAX[0]:0)+book-1)->getPreferredAbbreviation();
}

int VerseTreeKey::getBookFromAbbrev

(

const char *

abbr

)

const [protected, virtual]

Reimplemented from VerseKey.

Definition at line 89 of file versetreekey.cpp.

{
    int bookno = VerseKey::getBookFromAbbrev(iabbr);
    if (bookno < 0) {
/*
        vector<struct sbook>::iterator it = find(books, iabbr);
        if (it == books.end()) {
            TreeKey *tkey = this->treeKey;
            int saveError = tkey->popError();
            long bookmark = tkey->getOffset();
            SWBuf segment;
            internalPosChange = true;
            do {
                segment = (SWBuf)tkey->getLocalName();
            } while (tkey->parent());
            segment << 1;
            if (saveError) {
                error = saveError;
            }
            tkey->setOffset(bookmark);
        }
        books.push_back(sbook(iabbr));
*/
    }
    return bookno;
}

virtual int VerseKey::getBookMax

(

)

const [inline, virtual, inherited]

Definition at line 269 of file versekey.h.

{ return BMAX[testament-1]; }

const char * VerseKey::getBookName

(

)

const [virtual, inherited]

Get/Set position of this key by Book Name

Definition at line 1174 of file versekey.cpp.

                                        {
    return getPrivateLocale()->translate(refSys->getBook(((testament>1)?BMAX[0]:0)+book-1)->getLongName());
}

int VerseKey::getChapter

(

)

const [virtual, inherited]

Gets chapter

Returns:

value of chapter

Definition at line 1419 of file versekey.cpp.

{
    return chapter;
}

int VerseKey::getChapterMax

(

)

const [virtual, inherited]

Definition at line 1236 of file versekey.cpp.

                                  {
    const VersificationMgr::Book *b = refSys->getBook(((testament>1)?BMAX[0]:0)+book-1);
    return (b) ? b->getChapterMax() : -1;
}

const SWClass* SWObject::getClass

(

)

const [inline, inherited]

Use this to get the class definition and inheritance order.

Returns:

The class definition of this object

Definition at line 59 of file swobject.h.

                                     {
        return myclass;
    }

long VerseKey::getIndex

(

)

const [virtual, inherited]

Gets index based upon current verse

Returns:

offset

Reimplemented from SWKey.

Definition at line 1578 of file versekey.cpp.

{
    long  offset;

    if (!testament) { // if we want module heading
        offset = 0;
    }
    else if (!book) {   // we want testament heading
        offset = ((testament == 2) ? refSys->getNTStartOffset():0) + 1;
    }
    else {
        offset = refSys->getOffsetFromVerse((((testament>1)?BMAX[0]:0)+book-1), chapter, verse);
    }
    return offset;
}

char* SWKey::getLocale

(

)

const [inline, inherited]

Definition at line 215 of file swkey.h.

{ return localeName; }

VerseKey & VerseKey::getLowerBound

(

)

const [inherited]

gets the lower boundary of this VerseKey

Returns:

the lower boundary of this VerseKey

Definition at line 1063 of file versekey.cpp.

{
    initBounds();
    if (!isAutoNormalize()) {
        tmpClone->testament = lowerBoundComponents.test;
        tmpClone->book      = lowerBoundComponents.book;
        tmpClone->chapter   = lowerBoundComponents.chap;
        tmpClone->setVerse   (lowerBoundComponents.verse);
        tmpClone->setSuffix  (lowerBoundComponents.suffix);
    }
    else {
        tmpClone->setIndex(lowerBound);
        tmpClone->setSuffix  (lowerBoundComponents.suffix);
    }

    return (*tmpClone);
}

const char * VerseKey::getOSISBookName

(

)

const [virtual, inherited]

Definition at line 1179 of file versekey.cpp.

                                            {
    return refSys->getBook(((testament>1)?BMAX[0]:0)+book-1)->getOSISName();
}

const char * VerseKey::getOSISRef

(

)

const [virtual, inherited]

Definition at line 1707 of file versekey.cpp.

                                       {
    static char buf[5][254];
    static int loop = 0;

    if (loop > 4)
        loop = 0;

    if (getVerse())
        sprintf(buf[loop], "%s.%d.%d", getOSISBookName(), getChapter(), getVerse());
    else if (getChapter())
        sprintf(buf[loop], "%s.%d", getOSISBookName(), getChapter());
    else if (getBook())
        sprintf(buf[loop], "%s", getOSISBookName());
    else    buf[loop][0] = 0;
    return buf[loop++];
}

const char * VerseKey::getOSISRefRangeText

(

)

const [virtual, inherited]

Reimplemented from SWKey.

Definition at line 1745 of file versekey.cpp.

                                                {
    if (isBoundSet() && (lowerBound != upperBound)) {
        SWBuf buf = getLowerBound().getOSISRef();
        buf += "-";
        buf += getUpperBound().getOSISRef();
        stdstr(&rangeText, buf.c_str());
    }
    else stdstr(&rangeText, getOSISRef());
    return rangeText;
}

SWLocale * SWKey::getPrivateLocale

(

)

const [protected, inherited]

Definition at line 110 of file swkey.cpp.

                                        {
    if (!locale) {
        if ((!localeCache.name) || (strcmp(localeCache.name, localeName))) {
            stdstr(&(localeCache.name), localeName);
            // this line is the entire bit of work we're trying to avoid with the cache
            // worth it?  compare time examples/cmdline/search KJV "God love world" to
            // same with this method reduced to:
            // if (!local) local = ... (call below); return locale;
            localeCache.locale = LocaleMgr::getSystemLocaleMgr()->getLocale(localeName);
        }
        locale = localeCache.locale;
    }
    return locale;
}

const char * VerseKey::getRangeText

(

)

const [virtual, inherited]

Reimplemented from SWKey.

Definition at line 1729 of file versekey.cpp.

                                         {
    if (isBoundSet() && lowerBound != upperBound) {
        SWBuf buf = (const char *)getLowerBound();
        buf += "-";
        buf += (const char *)getUpperBound();
        stdstr(&rangeText, buf.c_str());
    }
    else stdstr(&rangeText, getText());
    return rangeText;
}

const char * VerseKey::getShortText

(

)

const [virtual, inherited]

Reimplemented from SWKey.

Definition at line 1157 of file versekey.cpp.

                                         {
    static char *stext = 0;
    char buf[2047];
    freshtext();
    if (book < 1) {
        if (testament < 1)
            sprintf(buf, "[ Module Heading ]");
        else sprintf(buf, "[ Testament %d Heading ]", (int)testament);
    }
    else {
        sprintf(buf, "%s %d:%d", getBookAbbrev(), chapter, verse);
    }
    stdstr(&stext, buf);
    return stext;
}

char VerseKey::getSuffix

(

)

const [virtual, inherited]

Gets verse suffix

Returns:

value of verse suffix

Definition at line 1527 of file versekey.cpp.

                               {
    return suffix;
}

char VerseKey::getTestament

(

)

const [virtual, inherited]

Gets testament

Returns:

value of testament

Definition at line 1395 of file versekey.cpp.

{
    return testament;
}

long VerseKey::getTestamentIndex

(

)

const [virtual, inherited]

Gets index into current testament based upon current verse

Returns:

offset

Definition at line 1601 of file versekey.cpp.

{
    long offset = getIndex();
    return (testament > 1) ? offset - refSys->getNTStartOffset() : offset;
}

virtual int VerseKey::getTestamentMax

(

)

const [inline, virtual, inherited]

Definition at line 258 of file versekey.h.

{ return 2; }

const char * VerseKey::getText

(

)

const [virtual, inherited]

refreshes keytext before returning if cast to a (char *) is requested

Reimplemented from SWKey.

Definition at line 1151 of file versekey.cpp.

                                    {
    freshtext();
    return keytext;
}

TreeKey * VerseTreeKey::getTreeKey

(

)

[virtual]

Reimplemented from TreeKey::PositionChangeListener.

Definition at line 250 of file versetreekey.cpp.

                                  {
    syncVerseToTree();
    return treeKey;
}

VerseKey & VerseKey::getUpperBound

(

)

const [inherited]

gets the upper boundary of this VerseKey

Returns:

the upper boundary of this VerseKey

Definition at line 1086 of file versekey.cpp.

{
    initBounds();
    if (!isAutoNormalize()) {
        tmpClone->testament = upperBoundComponents.test;
        tmpClone->book      = upperBoundComponents.book;
        tmpClone->chapter   = upperBoundComponents.chap;
        tmpClone->setVerse   (upperBoundComponents.verse);
        tmpClone->setSuffix  (upperBoundComponents.suffix);
    }
    else {
        tmpClone->setIndex(upperBound);
        tmpClone->setSuffix  (upperBoundComponents.suffix);
    }

    return (*tmpClone);
}

int VerseKey::getVerse

(

)

const [virtual, inherited]

Gets verse

Returns:

value of verse

Definition at line 1431 of file versekey.cpp.

{
    return verse;
}

int VerseKey::getVerseMax

(

)

const [virtual, inherited]

Definition at line 1241 of file versekey.cpp.

                                {
    const VersificationMgr::Book *b = refSys->getBook(((testament>1)?BMAX[0]:0)+book-1);
    return (b) ? b->getVerseMax(chapter) : -1;
}

const char * VerseKey::getVersificationSystem

(

)

const [virtual, inherited]

Definition at line 272 of file versekey.cpp.

{ return refSys->getName(); }

SWDEPRECATED char VerseKey::Headings

(

char

iheadings = MAXPOS(char)

)

[inline, inherited]

Sets/gets flag that tells VerseKey to include chapter/book/testament/module intros

Deprecated:

Use setIntros() and isIntros() instead.

Parameters:

iheadings

value which to set intros [MAXPOS(char)] - only get

Returns:

if unchanged -> value of intros, if changed -> previous value of intros

Definition at line 384 of file versekey.h.

{ char retVal = isIntros(); if (iheadings != MAXPOS(char)) setIntros(iheadings); return retVal; }

void VerseTreeKey::increment

(

int

steps = 1

)

[virtual]

Increments key a number of verses

Parameters:

steps

Number of verses to jump forward

Returns:

*this

Reimplemented from VerseKey.

Definition at line 155 of file versetreekey.cpp.

                                      {
    int treeError = 0;
    if (!error) lastGoodOffset = getTreeKey()->getOffset();
    do {
        treeKey->increment();
        treeError = treeKey->popError();
    // iterate until 3 levels and no versekey parse errors
    } while (!treeError && ((treeKey->getLevel() < 3) || error));
    if (error && !treeError) {
        int saveError = error;
        decrement();
        error = saveError;
    }
    if (treeError) {
        treeKey->setOffset(lastGoodOffset);
        error = treeError;
    }
    // bounds
    if (_compare(getUpperBound()) > 0) {
        positionFrom(getUpperBound());
        error = KEYERR_OUTOFBOUNDS;
    }
    if (_compare(getLowerBound()) < 0) {
        positionFrom(getLowerBound());
        error = KEYERR_OUTOFBOUNDS;
    }
}

void VerseTreeKey::init

(

TreeKey *

treeKey

)

[private]

Definition at line 74 of file versetreekey.cpp.

{
    myclass = &classdef;
    this->treeKey = (TreeKey *)treeKey->clone();
    this->treeKey->setPositionChangeListener(this);
    internalPosChange = false;
}

bool VerseKey::isAutoNormalize

(

)

const [virtual, inherited]

Definition at line 1540 of file versekey.cpp.

{
    return autonorm;
}

virtual bool SWKey::isBoundSet

(

)

const [inline, virtual, inherited]

Definition at line 180 of file swkey.h.

{ return boundSet; }

bool VerseKey::isIntros

(

)

const [virtual, inherited]

Definition at line 1566 of file versekey.cpp.

{
    return intros;
}

bool SWKey::isPersist

(

)

const [inherited]

Gets whether this key should persist in any module to which it is set otherwise just a copy will be used in the module.

Returns:

1 - persists in module; 0 - a copy is attempted

Definition at line 98 of file swkey.cpp.

{
    return persist;
}

virtual bool VerseTreeKey::isTraversable

(

)

const [inline, virtual]

Whether or not this key can be ++ -- incremented

Reimplemented from VerseKey.

Definition at line 99 of file versetreekey.h.

{ return true; }

SWDEPRECATED VerseKey& VerseKey::LowerBound

(

)

const [inline, inherited]

Definition at line 186 of file versekey.h.

{ return getLowerBound(); }

SWDEPRECATED VerseKey& VerseKey::LowerBound

(

const VerseKey &

lb

)

[inline, inherited]

Definition at line 173 of file versekey.h.

{ setLowerBound(lb); return getLowerBound(); }

long VerseTreeKey::NewIndex

(

)

const [virtual]

Definition at line 260 of file versetreekey.cpp.

                                  {
    return treeKey->getOffset();
}

void VerseKey::normalize

(

bool

autocheck = false

)

[virtual, inherited]

checks limits and normalizes if necessary (e.g. Matthew 29:47 = Mark 2:2). If last verse is exceeded, key is set to last Book CH:VS

Returns:

*this

Definition at line 1308 of file versekey.cpp.

{

    if ((!autocheck || autonorm)    // only normalize if we were explicitely called or if autonorm is turned on
    ) {
        error = 0;

        while ((testament < 3) && (testament > 0)) {


            if (book > BMAX[testament-1]) {
                book -= (BMAX[testament-1] + (intros?1:0));
                testament++;
                continue;
            }
            if (book < (intros?0:1)) {
                if (--testament > 0) {
                    book += (BMAX[testament-1] + (intros?1:0));
                }
                continue;
            }


            if (chapter > getChapterMax()) {
                chapter -= (getChapterMax() + (intros?1:0));
                book++;
                continue;
            }
            if (chapter < (intros?0:1)) {
                --book;
                chapter += (getChapterMax() + (intros?1:0));
                continue;
            }


            if (chapter > 0 && verse > getVerseMax()) {
                verse -= (getVerseMax() + (intros?1:0));
                chapter++;
                continue;
            }
            if (verse < (intros?0:1)) {
                if (--chapter < (intros?0:1)) {
                    --book;
                    chapter += (getChapterMax() + (intros?1:0));
                }
                verse += (getVerseMax() + (intros?1:0));
                continue;
            }

            break;  // If we've made it this far (all failure checks continue) we're ok
        }

        if (testament > (BMAX[1]?2:1)) {
            testament = BMAX[1]?2:1;
            book      = BMAX[testament-1];
            chapter   = getChapterMax();
            verse     = getVerseMax();
            error     = KEYERR_OUTOFBOUNDS;
        }

        if (testament < 1) {
            error     = ((!intros) || (testament < 0) || (book < 0)) ? KEYERR_OUTOFBOUNDS : 0;
            testament = ((intros) ? 0 : 1);
            book      = ((intros) ? 0 : 1);
            chapter   = ((intros) ? 0 : 1);
            verse     = ((intros) ? 0 : 1);
        }

            // should we always perform bounds checks?  Tried but seems to cause infinite recursion
        if (_compare(getUpperBound()) > 0) {
            positionFrom(getUpperBound());
            error = KEYERR_OUTOFBOUNDS;
        }
        if (_compare(getLowerBound()) < 0) {
            positionFrom(getLowerBound());
            error = KEYERR_OUTOFBOUNDS;
        }
    }
}

void VerseTreeKey::Normalize

(

char

autocheck = 0

)

[virtual]

Reimplemented from VerseKey.

Definition at line 256 of file versetreekey.cpp.

                                           {
    error = 0;
}

virtual SWKEY_OPERATORS SWKey& VerseTreeKey::operator=

(

const VerseKey &

ikey

)

[inline, virtual]

Definition at line 119 of file versetreekey.h.

{ copyFrom(ikey); return *this; }

char VerseKey::parse

(

bool

checkNormalize = true

)

[protected, virtual, inherited]

Parse a character array into testament|book|chapter|verse

Definition at line 282 of file versekey.cpp.

{
    testament = BMAX[1]?2:1;
    book      = BMAX[BMAX[1]?1:0];
    chapter   = 1;
    verse     = 1;

    int error = 0;

    if (keytext) {
        // pass our own copy of keytext as keytext memory may be freshed during parse 
        ListKey tmpListKey = parseVerseList(SWBuf(keytext).c_str());
        if (tmpListKey.Count()) {
            this->positionFrom(*tmpListKey.getElement(0));
            error = this->error;
        } else error = 1;
    }
    if (checkAutoNormalize) {
        normalize(true);
    }
    freshtext();

    return (this->error) ? this->error : (this->error = error);
}

SWDEPRECATED ListKey VerseKey::ParseVerseList	(	const char *	buf,
		const char *	defaultKey = 0,
		bool	expandRange = false,
		bool	useChapterAsVerse = false
	)			[inline, inherited]

Definition at line 444 of file versekey.h.

{ return parseVerseList(buf, defaultKey, expandRange, useChapterAsVerse); }

ListKey VerseKey::parseVerseList	(	const char *	buf,
		const char *	defaultKey = 0,
		bool	expandRange = false,
		bool	useChapterAsVerse = false
	)			[virtual, inherited]

Definition at line 471 of file versekey.cpp.

                                                                                                                  {

    // hold on to our own copy of params, as threads/recursion may change outside values
    const char *bufStart = buf;
    SWBuf iBuf = buf;
    buf = iBuf.c_str();
    SWBuf iDefaultKey = defaultKey;
    if (defaultKey) defaultKey = iDefaultKey.c_str();

    char book[2048];    // TODO: bad, remove
    char number[2048];  // TODO: bad, remove
    *book = 0;
    *number = 0;
    int tobook = 0;
    int tonumber = 0;
    char suffix = 0;
    int chap = -1, verse = -1;
    int bookno = 0;
    int loop;
    char comma = 0;
    char dash = 0;
    const char *orig = buf;
    int q;
    ListKey tmpListKey;
    ListKey internalListKey;
    char lastPartial = 0;
    bool inTerm = true;
    int notAllDigits = 0;
    bool doubleF = false;

    // assert we have a buffer
    if (!buf) return internalListKey;

    VerseKey *curKey  = (VerseKey *)this->clone();
    VerseKey *lastKey = (VerseKey *)this->clone();
    lastKey->clearBounds();
    curKey->clearBounds();

    // some silly checks for corner cases
    if (!strcmp(buf, "[ Module Heading ]")) {
        curKey->setVerse(0);
        curKey->setChapter(0);
        curKey->setBook(0);
        curKey->setTestament(0);
        lastKey->setLowerBound(*curKey);
        lastKey->setUpperBound(*curKey);
        internalListKey << *lastKey;
        delete curKey;
        delete lastKey;
        return internalListKey;
    }
    if ((!strncmp(buf, "[ Testament ", 12)) &&
        (isdigit(buf[12])) &&
        (!strcmp(buf+13, " Heading ]"))) {
        curKey->setVerse(0);
        curKey->setChapter(0);
        curKey->setBook(0);
        curKey->setTestament(buf[12]-48);
        lastKey->setLowerBound(*curKey);
        lastKey->setUpperBound(*curKey);
        internalListKey << *lastKey;
        delete curKey;
        delete lastKey;
        return internalListKey;
    }

    curKey->setAutoNormalize(isAutoNormalize());
    lastKey->setAutoNormalize(false);
    if (defaultKey) *lastKey = defaultKey;

    while (*buf) {
        switch (*buf) {
        case ':':
            if (buf[1] != ' ') {        // for silly "Mat 1:1: this verse...."
                number[tonumber] = 0;
                tonumber = 0;
                if (*number) {
                    if (chap >= 0)
                        verse = atoi(number);
                    else    chap  = atoi(number);
                }
                *number = 0;
                comma = 0;
                break;
            }
            // otherwise drop down to next case
        case ' ':
            inTerm = true;
            while (true) {
                if ((!*number) || (chap < 0))
                    break;
                for (q = 1; ((buf[q]) && (buf[q] != ' ')); q++);
                if (buf[q] == ':')
                    break;
                inTerm = false;
                break;
            }
            if (inTerm) {
                book[tobook++] = ' ';
                break;
            }

        case '-':
            if (chap == -1) {
                book[tobook] = *buf;
                book[tobook+1] = *(buf+1);
                book[tobook+2] = 0;
                int bookno = getBookFromAbbrev(book);
                if (bookno > -1) {
                    tobook++;
                    buf++;
                    break;
                }
            }
        case ',': // on number new verse
        case ';': // on number new chapter
            number[tonumber] = 0;
            tonumber = 0;
            if (*number) {
                if (chap >= 0)
                    verse = atoi(number);
                else    chap = atoi(number);
            }
            *number = 0;
            book[tobook] = 0;
            tobook = 0;
            bookno = -1;
            if (*book) {
                loop = strlen(book) - 1;

                for (; loop+1; loop--) { if (book[loop] == ' ') book[loop] = 0; else break; }

                if (loop > 0 && isdigit(book[loop-1]) && book[loop] >= 'a' && book[loop] <= 'z') {
                    book[loop--] = 0;
                }
                for (; loop+1; loop--) {
                    if ((isdigit(book[loop])) || (book[loop] == ' ')) {
                        book[loop] = 0;
                        continue;
                    }
                    else {
                        if ((SW_toupper(book[loop])=='F')&&(loop)) {
                            if ((isdigit(book[loop-1])) || (book[loop-1] == ' ') || (SW_toupper(book[loop-1]) == 'F')) {
                                book[loop] = 0;
                                continue;
                            }
                        }
                    }
                    break;
                }

                for (loop = strlen(book) - 1; loop+1; loop--) {
                    if (book[loop] == ' ') {
                        // "PS C" is ok, but "II C" is not ok
                        if (isroman(&book[loop+1]) && !isroman(book,loop)) {
                            if (verse == -1) {
                                verse = chap;
                                chap = from_rom(&book[loop+1]);
                                book[loop] = 0;
                            }
                        }
                            break;
                    }
                }

                if ((!stricmp(book, "V")) || (!stricmp(book, "VER"))) { // Verse abbrev
                    if (verse == -1) {
                        verse = chap;
                        chap = lastKey->getChapter();
                        *book = 0;
                    }
                }
                if ((!stricmp(book, "ch")) || (!stricmp(book, "chap"))) {   // Verse abbrev
                    strcpy(book, lastKey->getBookName());
                }
                bookno = getBookFromAbbrev(book);
                if ((bookno > -1) && (suffix == 'f') && (book[strlen(book)-1] == 'f')) {
                    suffix = 0;
                }
            }
            if (((bookno > -1) || (!*book)) && ((*book) || (chap >= 0) || (verse >= 0))) {
                char partial = 0;
                curKey->setVerse(1);
                curKey->setChapter(1);
                curKey->setBook(1);

                if (bookno < 0) {
                    curKey->setTestament(lastKey->getTestament());
                    curKey->setBook(lastKey->getBook());
                }
                else {
                    int t = 1;
                    if (bookno > BMAX[0]) {
                        t++;
                        bookno -= BMAX[0];
                    }
                    curKey->setTestament(t);
                    curKey->setBook(bookno);
                }
                

                if (((comma)||((verse < 0)&&(bookno < 0)))&&(!lastPartial)) {
//              if (comma) {
                    curKey->setChapter(lastKey->getChapter());
                    curKey->setVerse(chap);  // chap because this is the first number captured
                    if (suffix) {
                        curKey->setSuffix(suffix);
                    }
                }
                else {
                    if (useChapterAsVerse && verse < 0 && chap > 0 && curKey->getChapterMax() == 1) {
                        verse = chap;
                        chap = 1;
                    }

                    
                    if (chap >= 0) {
                        curKey->setChapter(chap);
                    }
                    else {
                        partial++;
                        curKey->setChapter(1);
                    }
                    if (verse >= 0) {
                        curKey->setVerse(verse);
                        if (suffix) {
                            curKey->setSuffix(suffix);
                        }
                    }
                    else {
                        partial++;
                        curKey->setVerse(1);
                    }
                }

                // check for '-'
                for (q = 0; ((buf[q]) && (buf[q] == ' ')); q++);
                if ((buf[q] == '-') && (expandRange)) { // if this is a dash save lowerBound and wait for upper
                    buf+=q;
                    lastKey->setLowerBound(*curKey);
                    lastKey->setPosition(TOP);
                    tmpListKey << *lastKey;
                    ((VerseKey *)tmpListKey.GetElement())->setAutoNormalize(isAutoNormalize());
                    tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                }
                else {
                    if (!dash) {    // if last separator was not a dash just add
                        if (expandRange && partial) {
                            lastKey->setLowerBound(*curKey);
                            if (partial > 1)
                                curKey->setPosition(MAXCHAPTER);
                            if (partial > 0)
                                *curKey = MAXVERSE;
                            lastKey->setUpperBound(*curKey);
                            *lastKey = TOP;
                            tmpListKey << *lastKey;
                            ((VerseKey *)tmpListKey.GetElement())->setAutoNormalize(isAutoNormalize());
                            tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                        }
                        else {
                            bool f = false;
                            if (curKey->getSuffix() == 'f') {
                                curKey->setSuffix(0);
                                f = true;
                            }
                            lastKey->setLowerBound(*curKey);
                            if (f && doubleF) (*curKey) = MAXVERSE;
                            else if (f) (*curKey)++;
                            lastKey->setUpperBound(*curKey);
                            *lastKey = TOP;
                            tmpListKey << *lastKey;
                            ((VerseKey *)tmpListKey.GetElement())->setAutoNormalize(isAutoNormalize());
                            tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                        }
                    }
                    else    if (expandRange) {
                        VerseKey *newElement = SWDYNAMIC_CAST(VerseKey, tmpListKey.GetElement());
                        if (newElement) {
                            if (partial > 1)
                                *curKey = MAXCHAPTER;
                            if (partial > 0)
                                *curKey = MAXVERSE;
                            newElement->setUpperBound(*curKey);
                            *lastKey = *curKey;
                            *newElement = TOP;
                            tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                        }
                    }
                }
                lastPartial = partial;
            }
            *book = 0;
            chap = -1;
            verse = -1;
            suffix = 0;
            if (*buf == ',')
                comma = 1;
            else    comma = 0;
            if (*buf == '-')
                dash = 1;
            else    dash = 0;
            break;
        case 10:    // ignore these
        case 13:
        case '[':
        case ']':
        case '(':
        case ')':
        case '{':
        case '}':
            break;
        case '.':
            if (buf > orig) {           // ignore (break) if preceeding char is not a digit 
                for (notAllDigits = tobook; notAllDigits; notAllDigits--) {
                    if ((!isdigit(book[notAllDigits-1])) && (!strchr(" .", book[notAllDigits-1])))
                        break;
                }
                if (!notAllDigits && !isdigit(buf[1]))
                    break;
            }

            number[tonumber] = 0;
            tonumber = 0;
            if (*number) {
                if (chap >= 0)
                    verse = atoi(number);
                else    chap  = atoi(number);
                *number = 0;
            }
            break;

        default:
            if (isdigit(*buf)) {
                number[tonumber++] = *buf;
                suffix = 0;
                doubleF = 0;
            }
            else {
                switch (*buf) {
                case ' ':    // ignore these and don't reset number
                case 'F':
                    break;
                default:
                    // suffixes (and oddly 'f'-- ff.)
                    if ((*buf >= 'a' && *buf <= 'z' && (chap >=0 || bookno > -1 || lastKey->isBoundSet()))
                            || *buf == 'f') {
                        // if suffix is already an 'f', then we need to mark if we're doubleF.
                        doubleF = (*buf == 'f' && suffix == 'f');
                        if (suffix && !doubleF) {
                            // we've already had a suffix one, so this is another letter, thus any number is not a number, e.g., '2jn'. We're on 'n'
                            number[tonumber] = 0;
                            tonumber = 0;
                        }
                        suffix = *buf;
                    }
                    else {
                        number[tonumber] = 0;
                        tonumber = 0;
                    }
                    break;
                }
            }
            if (chap == -1)
                book[tobook++] = *buf;
        }
        buf++;
    }
    number[tonumber] = 0;
    tonumber = 0;
    if (*number) {
        if (chap >= 0)
            verse = atoi(number);
        else    chap  = atoi(number);
    }
    *number = 0;
    book[tobook] = 0;
    tobook = 0;
    if (*book) {
        loop = strlen(book) - 1;

        for (; loop+1; loop--) { if (book[loop] == ' ') book[loop] = 0; else break; }

        if (loop > 0 && isdigit(book[loop-1]) && book[loop] >= 'a' && book[loop] <= 'z') {
            book[loop--] = 0;
        }
        for (; loop+1; loop--) {
            if ((isdigit(book[loop])) || (book[loop] == ' ')) {
                book[loop] = 0;
                continue;
            }
            else {
                if ((SW_toupper(book[loop])=='F')&&(loop)) {
                    if ((isdigit(book[loop-1])) || (book[loop-1] == ' ') || (SW_toupper(book[loop-1]) == 'F')) {
                        book[loop] = 0;
                        continue;
                    }
                }
            }
            break;
        }

        for (loop = strlen(book) - 1; loop+1; loop--) {
            if (book[loop] == ' ') {
                // "PS C" is ok, but "II C" is not ok
                if (isroman(&book[loop+1]) && !isroman(book,loop)) {
                    if (verse == -1) {
                        verse = chap;
                        chap = from_rom(&book[loop+1]);
                        book[loop] = 0;
                    }
                }
                break;
            }
        }

        if ((!stricmp(book, "V")) || (!stricmp(book, "VER"))) { // Verse abbrev.
            if (verse == -1) {
                verse = chap;
                chap = lastKey->getChapter();
                *book = 0;
            }
        }

        if ((!stricmp(book, "ch")) || (!stricmp(book, "chap"))) {   // Verse abbrev
            strcpy(book, lastKey->getBookName());
        }
        bookno = getBookFromAbbrev(book);
        if ((bookno > -1) && (suffix == 'f') && (book[strlen(book)-1] == 'f')) {
            suffix = 0;
        }
    }
    if (((bookno > -1) || (!*book)) && ((*book) || (chap >= 0) || (verse >= 0))) {
        char partial = 0;
        curKey->setVerse(1);
        curKey->setChapter(1);
        curKey->setBook(1);

        if (bookno < 0) {
            curKey->setTestament(lastKey->getTestament());
            curKey->setBook(lastKey->getBook());
        }
        else {
            int t = 1;
            if (bookno > BMAX[0]) {
                t++;
                bookno -= BMAX[0];
            }
            curKey->setTestament(t);
            curKey->setBook(bookno);
        }

        if (((comma)||((verse < 0)&&(bookno < 0)))&&(!lastPartial)) {
            curKey->setChapter(lastKey->getChapter());
            curKey->setVerse(chap);  // chap because this is the first number captured
            if (suffix) {
                curKey->setSuffix(suffix);
            }
        }
        else {
            if (useChapterAsVerse && verse < 0 && chap > 0 && curKey->getChapterMax() == 1) {
                verse = chap;
                chap = 1;
            }

            
            if (chap >= 0) {
                curKey->setChapter(chap);
            }
            else {
                partial++;
                curKey->setChapter(1);
            }
            if (verse >= 0) {
                curKey->setVerse(verse);
                if (suffix) {
                    curKey->setSuffix(suffix);
                }
            }
            else {
                partial++;
                curKey->setVerse(1);
            }
        }

        if ((*buf == '-') && (expandRange)) {   // if this is a dash save lowerBound and wait for upper
            lastKey->setLowerBound(*curKey);
            *lastKey = TOP;
            tmpListKey << *lastKey;
            tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
        }
        else {
            if (!dash) {    // if last separator was not a dash just add
                if (expandRange && partial) {
                    lastKey->setLowerBound(*curKey);
                    if (partial > 1)
                        *curKey = MAXCHAPTER;
                    if (partial > 0)
                        *curKey = MAXVERSE;
                    lastKey->setUpperBound(*curKey);
                    *lastKey = TOP;
                    tmpListKey << *lastKey;
                    tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                }
                else {
                    bool f = false;
                    if (curKey->getSuffix() == 'f') {
                        curKey->setSuffix(0);
                        f = true;
                    }
                    lastKey->setLowerBound(*curKey);
                    if (f && doubleF) (*curKey) = MAXVERSE;
                    else if (f) (*curKey)++;
                    lastKey->setUpperBound(*curKey);
                    *lastKey = TOP;
                    tmpListKey << *lastKey;
                    tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                }
            }
            else if (expandRange) {
                VerseKey *newElement = SWDYNAMIC_CAST(VerseKey, tmpListKey.GetElement());
                if (newElement) {
                    if (partial > 1)
                        *curKey = MAXCHAPTER;
                    if (partial > 0)
                        *curKey = MAXVERSE;
                    newElement->setUpperBound(*curKey);
                    *newElement = TOP;
                    tmpListKey.GetElement()->userData = (__u64)(bufStart+(buf-iBuf.c_str()));
                }
            }
        }
    }
    *book = 0;
    tmpListKey = TOP;
    internalListKey = tmpListKey;
    internalListKey = TOP;  // Align internalListKey to first element before passing back;

    delete curKey;
    delete lastKey;

    return internalListKey;
}

SWDEPRECATED char SWKey::Persist

(

signed char

ipersist

)

[inline, inherited]

Sets whether this key should persist in any module to which it is set otherwise just a copy will be used in the module.

Parameters:

ipersist

value which to set persist;

Returns:

1 - persists in module; 0 - a copy is attempted

Definition at line 153 of file swkey.h.

{ setPersist(ipersist); return isPersist(); }

SWDEPRECATED char SWKey::Persist

(

)

const [inline, inherited]

Definition at line 146 of file swkey.h.

{ return isPersist(); }

char SWKey::popError

(

)

[virtual, inherited]

Definition at line 146 of file swkey.cpp.

{
    char retval = error;

    error = 0;
    return retval;
}

void VerseTreeKey::positionChanged

(

)

[virtual]

Implements TreeKey::PositionChangeListener.

Definition at line 184 of file versetreekey.cpp.

                                   {
    if (!internalPosChange) {
        TreeKey *tkey = this->TreeKey::PositionChangeListener::getTreeKey();
        int saveError = tkey->popError();
        long bookmark = tkey->getOffset();
        SWBuf seg[4];
        internalPosChange = true;
        int legs = 0;
        do {
            seg[legs] = tkey->getLocalName();
            legs++;
        } while (tkey->parent() && (legs < 4));

        legs--;

        if ((legs < 2) && (!seg[0].length() || seg[0] == "/")) {        //"[ Module Heading ]";
            testament = 0;
            book      = 0;
            chapter   = 0;
            setVerse(0);
        }
        else if ((legs < 2)
            && ((!strncmp(seg[0].c_str(), "[ Testament ", 12)) &&       //"[ Testament n Heading ]";
                (isdigit(seg[0][12])) &&
                (!strcmp(seg[0].c_str()+13, " Heading ]")))) {
            testament = (seg[0][12]-48);
            book      = 0;
            chapter   = 0;
            setVerse(0);
        }   //path = "[ Module Heading ]";
        else {
            setBookName(seg[--legs]);
            chapter = (legs > 0) ? atoi(seg[--legs]) : 0;
            setVerse((legs > 0) ? atoi(seg[--legs]) : 0);
        }

//      setText(path);
        if (saveError) {
            error = saveError;
        }
        tkey->setOffset(bookmark);
        tkey->setError(saveError);
        internalPosChange = false;
    }
}

virtual void SWKey::positionFrom

(

const SWKey &

ikey

)

[inline, virtual, inherited]

Definition at line 172 of file swkey.h.

{ copyFrom(ikey); }

void VerseKey::positionFrom

(

const SWKey &

ikey

)

[virtual, inherited]

Only repositions this VerseKey to another VerseKey

Definition at line 143 of file versekey.cpp.

                                             {
    error = 0;
        const SWKey *fromKey = &ikey;
    ListKey *tryList = SWDYNAMIC_CAST(ListKey, fromKey);
    if (tryList) {
        SWKey *k = tryList->getElement();
        if (k) fromKey = k;
    }
    VerseKey *tryVerse = SWDYNAMIC_CAST(VerseKey, fromKey);
    if (tryVerse) {
        setFromOther(*tryVerse);
    }
    else {
        SWKey::positionFrom(*fromKey);
        parse();
    }

    // should we always perform bounds checks?  Tried but seems to cause infinite recursion
    if (_compare(getUpperBound()) > 0) {
        setFromOther(getUpperBound());
        error = KEYERR_OUTOFBOUNDS;
    }
    if (_compare(getLowerBound()) < 0) {
        setFromOther(getLowerBound());
        error = KEYERR_OUTOFBOUNDS;
    }
}

void VerseKey::setAutoNormalize

(

bool

iautonorm

)

[virtual, inherited]

Sets flag that tells VerseKey to automatically normalize itself when modified

Parameters:

iautonorm

value which to set autonorm [MAXPOS(char)] - only get

Returns:

if unchanged -> value of autonorm, if changed -> previous value of autonorm

Definition at line 1545 of file versekey.cpp.

{
    autonorm = iautonorm?1:0;
    normalize(true);
}

void VerseKey::setBook

(

char

ibook

)

[virtual, inherited]

Sets book

Parameters:

ibook

value which to set book

Definition at line 1462 of file versekey.cpp.

{
    suffix  = 0;
    verse   = (intros) ? 0 : 1;
    chapter = (intros) ? 0 : 1;
    book    = ibook;
    normalize(true);
}

void VerseKey::setBookName

(

const char *

bname

)

[virtual, inherited]

Definition at line 1479 of file versekey.cpp.

{
    int bnum = getBookFromAbbrev(bname);
    if (bnum > -1) {
        if (bnum > BMAX[0]) {
            bnum -= BMAX[0];
            testament = 2;
        }
        else    testament = 1;
        setBook(bnum);
    }
    else error = KEYERR_OUTOFBOUNDS;
}

void VerseKey::setChapter

(

int

ichapter

)

[virtual, inherited]

Sets chapter

Parameters:

ichapter

value which to set chapter

Definition at line 1500 of file versekey.cpp.

{
    suffix  = 0;
    verse   = (intros) ? 0 : 1;
    chapter = ichapter;
    normalize(true);
}

virtual void SWKey::setError

(

char

err

)

[inline, virtual, inherited]

Definition at line 161 of file swkey.h.

{ error = err; }

void VerseKey::setIndex

(

long

iindex

)

[virtual, inherited]

Sets index based upon current verse

Parameters:

iindex

value to set index to

Returns:

offset

Reimplemented from SWKey.

Definition at line 1615 of file versekey.cpp.

{
    // assert we're sane
    if (iindex < 0) {
        error = KEYERR_OUTOFBOUNDS;
        return;
    }

    int b;
    error = refSys->getVerseFromOffset(iindex, &b, &chapter, &verse);
    book = (unsigned char)b;
    testament = 1;
    if (book > BMAX[0]) {
        book -= BMAX[0];
        testament = 2;
    }
    // special case for Module and Testament heading
    if (book < 0) { testament = 0; book = 0; }
    if (chapter < 0) { book = 0; chapter = 0; }

    checkBounds();
}

void VerseKey::setIntros

(

bool

val

)

[virtual, inherited]

The Intros property determine whether or not to include chapter/book/testament/module intros

Definition at line 1560 of file versekey.cpp.

{
    intros = val;
    normalize(true);
}

void SWKey::setLocale

(

const char *

name

)

[inline, inherited]

Definition at line 216 of file swkey.h.

{ stdstr(&localeName, name); locale = 0;    } // this will force an on demand lookup of our locale

void VerseKey::setLowerBound

(

const VerseKey &

lb

)

[inherited]

sets the lower boundary for this VerseKey

Parameters:

lb

the new lower boundary for this VerseKey

Definition at line 1019 of file versekey.cpp.

{
    initBounds();

    lowerBound = lb.getIndex();
    lowerBoundComponents.test   = lb.getTestament();
    lowerBoundComponents.book   = lb.getBook();
    lowerBoundComponents.chap   = lb.getChapter();
    lowerBoundComponents.verse  = lb.getVerse();
    lowerBoundComponents.suffix = lb.getSuffix();

    // both this following check and UpperBound check force upperBound to
    // change allowing LowerBound then UpperBound logic to always flow
    // and set values without restrictions, as expected
    if (upperBound < lowerBound) upperBound = lowerBound;
    boundSet = true;
}

void SWKey::setPersist

(

bool

ipersist

)

[inherited]

Definition at line 134 of file swkey.cpp.

{
    persist = ipersist;
}

void VerseTreeKey::setPosition

(

SW_POSITION

newpos

)

[virtual]

Positions this key

Parameters:

newpos

Position to set to.

Returns:

*this

Reimplemented from VerseKey.

Definition at line 265 of file versetreekey.cpp.

                                            {

    if (isBoundSet()) {
        return VerseKey::setPosition(p);
    }

    switch (p) {
    case POS_TOP:
        popError();
        treeKey->setPosition(p);
        increment();
        decrement();
        popError();
        break;
    case POS_BOTTOM:
        popError();
        treeKey->setPosition(p);
        decrement();
        increment();
        popError();
        break;
    case POS_MAXVERSE:
    case POS_MAXCHAPTER:
        VerseKey::setPosition(p);
        break;
    }
}

void VerseKey::setSuffix

(

char

isuffix

)

[virtual, inherited]

Sets/gets verse suffix

Parameters:

isuffix

value which to set verse suffix

Definition at line 1531 of file versekey.cpp.

                                 {
    suffix = suf;
}

void VerseKey::setTestament

(

char

itestament

)

[virtual, inherited]

Sets testament

Parameters:

itestament

value which to set testament

Definition at line 1445 of file versekey.cpp.

{
    suffix  = 0;
    verse   = (intros) ? 0 : 1;
    chapter = (intros) ? 0 : 1;
    book    = (intros) ? 0 : 1;
    testament = itestament;
    normalize(true);
}

virtual void VerseKey::setText

(

const char *

ikey

)

[inline, virtual, inherited]

Sets this SWKey with a character string

Parameters:

ikey

string used to set this key

Reimplemented from SWKey.

Definition at line 210 of file versekey.h.

{ SWKey::setText(ikey); parse(); }

virtual void VerseKey::setText	(	const char *	ikey,
		bool	checkNormalize
	)			[inline, virtual, inherited]

Definition at line 209 of file versekey.h.

{ SWKey::setText(ikey); parse(checkNormalize); }

void TreeKey::PositionChangeListener::setTreeKey

(

TreeKey *

tk

)

[inline, inherited]

Definition at line 60 of file treekey.h.

{ treeKey = tk; }

void VerseKey::setUpperBound

(

const VerseKey &

ub

)

[inherited]

sets the upper boundary for this VerseKey

Parameters:

ub

the new upper boundary for this VerseKey

Returns:

the upper boundary the key was set to

Definition at line 1042 of file versekey.cpp.

{
    initBounds();

    upperBound = ub.getIndex();
    upperBoundComponents.test   = ub.getTestament();
    upperBoundComponents.book   = ub.getBook();
    upperBoundComponents.chap   = ub.getChapter();
    upperBoundComponents.verse  = ub.getVerse();
    upperBoundComponents.suffix = ub.getSuffix();

    // see setLowerBound comment, above
    if (upperBound < lowerBound) upperBound = lowerBound;
    boundSet = true;
}

void VerseKey::setVerse

(

int

iverse

)

[virtual, inherited]

Sets verse

Parameters:

iverse

value which to set verse

Definition at line 1519 of file versekey.cpp.

{
    suffix  = 0;
    verse   = iverse;
    normalize(true);
}

void VerseKey::setVersificationSystem

(

const char *

name

)

[virtual, inherited]

Definition at line 254 of file versekey.cpp.

                                                      {
    const VersificationMgr::System *newRefSys = VersificationMgr::getSystemVersificationMgr()->getVersificationSystem(name);
    // TODO: cheese, but what should we do if requested v11n system isn't found?
    if (!newRefSys)   newRefSys = VersificationMgr::getSystemVersificationMgr()->getVersificationSystem("KJV");
    if (refSys != newRefSys) {
        refSys = newRefSys;
        BMAX[0] = refSys->getBMAX()[0];
        BMAX[1] = refSys->getBMAX()[1];

        // TODO: adjust bounds for versificaion system ???
        // TODO: when we have mapping done, rethink this
        //necessary as our bounds might not mean anything in the new v11n system
        clearBounds();
    }

}

void VerseTreeKey::syncVerseToTree

(

)

[private]

Definition at line 231 of file versetreekey.cpp.

                                   {
    internalPosChange = true;
    SWBuf path;
    if (!getTestament()) path = "/"; // "[ Module Heading ]";
    else if (!getBook()) path.setFormatted("/[ Testament %d Heading ]", getTestament());
    else path.setFormatted("/%s/%d/%d", getOSISBookName(), getChapter(), getVerse());
    if (getSuffix()) path += getSuffix();
    long bookmark = treeKey->getOffset();
    treeKey->setText(path);

    // if our module has jacked inconsistencies, then let's put our tree back to where it was
    if (treeKey->popError()) {
        treeKey->setOffset(bookmark);
    }

    internalPosChange = false;
}

SWDEPRECATED char VerseKey::Testament

(

char

itestament

)

[inline, inherited]

Deprecated:

Use setTestament() instead.

Definition at line 307 of file versekey.h.

{ char retVal = getTestament(); setTestament(itestament); return retVal; } // deprecated

SWDEPRECATED char VerseKey::Testament

(

)

const [inline, inherited]

Deprecated:

Use getTestament() instead.

Definition at line 257 of file versekey.h.

{ return getTestament(); }  // deprecated

SWDEPRECATED long VerseKey::TestamentIndex

(

)

const [inline, inherited]

Deprecated:

Use getTestamentIndex()

Definition at line 417 of file versekey.h.

{ return getTestamentIndex(); } // deprecated, use getTestamentIndex()

SWDEPRECATED VerseKey& VerseKey::UpperBound

(

)

const [inline, inherited]

Definition at line 192 of file versekey.h.

{ return getUpperBound(); }

SWDEPRECATED VerseKey& VerseKey::UpperBound

(

const VerseKey &

ub

)

[inline, inherited]

Definition at line 180 of file versekey.h.

{ setUpperBound(ub); return getUpperBound(); }

void VerseKey::validateCurrentLocale

(

)

const [inherited]

Definition at line 429 of file versekey.cpp.

                                           {
    if (SWLog::getSystemLog()->getLogLevel() >= SWLog::LOG_DEBUG) { //make sure log is wanted, this loop stuff costs a lot of time
        for (int i = 0; i < refSys->getBookCount(); i++) {
            const int bn = getBookFromAbbrev(getPrivateLocale()->translate(refSys->getBook(i)->getLongName()));
            if (bn != i+1) {
                char *abbr = 0;
                stdstr(&abbr, getPrivateLocale()->translate(refSys->getBook(i)->getLongName()), 2);
                strstrip(abbr);
                SWLog::getSystemLog()->logDebug("VerseKey::Book: %s does not have a matching toupper abbrevs entry! book number returned was: %d, should be %d. Required entry to add to locale:", abbr, bn, i);

                StringMgr* stringMgr = StringMgr::getSystemStringMgr();
                const bool hasUTF8Support = StringMgr::hasUTF8Support();
                if (hasUTF8Support) { //we have support for UTF-8 handling; we expect UTF-8 encoded locales
                    stringMgr->upperUTF8(abbr, strlen(abbr)*2);
                }
                else {
                    stringMgr->upperLatin1(abbr);
                }
                SWLog::getSystemLog()->logDebug("%s=%s\n", abbr, refSys->getBook(i)->getOSISName());
                delete [] abbr;
            }
        }
    }
}

SWDEPRECATED int VerseKey::Verse

(

int

iverse

)

[inline, inherited]

Deprecated:

Use setVerse() instead.

Definition at line 337 of file versekey.h.

{ char retVal = getVerse(); setVerse(iverse); return retVal; } // deprecated;

SWDEPRECATED int VerseKey::Verse

(

)

const [inline, inherited]

Deprecated:

Use getVerse() instead.

Definition at line 290 of file versekey.h.

{ return getVerse(); }      // deprecated

---

Member Data Documentation

int VerseKey::BMAX[2] [inherited]

Definition at line 123 of file versekey.h.

signed char VerseKey::book [protected, inherited]

Definition at line 93 of file versekey.h.

bool SWKey::boundSet [mutable, protected, inherited]

Definition at line 105 of file swkey.h.

signed int VerseKey::chapter [protected, inherited]

Definition at line 94 of file versekey.h.

SWClass VerseTreeKey::classdef [static, private]

Reimplemented from VerseKey.

Definition at line 41 of file versetreekey.h.

char SWKey::error [protected, inherited]

Definition at line 107 of file swkey.h.

bool VerseTreeKey::internalPosChange

Definition at line 105 of file versetreekey.h.

char* SWKey::keytext [protected, inherited]

Definition at line 103 of file swkey.h.

long VerseTreeKey::lastGoodOffset [private]

Definition at line 47 of file versetreekey.h.

char* SWKey::localeName [protected, inherited]

Definition at line 109 of file swkey.h.

SWClass* SWObject::myclass [protected, inherited]

Definition at line 53 of file swobject.h.

bool SWKey::persist [protected, inherited]

Definition at line 106 of file swkey.h.

char* SWKey::rangeText [mutable, protected, inherited]

Definition at line 104 of file swkey.h.

signed char VerseKey::suffix [protected, inherited]

Definition at line 96 of file versekey.h.

signed char VerseKey::testament [protected, inherited]

The Testament: 0 - Module Heading; 1 - Old; 2 - New

Definition at line 92 of file versekey.h.

TreeKey* VerseTreeKey::treeKey [private]

Reimplemented from TreeKey::PositionChangeListener.

Definition at line 42 of file versetreekey.h.

__u64 SWKey::userData [inherited]

Definition at line 116 of file swkey.h.

signed int VerseKey::verse [protected, inherited]

Definition at line 95 of file versekey.h.

---

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

• include/versetreekey.h
• src/keys/versetreekey.cpp