TreeKeyIdx Class Reference

#include <treekeyidx.h>

Inheritance diagram for TreeKeyIdx:

Collaboration diagram for TreeKeyIdx:

Classes
class	TreeNode

Public Member Functions
virtual int	_compare (const TreeKeyIdx &ikey)
virtual void	append ()
virtual void	appendChild ()
virtual void	assureKeyPath (const char *keyPath=0)
virtual void	clearBounds () const
virtual SWKey *	clone () const
virtual int	compare (const SWKey &ikey)
virtual void	copyFrom (const TreeKeyIdx &ikey)
virtual void	copyFrom (const SWKey &ikey)
virtual void	decrement (int steps=1)
virtual bool	equals (const SWKey &ikey)
SWDEPRECATED char	Error ()
virtual bool	firstChild ()
const SWClass *	getClass () const
virtual char	getError () const
virtual long	getIndex () const
virtual int	getLevel ()
char *	getLocale () const
virtual const char *	getLocalName ()
unsigned long	getOffset () 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 const char *	getUserData (int *size=0) const
virtual bool	hasChildren ()
virtual void	increment (int steps=1)
virtual void	insertBefore ()
virtual bool	isBoundSet () const
bool	isPersist () const
virtual bool	isTraversable () const
virtual bool	nextSibling ()
virtual SWKey &	operator= (const TreeKeyIdx &ikey)
virtual bool	parent ()
SWDEPRECATED char	Persist () const
SWDEPRECATED char	Persist (signed char ipersist)
virtual char	popError ()
virtual void	positionFrom (const SWKey &ikey)
virtual bool	previousSibling ()
virtual void	remove ()
virtual void	root ()
virtual void	save ()
virtual void	setError (char err)
virtual void	setIndex (long iindex)
void	setLocale (const char *name)
virtual const char *	setLocalName (const char *)
void	setOffset (unsigned long offset)
void	setPersist (bool ipersist)
virtual void	setPosition (SW_POSITION p)
void	setPositionChangeListener (PositionChangeListener *pcl)
virtual SWKEY_OPERATORS void	setText (const char *ikey)
virtual void	setUserData (const char *userData, int size=0)
	TreeKeyIdx (const TreeKeyIdx &ikey)
	TreeKeyIdx (const char *idxPath, int fileMode=-1)
virtual	~TreeKeyIdx ()

Static Public Member Functions
static signed char	create (const char *path)

Public Attributes
class TreeKey::PositionChangeListener *	posChangeListener
SW_u64	userData

Protected Member Functions
SWLocale *	getPrivateLocale () const
void	positionChanged ()

Protected Attributes
bool	boundSet
char	error
char *	keytext
char *	localeName
const SWClass *	myClass
bool	persist
char *	rangeText
SWBuf	unsnappedKeyText

Private Member Functions
void	getTreeNodeFromDatOffset (long ioffset, TreeNode *buf) const
char	getTreeNodeFromIdxOffset (long ioffset, TreeNode *node) const
void	init ()
void	saveTreeNode (TreeNode *node)
void	saveTreeNodeOffsets (TreeNode *node)

Private Attributes
class TreeKeyIdx::TreeNode	currentNode
FileDesc *	datfd
FileDesc *	idxfd
char *	path

Detailed Description

Class TreeKeyIdx The TreeKey implementation used for tree-based modules in SWORD, such as GenBooks.

Definition at line 39 of file treekeyidx.h.

Constructor & Destructor Documentation

TreeKeyIdx::TreeKeyIdx

(

const TreeKeyIdx &

ikey

)

Definition at line 41 of file treekeyidx.cpp.

                                             : currentNode() {
    init();
    path = 0;
    idxfd = 0;
    datfd = 0;
    copyFrom(ikey);
}

TreeKeyIdx::TreeKeyIdx	(	const char *	idxPath,
		int	fileMode = -1
	)

