VerseKey Class Reference

#include <versekey.h>

Inheritance diagram for VerseKey:

Collaboration diagram for VerseKey:

Classes
struct	VerseComponents

Public Member Functions
virtual int	_compare (const VerseKey &ikey)
SWDEPRECATED char	AutoNormalize (char iautonorm)
SWDEPRECATED char	AutoNormalize () const
SWDEPRECATED char	Book () const
SWDEPRECATED char	Book (char ibook)
SWDEPRECATED int	Chapter () const
SWDEPRECATED int	Chapter (int ichapter)
void	clearBounds () const
SWDEPRECATED void	ClearBounds ()
virtual SWKey *	clone () const
virtual int	compare (const SWKey &ikey)
virtual void	copyFrom (const SWKey &ikey)
virtual void	copyFrom (const VerseKey &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 char	getError () 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 *	getShortRangeText () 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
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 VerseKey &lb)
SWDEPRECATED VerseKey &	LowerBound () const
virtual void	normalize (bool autocheck=false)
SWDEPRECATED void	Normalize (char autocheck=0)
virtual SWKEY_OPERATORS SWKey &	operator= (const VerseKey &ikey)
virtual ListKey	parseVerseList (const char *buf, const char *defaultKey=0, bool expandRange=false, bool useChapterAsVerse=false)
SWDEPRECATED ListKey	ParseVerseList (const char *buf, const char *defaultKey=0, bool expandRange=false, bool useChapterAsVerse=false)
SWDEPRECATED char	Persist () const
SWDEPRECATED char	Persist (signed char ipersist)
virtual char	popError ()
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, bool checkNormalize)
virtual void	setText (const char *ikey)
void	setUpperBound (const VerseKey &ub)
virtual void	setVerse (int iverse)
virtual void	setVersificationSystem (const char *name)
SWDEPRECATED char	Testament () const
SWDEPRECATED char	Testament (char itestament)
SWDEPRECATED long	TestamentIndex () const
SWDEPRECATED VerseKey &	UpperBound (const VerseKey &ub)
SWDEPRECATED VerseKey &	UpperBound () const
void	validateCurrentLocale () const
SWDEPRECATED int	Verse () const
SWDEPRECATED int	Verse (int iverse)
	VerseKey (const char *ikey=0)
	VerseKey (const SWKey *ikey)
	VerseKey (const char *min, const char *max, const char *v11n="KJV")
	VerseKey (const SWKey &k)
	VerseKey (const VerseKey &k)
virtual	~VerseKey ()

Static Public Member Functions
static const char *	convertToOSIS (const char *inRef, const SWKey *defaultKey)

Public Attributes
int	BMAX [2]
SW_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
const SWClass *	myClass
bool	persist
char *	rangeText
signed char	suffix
signed char	testament
signed int	verse

Private Member Functions
void	checkBounds ()
void	init (const char *v11n="KJV")
void	initBounds () const
void	setFromOther (const VerseKey &vk)

Private Attributes
char	autonorm
ListKey	internalListKey
char	intros
long	lowerBound
VerseComponents	lowerBoundComponents
const VersificationMgr::System *	refSys
VerseKey *	tmpClone
long	upperBound
VerseComponents	upperBoundComponents

Static Private Attributes
static int	instance = 0

Detailed Description

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

Definition at line 53 of file versekey.h.

Constructor & Destructor Documentation

VerseKey::VerseKey

(

const char *

ikey = 0

)

VerseKey Constructor - initializes Instance of VerseKey

Parameters

ikey	text key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

Definition at line 105 of file versekey.cpp.

                                       : SWKey(ikeyText)
{
    init();
    if (ikeyText)
        parse();
}

VerseKey::VerseKey

(

const SWKey *

ikey

)

VerseKey Constructor - initializes instance of VerseKey

Parameters

ikey	base key (will take various forms of 'BOOK CH:VS'. See parse() for more detailed information)

Definition at line 90 of file versekey.cpp.

                                    : SWKey(*ikey)
{
    init();
    if (ikey)
        copyFrom(*ikey);
}

VerseKey::VerseKey	(	const char *	min,
		const char *	max,
		const char *	v11n = "KJV"
	)

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

Parameters

min	the lower boundary of the new VerseKey
max	the upper boundary of the new VerseKey

