include/Containers/template/GufieChainedList.hpp

Go to the documentation of this file.

#ifndef h_HPP_GufieChainedList_HPP_h


//
/* - · ·· Constructors / Destructor                ·· · - */
//----------------------------------------------------------
// Default constructor
template <class U, unsigned int pow2>
CGufieChainedList<U, pow2>::CGufieChainedList() : mlNumberOfNodes(0), mlNumberOfBlocks(0), mlBlockSize(ChainedBS), mpxBlock(NULL), mpxFirst(NULL), mpxLast(NULL), mpxCurrent(NULL), mbIntegrity(true), mpxBLast(NULL)
{
    mbUseBlocks = (pow2==0) ? false: true;
}

// Copy constructor
template <class U, unsigned int pow2>
CGufieChainedList<U, pow2>::CGufieChainedList(const CGufieChainedList & copy) 
{
    unsigned int i;
    mbUseBlocks = copy.mbUseBlocks;
    mbIntegrity = copy.mbIntegrity;
    mlBlockSize = copy.mlBlockSize;
    mlNumberOfNodes = copy.mlNumberOfNodes;
    mlNumberOfBlocks = copy.mlNumberOfBlocks;

    if (mbUseBlocks)
    {
        // If copy is empty
        if (copy.mpxBlock == NULL)
        {
            mpxFirst = mpxLast = mpxCurrent = NULL;
            mpxBlock = mpxBLast = NULL;
            return;
        }
        
        // Must copy block contents
        LinearBlock<ChainedBS> * pBlock = new LinearBlock<ChainedBS>;
        LinearBlock<ChainedBS> * copyBlock = copy.mpxBlock;

        if (pBlock == NULL) return;

        // Set first block info
        mpxBlock = pBlock;
        mpxBlock->spxPrevious = NULL;
        mpxBlock->spxNext = NULL;
        mpxBLast = pBlock;
        mpxBlock->soUsed = copy.mpxBlock->soUsed;

        // Create blocks
        for (i=1; i < mlNumberOfBlocks; i++)
        {
            if (!pBlock->CreateNewBlock()) return;
            pBlock->soUsed = copyBlock->soUsed;
            pBlock = pBlock->spxNext;
            copyBlock = copyBlock->spxNext;
            mpxBLast = pBlock;
        }

        // Link nodes
        ChainedNode * pNode = mpxBlock->GetData();

        mpxFirst = pNode;
        mpxFirst->mpxPrevious = NULL;
        mpxCurrent = NULL;
        pBlock = mpxBlock;

        for (i=0; i < mlNumberOfBlocks; i++)
        {
            pNode = pBlock->GetData();
            for (unsigned int j=0; j < ChainedBS; j++)
            {
                pNode->mpxPrevious = mpxCurrent;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                mpxCurrent = pNode;
                pNode ++;
            }
            pBlock = pBlock->spxNext;
        }

        // Fill with datas
        ChainedNode * copyNode = copy.mpxFirst;
        pNode = mpxFirst;

        for (i=0; i < mlNumberOfNodes; i++)
        {
            if ((pNode == NULL)||(copyNode == NULL)) return;
            pNode->Set(copyNode->mpuElement);
            pNode = pNode->mpxNext;
            copyNode = copyNode->mpxNext;
        }


        if (pNode!=NULL) mpxLast = pNode->mpxPrevious; else mpxLast = mpxCurrent;
        mpxCurrent = pNode;
        mpxLast->mpxNext = NULL;
        mbIntegrity = true;
    }
    else
    {
        // Define temporary variables
        ChainedNode * pNode0 = NULL;
        ChainedNode * pNode;
        ChainedNode * pCopy =  copy.mpxFirst;
        for (unsigned int i = 0; i < mlNumberOfNodes; i++)
        {
            pNode = new ChainedNode;
            // Test creation
            if (pNode == NULL) return;
            if (i==0) mpxFirst = pNode;
            pNode->mpxPrevious = pNode0;
            if (pNode->mpxPrevious != NULL) pNode->mpxPrevious->mpxNext = pNode;
            
            // Test data validity
            if (pCopy == NULL) return;
            // And copy it
            pNode->Set(pCopy->mpuElement);
            pCopy = pCopy->mpxNext;
            pNode0 = pNode;
        }

        // That's okay, copy pointers infos
        mpxLast = pNode;
        mpxCurrent = mpxLast;
        mpxBlock = mpxBLast = NULL;

    }
}

// Destructor
template <class U, unsigned int pow2>
CGufieChainedList<U, pow2>::~CGufieChainedList() 
{
    Free();
}