Definition at line 49 of file treekeyidx.cpp.

                                                        : currentNode() {
    SWBuf buf;

    init();
    path = 0;
    stdstr(&path, idxPath);

    if (fileMode == -1) { // try read/write if possible
        fileMode = FileMgr::RDWR;
    }
        
    buf.setFormatted("%s.idx", path);
    idxfd = FileMgr::getSystemFileMgr()->open(buf, fileMode, true);
    buf.setFormatted("%s.dat", path);
    datfd = FileMgr::getSystemFileMgr()->open(buf, fileMode, true);

    if (!datfd || datfd->getFd() < 0) {
// couldn't find datafile but this might be fine if we're
// merely instantiating a remote InstallMgr SWMgr
SWLOGD("Couldn't open file: %s. errno: %d", buf.c_str(), errno);
        error = errno;
    }
    else {
        root();
    }
}

TreeKeyIdx::~TreeKeyIdx ( )

virtual

Definition at line 82 of file treekeyidx.cpp.

                         {
    if (path)
        delete [] path;

    FileMgr::getSystemFileMgr()->close(idxfd);
    FileMgr::getSystemFileMgr()->close(datfd);
}

Member Function Documentation

int TreeKeyIdx::_compare ( const TreeKeyIdx &  ikey )

virtual

Definition at line 570 of file treekeyidx.cpp.

                                                 {
        return (int)(getOffset() - ikey.getOffset());
}

void TreeKeyIdx::append ( )

virtual

Implements TreeKey.

Definition at line 203 of file treekeyidx.cpp.

                        {
    TreeNode lastSib;
    if (currentNode.offset) {
        getTreeNodeFromIdxOffset(currentNode.offset, &lastSib);
        while (lastSib.next > -1) {
            getTreeNodeFromIdxOffset(lastSib.next, &lastSib);
        }
        SW_u32 idxOffset = (SW_u32)idxfd->seek(0, SEEK_END);
        lastSib.next = idxOffset;
        saveTreeNodeOffsets(&lastSib);
        SW_u32 parent = currentNode.parent;
        currentNode.clear();
        currentNode.offset = idxOffset;
        currentNode.parent = parent;
        positionChanged();
    }
}

void TreeKeyIdx::appendChild ( )

virtual

Implements TreeKey.

Definition at line 222 of file treekeyidx.cpp.

                             {
    if (firstChild()) {
        append();
    }
    else {
        SW_u32 idxOffset = (SW_u32)idxfd->seek(0, SEEK_END);
        currentNode.firstChild = idxOffset;
        saveTreeNodeOffsets(&currentNode);
        SW_u32 parent = currentNode.offset;
        currentNode.clear();
        currentNode.offset = idxOffset;
        currentNode.parent = parent;
    }
    positionChanged();
}

void TreeKey::assureKeyPath ( const char *  keyPath = 0 )

virtualinherited

Set the key to this path. If the path doesn't exist, then nodes are created as necessary

Parameters

keyPath

path to set/create; if unsupplied, then use any unsnapped setText value.

Definition at line 41 of file treekey.cpp.

                                                 {

    if (!keyBuffer) {
        keyBuffer = unsnappedKeyText;
        //assert we have something to do before setting root
        if (!*keyBuffer)
            return;
    }

    char *keybuf = 0;
    stdstr(&keybuf, keyBuffer);

    root();

    // TODO: change to NOT use strtok. strtok is dangerous.
    SWBuf tok = strtok(keybuf, "/");
    tok.trim();
    while (tok.size()) {
        bool foundkey = false;
        if (hasChildren()) {
            firstChild();
            if (tok == getLocalName()) {
                foundkey = true;
            }
            else {
                while (nextSibling()) {
                    if (getLocalName()) {
                        if (tok == getLocalName()) {
                            foundkey = true;
                            break;
                        }
                    }
                }
            }
            if (!foundkey) {
                append();
                setLocalName(tok);
                save();     
            }
        }
        else {
            appendChild();
            setLocalName(tok);
            save();
        }

#ifdef DEBUG
//      std::cout << getLocalName() << " : " << tok << std::endl;
#endif

        tok = strtok(0, "/");
        tok.trim();

    }
    delete [] keybuf;
}

virtual void SWKey::clearBounds ( ) const

inlinevirtualinherited

Reimplemented in VerseKey.

Definition at line 190 of file swkey.h.

{ boundSet = false; }

SWKey * TreeKeyIdx::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 668 of file treekeyidx.cpp.

{
    return new TreeKeyIdx(*this);
}

int TreeKeyIdx::compare ( const SWKey &  ikey )

virtual

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

Implements TreeKey.

