fbarray.h

Go to the documentation of this file.

#ifndef __FBARRAY_H__
#define __FBARRAY_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbversion.h>

#include <assert.h>
#include <string.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

FBSDK_DLL void* FBRealloc(void* memblock, size_t size);

FBSDK_DLL void FBFree(void* memblock);

// FBArrayTemplate

template <class Type> class FBArrayTemplate 
{
  public:
    inline FBArrayTemplate(int pItemPerBlock=10) 
    {
        mArray          = NULL;
        mArrayCount     = 0;
        mBlockCount     = 0;
        mItemPerBlock   = pItemPerBlock;    
    }

    inline FBArrayTemplate(const FBArrayTemplate<Type>& pArrayTemplate)
    { 
        mArray          = NULL;
        mArrayCount     = 0;
        mBlockCount     = 0;
        mItemPerBlock   = 10;    

        *this = pArrayTemplate; 
    }

    inline ~FBArrayTemplate()
    {
        Clear();
    }

    inline int InsertAt ( int pIndex, Type pItem)
    {
        if (pIndex>mArrayCount) 
        {
            pIndex = mArrayCount;
        }

        if (mArrayCount>= mBlockCount*mItemPerBlock) 
        {
             // must allocate or reallocate block of items
              mBlockCount++;
              mArray = (Type *)FBRealloc( mArray,(size_t)(mBlockCount*mItemPerBlock*sizeof(Type)));
        }

        if (pIndex<mArrayCount) 
        {
            // This is an insert
            memmove (&(mArray[pIndex+1]),&(mArray[pIndex]),sizeof(Type)*(mArrayCount-pIndex));
        }

        mArray[pIndex] = pItem;
        mArrayCount++;

        return pIndex;
    }

    inline void RemoveAt ( int pIndex )
    {
        assert( pIndex<mArrayCount );
        if (pIndex+1<mArrayCount) {
            memmove (&(mArray[pIndex]),&(mArray[pIndex+1]),sizeof(Type)*(mArrayCount-pIndex-1));
        }
        mArrayCount --;
        memset (&(mArray[mArrayCount]),0,sizeof(Type)); // Cleanup last element to make sure we don't access it later
    }
    
    
    inline void RemoveLast() { RemoveAt( mArrayCount-1 ); } 

    inline bool Remove ( Type &pItem )
    {
      int Index = Find( pItem );
        if (Index>=0) {
            RemoveAt( Index );
            return true;
        }
        return false;
    }

    inline bool RemoveIt ( Type pItem )
    {
      int Index = Find( pItem );
        if (Index>=0) {
            RemoveAt( Index );
            return true;
        }
        return false;
    }

    inline void Clear()
    {
        if (mArray!=NULL) {
            FBFree(mArray);
            mArray = NULL;
        }
        mArrayCount  = 0L;
        mBlockCount  = 0L;
    }

    inline Type &operator[](int pIndex) const
    {
        assert( pIndex<mArrayCount );
        return mArray[pIndex];
    }

    inline void SetAt(int pIndex,Type pItem)
    {
        assert( pIndex<mArrayCount );
        mArray[pIndex] = pItem;
    }

    inline void SetLast(Type pItem) 
    { 
        SetAt(mArrayCount-1,pItem ); 
    }

    inline int GetCount () const
    { 
        return mArrayCount; 
    }

    inline void SetCount(int pCount)
    {
        if (pCount > mArrayCount)
        {
            if( pCount )
            {
                const int lTempNewBlockCount = ( (int) (mArrayCount+pCount + mItemPerBlock - 1 ) / mItemPerBlock );
                const int lNewBlockCount = (lTempNewBlockCount > 1 ? lTempNewBlockCount : 1);

                const int lOldArraySize = mArrayCount*sizeof(Type);
                const int lNewArraySize = lNewBlockCount*mItemPerBlock*sizeof(Type);

                if( lNewBlockCount > (int) mBlockCount )
                {           
                    mArray = (Type *)FBRealloc( mArray, (size_t) lNewArraySize );
                    mBlockCount = lNewBlockCount;
                }
                
                memset( ((char *)mArray) + lOldArraySize, 0, (size_t) (lNewArraySize-lOldArraySize) );
                mArrayCount += pCount;
            }
        } else 
        {
            mArrayCount = pCount;
        }
    }

    inline Type GetAt(int pIndex) 
    {       
        assert( pIndex<mArrayCount );
        return mArray[pIndex]; 
    }

    inline Type GetLast()           
    { 
        return mArray[mArrayCount-1]; 
    }

    inline int Find( Type pItem )
    {
      int Count;
        for (Count=0; Count<mArrayCount; Count++) {
            if (mArray[Count]==pItem) {
                return Count;
            }
        }
        return -1;
    }

    inline int Add( Type pItem ) 
    { 
        return InsertAt( mArrayCount,pItem ); 
    }

    inline Type *GetArray() 
    { 
        return mArray; 
    }

    inline FBArrayTemplate<Type>& operator=(const FBArrayTemplate<Type>& pArrayTemplate)
    {
        if (this != &pArrayTemplate)
        {
            Clear();

            mItemPerBlock = pArrayTemplate.mItemPerBlock;

            SetCount(pArrayTemplate.GetCount());
            memcpy(mArray, pArrayTemplate.mArray, sizeof(Type) * pArrayTemplate.GetCount());
        }

        return (*this);
    }

  private:
    Type      *mArray;          
    int       mArrayCount;      
    int       mBlockCount;      
    int       mItemPerBlock;
};

typedef class FBSDK_DLL FBArrayTemplate<bool *>         FBArrayHBool;
typedef class FBSDK_DLL FBArrayTemplate<char *>         FBArrayHChar;
typedef class FBSDK_DLL FBArrayTemplate<int *>          FBArrayHkInt;
typedef class FBSDK_DLL FBArrayTemplate<unsigned int *> FBArrayHkUInt;
typedef class FBSDK_DLL FBArrayTemplate<float *>        FBArrayHkFloat;
typedef class FBSDK_DLL FBArrayTemplate<double *>       FBArrayHkDouble;
typedef class FBSDK_DLL FBArrayTemplate<void *>         FBArrayHVoid;

typedef class FBSDK_DLL FBArrayTemplate<bool>           FBArrayBool;
typedef class FBSDK_DLL FBArrayTemplate<char>           FBArrayChar;
typedef class FBSDK_DLL FBArrayTemplate<int>            FBArrayInt;
typedef class FBSDK_DLL FBArrayTemplate<unsigned int>   FBArrayUInt;
typedef class FBSDK_DLL FBArrayTemplate<float>          FBArrayFloat;
typedef class FBSDK_DLL FBArrayTemplate<double>         FBArrayDouble;

#define FB_DEFINE_ARRAY( DllTag, Type ) \
    typedef class DllTag FBArrayTemplate< FB##Type* > FBArray##Type;

#if defined(KARCH_DEV_INTEL)
    #define FBImplementArray( DllTag, Type ) 
#else
    #define FBImplementArray( DllTag, Type ) \
        template class DllTag FBSDKNamespaceFunc( FBArrayTemplate ) < FB##Type* >;
#endif


#ifdef FBSDKUseNamespace
    }
#endif
#endif // __FBARRAY_H