//
/* - · ·· Operators                                ·· · - */
//----------------------------------------------------------
template <class U, unsigned int pow2>
CGufieChainedList<U, pow2>& CGufieChainedList<U, pow2>::operator =(const CGufieChainedList & copy) 
{
    if (&copy == this) return (*this);  // Test a=a

    if (mpxBlock != NULL) 
        if (!mpxBlock->DeleteAll()) return (*this);
    
    unsigned int i;
    if (!mbUseBlocks)
    {
        ChainedNode * pNode = mpxFirst;

        // Must we delete nodes ?;
        if (mpxFirst!=NULL)
        {
            // We must clean node before anything else;
            while (pNode!=NULL)
            {
                mpxFirst = pNode->mpxNext;
                delete pNode;
                pNode = mpxFirst;
            }
        }
    
    }

    mbUseBlocks = copy.mbUseBlocks;
    mbIntegrity = copy.mbIntegrity;
    mlBlockSize = copy.mlBlockSize;
    mlNumberOfNodes = copy.mlNumberOfNodes;
    mlNumberOfBlocks = copy.mlNumberOfBlocks;

    if (mbUseBlocks)
    {
        // If copy is empty
        if (copy.mpxBlock == NULL)
        {
            mpxFirst = mpxLast = mpxCurrent = NULL;
            mpxBlock = mpxBLast = NULL;
            return (*this);
        }
        
        // Must copy block contents
        LinearBlock<ChainedBS> * pBlock = new LinearBlock<ChainedBS>;
        LinearBlock<ChainedBS> * copyBlock = copy.mpxBlock;

        if (pBlock == NULL) return (*this);

        // Set first block info
        mpxBlock = pBlock;
        mpxBlock->spxPrevious = NULL;
        mpxBlock->spxNext = NULL;
        mpxBLast = pBlock;
        mpxBlock->soUsed = copy.mpxBlock->soUsed;

        // Create blocks
        for (i=1; i < mlNumberOfBlocks; i++)
        {
            if (!pBlock->CreateNewBlock()) return (*this);
            pBlock->soUsed = copyBlock->soUsed;
            pBlock = pBlock->spxNext;
            copyBlock = copyBlock->spxNext;
            mpxBLast = pBlock;
        }

        // Link nodes
        ChainedNode * pNode = mpxBlock->GetData();

        mpxFirst = pNode;
        mpxFirst->mpxPrevious = NULL;
        mpxCurrent = NULL;
        pBlock = mpxBlock;

        for (i=0; i < mlNumberOfBlocks; i++)
        {
            pNode = pBlock->GetData();
            for (unsigned int j=0; j < ChainedBS; j++)
            {
                pNode->mpxPrevious = mpxCurrent;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                mpxCurrent = pNode;
                pNode ++;
            }
            pBlock = pBlock->spxNext;
        }

        // Fill with datas
        ChainedNode * copyNode = copy.mpxFirst;
        pNode = mpxFirst;

        for (i=0; i < mlNumberOfNodes; i++)
        {
            if ((pNode == NULL)||(copyNode == NULL)) return (*this);
            // Copy the Node element
            pNode->Set(copyNode->Get());
            pNode = pNode->mpxNext;
            copyNode = copyNode->mpxNext;
        }


        if (pNode!=NULL) mpxLast = pNode->mpxPrevious; else mpxLast = mpxCurrent;
        mpxCurrent = pNode;
        mpxLast->mpxNext = NULL;
        mbIntegrity = true;
    }
    else
    {
        ChainedNode * pNode = NULL;
        
        // Define temporary variables
        ChainedNode * pNode0 = NULL;
        ChainedNode * pCopy =  copy.mpxFirst;
        for (unsigned int i = 0; i < mlNumberOfNodes; i++)
        {
            pNode = new ChainedNode;
            // Test creation
            if (pNode == NULL) return (*this);
            if (i==0) mpxFirst = pNode;
            pNode->mpxPrevious = pNode0;
            if (pNode->mpxPrevious != NULL) pNode->mpxPrevious->mpxNext = pNode;
            
            // Test data validity
            if (pCopy == NULL) return (*this);
            // And copy it
            pNode->Set(pCopy->Get());
            pCopy = pCopy->mpxNext;
            pNode0 = pNode;
        }

        // That's okay, copy pointers infos
        mpxLast = pNode;
        mpxCurrent = mpxLast;
        mpxBlock = mpxBLast = NULL;

    }

    return (*this);
}



//
/* - · ·· Functions                                ·· · - */
//----------------------------------------------------------
template <class T, unsigned int pow2>
bool CGufieChainedList<T, pow2>::Connect(ChainedNode *pNode, ChainedNode *pP, ChainedNode *pN)
{

    if (pNode == NULL) return false;
    if ((pP==NULL)&&(pN==NULL)&&(pNode->mpuElement!=NULL)&&((pNode->mpxPrevious!=NULL)||(pNode->mpxNext!=NULL)))
    {
        // Warning connection will be lost...
        pNode->mpxPrevious = pP;
        pNode->mpxNext = pN;
        return false;
    }
    
    pNode->mpxPrevious = pP;
    pNode->mpxNext = pN;

    return true;
}