Definition at line 575 of file treekeyidx.cpp.

                                         {
    const TreeKeyIdx *treeKey = SWDYNAMIC_CAST(const TreeKeyIdx, (&ikey));
    if (treeKey)
        return _compare(*treeKey);
    return SWKey::compare(ikey);
}

void TreeKeyIdx::copyFrom ( const TreeKeyIdx &  ikey )

virtual

Definition at line 450 of file treekeyidx.cpp.

                                                {
    unsnappedKeyText = "";

    SWKey::copyFrom(ikey);

    currentNode.offset = ikey.currentNode.offset;
    currentNode.parent = ikey.currentNode.parent;
    currentNode.next = ikey.currentNode.next;
    currentNode.firstChild = ikey.currentNode.firstChild;
    stdstr(&(currentNode.name), ikey.currentNode.name);
    currentNode.dsize = ikey.currentNode.dsize;

    if (currentNode.userData)
        delete [] currentNode.userData;
    if (currentNode.dsize) {
        currentNode.userData = new char [ currentNode.dsize ];
        memcpy(currentNode.userData, ikey.currentNode.userData, currentNode.dsize);
    }
    else currentNode.userData = 0;

    bool newFiles = true;

    if (path && ikey.path)
        newFiles = strcmp(path, ikey.path);

    if (newFiles) {
        stdstr(&path, ikey.path);

        if (idxfd) {
            FileMgr::getSystemFileMgr()->close(idxfd);
            FileMgr::getSystemFileMgr()->close(datfd);
        }
        idxfd = FileMgr::getSystemFileMgr()->open(ikey.idxfd->path, ikey.idxfd->mode, ikey.idxfd->perms);
        datfd = FileMgr::getSystemFileMgr()->open(ikey.datfd->path, ikey.datfd->mode, ikey.datfd->perms);
    }
    positionChanged();
}

void TreeKeyIdx::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 550 of file treekeyidx.cpp.

                                           {
    unsnappedKeyText = ikey;
    SWKey::copyFrom(ikey);
    positionChanged();
}

signed char TreeKeyIdx::create ( const char *  path )

static

Definition at line 290 of file treekeyidx.cpp.

                                                {
    char *path = 0;
    char *buf = new char [ strlen (ipath) + 20 ];
    FileDesc *fd, *fd2;

    stdstr(&path, ipath);

    if ((path[strlen(path)-1] == '/') || (path[strlen(path)-1] == '\\'))
        path[strlen(path)-1] = 0;

    sprintf(buf, "%s.dat", path);
    FileMgr::removeFile(buf);
    fd = FileMgr::getSystemFileMgr()->open(buf, FileMgr::CREAT|FileMgr::WRONLY, FileMgr::IREAD|FileMgr::IWRITE);
    fd->getFd();
    FileMgr::getSystemFileMgr()->close(fd);

    sprintf(buf, "%s.idx", path);
    FileMgr::removeFile(buf);
    fd2 = FileMgr::getSystemFileMgr()->open(buf, FileMgr::CREAT|FileMgr::WRONLY, FileMgr::IREAD|FileMgr::IWRITE);
    fd2->getFd();
    FileMgr::getSystemFileMgr()->close(fd2);
    TreeKeyIdx newTree(path);
    TreeKeyIdx::TreeNode root;
    stdstr(&(root.name), "");
    newTree.saveTreeNode(&root);

    delete [] path;

    return 0;
}

void TreeKeyIdx::decrement ( int  steps = 1 )

virtual

Decrements key a number of entry positions This is only valid if isTraversable is true

Parameters

steps

Number of entries to jump backward

Implements TreeKey.

Definition at line 583 of file treekeyidx.cpp.

                                    {
    error = getTreeNodeFromIdxOffset(currentNode.offset - (4*steps), &currentNode);
    positionChanged();
}

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

bool TreeKeyIdx::firstChild ( )

virtual

Go to the first child of the current node

Returns

success or failure

Implements TreeKey.

Definition at line 158 of file treekeyidx.cpp.

                            {
    if (currentNode.firstChild > -1) {
        error = getTreeNodeFromIdxOffset(currentNode.firstChild, &currentNode);
        positionChanged();
        return true;
    }
    return false;
}

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

virtual long TreeKey::getIndex ( ) const

