ListKey Class Reference

#include <listkey.h>

Inheritance diagram for ListKey:

Collaboration diagram for ListKey:

Public Member Functions
virtual void	add (const SWKey &ikey)
virtual void	clear ()
virtual void	clearBounds () const
virtual SWDEPRECATED void	ClearList ()
virtual SWKey *	clone () const
virtual int	compare (const SWKey &ikey)
virtual void	copyFrom (const ListKey &ikey)
virtual void	copyFrom (const SWKey &ikey)
virtual SWDEPRECATED int	Count ()
virtual void	decrement (int step=1)
virtual bool	equals (const SWKey &ikey)
SWDEPRECATED char	Error ()
const SWClass *	getClass () const
virtual int	getCount () const
virtual SWKey *	getElement (int pos=-1)
virtual const SWKey *	getElement (int pos=-1) const
virtual SWDEPRECATED SWKey *	GetElement (int pos=-1)
virtual char	getError () const
virtual long	getIndex () const
char *	getLocale () const
virtual const char *	getOSISRefRangeText () const
virtual const char *	getRangeText () const
virtual const char *	getShortRangeText () const
virtual const char *	getShortText () const
virtual const char *	getText () const
virtual void	increment (int step=1)
virtual bool	isBoundSet () const
bool	isPersist () const
virtual bool	isTraversable () const
	ListKey (const char *ikey=0)
	ListKey (ListKey const &k)
virtual void	nextElement ()
ListKey &	operator<< (const SWKey &ikey)
SWKEY_OPERATORS ListKey &	operator= (const ListKey &key)
SWDEPRECATED char	Persist () const
SWDEPRECATED char	Persist (signed char ipersist)
virtual char	popError ()
virtual void	positionFrom (const SWKey &ikey)
virtual void	remove ()
virtual SWDEPRECATED void	Remove ()
virtual void	setError (char err)
virtual void	setIndex (long index)
void	setLocale (const char *name)
void	setPersist (bool ipersist)
virtual void	setPosition (SW_POSITION pos)
virtual void	setText (const char *ikey)
virtual char	setToElement (int ielement, SW_POSITION pos=TOP)
virtual SWDEPRECATED char	SetToElement (int ielement, SW_POSITION pos=TOP)
virtual void	sort ()
virtual	~ListKey ()

Public Attributes
SW_u64	userData

Protected Member Functions
SWLocale *	getPrivateLocale () const

Protected Attributes
SWKey **	array
int	arraycnt
int	arraymax
int	arraypos
bool	boundSet
char	error
char *	keytext
char *	localeName
const SWClass *	myClass
bool	persist
char *	rangeText

Private Member Functions
void	init ()

Detailed Description

ListKey is a container SWKey which faciliates a list of SWKey objects

Definition at line 38 of file listkey.h.

Constructor & Destructor Documentation

ListKey::ListKey

(

const char *

ikey = 0

)

initializes instance of ListKey

Parameters

ikey

text key

Definition at line 43 of file listkey.cpp.

                                : SWKey(ikey) {
    arraymax = 0;
    clear();
    init();
}

ListKey::ListKey

(

ListKey const &

k

)

Definition at line 50 of file listkey.cpp.

                                 : SWKey(k.keytext) {
    arraymax = k.arraymax;
    arraypos = k.arraypos;
    arraycnt = k.arraycnt;
    array = (arraymax)?(SWKey **)malloc(k.arraymax * sizeof(SWKey *)):0;
    for (int i = 0; i < arraycnt; i++)
        array[i] = k.array[i]->clone();
    init();
}

ListKey::~ListKey ( )

virtual

cleans up instance of ListKey

Definition at line 77 of file listkey.cpp.

{
    clear();
}

Member Function Documentation

void ListKey::add ( const SWKey &  ikey )

virtual

Definition at line 128 of file listkey.cpp.

                                   {
    if (++arraycnt > arraymax) {
        array = (SWKey **) ((array) ? realloc(array, (arraycnt + 32) * sizeof(SWKey *)) : calloc(arraycnt + 32, sizeof(SWKey *)));
        arraymax = arraycnt + 32;
    }
    array[arraycnt-1] = ikey.clone();
    setToElement(arraycnt-1);
}

void ListKey::clear ( )

virtual

Clears out elements of list