Definition at line 261 of file versekey.cpp.

                                                                     : SWKey()
{
    init(v11n);
    ListKey tmpListKey = parseVerseList(min);
    if (tmpListKey.getCount()) {
        VerseKey *newElement = SWDYNAMIC_CAST(VerseKey, tmpListKey.getElement(0));
        setLowerBound(*newElement);
    }
    tmpListKey = parseVerseList(max, min, true);
    if (tmpListKey.getCount()) {
        VerseKey *newElement = SWDYNAMIC_CAST(VerseKey, tmpListKey.getElement(0));
        setUpperBound((newElement->isBoundSet())?newElement->getUpperBound():*newElement);
    }
    setPosition(TOP);
}

VerseKey::VerseKey

(

const SWKey &

k

)

VerseKey Copy Constructor - will create a new VerseKey

based on an existing SWKey

Parameters

k	the VerseKey to copy from

Definition at line 83 of file versekey.cpp.

                                    : SWKey(ikey)
{
    init();
    copyFrom(ikey);
}

VerseKey::VerseKey

(

const VerseKey &

k

)

VerseKey Copy Constructor - will create a new VerseKey

based on an existing one

Parameters

k	the VerseKey to copy from

Definition at line 113 of file versekey.cpp.

                                    : SWKey(k)
{
    init();
    copyFrom(k);
}

VerseKey::~VerseKey ( )

virtual

VerseKey Destructor

Cleans up an instance of VerseKey

Definition at line 290 of file versekey.cpp.

                    {

    delete tmpClone;

    --instance;
}

Member Function Documentation

int VerseKey::_compare ( const VerseKey &  ikey )

virtual

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 1790 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 (int)keyval1;
}

SWDEPRECATED char VerseKey::AutoNormalize ( char  iautonorm )

inline

Deprecated:

Use setAutoNormalize() instead.

Definition at line 375 of file versekey.h.

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

SWDEPRECATED char VerseKey::AutoNormalize ( ) const

inline

Deprecated:

Use isAutoNormalize() instead.

Definition at line 379 of file versekey.h.

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

SWDEPRECATED char VerseKey::Book ( ) const

inline

Deprecated:

Use getBook() instead.

Definition at line 276 of file versekey.h.

{ return getBook(); }   // deprecated

SWDEPRECATED char VerseKey::Book ( char  ibook )

inline

Deprecated:

Use setBook() instead.

Definition at line 325 of file versekey.h.

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

SWDEPRECATED int VerseKey::Chapter ( ) const

inline

Deprecated:

Use getChapter() instead.

Definition at line 287 of file versekey.h.

{ return getChapter(); }    // deprecated

SWDEPRECATED int VerseKey::Chapter ( int  ichapter )

inline

Deprecated:

Use setChapter() instead.

Definition at line 335 of file versekey.h.

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

void VerseKey::checkBounds ( )

private

Definition at line 1741 of file versekey.cpp.

                           {

    long i = getIndex();

    initBounds();
    if (i > upperBound) {
        setIndex(upperBound);
        i = getIndex();
        error = KEYERR_OUTOFBOUNDS;
    }
    if (i < lowerBound) {
        setIndex(lowerBound);
        error = KEYERR_OUTOFBOUNDS;
    }
}

void VerseKey::clearBounds ( ) const

virtual

clears the boundaries of this VerseKey

Reimplemented from SWKey.

Definition at line 1202 of file versekey.cpp.

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

SWDEPRECATED void VerseKey::ClearBounds ( )

inline

Deprecated:

Use clearBounds

Definition at line 208 of file versekey.h.

{ clearBounds(); }

SWKey * VerseKey::clone ( ) const

virtual

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

Reimplemented from SWKey.

Reimplemented in VerseTreeKey.

Definition at line 278 of file versekey.cpp.

{
    return new VerseKey(*this);
}

int VerseKey::compare ( const SWKey &  ikey )

virtual

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

Reimplemented from SWKey.

Definition at line 1768 of file versekey.cpp.