inlinevirtualinherited

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

Reimplemented from SWKey.

Definition at line 127 of file treekey.h.

{ return getOffset(); }

int TreeKeyIdx::getLevel ( )

virtual

Reimplemented from TreeKey.

Definition at line 136 of file treekeyidx.cpp.

                         {
    TreeNode iterator;
    iterator.parent = currentNode.parent;
    int level = 0;
    while (iterator.parent > -1) {
        level++;
        getTreeNodeFromIdxOffset(iterator.parent, &iterator);
    }
    return level;
}

char* SWKey::getLocale ( ) const

inlineinherited

Definition at line 224 of file swkey.h.

{ return localeName; }

const char * TreeKeyIdx::getLocalName ( )

virtual

Implements TreeKey.

Definition at line 91 of file treekeyidx.cpp.

                                     {
    unsnappedKeyText = "";
    return currentNode.name;
}

unsigned long TreeKeyIdx::getOffset ( ) const

virtual

Implements TreeKey.

Definition at line 410 of file treekeyidx.cpp.

                                          {
    unsnappedKeyText = "";
    return currentNode.offset;
}

const char * SWKey::getOSISRefRangeText ( ) const

virtualinherited

Reimplemented in VerseKey, and ListKey.

Definition at line 203 of file swkey.cpp.

                                             {
    return getRangeText();
}

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 * SWKey::getRangeText ( ) const

virtualinherited

Reimplemented in VerseKey, and ListKey.

Definition at line 193 of file swkey.cpp.

                                      {
    stdstr(&rangeText, keytext);
    return rangeText;
}

virtual const char* SWKey::getShortRangeText ( ) const

inlinevirtualinherited

Reimplemented in VerseKey, and ListKey.

Definition at line 187 of file swkey.h.

{ return getRangeText(); }

virtual const char* SWKey::getShortText ( ) const

inlinevirtualinherited

Reimplemented in VerseKey, and ListKey.

Definition at line 185 of file swkey.h.

{ return getText(); }

const char * TreeKeyIdx::getText ( ) const

virtual

returns string representation of this key

Implements TreeKey.

Definition at line 615 of file treekeyidx.cpp.

                                      {
    TreeNode parent;
    static SWBuf fullPath;
    fullPath = currentNode.name;
    parent.parent = currentNode.parent;
    while (parent.parent > -1) {
        getTreeNodeFromIdxOffset(parent.parent, &parent);
        fullPath = ((SWBuf)parent.name) + (SWBuf) "/" + fullPath;
    }
    // we've snapped; clear our unsnapped text holder
    unsnappedKeyText = "";
    return fullPath.c_str();
}

void TreeKeyIdx::getTreeNodeFromDatOffset ( long  ioffset, TreeNode *  buf  ) const

private

Definition at line 331 of file treekeyidx.cpp.

                                                                            {
    unsnappedKeyText = "";
    char ch;
    SW_s32  tmp;
    SW_u16  tmp2;

    if (datfd && datfd->getFd() >= 0) {

        datfd->seek(ioffset, SEEK_SET);

        datfd->read(&tmp, 4);
        node->parent = swordtoarch32(tmp);

        datfd->read(&tmp, 4);
        node->next = swordtoarch32(tmp);

        datfd->read(&tmp, 4);
        node->firstChild = swordtoarch32(tmp);

        SWBuf name;
        do {
            datfd->read(&ch, 1);
            name += ch;
        } while (ch);

        stdstr(&(node->name), name.c_str());

        datfd->read(&tmp2, 2);
        node->dsize = swordtoarch16(tmp2);

        if (node->dsize) {
            if (node->userData)
                delete [] node->userData;
            node->userData = new char [node->dsize];
            datfd->read(node->userData, node->dsize);
        }
    }
}

char TreeKeyIdx::getTreeNodeFromIdxOffset ( long  ioffset, TreeNode *  node  ) const

private