Definition at line 87 of file listkey.cpp.

{
    int loop;

    if (arraymax) {
        for (loop = 0; loop < arraycnt; loop++)
            delete array[loop];

        free(array);
        arraymax  = 0;
    }
    arraycnt  = 0;
    arraypos  = 0;
    array     = 0;
}

virtual void SWKey::clearBounds ( ) const

inlinevirtualinherited

Reimplemented in VerseKey.

Definition at line 190 of file swkey.h.

{ boundSet = false; }

virtual SWDEPRECATED void ListKey::ClearList ( )

inlinevirtual

Deprecated:

, use clear(), instead

Definition at line 70 of file listkey.h.

{ clear(); }

SWKey * ListKey::clone ( ) const

virtual

Returns a new exact clone of this SWKey object. This allocates a new SWKey which must be deleted by the caller

Returns

new clone of this key

Reimplemented from SWKey.

Definition at line 68 of file listkey.cpp.

{
    return new ListKey(*this);
}

int SWKey::compare ( const SWKey &  ikey )

virtualinherited

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

Reimplemented in VerseKey, TreeKey, and TreeKeyIdx.

Definition at line 218 of file swkey.cpp.

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

void ListKey::copyFrom ( const ListKey &  ikey )

virtual

Equates this ListKey to another ListKey object

Parameters

ikey	other ListKey object

Definition at line 110 of file listkey.cpp.

                                          {
    clear();

    arraymax = ikey.arraymax;
    arraypos = ikey.arraypos;
    arraycnt = ikey.arraycnt;
    array = (arraymax)?(SWKey **)malloc(ikey.arraymax * sizeof(SWKey *)):0;
    for (int i = 0; i < arraycnt; i++)
        array[i] = ikey.array[i]->clone();

    setToElement(0);
}

virtual void ListKey::copyFrom ( const SWKey &  ikey )

inlinevirtual

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 130 of file listkey.h.

{ SWKey::copyFrom(ikey); }

virtual SWDEPRECATED int ListKey::Count ( )

inlinevirtual

Deprecated:

Use getCount

Definition at line 80 of file listkey.h.

{ return getCount(); }

void ListKey::decrement ( int  step = 1 )

virtual

Decrements a number of elements

Reimplemented from SWKey.

Definition at line 187 of file listkey.cpp.

                                {
    if (step < 0) {
        increment(step*-1);
        return;
    }
    popError();     // clear error
    for(; step && !popError(); step--) {
        if (arraypos > -1 && arraycnt) {
            if (array[arraypos]->isBoundSet())
                (*(array[arraypos]))--;
            if ((array[arraypos]->popError()) || (!array[arraypos]->isBoundSet())) {
                setToElement(arraypos-1, BOTTOM);
            }
            else SWKey::setText((const char *)(*array[arraypos]));
        }
        else error = KEYERR_OUTOFBOUNDS;
    }
}

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

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;
    }

int ListKey::getCount ( ) const

virtual

Returns number of key elements in list

Returns

number of key elements in list

Definition at line 211 of file listkey.cpp.

                            {
    return arraycnt;
}

SWKey * ListKey::getElement ( int  pos = -1 )

virtual

Gets a key element number

Parameters

pos	element number to get (or default current)

Returns

Key or null on error

Definition at line 270 of file listkey.cpp.

                                  {
    const ListKey &self = *this;
    return const_cast<SWKey *>(self.getElement(pos));
}

const SWKey * ListKey::getElement ( int  pos = -1 ) const

virtual

Definition at line 260 of file listkey.cpp.

                                              {
    if (pos < 0)
        pos = arraypos;
        
    if (pos >=arraycnt)
        error = KEYERR_OUTOFBOUNDS;

    return (error) ? 0:array[pos];
}

virtual SWDEPRECATED SWKey* ListKey::GetElement ( int  pos = -1 )

inlinevirtual

Deprecated:

Use getElement

Definition at line 117 of file listkey.h.

{ return getElement(pos); }

virtual char SWKey::getError ( ) const

inlinevirtualinherited

Definition at line 164 of file swkey.h.

{ return error; }

virtual long ListKey::getIndex ( ) const

inlinevirtual

Use this function to get an index position within a module.

Reimplemented from SWKey.

Definition at line 149 of file listkey.h.

{ return arraypos; }