template <class U, unsigned int pow2>
unsigned int CGufieChainedList<U, pow2>::Find(const U & arg)
{
    if (mpxFirst==NULL) return ChainedEnd;

    unsigned int i=0;
    ChainedNode * pNode = mpxFirst;
    while ((i<mlNumberOfNodes)&&(pNode!=NULL))
    {
#ifdef UseOperatorEqual
        if (pNode->Get() == arg) return i;
#else
        if (memcmp(&pNode->Get(), &arg, sizeof(arg)) == 0) return i; 
#endif
        i++;
        pNode = pNode->mpxNext;
    }

    return ChainedEnd;
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::UseBlocks(const bool & arg)
{
    if (mpxBlock != NULL) return false;
    
    if (arg)
    {   
        mbUseBlocks = true;
        return true;
    } 
    else
    {   
        mbUseBlocks = false;
        return true;
    } 

    return true;
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Add(const CGufieChainedList& copy, const unsigned int &pos) 
{
    if ((copy.mpxFirst==NULL)||(copy.mpxLast==NULL)) return false;
    
    if (pos >= mlNumberOfNodes-1)
    {
        // Want to add in the end...
        if (mbUseBlocks)
        {
            // Define temporary variables
            ChainedNode * pNode = NULL;
            ChainedNode * pNode0 = mpxLast;
            ChainedNode * pCopy =  copy.mpxFirst;

            for (unsigned int i=0; i < copy.mlNumberOfNodes; i++)
            {
                pNode = CreateNode();
                if (pNode == NULL) return false;
                
                if (mpxFirst == NULL) mpxFirst = pNode;
                pNode->mpxPrevious = pNode0;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                
                if (pCopy == NULL) return false;
                pNode->Set(pCopy->mpuElement);
                pCopy = pCopy->mpxNext;
                pNode0 = pNode;
            }

            mlNumberOfNodes += copy.mlNumberOfNodes;
            mpxLast = pNode;
            mpxLast->mpxNext = NULL;

            return true;
            
        }
        else
        {
        
            // Define temporary variables
            ChainedNode * pNode = NULL;
            ChainedNode * pNode0 = mpxLast;
            ChainedNode * pCopy =  copy.mpxFirst;

            for (unsigned int i=0; i < copy.mlNumberOfNodes; i++)
            {
                pNode = new ChainedNode;
                if (pNode == NULL) return false;
                
                pNode->mpxPrevious = pNode0;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                
                if (pCopy == NULL) return false;
                pNode->Set(pCopy->mpuElement);
                pCopy = pCopy->mpxNext;
                pNode0 = pNode;
            }

            mlNumberOfNodes += copy.mlNumberOfNodes;
            mpxLast = pNode;
            mpxCurrent = mpxLast;
            mpxLast->mpxNext = NULL;

            return true;
        }
    }
    else
    {
        if (mbUseBlocks)
        {
            unsigned int i;
            ChainedNode * pNode = NULL;
            ChainedNode * pLast = mpxLast;
            
            // We must probably create blocks, so let's do it...
            for (i=0; i < copy.mlNumberOfNodes; i++)
            {
                pNode = CreateNode();
                if (pNode == NULL) return false;
                
                pNode->mpxPrevious = pLast;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                
                pLast = pNode;
            }
            
            mlNumberOfNodes += copy.mlNumberOfNodes;

            // Now fill new nodes with previous datas
            ChainedNode * pInsert = pNode; 
            if (pInsert == NULL) return false;
            ChainedNode * pFirst = Goto(pos);
            if (pFirst == NULL) return false;

            pNode = mpxLast;
            mpxLast = pInsert;
            mpxLast->mpxNext = NULL;

            for (i=pos + copy.mlNumberOfNodes; i < mlNumberOfNodes; i++)
            {
                if ((pInsert==NULL)||(pNode ==  NULL)) return false;
                pInsert->Set(pNode->mpuElement);
                
                pInsert = pInsert->mpxPrevious;
                pNode = pNode->mpxPrevious;
            }

            // Let's then copy the insertion 
            pInsert = pFirst;
            pNode = copy.mpxFirst;
            for (i = 0; i < copy.mlNumberOfNodes; i++)
            {
                if ((pInsert==NULL)||(pNode ==  NULL)) return false;
                pInsert->Set(pNode->mpuElement);
                
                pInsert = pInsert->mpxNext;
                pNode = pNode->mpxNext;
            }

            // Okay, finish..
            return true;

        }   
        else
        {
            // Define temporary variables
            ChainedNode * pNode = NULL;
            ChainedNode * pFirst = Goto(pos);
            if (pFirst == NULL) return false;
            ChainedNode * pNode0 = pFirst->mpxPrevious;
            ChainedNode * pCopy =  copy.mpxFirst;

            for (unsigned int i=0; i < copy.mlNumberOfNodes; i++)
            {
                pNode = new ChainedNode;
                if (pNode == NULL) return false;
                
                pNode->mpxPrevious = pNode0;
                if ((i==0)&&(pos==0)) mpxFirst = pNode;
                if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                
                if (pCopy == NULL) return false;
                pNode->Set(pCopy->mpuElement);
                pCopy = pCopy->mpxNext;
                pNode0 = pNode;
            }
    
            mlNumberOfNodes += copy.mlNumberOfNodes;
            pNode->mpxNext = pFirst;
            pFirst->mpxPrevious = pNode;

            return true;
        }
    }

}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Add(const U& a, const unsigned int& pos) 
{
    if (pos >= mlNumberOfNodes)
    {
        // Add to end of list
        if (mbUseBlocks)
        {
            
            ChainedNode * pNode = CreateNode();
            if (pNode == NULL) return false;
            
            pNode->Set(a);
            if (mpxBlock==NULL) return false;
            mpxBLast->soUsed ++;  
            
            // Then test if it is the first node
            if (mlNumberOfNodes==0)
            {
                mpxFirst = pNode;
                pNode->mpxNext = NULL;
                pNode->mpxPrevious = NULL;
                mpxLast = mpxFirst;
                mlNumberOfNodes++;
            }
            else
            {
                mlNumberOfNodes++;
                mpxLast->mpxNext = pNode;
                pNode->mpxPrevious = mpxLast;
                pNode->mpxNext = NULL;
                mpxLast = pNode;
            }
            
            // Okay it's right so let's finish
            return true;
        }
        else
        {
            if (mpxFirst==NULL)
            {
                // List not existing, creating it
                mpxFirst = new ChainedNode(a);
                
                // Check creation
                if (mpxFirst == NULL) return false;

                // Connect pointers
                if (!Connect(mpxFirst,NULL,NULL)) return false;
                
                // Set other pointers
                mpxLast = mpxFirst;
                mpxCurrent = mpxFirst;
                
                // Increase number of nodes
                mlNumberOfNodes = 1;
                
                // Okay return 
                return true;
            }
            else
            {
                // List existing, adding node
                mpxCurrent = new ChainedNode(a);
            
                // Check creation
                if (mpxCurrent == NULL) return false;

                // Connect pointers
                if (!Connect(mpxCurrent,mpxLast,NULL)) return false;
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;

                // Increase number of nodes
                mlNumberOfNodes ++;
                
                // Okay return 
                return true;
            
            }
        }
    }
    else
    {
        // Insertion mode 

        // Do we use blocks ?
        if (mbUseBlocks)
        {
            // Must find the position to insert link
            ChainedNode *   pNode;
            // Test if a block exist, else call the same function
            // with correct argument
            if (mpxBlock==NULL)
            {
                if (pos == 0) return Add(a); else return false;
            }
            
            LinearBlock<ChainedBS> * pBlock = mpxBLast;
            // Inserting at the beginning
            if (pBlock->soUsed < ChainedBS)
            {
                // We have the place to store this pointer
                // so, go to the last element (mpxCurrent)
                if (mpxCurrent == NULL) return false;
                
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;
                mpxCurrent = mpxCurrent->mpxNext;
                mpxLast->mpxNext = NULL; 
                pNode = mpxLast;
                

                for (unsigned int i=pos; i < mlNumberOfNodes; i++)
                {
                    if (pNode->mpxPrevious !=NULL)
                    {
                        pNode->Set(pNode->mpxPrevious->mpuElement);
                        pNode = pNode->mpxPrevious;
                    }
                    
                
                }

                // Okay, set first pointer data
                pNode->Set(a);
                
                pBlock->soUsed++;
                mlNumberOfNodes ++;
                return true;
            }
            else
            {
                unsigned int i;
                // Must create a new block...
                if (!pBlock->CreateNewBlock()) return false;
                
                pBlock = pBlock->spxNext;
                mpxBLast = pBlock;

                // Attach pNode with beginning of datas
                pNode = pBlock->GetData();
                // The powerful thing is here, go from pointer by adding
                // Then link list, in reverse order
                mpxCurrent = mpxLast;
                for (i = 0; i < ChainedBS; i++, pNode++)
                {
                    pNode->mpxPrevious = mpxCurrent;
                    // the following line is not really needed, because after we are only going from 
                    // left to right... But, in case of a block disallocating, might 
                    // create a error... So, let this line enabled
                    if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                    mpxCurrent = pNode;
                }
            
                mlNumberOfBlocks ++;
                mpxCurrent -= ChainedBS - 1;

                // We have the place to store this pointer
                // so, go to the last element (mpxCurrent)
                if (mpxCurrent == NULL) return false;
                
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;
                mpxCurrent = mpxCurrent->mpxNext;
                mpxLast->mpxNext = NULL;
                pNode = mpxLast;
                

                for (i=pos; i < mlNumberOfNodes; i++)
                {
                    if (pNode->mpxPrevious !=NULL)
                    {
                        pNode->Set(pNode->mpxPrevious->mpuElement);
                        pNode = pNode->mpxPrevious;
                    }
                    
                
                }

                // Okay, set first pointer data
                pNode->Set(a);
                
                pBlock->soUsed++;
                mlNumberOfNodes ++;
                return true;

            }
                
        }
        else
        {
            // List existing, adding node
            ChainedNode * pNode = new ChainedNode(a);
            
            // Seeking list
            if (pos!=0) 
            {
                mpxCurrent = Goto(pos-1);
                if (mpxCurrent == NULL) return false;
                // Enable connections
                Connect(pNode, mpxCurrent, mpxCurrent->mpxNext);
                mpxCurrent->mpxNext = pNode;
                if (pNode->mpxNext!=NULL) pNode->mpxNext->mpxPrevious = pNode;

                // Increase number of nodes
                mlNumberOfNodes ++;
                
            } else
            {
                // Enable connections
                Connect(pNode, NULL, mpxFirst);
                mpxFirst->mpxPrevious = pNode;
                mpxFirst = pNode;
                
                // Increase number of nodes
                mlNumberOfNodes ++;
                
            
            }
            

        }
        return true;    
    }
    
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Add(U* a, const unsigned int& pos) 
{
    if (pos >= mlNumberOfNodes)
    {
        // Add to end of list
        if (mbUseBlocks)
        {
            
            ChainedNode * pNode = CreateNode();
            if (pNode == NULL) return false;
            
            pNode->Set(a);
            if (mpxBlock==NULL) return false;
            mpxBLast->soUsed ++;  
            
            // Then test if it is the first node
            if (mlNumberOfNodes==0)
            {
                mpxFirst = pNode;
                pNode->mpxNext = NULL;
                pNode->mpxPrevious = NULL;
                mpxLast = mpxFirst;
                mlNumberOfNodes++;
            }
            else
            {
                mlNumberOfNodes++;
                mpxLast->mpxNext = pNode;
                pNode->mpxPrevious = mpxLast;
                pNode->mpxNext = NULL;
                mpxLast = pNode;
            }
            
            // Okay it's right so let's finish
            return true;
        }
        else
        {
            if (mpxFirst==NULL)
            {
                // List not existing, creating it
                mpxFirst = new ChainedNode(a);
                
                // Check creation
                if (mpxFirst == NULL) return false;

                // Connect pointers
                if (!Connect(mpxFirst,NULL,NULL)) return false;
                
                // Set other pointers
                mpxLast = mpxFirst;
                mpxCurrent = mpxFirst;
                
                // Increase number of nodes
                mlNumberOfNodes = 1;
                
                // Okay return 
                return true;
            }
            else
            {
                // List existing, adding node
                mpxCurrent = new ChainedNode(a);
            
                // Check creation
                if (mpxCurrent == NULL) return false;

                // Connect pointers
                if (!Connect(mpxCurrent,mpxLast,NULL)) return false;
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;

                // Increase number of nodes
                mlNumberOfNodes ++;
                
                // Okay return 
                return true;
            
            }
        }
    }
    else
    {
        // Insertion mode 

        // Do we use blocks ?
        if (mbUseBlocks)
        {
            // Must find the position to insert link
            ChainedNode *   pNode;
            // Test if a block exist, else call the same function
            // with correct argument
            if (mpxBlock==NULL)
            {
                if (pos == 0) return Add(a); else return false;
            }
            
            LinearBlock<ChainedBS> * pBlock = mpxBLast;
            // Inserting at the beginning
            if (pBlock->soUsed < ChainedBS)
            {
                // We have the place to store this pointer
                // so, go to the last element (mpxCurrent)
                if (mpxCurrent == NULL) return false;
                
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;
                mpxCurrent = mpxCurrent->mpxNext;
                mpxLast->mpxNext = NULL; 
                pNode = mpxLast;
                

                for (unsigned int i=pos; i < mlNumberOfNodes; i++)
                {
                    if (pNode->mpxPrevious !=NULL)
                    {
                        pNode->Set(pNode->mpxPrevious->mpuElement);
                        pNode = pNode->mpxPrevious;
                    }
                    
                
                }

                // Okay, set first pointer data
                pNode->Set(a);
                
                pBlock->soUsed++;
                mlNumberOfNodes ++;
                return true;
            }
            else
            {
                unsigned int i;
                // Must create a new block...
                if (!pBlock->CreateNewBlock()) return false;
                
                pBlock = pBlock->spxNext;
                mpxBLast = pBlock;

                // Attach pNode with beginning of datas
                pNode = pBlock->GetData();
                // The powerful thing is here, go from pointer by adding
                // Then link list, in reverse order
                mpxCurrent = mpxLast;
                for (i = 0; i < ChainedBS; i++, pNode++)
                {
                    pNode->mpxPrevious = mpxCurrent;
                    // the following line is not really needed, because after we are only going from 
                    // left to right... But, in case of a block disallocating, might 
                    // create a error... So, let this line enabled
                    if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
                    mpxCurrent = pNode;
                }
            
                mlNumberOfBlocks ++;
                mpxCurrent -= ChainedBS - 1;

                // We have the place to store this pointer
                // so, go to the last element (mpxCurrent)
                if (mpxCurrent == NULL) return false;
                
                mpxLast->mpxNext = mpxCurrent;
                mpxLast = mpxCurrent;
                mpxCurrent = mpxCurrent->mpxNext;
                mpxLast->mpxNext = NULL;
                pNode = mpxLast;
                

                for (i=pos; i < mlNumberOfNodes; i++)
                {
                    if (pNode->mpxPrevious !=NULL)
                    {
                        pNode->Set(pNode->mpxPrevious->mpuElement);
                        pNode = pNode->mpxPrevious;
                    }
                    
                
                }

                // Okay, set first pointer data
                pNode->Set(a);
                
                pBlock->soUsed++;
                mlNumberOfNodes ++;
                return true;

            }
                
        }
        else
        {
            // List existing, adding node
            ChainedNode * pNode = new ChainedNode(a);
            
            // Seeking list
            if (pos!=0) 
            {
                mpxCurrent = Goto(pos-1);
                if (mpxCurrent == NULL) return false;
                // Enable connections
                Connect(pNode, mpxCurrent, mpxCurrent->mpxNext);
                mpxCurrent->mpxNext = pNode;
                if (pNode->mpxNext!=NULL) pNode->mpxNext->mpxPrevious = pNode;

                // Increase number of nodes
                mlNumberOfNodes ++;
                
            } else
            {
                // Enable connections
                Connect(pNode, NULL, mpxFirst);
                mpxFirst->mpxPrevious = pNode;
                mpxFirst = pNode;
                
                // Increase number of nodes
                mlNumberOfNodes ++;
                
            
            }
            

        }
        return true;    
    }
    
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Sub(const unsigned int& pos)
{
    if (pos >= mlNumberOfNodes-1)
    {
        // Remove last node
        if (mbUseBlocks)
        {
            // Check if list exist
            if ((mpxLast == NULL)||(mpxBlock == NULL)) return false;

            LinearBlock<ChainedBS> *        pBlock = mpxBLast;
            ChainedNode * pNode = mpxLast->mpxPrevious;

            if (pNode==NULL) 
            {
                // We have to clear the list...
                if (!mpxBlock->DeleteAll()) return false;
                mpxBlock = NULL;
                mpxBLast = NULL;
                mlNumberOfNodes = 0;
                mlNumberOfBlocks = 0;
                mbUseBlocks = true;
                mbIntegrity = true;
                mpxCurrent = mpxFirst = mpxLast = NULL;
                return true;
            }

            if (pBlock->soUsed == 1)
            {
                // This block will be empty after deletion, so delete it
                pNode->mpxNext = NULL;
                mpxLast = pNode;
                mpxCurrent = NULL;
                pBlock->soUsed = 0;
                mlNumberOfNodes --;
                mlNumberOfBlocks --;
                mpxBLast = pBlock->spxPrevious;
                pBlock->Delete();
                
                return true;
            } 
            
            // Okay block is al least filled with 2 pointers, can destroy the last one
            pNode->mpxNext = NULL;
            mpxLast->mpxNext = mpxCurrent;
            mpxCurrent = mpxLast;
            mpxLast = pNode;

            mlNumberOfNodes --;
            pBlock->soUsed --;

            return true;


        }
        else
        {
            if (mpxLast == NULL) return false;
            ChainedNode * pNode = mpxLast->mpxPrevious;
            
            if (pNode == NULL) 
            {
                // Only one node in list, delete list
                delete mpxLast;
                mpxLast = mpxFirst = mpxCurrent = NULL;
                mlNumberOfNodes = 0;
                return true;
            }
            
            pNode->mpxNext = NULL;
            delete mpxLast;
            mpxLast = pNode;
            mpxCurrent = mpxLast;
            mlNumberOfNodes --;

            return true;
        }
    }
    else
    {
        // Remove a node
        if (mbUseBlocks)
        {
            // Check if list exist
            if ((mpxLast == NULL)||(mpxBlock == NULL)) return false;

            LinearBlock<ChainedBS> *        pBlock = mpxBLast;
            ChainedNode * pNode = Goto(pos);
            // Does this node exist ?
            if ((pNode == NULL)||(pBlock==NULL)) return false;

            if (pBlock->soUsed == 1) 
            {
                // We have to clear a block
                for (unsigned int i = pos+1; i < mlNumberOfNodes; i++)
                {
                    if (pNode->mpxNext == NULL) return false;
                    pNode->Set(pNode->mpxNext->mpuElement);
                    pNode = pNode->mpxNext;
                }
                
                // Set beginning of free tab
                mpxCurrent = NULL;
                // And decrease list size
                mpxLast = mpxLast->mpxPrevious;
                mpxLast->mpxNext = NULL;
                // Delete last block
                pBlock->soUsed = 0;
                mpxBLast = pBlock->spxPrevious;
                pBlock->Delete();

                mlNumberOfNodes --;
                mlNumberOfBlocks --;
                
                return true;
            }
            
            // We have to traverse list
            for (unsigned int i = pos+1; i < mlNumberOfNodes; i++)
            {
                if (pNode->mpxNext == NULL) return false;
                pNode->Set(pNode->mpxNext->mpuElement);
                pNode = pNode->mpxNext;
            }
            
            // Restore free tab consistency
            mpxLast->mpxNext = mpxCurrent;
            // Set beginning of free tab
            mpxCurrent = mpxLast;           
            // And decrease list size
            mpxLast = mpxLast->mpxPrevious;
            mpxLast->mpxNext = NULL;
            // Delete last block
            pBlock->soUsed --;

            mlNumberOfNodes --;
                
            return true;
            

        }
        else
        {
            // Get the node pointer we want to detroy, and test it
            ChainedNode * pNode = Goto(pos);
            if (pNode == NULL) return false;
            
            // Make connections
            if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode->mpxNext;
            if (pNode->mpxNext!=NULL) pNode->mpxNext->mpxPrevious = pNode->mpxPrevious;
            
            
            if (pNode == mpxFirst) mpxFirst = pNode->mpxNext;
            // this case shouldn't occur, but...
            if (pNode == mpxLast) mpxLast = pNode->mpxPrevious;
            
            // Delete node
            delete pNode;
            mlNumberOfNodes --;

            return true;
        }
    
    }
    
    // return false; // Unreachable
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Insert(U& a, const unsigned int& pos) 
{
    if (pos>= mlNumberOfNodes) return Add(a); // Add the node to last position
    
    ChainedNode * pNode;
    if (mbUseBlocks)
    {
        // Create a node in the block
        pNode = CreateNode();

        // Set integrity to false (pNode->mpxNext != pNode++)
        mbIntegrity = false;
    }
    else
    {
        pNode = new ChainedNode(a);
    }

    if (pNode == NULL) return false;
    // Set element
    pNode->Set(a);
    
    // Make connections
    pNode->mpxNext = Goto(pos); 
    if (pNode->mpxNext==NULL) return false;

    pNode->mpxPrevious = pNode->mpxNext->mpxPrevious;
    if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
    pNode->mpxNext->mpxPrevious = pNode;

    return true;
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Swap(const unsigned int& pos0, const unsigned int& pos1) 
{
    if ((pos0>= mlNumberOfNodes)||(pos1>= mlNumberOfNodes)) return false; 
    
    // Get node pointers
    ChainedNode * pNode0 = Goto(pos0);
    ChainedNode * pNode1 = Goto(pos1);
    // And test them
    if ((pNode0==NULL)||(pNode1==NULL)) return false;

    if (mbUseBlocks)
    {
        // Here we must change contents
        // (in real linked list, it's only pointers that are 
        // exchanged, but this system preserve integrity
        U * a = pNode1->mpuElement;
        pNode1->Set(pNode0->mpuElement);
        pNode0->Set(a);

        return true;
    }
    else
    {
        if ((pNode0->mpxNext == pNode1)||(pNode0->mpxPrevious == pNode1))
        {
            // this nodes are linked...
            if (pNode0->mpxNext == pNode1)
            {
                // Is 1 after 0 ?
                if (pNode0->mpxPrevious!=NULL) pNode0->mpxPrevious->mpxNext = pNode1;               
                if (pNode1->mpxNext!=NULL) pNode1->mpxNext->mpxPrevious = pNode0;               
                
                pNode0->mpxNext = pNode1->mpxNext;
                pNode1->mpxPrevious = pNode0->mpxPrevious;
                pNode0->mpxPrevious = pNode1;
                pNode1->mpxNext = pNode0;
            } else
            {
                // Is 0 after 1 ?
                if (pNode1->mpxPrevious!=NULL) pNode1->mpxPrevious->mpxNext = pNode0;               
                if (pNode0->mpxNext!=NULL) pNode0->mpxNext->mpxPrevious = pNode1;               
                
                pNode1->mpxNext = pNode0->mpxNext;
                pNode0->mpxPrevious = pNode1->mpxPrevious;
                pNode1->mpxPrevious = pNode0;
                pNode0->mpxNext = pNode1;
            }
        
            return true;
        }
        
        
        ChainedNode * pNodeTemp0 = pNode0->mpxPrevious;
        ChainedNode * pNodeTemp1 = pNode0->mpxNext;

        if (pNode0->mpxPrevious!=NULL)  pNode0->mpxPrevious->mpxNext = pNode1;
        if (pNode0->mpxNext!=NULL)      pNode0->mpxNext->mpxPrevious = pNode1;
        if (pNode1->mpxPrevious!=NULL)  pNode1->mpxPrevious->mpxNext = pNode0;
        if (pNode1->mpxNext!=NULL)      pNode1->mpxNext->mpxPrevious = pNode0;

        pNode0->mpxPrevious = pNode1->mpxPrevious;
        pNode0->mpxNext = pNode1->mpxNext;

        pNode1->mpxPrevious = pNodeTemp0;
        pNode1->mpxNext = pNodeTemp1;

        return true;
    }

    // return false; // Unreachable
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Remove(const unsigned int& pos) 
{
    if (pos>= mlNumberOfNodes) return false; 
    
    // Get node pointer
    ChainedNode * pNode = Goto(pos);
    if (pNode == NULL) return false;

    if (mbUseBlocks)
    {

        if (pNode==mpxLast) 
        {
            LinearBlock<ChainedBS> * pBlock = mpxBLast;
            if (pBlock == NULL) return false;
            if (pBlock->soUsed == 1)
            {
                // must destroy a block
                pNode = mpxLast->mpxPrevious;
                if (pNode != NULL) pNode->mpxNext = NULL;
                mpxLast = pNode;
                mpxCurrent = NULL;


                pBlock->soUsed = 0;
                mlNumberOfNodes --;
                mlNumberOfBlocks --;
                mpxBLast = pBlock->spxPrevious;
                pBlock->Delete();

                if (!mlNumberOfBlocks) mpxBlock = NULL;
                if (!mlNumberOfNodes)  mpxFirst = NULL;

                return true;

            }
            else
            {
                mpxLast->mpxNext = mpxCurrent;
                mpxCurrent = mpxLast;
                mpxLast = mpxLast->mpxPrevious;
                mpxLast->mpxNext= NULL;

                mlNumberOfNodes --;
                pBlock->soUsed --;
                return true;
            }
        
        }
        
        // Find block that contains that node
        LinearBlock<ChainedBS> * pBlock = mpxBlock->Find(pNode);
        if (pBlock == NULL) return false;
        pBlock->soUsed --;
        // Set integrity to false (pNode->mpxNext != pNode++)
        mbIntegrity = false;
        
    }
    else
    {
    }

    // Make connections
    if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode->mpxNext;
    if (pNode->mpxNext!=NULL) pNode->mpxNext->mpxPrevious = pNode->mpxPrevious;
    
    
    if (pNode == mpxFirst) mpxFirst = pNode->mpxNext;
    // this case shouldn't occur, but...
    if (pNode == mpxLast) mpxLast = pNode->mpxPrevious;
    
    // Delete node
    if (!mbUseBlocks) delete pNode;
    mlNumberOfNodes --;

    return true;
}

template <class U, unsigned int pow2>
typename CGufieChainedList<U, pow2>::ChainedNode* CGufieChainedList<U, pow2>::CreateNode() 
{
    if (mpxCurrent == NULL)
    {
        
        // Here no block is available, so create a new block
        LinearBlock<ChainedBS> * pBlock;
        if (mpxBlock == NULL) 
        {
            mpxBlock = new LinearBlock<ChainedBS>;
            if (mpxBlock==NULL) return NULL;
            mpxBLast = mpxBlock;
            pBlock = mpxBlock;
        }
        else 
        {
            // Check if used reach the needed point...
            if (mpxBlock->soUsed < ChainedBS) 
            {
                // If a node (not the last one) has been deleted within this block 
                // Can find it, and return it, instead...
                
                ChainedNode * pNode = mpxBlock->GetData();
                for (unsigned int i = 0; i < ChainedBS; i++)
                {
                    if (pNode == NULL) return NULL;
                    if (pNode->mpxNext !=  (pNode+1))
                    {
                        // pNode+1 is the free node
                        return (pNode+1);
                    }

                    pNode ++;
                }
                return NULL;
            }
            
            pBlock = mpxBLast;
            if (pBlock->CreateNewBlock()!=true) return NULL;
            pBlock = pBlock->spxNext;
            mpxBLast = pBlock;
        }
        
        // Now, pBlock contains a new free block
        // Fill it with free pointers
        ChainedNode * pNode = (ChainedNode*) pBlock->GetData();
        
        // The powerful thing is here, go from pointer by adding
        // Then link list, in reverse order
        for (unsigned int i = 0; i < ChainedBS; i++, pNode++)
        {
            pNode->mpxPrevious = mpxCurrent;
            // the following line is not really needed, because after we are only going from 
            // left to right... But, in case of a block disallocating, might 
            // create a error... So, let this line enabled
            if (pNode->mpxPrevious!=NULL) pNode->mpxPrevious->mpxNext = pNode;
            mpxCurrent = pNode;
        }
    
        mpxCurrent -= ChainedBS - 1; 
        //if (mpxCurrent->mpxNext!=NULL)    mpxCurrent->mpxNext->mpxPrevious = mpxCurrent;

        mlNumberOfBlocks ++;

        mpxCurrent = mpxCurrent->mpxNext;
        return mpxCurrent->mpxPrevious;

    }
    
    if (mpxCurrent==NULL) return NULL;
    
    // Check if someone parsed the list
    if (mpxCurrent->mpxPrevious == NULL || mpxCurrent->mpxPrevious->mpxNext == mpxCurrent || mpxCurrent->mpxNext == NULL) 
    {
        // Not the last one
        if (mpxBLast != NULL && mpxBLast->soUsed < ChainedBS)
        {
            // Need to find the first free node
            ChainedNode * pNode = mpxBLast->GetData();
            for (unsigned int i = 0; i < ChainedBS; i++)
            {
                if (pNode == NULL) return NULL;
                if (pNode->mpxNext !=  (pNode+1))
                {
                    // pNode+1 is the free node

                    // Need to check if pNode+1 is outside the block
                    if ((pNode+1) > (mpxBLast->GetData() + ChainedBS))
                    {
                        // pNode + 1 is outside this block, need to create a new block
                        mpxCurrent = NULL;
                        return CreateNode();
                    }
                    else
                    // Now need to set back mpxCurrent correctly
                    {
                        mpxCurrent = (pNode + 1)->mpxNext;
                    }

                    return (pNode+1);
                }
                pNode ++;
            }
        } 
        // Get the next available pointer, in the next block that need to be created
        else
        {
            mpxCurrent = NULL;
            return CreateNode();
        }
    }
    
    mpxCurrent = mpxCurrent->mpxNext;
    
    return mpxCurrent->mpxPrevious;
}



template <class U, unsigned int pow2>
typename CGufieChainedList<U, pow2>::ChainedNode* CGufieChainedList<U, pow2>::Goto(const unsigned int& pos) 
{
    if (mpxFirst == NULL) return NULL;

    ChainedNode* pT;
    if ((mbUseBlocks)&&(mbIntegrity))
    {
        if (mpxBlock==NULL) return NULL;
    
        unsigned int distinblock = (pos>>pow2);
        LinearBlock<ChainedBS> *pBlock = mpxBlock;


        for (unsigned int i = 0; i < distinblock; i++)
        {
            if (pBlock==NULL) return NULL;
            pBlock = pBlock->spxNext;
        }

        pT = pBlock->GetData();
        pT += pos - (distinblock<<pow2);

    }
    else
    {
        if (pos <= (mlNumberOfNodes>>1))
        {
            // It's quicklier to reach pos starting by the beginning
            pT = mpxFirst;
            
            for (unsigned int i=0; i<pos; i++)
            {
                if (pT==NULL) return NULL;
                pT = pT->mpxNext;
            }
        } else
        {
            // It's quicklier to reach pos starting by the end
            pT = mpxLast;
            
            for (unsigned int i=pos+1; i < mlNumberOfNodes; i++)
            {
                if (pT==NULL) return NULL;
                pT = pT->mpxPrevious;
            }
        
        }
    }
    return pT;
}

template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Change(U & a, const unsigned int & pos) 
{
    if (mpxFirst == NULL) return false;

    if (pos > mlNumberOfNodes) return false;
    // Can add if last pos is selected...
    if (pos == mlNumberOfNodes) Add(a);

    ChainedNode* pT = Goto(pos);
    if (pT == NULL) return false;

#ifdef ChainedEqual
    pT->Get() = a;
#else
    if (pT->mpuElement != NULL)
        delete pT->mpuElement;

    pT->Set(a);
#endif

    return true;
    
}


template <class U, unsigned int pow2>
bool CGufieChainedList<U, pow2>::Free() 
{
    if (mpxFirst == NULL) return false;

    if (mbUseBlocks)
    {
        if (mpxBlock == NULL) return false;
        
        mpxBlock->DeleteAll();
        mpxBlock = NULL;
        mpxFirst = mpxLast = mpxCurrent = NULL;
        mlNumberOfNodes = 0;
        mlNumberOfBlocks = 0;
        mbIntegrity = true;
        mbUseBlocks = true;
    
    }
    else
    {
        mpxCurrent = mpxFirst;
        for (unsigned int i=0; i < mlNumberOfNodes; i++)
        {
            mpxLast = mpxCurrent->mpxNext;

            delete mpxCurrent;

            mpxCurrent = mpxLast;
            if (mpxCurrent == NULL) return false;
        }

        mpxFirst = mpxLast = mpxCurrent = NULL;
        mlNumberOfNodes = 0;
        mbIntegrity = true;
    
    }
    
    
    return true;
}

template <class U, unsigned int pow2>
U* CGufieChainedList<U, pow2>::ParseList(const bool & bInit) 
{
    if (mpxFirst == NULL) return NULL;

    if (bInit) { mpxCurrent = mpxFirst; return mpxCurrent->mpuElement; }
    else if (mpxCurrent!=mpxLast)      { mpxCurrent = mpxCurrent->mpxNext; return mpxCurrent->mpuElement; }
    else return NULL;
    
    
    // return NULL; // Unreachable
}

template <class U, unsigned int pow2>
U* CGufieChainedList<U, pow2>::ParseListStart(const unsigned int & uiPos) 
{
    if (uiPos != ChainedEnd)  { mpxCurrent = Goto(uiPos); if (mpxCurrent!=NULL) return mpxCurrent->mpuElement; else return NULL; }
    else if (mpxCurrent!=NULL)     { mpxCurrent = mpxCurrent->mpxNext; return mpxCurrent->mpuElement; }
    else return NULL;
    
    
    // return NULL; // Unreachable
}

template <class U, unsigned int pow2>
U* CGufieChainedList<U, pow2>::ReverseParseList(const bool & bInit) 
{
    if (mpxLast == NULL) return NULL;

    if (bInit) { mpxCurrent = mpxLast; return mpxCurrent->mpuElement; }
    else if (mpxCurrent!=mpxFirst)     { mpxCurrent = mpxCurrent->mpxPrevious; return mpxCurrent->mpuElement; }
    else return NULL;
    
    
    // return NULL; // Unreachable
}

template <class U, unsigned int pow2>
U* CGufieChainedList<U, pow2>::ReverseParseListStart(const unsigned int & uiPos) 
{
    if (uiPos != ChainedEnd)  { mpxCurrent = Goto(uiPos); if (mpxCurrent!=NULL) return mpxCurrent->mpuElement; else return NULL; }
    else if (mpxCurrent!=NULL)     { mpxCurrent = mpxCurrent->mpxPrevious; return mpxCurrent->mpuElement; }
    else return NULL;
    
    
    // return NULL; // Unreachable
}





#define h_HPP_GufieChainedList_HPP_h
#endif

(C) An X-Ryl669 project 2007

This document describes Unlimited Zooming Interface source code. UZI stands for Unlimited Zooming Interface, and source code license is