Definition at line 380 of file treekeyidx.cpp.

                                                                            {
    unsnappedKeyText = "";
    SW_u32 offset;
    char error = KEYERR_OUTOFBOUNDS;
    
    if (ioffset < 0) {
        ioffset = 0;
        error = 77; // out of bounds but still position to 0;
    }

    node->offset = (SW_s32)ioffset;
    if (idxfd && idxfd->getFd() >= 0) {
        idxfd->seek(ioffset, SEEK_SET);
        if (idxfd->read(&offset, 4) == 4) {
            offset = swordtoarch32(offset);
            error = (error == 77) ? KEYERR_OUTOFBOUNDS : 0;
            getTreeNodeFromDatOffset(offset, node);
        }
        else {
            idxfd->seek(-4, SEEK_END);
            if (idxfd->read(&offset, 4) == 4) {
                offset = swordtoarch32(offset);
                getTreeNodeFromDatOffset(offset, node);
            }
        }
    }
    return error;
}

const char * TreeKeyIdx::getUserData ( int *  size = 0 ) const

virtual

Implements TreeKey.

Definition at line 97 of file treekeyidx.cpp.

                                                   {
    unsnappedKeyText = "";
    if (size)
        *size = (int)currentNode.dsize;
    return currentNode.userData;
}

bool TreeKeyIdx::hasChildren ( )

virtual

Does the current node have children?

Returns

whether or not it does

Implements TreeKey.

Definition at line 198 of file treekeyidx.cpp.

                             {
    return (currentNode.firstChild > -1);
}

void TreeKeyIdx::increment ( int  steps = 1 )

virtual

Increments key a number of entry positions This is only valid if isTraversable is true

Parameters

steps

Number of entries to jump forward

Implements TreeKey.

Definition at line 588 of file treekeyidx.cpp.

                                    {
    error = getTreeNodeFromIdxOffset(currentNode.offset + (4*steps), &currentNode);
    if (error) {
        SWLog::getSystemLog(); // strange fix for android // ->logError("error: %d", error);
    }
    positionChanged();

/*
    // assert positive
    if (steps < 0) {
        decrement(steps * -1);
        return;
    }

    while (steps > 0) {
        if (!firstChild()) {
            if (!nextSibbling() {
                error = KEYERR_OUTOFBOUNDS;
                return;
            }
        }
        steps--;
    }
*/
}

void TreeKeyIdx::init ( )

private

Definition at line 77 of file treekeyidx.cpp.

                      {
    myClass = &classdef;
}

void TreeKeyIdx::insertBefore ( )

virtual

Implements TreeKey.

Definition at line 239 of file treekeyidx.cpp.

                              {
}

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

inlinevirtual

Whether or not this key can be ++ – incremented

Reimplemented from TreeKey.

Definition at line 119 of file treekeyidx.h.

{ return true; }

bool TreeKeyIdx::nextSibling ( )

virtual

Go to the next sibling of the current node

Returns

success or failure

Implements TreeKey.

Definition at line 168 of file treekeyidx.cpp.

                             {
    if (currentNode.next > -1) {
        error = getTreeNodeFromIdxOffset(currentNode.next, &currentNode);
        positionChanged();
        return true;
    }
    return false;
}

virtual SWKey& TreeKeyIdx::operator= ( const TreeKeyIdx &  ikey )

inlinevirtual

Definition at line 109 of file treekeyidx.h.

{ copyFrom(ikey); return *this; }

bool TreeKeyIdx::parent ( )

virtual

Go to the parent of the current node

Returns

success or failure

Implements TreeKey.

Definition at line 148 of file treekeyidx.cpp.

                        {
    if (currentNode.parent > -1) {
        error = getTreeNodeFromIdxOffset(currentNode.parent, &currentNode);
        positionChanged();
        return true;
    }
    return false;
}

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 TreeKey::positionChanged ( )

inlineprotectedinherited

Definition at line 51 of file treekey.h.

{ if (posChangeListener) posChangeListener->positionChanged(); }

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

inlinevirtualinherited

Reimplemented in VerseKey.

Definition at line 180 of file swkey.h.

{ copyFrom(ikey); }

bool TreeKeyIdx::previousSibling ( )

virtual

Go to the previous sibling of the current node

Returns

success or failure

Implements TreeKey.