char* SWKey::getLocale ( ) const

inlineinherited

Definition at line 224 of file swkey.h.

{ return localeName; }

const char * ListKey::getOSISRefRangeText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 315 of file listkey.cpp.

                                               {
    char *buf = new char[(arraycnt + 1) * 255];
    buf[0] = 0;
    for (int i = 0; i < arraycnt; i++) {
        strcat(buf, array[i]->getOSISRefRangeText());
        if (i < arraycnt-1)
            strcat(buf, ";");
    }
    stdstr(&rangeText, buf);
    delete [] buf;
    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 * ListKey::getRangeText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 297 of file listkey.cpp.

                                        {
    char *buf = new char[(arraycnt + 1) * 255];
    buf[0] = 0;
    for (int i = 0; i < arraycnt; i++) {
        strcat(buf, array[i]->getRangeText());
        if (i < arraycnt-1)
            strcat(buf, "; ");
    }
    stdstr(&rangeText, buf);
    delete [] buf;
    return rangeText;
}

const char * ListKey::getShortRangeText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 333 of file listkey.cpp.

                                             {
    SWBuf buf;
    for (int i = 0; i < arraycnt; i++) {
        buf += array[i]->getShortRangeText();
        if (i < arraycnt-1)
            buf += "; ";
    }
    stdstr(&rangeText, buf.c_str());
    return rangeText;
}

const char * ListKey::getShortText ( ) const

virtual

Reimplemented from SWKey.

Definition at line 355 of file listkey.cpp.

                                        {
    int pos = arraypos;
    SWKey *key = (pos >= arraycnt || !arraycnt) ? 0:array[pos];
    return (key) ? key->getShortText() : keytext;
}

const char * ListKey::getText ( ) const

virtual

returns string representation of this key

Reimplemented from SWKey.

Definition at line 349 of file listkey.cpp.

                                   {
    int pos = arraypos;
    SWKey *key = (pos >= arraycnt || !arraycnt) ? 0:array[pos];
    return (key) ? key->getText() : keytext;
}

void ListKey::increment ( int  step = 1 )

virtual

Increments a number of elements

Reimplemented from SWKey.

Definition at line 163 of file listkey.cpp.

                                {
    if (step < 0) {
        decrement(step*-1);
        return;
    }
    popError();     // clear error
    for(; step && !popError(); step--) {
        if (arraypos < arraycnt && arraycnt) {
            if (array[arraypos]->isBoundSet())
                (*(array[arraypos]))++;
            if ((array[arraypos]->popError()) || (!array[arraypos]->isBoundSet())) {
                setToElement(arraypos+1);
            }
            else SWKey::setText((const char *)(*array[arraypos]));
        }
        else error = KEYERR_OUTOFBOUNDS;
    }
}

void ListKey::init ( )

private

Definition at line 61 of file listkey.cpp.

                   {
    myClass = &classdef;
    // this is a listkey, bound is always set
    boundSet = true;
}

virtual bool SWKey::isBoundSet ( ) const

inlinevirtualinherited

Definition at line 189 of file swkey.h.

{ return boundSet; }

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 ListKey::isTraversable ( ) const

inlinevirtual

Whether or not this key can be ++ – incremented

Reimplemented from SWKey.

Definition at line 148 of file listkey.h.

{ return true; }

virtual void ListKey::nextElement ( )

inlinevirtual

Definition at line 146 of file listkey.h.

{ setToElement(arraypos + 1); }

ListKey& ListKey::operator<< ( const SWKey &  ikey )

inline

Adds an element to the list

Parameters

ikey	the element to add

Definition at line 122 of file listkey.h.

{ add(ikey); return *this; }

SWKEY_OPERATORS ListKey& ListKey::operator= ( const ListKey &  key )

inline

Definition at line 165 of file listkey.h.

{ copyFrom(key); return *this; }

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;
}

virtual void SWKey::positionFrom ( const SWKey &  ikey )

inlinevirtualinherited

Reimplemented in VerseKey.

Definition at line 180 of file swkey.h.

{ copyFrom(ikey); }

void ListKey::remove ( )

virtual

Removes current element from list