{
    const SWKey *testKey = &ikey;
    const VerseKey *vkey = (const VerseKey *)SWDYNAMIC_CAST(const 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

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

Parameters

inRef	reference string to try to parse
defaultKey	for details

See Also

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

Definition at line 1887 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.getCount(); 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, (size_t)((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 SWKey &  ikey )

virtual

Copies as much info (position, range, etc.) as possible from another SWKey object

Parameters

ikey	other SWKey object from which to copy

Reimplemented from SWKey.

Definition at line 239 of file versekey.cpp.

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

void VerseKey::copyFrom ( const VerseKey &  ikey )

virtual

Equates this VerseKey to another VerseKey

Definition at line 218 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::decrement ( int  steps = 1 )

virtual

Decrements key a number of verses

Parameters

steps

Number of verses to jump backward

Reimplemented from SWKey.

Reimplemented in VerseTreeKey.

Definition at line 1374 of file versekey.cpp.

                                 {
    // if we're not autonormalizing and we're already not normalized
    if (!autonorm && chapter > 0 && verse > getVerseMax()) {
        verse -= step;
        checkBounds();
        return;
    }
    char ierror = 0;
    setIndex(getIndex() - step);
    while ((!verse) && (!intros) && (!ierror)) {
        setIndex(getIndex() - 1);
        ierror = popError();
    }
    if ((ierror) && (!intros))
        (*this)++;

    error = (ierror) ? ierror : error;
}

virtual bool SWKey::equals ( const SWKey &  ikey )

inlinevirtualinherited

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 204 of file swkey.h.

{ return !compare(ikey); }

SWDEPRECATED char SWKey::Error ( )

inlineinherited

Deprecated:

Use popError and getError instead

Definition at line 169 of file swkey.h.

{ return popError(); }

void VerseKey::freshtext ( ) const

protected

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

Definition at line 357 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

Gets book

Returns

value of book

Definition at line 1510 of file versekey.cpp.

{
    return book;
}

const char * VerseKey::getBookAbbrev ( ) const

virtual

Definition at line 1275 of file versekey.cpp.

                                          {
    return getPrivateLocale()->translate((SWBuf("prefAbbr_")+refSys->getBook(((testament>1)?BMAX[0]:0)+book-1)->getPreferredAbbreviation()).c_str());
}

int VerseKey::getBookFromAbbrev ( const char *  abbr ) const

protectedvirtual

Reimplemented in VerseTreeKey.

Definition at line 396 of file versekey.cpp.

{
    int diff, abLen, min, max, target, retVal = -1;

    char *abbr = 0;

    int abbrevsCnt;

    const struct abbrev *abbrevs = getPrivateLocale()->getBookAbbrevs(&abbrevsCnt);

    StringMgr* stringMgr = StringMgr::getSystemStringMgr();
    const bool hasUTF8Support = StringMgr::hasUTF8Support();

    // The first iteration of this loop tries to uppercase
    // the string. If we still fail to match, we try
    // matching the string without any toupper logic.
    // This is useful for, say, Chinese user input
    // on a system that doesn't properly support
    // a true Unicode-toupper function (!hasUTF8Support)
    for (int i = 0; i < 2; i++) {
        stdstr(&abbr, iabbr, 2);
        strstrip(abbr);

        if (!i) {
            if (hasUTF8Support) { //we have support for UTF-8 handling; we expect UTF-8 encoded locales
                stringMgr->upperUTF8(abbr, (unsigned int)(strlen(abbr)*2));
            }
            else {
                stringMgr->upperLatin1(abbr);
            }
        }

        abLen = (int)strlen(abbr);

        if (abLen) {
            min = 0;
            max = abbrevsCnt;

            // binary search for a match
            while(1) {
                target = min + ((max - min) / 2);
                diff = strncmp(abbr, abbrevs[target].ab, abLen);
                if ((!diff)||(target >= max)||(target <= min))
                    break;
                if (diff > 0)
                    min = target;
                else    max = target;
            }

            // lets keep backing up till we find the 'first' valid match
            for (; target > 0; target--) {
                if (strncmp(abbr, abbrevs[target-1].ab, abLen))
                    break;
            }

            if (!diff) {
                // lets keep moving forward till we find an abbrev in our refSys
                retVal = refSys->getBookNumberByOSISName(abbrevs[target].osis);
                while ((retVal < 0)  && (target < max) && (!strncmp(abbr, abbrevs[target+1].ab, abLen))) {
                    target++;
                    retVal = refSys->getBookNumberByOSISName(abbrevs[target].osis);
                }
            }
            else retVal = -1;
        }
        if (retVal > 0)
            break;
    }
    delete [] abbr;
    return retVal;
}

virtual int VerseKey::getBookMax ( ) const

inlinevirtual

Definition at line 277 of file versekey.h.

{ return BMAX[testament-1]; }

const char * VerseKey::getBookName ( ) const

virtual

Get/Set position of this key by Book Name

Definition at line 1265 of file versekey.cpp.

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

int VerseKey::getChapter ( ) const

virtual

Gets chapter

Returns

value of chapter

Definition at line 1522 of file versekey.cpp.

{
    return chapter;
}

int VerseKey::getChapterMax ( ) const

virtual

Definition at line 1327 of file versekey.cpp.

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

const SWClass* SWObject::getClass ( ) const

inlineinherited

Use this to get the class definition and inheritance order.

Returns

The class definition of this object

Definition at line 63 of file swobject.h.

                                    {
        return myClass;
    }

virtual char SWKey::getError ( ) const

inlinevirtualinherited

Definition at line 164 of file swkey.h.

{ return error; }

long VerseKey::getIndex ( ) const

virtual

Gets index based upon current verse

Returns

offset

Reimplemented from SWKey.

Definition at line 1681 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

inlineinherited

Definition at line 224 of file swkey.h.

{ return localeName; }

VerseKey & VerseKey::getLowerBound

(

)

const

gets the lower boundary of this VerseKey

Returns

the lower boundary of this VerseKey

Definition at line 1156 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

Definition at line 1270 of file versekey.cpp.

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

const char * VerseKey::getOSISRef ( ) const

virtual

Definition at line 1810 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

Reimplemented from SWKey.

Definition at line 1873 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

protectedinherited

Definition at line 111 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

Reimplemented from SWKey.

Definition at line 1832 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::getShortRangeText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 1848 of file versekey.cpp.

                                              {
    if (isBoundSet() && (lowerBound != upperBound)) {
        SWBuf buf = getLowerBound().getShortText();
        buf += "-";
        if ( getUpperBound().getTestament() == getLowerBound().getTestament()
          && getUpperBound().getBook() == getLowerBound().getBook()
          && getUpperBound().getChapter() == getLowerBound().getChapter()) {
            buf.appendFormatted("%d", getUpperBound().getVerse());
        }
        else if ( getUpperBound().getTestament() == getLowerBound().getTestament()
               && getUpperBound().getBook() == getLowerBound().getBook()) {
            buf.appendFormatted("%d:%d", getUpperBound().getChapter(), getUpperBound().getVerse());
        }
        else buf += getUpperBound().getShortText();
        stdstr(&rangeText, buf.c_str());
    }
    else stdstr(&rangeText, getShortText());
    return rangeText;
}

const char * VerseKey::getShortText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 1248 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

Gets verse suffix

Returns

value of verse suffix

Definition at line 1630 of file versekey.cpp.

                               {
    return suffix;
}

char VerseKey::getTestament ( ) const

virtual

Gets testament

Returns

value of testament

Definition at line 1498 of file versekey.cpp.

{
    return testament;
}

long VerseKey::getTestamentIndex ( ) const

virtual

Gets index into current testament based upon current verse

Returns

offset

Definition at line 1704 of file versekey.cpp.

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

virtual int VerseKey::getTestamentMax ( ) const

inlinevirtual

Definition at line 266 of file versekey.h.

{ return 2; }

const char * VerseKey::getText ( ) const

virtual

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

Reimplemented from SWKey.

Definition at line 1242 of file versekey.cpp.

                                    {
    freshtext();
    return keytext;
}

VerseKey & VerseKey::getUpperBound

(

)

const

gets the upper boundary of this VerseKey

Returns

the upper boundary of this VerseKey

Definition at line 1179 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

Gets verse

Returns

value of verse

Definition at line 1534 of file versekey.cpp.

{
    return verse;
}

int VerseKey::getVerseMax ( ) const

virtual

Definition at line 1333 of file versekey.cpp.

                                {
    if (book < 1) return 0;
    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

Definition at line 316 of file versekey.cpp.

{ return refSys->getName(); }

SWDEPRECATED char VerseKey::Headings ( char  iheadings = MAXPOS(char) )

inline

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 391 of file versekey.h.

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

void VerseKey::increment ( int  steps = 1 )

virtual

Increments key a number of verses

Parameters

steps

Number of verses to jump forward

Reimplemented from SWKey.

Reimplemented in VerseTreeKey.

Definition at line 1348 of file versekey.cpp.

                                 {
    // if we're not autonormalizing and we're already not normalized
    if (!autonorm && chapter > 0 && verse > getVerseMax()) {
        verse += step;
        checkBounds();
        return;
    }
    char ierror = 0;
    setIndex(getIndex() + step);
    while ((!verse) && (!intros) && (!ierror)) {
        setIndex(getIndex() + 1);
        ierror = popError();
    }

    error = (ierror) ? ierror : error;
}

void VerseKey::init ( const char *  v11n = "KJV" )

private

initializes this VerseKey()

Definition at line 56 of file versekey.cpp.

                                    {
    myClass = &classdef;

    instance++;
    autonorm = 1;       // default auto normalization to true
    intros = false;     // default display intros option is false
    upperBound = 0;
    lowerBound = 0;
    boundSet = false;
    testament = 1;
    book = 1;
    chapter = 1;
    verse = 1;
    suffix = 0;
    tmpClone = 0;
    refSys = 0;

    setVersificationSystem(v11n);
}

void VerseKey::initBounds ( ) const

private

Definition at line 1209 of file versekey.cpp.

                                {
    if (!tmpClone) {
        tmpClone = (VerseKey *)this->clone();
        tmpClone->setAutoNormalize(false);
        tmpClone->setIntros(true);
        tmpClone->setTestament((BMAX[1])?2:1);
        tmpClone->setBook(BMAX[(BMAX[1])?1:0]);
        tmpClone->setChapter(tmpClone->getChapterMax());
        tmpClone->setVerse(tmpClone->getVerseMax());
        upperBound = tmpClone->getIndex();
        upperBoundComponents.test   = tmpClone->getTestament();
        upperBoundComponents.book   = tmpClone->getBook();
        upperBoundComponents.chap   = tmpClone->getChapter();
        upperBoundComponents.verse  = tmpClone->getVerse();
        upperBoundComponents.suffix = tmpClone->getSuffix();

        lowerBound = 0;
        lowerBoundComponents.test   = 0;
        lowerBoundComponents.book   = 0;
        lowerBoundComponents.chap   = 0;
        lowerBoundComponents.verse  = 0;
        lowerBoundComponents.suffix = 0;

    }
    else tmpClone->setLocale(getLocale());
}

bool VerseKey::isAutoNormalize ( ) const

virtual

Definition at line 1643 of file versekey.cpp.

{
    return autonorm;
}

virtual bool SWKey::isBoundSet ( ) const

inlinevirtualinherited

Definition at line 189 of file swkey.h.

{ return boundSet; }

bool VerseKey::isIntros ( ) const

virtual

Definition at line 1669 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 99 of file swkey.cpp.

{
    return persist;
}

virtual bool VerseKey::isTraversable ( ) const

inlinevirtual

Whether or not this key can be ++ – incremented

Reimplemented from SWKey.

Reimplemented in VerseTreeKey.

Definition at line 249 of file versekey.h.

{ return true; }

SWDEPRECATED VerseKey& VerseKey::LowerBound ( const VerseKey &  lb )

inline

Deprecated:

Use setLowerBound / getLowerBound

Definition at line 173 of file versekey.h.

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

SWDEPRECATED VerseKey& VerseKey::LowerBound ( ) const

inline

Deprecated:

Use getLowerBound

Definition at line 191 of file versekey.h.

{ return getLowerBound(); }

void VerseKey::normalize ( bool  autocheck = false )

virtual

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

Definition at line 1401 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;
                if (book < (intros?0:1)) {
                    if (--testament > 0) {
                        book += (BMAX[testament-1] + (intros?1:0));
                    }
                }
                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;
                    if (book < (intros?0:1)) {
                        if (--testament > 0) {
                            book += (BMAX[testament-1] + (intros?1:0));
                        }
                    }
                    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;
        }
    }
}

SWDEPRECATED void VerseKey::Normalize ( char  autocheck = 0 )

inline

Deprecated:

Use normalize

Definition at line 362 of file versekey.h.

{ normalize(autocheck!=0); }

virtual SWKEY_OPERATORS SWKey& VerseKey::operator= ( const VerseKey &  ikey )

inlinevirtual

Reimplemented in VerseTreeKey.

Definition at line 487 of file versekey.h.

{ positionFrom(ikey); return *this; }

char VerseKey::parse ( bool  checkNormalize = true )

protectedvirtual

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

Definition at line 326 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.getCount()) {
            this->positionFrom(*tmpListKey.getElement(0));
            error = this->error;
        } else error = 1;
    }
    if (checkAutoNormalize) {
        normalize(true);
    }
    freshtext();

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

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