Definition at line 178 of file treekeyidx.cpp.

                                 {
    TreeNode iterator;
    SW_s32 target = currentNode.offset;
    if (currentNode.parent > -1) {
        getTreeNodeFromIdxOffset(currentNode.parent, &iterator);
        getTreeNodeFromIdxOffset(iterator.firstChild, &iterator);
        if (iterator.offset != target) {
            while ((iterator.next != target) && (iterator.next > -1))
                getTreeNodeFromIdxOffset(iterator.next, &iterator);
            if (iterator.next > -1) {
                error = getTreeNodeFromIdxOffset(iterator.offset, &currentNode);
                positionChanged();
                return true;
            }
        }
    }
    return false;
}

void TreeKeyIdx::remove ( )

virtual

Implements TreeKey.

Definition at line 243 of file treekeyidx.cpp.

                        {
    TreeNode node;
    bool done = false;
    if (currentNode.offset) {
        getTreeNodeFromIdxOffset(currentNode.offset, &node);
        if (node.parent > -1) {
            TreeNode parent;
            getTreeNodeFromIdxOffset(node.parent, &parent);
            if (parent.firstChild == node.offset) {
                parent.firstChild = node.next;
                saveTreeNodeOffsets(&parent);
                getTreeNodeFromIdxOffset(parent.offset, &currentNode);
                done = true;
            }
        }
        if (!done) {
            TreeNode iterator;
            SW_s32 target = currentNode.offset;
            if (currentNode.parent > -1) {
                getTreeNodeFromIdxOffset(currentNode.parent, &iterator);
                getTreeNodeFromIdxOffset(iterator.firstChild, &iterator);
                if (iterator.offset != target) {
                    while ((iterator.next != target) && (iterator.next > -1)) {
                        getTreeNodeFromIdxOffset(iterator.next, &iterator);
                    }
                    if (iterator.next > -1) {
                        TreeNode prev;
                        getTreeNodeFromIdxOffset(iterator.offset, &prev);
                        prev.next = node.next;
                        saveTreeNodeOffsets(&prev);
                        getTreeNodeFromIdxOffset(prev.offset, &currentNode);
                    }
                }
            }
        }
        positionChanged();
    }
}

void TreeKeyIdx::root ( )

virtual

Go to the root node

Implements TreeKey.

Definition at line 131 of file treekeyidx.cpp.

                      {
    error = getTreeNodeFromIdxOffset(0, &currentNode);
    positionChanged();
}

void TreeKeyIdx::save ( )

virtual

Reimplemented from TreeKey.

Definition at line 126 of file treekeyidx.cpp.

                      {
    saveTreeNode(&currentNode);
}

void TreeKeyIdx::saveTreeNode ( TreeNode *  node )

private

Definition at line 489 of file treekeyidx.cpp.

                                            {
    long datOffset = 0;
    SW_s32 tmp;
    if (idxfd && idxfd->getFd() >= 0) {

        idxfd->seek(node->offset, SEEK_SET);
        datOffset = datfd->seek(0, SEEK_END);
        tmp = (SW_s32)archtosword32(datOffset);
        idxfd->write(&tmp, 4);

        saveTreeNodeOffsets(node);

        datfd->write(node->name, strlen(node->name));
        char null = 0;
        datfd->write(&null, 1);

        SW_u16 tmp2 = archtosword16(node->dsize);
        datfd->write(&tmp2, 2);

        if (node->dsize) {
            datfd->write(node->userData, node->dsize);
        }
    }
}

void TreeKeyIdx::saveTreeNodeOffsets ( TreeNode *  node )

private

Definition at line 421 of file treekeyidx.cpp.

                                                   {
    unsnappedKeyText = "";
    long datOffset = 0;
    SW_s32 tmp;

    if (idxfd && idxfd->getFd() >= 0) {
        idxfd->seek(node->offset, SEEK_SET);
        if (idxfd->read(&tmp, 4) != 4) {
            datOffset = datfd->seek(0, SEEK_END);
            tmp = (SW_s32)archtosword32(datOffset);
            idxfd->write(&tmp, 4);
        }
        else {
            datOffset = swordtoarch32(tmp);
            datfd->seek(datOffset, SEEK_SET);
        }

        tmp = (SW_s32)archtosword32(node->parent);
        datfd->write(&tmp, 4);

        tmp = (SW_s32)archtosword32(node->next);
        datfd->write(&tmp, 4);

        tmp = (SW_s32)archtosword32(node->firstChild);
        datfd->write(&tmp, 4);
    }
}

virtual void SWKey::setError ( char  err )