Definition at line 281 of file listkey.cpp.

                     {
    if ((arraypos > -1) && (arraypos < arraycnt)) {
        delete array[arraypos];
        if (arraypos < arraycnt - 1)
            memmove(&array[arraypos], &array[arraypos+1], (arraycnt - arraypos - 1) * sizeof(SWKey *));
        arraycnt--;
        
        setToElement((arraypos)?arraypos-1:0);
    }
}

virtual SWDEPRECATED void ListKey::Remove ( )

inlinevirtual

Deprecated:

Use remove

Definition at line 88 of file listkey.h.

{ remove(); }

virtual void SWKey::setError ( char  err )

inlinevirtualinherited

Definition at line 165 of file swkey.h.

{ error = err; }

virtual void ListKey::setIndex ( long  index )

inlinevirtual

Returns the index for the new one given as as parameter. The first parameter is the new index.

Reimplemented from SWKey.

Definition at line 159 of file listkey.h.

{ setToElement((int)index); }

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 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 ListKey::setPosition ( SW_POSITION  pos )

virtual

Positions this key

Parameters

pos

position

Reimplemented from SWKey.

Definition at line 147 of file listkey.cpp.

                                       {
    switch (p) {
    case 1: // GCC won't compile P_TOP
        setToElement(0, p);
        break;
    case 2: // GCC won't compile P_BOTTOM
        setToElement(arraycnt-1, p);
        break;
    }
}

void ListKey::setText ( const char *  ikey )

virtual

Sets this SWKey with a character string

Parameters

ikey	string used to set this key

Reimplemented from SWKey.

Definition at line 362 of file listkey.cpp.

                                      {
    // at least try to set the current element to this text
    for (arraypos = 0; arraypos < arraycnt; arraypos++) {
        SWKey *key = array[arraypos];
        if (key) {
            if (key->isTraversable() && key->isBoundSet()) {
                key->setText(ikey);
                if (!key->popError())
                    break;
            }
            else {
                if (!strcmp(key->getText(), ikey))
                    break;
            }
        }
    }
    if (arraypos >= arraycnt) {
        error = 1;
        arraypos = arraycnt-1;
    }
    
    SWKey::setText(ikey);
}

char ListKey::setToElement ( int  ielement, SW_POSITION  pos = TOP  )

virtual

Sets container to subkey element number and repositions that subkey to either top or bottom

Parameters

ielement	- element number to set to
pos	- set the subkey element to position (TOP) or BOTTOM

Returns

error status deprecated use setToElement

Definition at line 225 of file listkey.cpp.

                                                        {
    arraypos = ielement;
    if (arraypos >= arraycnt) {
        arraypos = (arraycnt>0)?arraycnt - 1:0;
        error = KEYERR_OUTOFBOUNDS;
    }
    else {
        if (arraypos < 0) {
            arraypos = 0;
            error = KEYERR_OUTOFBOUNDS;
        }
        else {
            error = 0;
        }
    }
    
    if (arraycnt) {
        if (array[arraypos]->isBoundSet())
            (*array[arraypos]) = pos;
        SWKey::setText((const char *)(*array[arraypos]));
    }
    else SWKey::setText("");
    
    return error;
}

virtual SWDEPRECATED char ListKey::SetToElement ( int  ielement, SW_POSITION  pos = TOP  )

inlinevirtual

Deprecated:

Use setToElement

Definition at line 102 of file listkey.h.

{ return setToElement(ielement, pos); }

void ListKey::sort ( )

virtual

Definition at line 387 of file listkey.cpp.

                   {
    for (int i = 0; i < arraycnt; i++) {
        for (int j = i; j < arraycnt; j++) {
            if (*array[j] < *array[i]) {
                SWKey *tmp = array[i];
                array[i] = array[j];
                array[j] = tmp;
            }
        }
    }
}

Member Data Documentation

SWKey** ListKey::array

protected

Definition at line 46 of file listkey.h.

int ListKey::arraycnt

protected

Definition at line 45 of file listkey.h.

int ListKey::arraymax

protected

Definition at line 44 of file listkey.h.

int ListKey::arraypos

protected

Definition at line 43 of file listkey.h.

bool SWKey::boundSet

mutableprotectedinherited

Definition at line 104 of file swkey.h.

char SWKey::error

mutableprotectedinherited

Definition at line 106 of file swkey.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.

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.

SW_u64 SWKey::userData

inherited

Definition at line 115 of file swkey.h.

---

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

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