virtual

Definition at line 515 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;
            }
            goto terminate_range;
            // 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) {
                if (tobook < 1 || book[tobook-1] != ' ') {
                    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
terminate_range:
            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 = (int)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 = (int)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 = fromRoman(&book[loop+1]);
                                book[loop] = 0;
                            }
                        }
                            break;
                    }
                }

                // check for special inscriptio and subscriptio which are saved as book intro and chap 1 intro (for INTF)
                for (loop = (int)strlen(book) - 1; loop+1; loop--) {
                    if (book[loop] == ' ') {
                        if (!strnicmp(&book[loop+1], "inscriptio", (int)strlen(&book[loop+1]))) {
                            book[loop] = 0;
                            verse = 0;
                            chap = 0;
                        }
                        else if (!strnicmp(&book[loop+1], "subscriptio", (int)strlen(&book[loop+1]))) {
                            book[loop] = 0;
                            verse = 0;
                            chap = 1;
                        }
                            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 = (SW_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 = (SW_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 = (SW_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 = (SW_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;
            }
            else if (chap == -1 && (tobook < 1 || book[tobook-1] != ' ')) {
                book[tobook++] = ' ';
            }
            
            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 = (int)strlen(book) - 1;

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

        // check if endsWith([0-9][a-z]) and kill the last letter, e.g., ...12a, and chop off the 'a'
        // why?  What's this for? wouldn't this mess up 2t?
        if (loop > 0 && isdigit(book[loop-1]) && book[loop] >= 'a' && book[loop] <= 'z') {
            book[loop--] = 0;
        }

        // skip trailing spaces and numbers
        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;
        }

        // check for roman numeral chapter
        for (loop = (int)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 = fromRoman(&book[loop+1]);
                        book[loop] = 0;
                    }
                }
                break;
            }
        }
        // check for special inscriptio and subscriptio which are saved as book intro and chap 1 intro (for INTF)
        for (loop = (int)strlen(book) - 1; loop+1; loop--) {
            if (book[loop] == ' ') {
                if (!strnicmp(&book[loop+1], "inscriptio", (int)strlen(&book[loop+1]))) {
                    book[loop] = 0;
                    verse = 0;
                    chap = 0;
                    suffix = 0;
                }
                else if (!strnicmp(&book[loop+1], "subscriptio", (int)strlen(&book[loop+1]))) {
                    book[loop] = 0;
                    verse = 0;
                    chap = 1;
                    suffix = 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 = (SW_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 = (SW_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 = (SW_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 = (SW_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 ListKey VerseKey::ParseVerseList ( const char *  buf, const char *  defaultKey = 0, bool  expandRange = false, bool  useChapterAsVerse = false  )

inline

Deprecated:

Use parseVerseList

Definition at line 453 of file versekey.h.

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

SWDEPRECATED char SWKey::Persist ( ) const

inlineinherited

Deprecated:

Use isPersist

Definition at line 148 of file swkey.h.

{ return isPersist(); }

SWDEPRECATED char SWKey::Persist ( signed char  ipersist )

inlineinherited

Deprecated:

Use setPersist and isPersist instead.

Definition at line 158 of file swkey.h.

{ setPersist(ipersist!=0); return isPersist(); }

char SWKey::popError ( )

virtualinherited

Gets and clears error status

Returns

error status

Definition at line 147 of file swkey.cpp.

{
    char retval = error;

    error = 0;
    return retval;
}

void VerseKey::positionFrom ( const SWKey &  ikey )

virtual

Only repositions this VerseKey to another VerseKey

Reimplemented from SWKey.

Definition at line 183 of file versekey.cpp.

                                             {
    error = 0;
        const SWKey *fromKey = &ikey;
    const ListKey *tryList = SWDYNAMIC_CAST(const ListKey, fromKey);
    if (tryList) {
        const SWKey *k = tryList->getElement();
        if (k) fromKey = k;
    }
    const VerseKey *tryVerse = SWDYNAMIC_CAST(const VerseKey, fromKey);
    if (tryVerse) {
        setFromOther(*tryVerse);
    }
    else {
        SWKey::positionFrom(*fromKey);
// extraneous parse which inadvertently clears error flag
// SWKey::positionFrom already calls copyFrom which calls setText, which VerseKey::setText already calls parse()
//      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

Sets flag that tells VerseKey to automatically normalize itself when modified

Parameters

iautonorm

value which to set autonorm

Definition at line 1648 of file versekey.cpp.

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

void VerseKey::setBook ( char  ibook )

virtual

Sets book

Parameters

ibook

value which to set book

Definition at line 1565 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

Definition at line 1582 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

Sets chapter

Parameters

ichapter

value which to set chapter

Definition at line 1603 of file versekey.cpp.

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

virtual void SWKey::setError ( char  err )

inlinevirtualinherited

Definition at line 165 of file swkey.h.

{ error = err; }

void VerseKey::setFromOther ( const VerseKey &  vk )

private

Definition at line 124 of file versekey.cpp.

                                                {
    if (refSys == ikey.refSys) {
        testament = ikey.getTestament();
        book = ikey.getBook();
        chapter = ikey.getChapter();
        verse = ikey.getVerse();
        suffix = ikey.getSuffix();
    }
    else {
        // map verse between systems
        const char* map_book = ikey.getOSISBookName();
        int map_chapter = ikey.getChapter();
        int map_verse = ikey.getVerse();
        int map_range = map_verse;

        ikey.refSys->translateVerse(refSys, &map_book, &map_chapter, &map_verse, &map_range);
//dbg_mapping SWLOGD("verse: %s.%i.%i-%i\n", map_book, map_chapter, map_verse, map_range);
        
        book = refSys->getBookNumberByOSISName(map_book);

        // check existence
        if (book == -1) {
            book = 1;
            error = KEYERR_OUTOFBOUNDS;
        }
        else if (refSys->getBook(book-1)->getChapterMax() < map_chapter) {
            map_chapter = refSys->getBook(book-1)->getChapterMax();
            map_verse = refSys->getBook(book-1)->getVerseMax(map_chapter);
            error = KEYERR_OUTOFBOUNDS;
        }
        else if (map_chapter > 0 && refSys->getBook(book-1)->getVerseMax(map_chapter) < map_verse) {
            map_verse = refSys->getBook(book-1)->getVerseMax(map_chapter);
            error = KEYERR_OUTOFBOUNDS;
        }

        // set values
        if (book > BMAX[0])
            book -= BMAX[0], testament = 2;
        else
            testament = 1;

        //if (map_verse == 0) Headings(1);

        chapter = map_chapter;
        verse = map_verse;
        suffix = ikey.getSuffix();
        
        if (map_verse < map_range) {
            if (map_range > refSys->getBook(((testament>1)?BMAX[0]:0)+book-1)->getVerseMax(chapter))
                ++map_range;
            verse = map_range;
            setUpperBound(this);
            verse = map_verse;
            setLowerBound(this);
        }
    }
}

void VerseKey::setIndex ( long  iindex )

virtual

Sets index based upon current verse

Parameters

iindex

value to set index to

Reimplemented from SWKey.

Definition at line 1718 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

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

Definition at line 1663 of file versekey.cpp.

{
    intros = val;
    normalize(true);
}

void SWKey::setLocale ( const char *  name )

inlineinherited

Definition at line 225 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

)

sets the lower boundary for this VerseKey

Parameters

lb	the new lower boundary for this VerseKey

Definition at line 1112 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

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;

Definition at line 135 of file swkey.cpp.

{
    persist = ipersist;
}

void VerseKey::setPosition ( SW_POSITION  newpos )

virtual

Positions this key

Parameters

newpos

Position to set to.

Reimplemented from SWKey.

Reimplemented in VerseTreeKey.

Definition at line 1288 of file versekey.cpp.

                                        {
    switch (p) {
    case POS_TOP: {
        const VerseKey *lb = &getLowerBound();
        testament = (lb->getTestament() || intros) ? lb->getTestament() : 1;
        book      = (lb->getBook()      || intros) ? lb->getBook() : 1;
        chapter   = (lb->getChapter()   || intros) ? lb->getChapter() : 1;
        verse     = (lb->getVerse()     || intros) ? lb->getVerse() : 1;
        suffix    = lb->getSuffix();
        break;
    }
    case POS_BOTTOM: {
        const VerseKey *ub = &getUpperBound();
        testament = (ub->getTestament() || intros) ? ub->getTestament() : 1;
        book      = (ub->getBook()      || intros) ? ub->getBook() : 1;
        chapter   = (ub->getChapter()   || intros) ? ub->getChapter() : 1;
        verse     = (ub->getVerse()     || intros) ? ub->getVerse() : 1;
        suffix    = ub->getSuffix();
        break;
    }
    case POS_MAXVERSE:
        suffix    = 0;
        verse     = 1;
        normalize();
        verse     = getVerseMax();
        suffix    = 0;
        break;
    case POS_MAXCHAPTER:
        suffix    = 0;
        verse     = 1;
        chapter   = 1;
        normalize();
        chapter   = getChapterMax();
        break;
    }
    normalize(true);
    popError(); // clear error from normalize
}

void VerseKey::setSuffix ( char  isuffix )

virtual

Sets/gets verse suffix

Parameters

isuffix

value which to set verse suffix

Definition at line 1634 of file versekey.cpp.

                                 {
    suffix = suf;
}

void VerseKey::setTestament ( char  itestament )

virtual

Sets testament

Parameters

itestament

value which to set testament

Definition at line 1548 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, bool  checkNormalize  )

inlinevirtual

Definition at line 220 of file versekey.h.

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

virtual void VerseKey::setText ( const char *  ikey )

inlinevirtual

Sets this SWKey with a character string

Parameters

ikey	string used to set this key

Reimplemented from SWKey.

Definition at line 221 of file versekey.h.

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

void VerseKey::setUpperBound

(

const VerseKey &

ub

)

sets the upper boundary for this VerseKey

Parameters

ub	the new upper boundary for this VerseKey

Definition at line 1135 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

Sets verse

Parameters

iverse

value which to set verse

Definition at line 1622 of file versekey.cpp.

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

void VerseKey::setVersificationSystem ( const char *  name )

virtual

Definition at line 298 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();
    }

}

SWDEPRECATED char VerseKey::Testament ( ) const

inline

Deprecated:

Use getTestament() instead.

Definition at line 265 of file versekey.h.

{ return getTestament(); }  // deprecated

SWDEPRECATED char VerseKey::Testament ( char  itestament )

inline

Deprecated:

Use setTestament() instead.

Definition at line 315 of file versekey.h.

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

SWDEPRECATED long VerseKey::TestamentIndex ( ) const

inline

Deprecated:

Use getTestamentIndex()

Definition at line 423 of file versekey.h.

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

SWDEPRECATED VerseKey& VerseKey::UpperBound ( const VerseKey &  ub )

inline

Deprecated:

Use setUpperBound / getUpperBound

Definition at line 182 of file versekey.h.

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

SWDEPRECATED VerseKey& VerseKey::UpperBound ( ) const

inline

Deprecated:

Use getUpperBound

Definition at line 200 of file versekey.h.

{ return getUpperBound(); }

void VerseKey::validateCurrentLocale

(

)

const

Definition at line 473 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()->logWarning("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, (unsigned int)(strlen(abbr)*2));
                }
                else {
                    stringMgr->upperLatin1(abbr);
                }
                SWLOGD("%s=%s\n", abbr, refSys->getBook(i)->getOSISName());
                delete [] abbr;
            }
        }
    }
}

SWDEPRECATED int VerseKey::Verse ( ) const

inline

Deprecated:

Use getVerse() instead.

Definition at line 298 of file versekey.h.

{ return getVerse(); }      // deprecated

SWDEPRECATED int VerseKey::Verse ( int  iverse )

inline

Deprecated:

Use setVerse() instead.

Definition at line 345 of file versekey.h.

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

Member Data Documentation

char VerseKey::autonorm

private

flag for auto normalization

Definition at line 65 of file versekey.h.

int VerseKey::BMAX[2]

Definition at line 120 of file versekey.h.

signed char VerseKey::book

protected

Definition at line 96 of file versekey.h.

bool SWKey::boundSet

mutableprotectedinherited

Definition at line 104 of file swkey.h.

signed int VerseKey::chapter

protected

Definition at line 97 of file versekey.h.

char SWKey::error

mutableprotectedinherited

Definition at line 106 of file swkey.h.

int VerseKey::instance = 0

staticprivate

number of instantiated VerseKey objects or derivitives

Definition at line 58 of file versekey.h.

ListKey VerseKey::internalListKey

private

Definition at line 59 of file versekey.h.

char VerseKey::intros

private

flag for intros on/off

Definition at line 69 of file versekey.h.

char* SWKey::keytext

protectedinherited

Definition at line 102 of file swkey.h.

char* SWKey::localeName

protectedinherited

Definition at line 108 of file swkey.h.

long VerseKey::lowerBound

mutableprivate

Definition at line 84 of file versekey.h.

VerseComponents VerseKey::lowerBoundComponents

mutableprivate

Definition at line 89 of file versekey.h.

const SWClass* SWObject::myClass

protectedinherited

Definition at line 55 of file swobject.h.

bool SWKey::persist

protectedinherited

Definition at line 105 of file swkey.h.

char* SWKey::rangeText

mutableprotectedinherited

Definition at line 103 of file swkey.h.

const VersificationMgr::System* VerseKey::refSys

private

Definition at line 61 of file versekey.h.

signed char VerseKey::suffix

protected

Definition at line 99 of file versekey.h.

signed char VerseKey::testament

protected

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

Definition at line 95 of file versekey.h.

VerseKey* VerseKey::tmpClone

mutableprivate

Definition at line 85 of file versekey.h.

long VerseKey::upperBound

mutableprivate

Definition at line 84 of file versekey.h.

VerseComponents VerseKey::upperBoundComponents

mutableprivate

Definition at line 89 of file versekey.h.

SW_u64 SWKey::userData

inherited

Definition at line 115 of file swkey.h.

signed int VerseKey::verse

protected

Definition at line 98 of file versekey.h.

---

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

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