inlinevirtualinherited

Definition at line 165 of file swkey.h.

{ error = err; }

virtual void TreeKey::setIndex ( long  iindex )

inlinevirtualinherited

See documentation for Index()

Reimplemented from SWKey.

Definition at line 128 of file treekey.h.

{ setOffset(iindex); }

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

const char * TreeKeyIdx::setLocalName ( const char *  newName )

virtual

Implements TreeKey.

Definition at line 119 of file treekeyidx.cpp.

                                                        {
    unsnappedKeyText = "";
    stdstr(&(currentNode.name), newName);
    return currentNode.name;
}

void TreeKeyIdx::setOffset ( unsigned long  offset )

virtual

Implements TreeKey.

Definition at line 415 of file treekeyidx.cpp.

                                               {
    error = getTreeNodeFromIdxOffset(offset, &currentNode);
    positionChanged();
}

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 TreeKeyIdx::setPosition ( SW_POSITION  p )

virtual

Implements TreeKey.

Definition at line 556 of file treekeyidx.cpp.

                                          {
    switch (p) {
    case POS_TOP:
        root();
        break;
    case POS_BOTTOM:
        error = getTreeNodeFromIdxOffset(idxfd->seek(-4, SEEK_END), &currentNode);
        break;
    } 
    positionChanged();
    popError(); // clear error from normalize
}

void TreeKey::setPositionChangeListener ( PositionChangeListener *  pcl )

inlineinherited

Definition at line 64 of file treekey.h.

{ posChangeListener = pcl; posChangeListener->setTreeKey(this); }

void TreeKeyIdx::setText ( const char *  ikey )

virtual

Sets this SWKey with a character string

Parameters

ikey	string used to set this key

Implements TreeKey.

Definition at line 515 of file treekeyidx.cpp.

                                         {
    char *buf = 0;
    stdstr(&buf, ikey);
    SWBuf leaf = strtok(buf, "/");
    leaf.trim();
    root();
    while ((leaf.size()) && (!popError())) {
        bool ok, inChild = false;
        error = KEYERR_OUTOFBOUNDS;
        for (ok = firstChild(); ok; ok = nextSibling()) {
            inChild = true;
            if (leaf == getLocalName()) {
                error = 0;
                break;
            }
        }
        leaf = strtok(0, "/");
        leaf.trim();
        if (!ok) {
                if (inChild) {  // if we didn't find a matching child node, default to first child
                parent();
                firstChild();
            }
            error = KEYERR_OUTOFBOUNDS;
        }
    }
    if (leaf.size())
        error = KEYERR_OUTOFBOUNDS;
    delete [] buf;
    unsnappedKeyText = ikey;
    positionChanged();
}

void TreeKeyIdx::setUserData ( const char *  userData, int  size = 0  )

virtual

Implements TreeKey.

Definition at line 105 of file treekeyidx.cpp.

                                                           {
    // this makes sure any unsnapped path exists
    assureKeyPath();
    if (currentNode.userData)
        delete currentNode.userData;

    if (!size)
        size = (int)strlen(userData) + 1;

    currentNode.userData = new char [ size ];
    memcpy(currentNode.userData, userData, size);
    currentNode.dsize = size;
}

Member Data Documentation

bool SWKey::boundSet

mutableprotectedinherited

Definition at line 104 of file swkey.h.

class TreeKeyIdx::TreeNode TreeKeyIdx::currentNode

private

FileDesc* TreeKeyIdx::datfd

private

Definition at line 59 of file treekeyidx.h.

char SWKey::error

mutableprotectedinherited

Definition at line 106 of file swkey.h.

FileDesc* TreeKeyIdx::idxfd

private

Definition at line 58 of file treekeyidx.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.

char* TreeKeyIdx::path

private

Definition at line 56 of file treekeyidx.h.

bool SWKey::persist

protectedinherited

Definition at line 105 of file swkey.h.

class TreeKey::PositionChangeListener * TreeKey::posChangeListener

inherited

char* SWKey::rangeText

mutableprotectedinherited

Definition at line 103 of file swkey.h.

SWBuf TreeKey::unsnappedKeyText

mutableprotectedinherited

Definition at line 47 of file treekey.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/treekeyidx.h
• src/keys/treekeyidx.cpp