karrayul.h

Go to the documentation of this file.

#ifndef FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KARRAYUL_H
#define FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KARRAYUL_H

/**************************************************************************************

 Copyright (C) 2001 - 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 <fbxfilesdk/components/kbaselib/kbaselib_h.h>

#ifndef KFBX_PLUGIN
    #include <fbxfilesdk/components/kbaselib/klib/kdebug.h>
#endif

#include <string.h>
#include <stdlib.h>

#define KFBX_ARRAYUL_BLOCKSIZE 4

#include <fbxfilesdk/components/kbaselib/kbaselib_forward.h>
#include <fbxfilesdk/fbxfilesdk_nsbegin.h> // namespace

    /***********************************************************************
        CLASS KStaticArray
    ************************************************************************/
    template< class Type > class KBaseStaticArray
    {
        protected:
        int  mCount;
        Type *mArrayBuf;

        public:
        inline int GetCount() { return mCount; }

        inline Type &operator[](int pIndex)
        {
        #ifndef KFBX_PLUGIN
            K_ASSERT_MSG( pIndex >= 0   , "Buffer underflow");
            K_ASSERT_MSG( pIndex < mCount,"Buffer overflow.");
        #endif
            return mArrayBuf[pIndex];
        }
    };

    // Static Array
    template< class Type, int Count > class KStaticArray : public KBaseStaticArray<Type>
    {
        public:
        Type mArray[Count];
            inline KStaticArray(){ this->mArrayBuf = mArray; this->mCount = Count;}
    };

    template< class Type, int Count1, int Count2 > class KStaticArray2d
    {
        public:
#if defined(KARCH_DEV_MSC) && (_MSC_VER <= 1200)// VC6
        KStaticArray<Type,Count2> *mArray;

        KStaticArray2d() { mArray = new KStaticArray<Type,Count2>(Count1); }
        ~KStaticArray2d() { delete[] mArray; }
#else
        KStaticArray<Type,Count2> mArray[Count1];
#endif

        // Access pointer at given index.
        inline KStaticArray< Type, Count2 > &operator[](int pIndex)
        {
        #ifndef KFBX_PLUGIN
            K_ASSERT_MSG( pIndex >= 0   , "Buffer underflow.");
            K_ASSERT_MSG( pIndex < Count1,"Buffer overflow.");
        #endif
            return mArray[pIndex];
        }
    };

    /***********************************************************************
        CLASS KArrayTemplate
    ************************************************************************/
    class  KBaseArraySize {
        public:
            KBaseArraySize( int pItemSize)
                : mItemSize(pItemSize)
            {
            }
            inline int GetTypeSize() const { return mItemSize; }
        private:
            int mItemSize;
    };

    template <class T> class  KBaseArraySizeType
    {
        public:
            inline int GetTypeSize() const { return sizeof(T); }
    };

    // Helpers
    KFBX_DLL void KBaseArrayFree(char*);
    KFBX_DLL char* KBaseArrayRealloc(char*, size_t);
    
    //
    //  WARNING!
    //
    //  Anything beyond these lines may not be documented accurately and is
    //  subject to change without notice.
    //
    #ifndef DOXYGEN_SHOULD_SKIP_THIS
        KFBX_DLL void* KBaseArrayGetAlloc();
    #endif

    template <class TypeSize> class  KBaseArray
    {
        protected:
            struct KHeader {
                int mArrayCount;
                int mBlockCount;
            };


        protected:
            inline KBaseArray(TypeSize pTypeSize)
                : mTypeSize(pTypeSize)
            {
                mBaseArray  = NULL;
                #ifndef KFBX_PLUGIN
                    K_ASSERT( pItemPerBlock > 0 );
                #endif
            }


            inline ~KBaseArray(){
                Clear ();
            }

            inline int      InsertAt(int pIndex, void *pItem)
            {
              int lArrayCount = GetArrayCount();
              int lBlockCount = GetBlockCount();

                #ifndef KFBX_PLUGIN
                    K_ASSERT( pIndex >= 0 );
                #endif

                if (pIndex>lArrayCount) {
                    pIndex = GetArrayCount();
                }

                if (lArrayCount>= lBlockCount*KFBX_ARRAYUL_BLOCKSIZE)
                {
                    // must Alloc.Realloc some new space

                    // double the number of blocks.
                    lBlockCount = ( 0 == lBlockCount ) ? 1 : lBlockCount * 2;
                    mBaseArray = KBaseArrayRealloc(mBaseArray, (size_t) (lBlockCount*KFBX_ARRAYUL_BLOCKSIZE*GetTypeSize()) + GetHeaderOffset() );
                    if(mBaseArray  == NULL)
                    {
                        return -1;
                    }
                }

                if (pIndex<lArrayCount)
                {
                    // This is an insert
                    memmove (&(mBaseArray[(pIndex+1)*GetTypeSize()+ GetHeaderOffset() ]), &(mBaseArray[(pIndex)*GetTypeSize()+ GetHeaderOffset()] ), GetTypeSize()*(lArrayCount-pIndex));
                }

                memmove (&(mBaseArray[(pIndex)*GetTypeSize()+ GetHeaderOffset() ]), pItem, GetTypeSize());

                SetArrayCount(lArrayCount+1);
                SetBlockCount(lBlockCount);

                return pIndex;
            }


            inline void*    GetAt(int pIndex)                           { return &(mBaseArray[(pIndex)*GetTypeSize()+ GetHeaderOffset() ]); }

            inline void RemoveAt(int pIndex)
            {

            #if defined(_DEBUG) && !defined(KARCH_ENV_MACOSX)
                if (!ValidateIndex( pIndex ))
                {
                    return;
                }
            #endif
                int lArrayCount = GetArrayCount();
                if (pIndex+1<lArrayCount)
                {
                    memmove (&(mBaseArray[(pIndex)*GetTypeSize()+ GetHeaderOffset() ]), &(mBaseArray[(pIndex+1)*GetTypeSize()+ GetHeaderOffset() ]), GetTypeSize()*(lArrayCount-pIndex-1));
                }

                SetArrayCount( lArrayCount-1 );

            #ifdef _DEBUG
                memset( &(mBaseArray[(GetArrayCount())*GetTypeSize()+ GetHeaderOffset() ]),0,GetTypeSize());
            #endif
            }


            inline bool ValidateIndex( int pIndex ) const
            {
                int lArrayCount = GetArrayCount();
                if (pIndex>=0 && pIndex<lArrayCount)
                {
                    return true;
                } else
                {
                    #ifndef KFBX_PLUGIN
                        K_ASSERT_MSG_NOW(_T("ArrayTemplate : Index out of range"));
                    #endif
                    return false;
                }
            }


        public:
            inline int GetCount() const { return GetArrayCount(); }

            inline void Clear()
            {
                if (mBaseArray!=NULL)
                {
                    KBaseArrayFree(mBaseArray);
                    mBaseArray = NULL;
                }
            }


            inline void Empty()
            {
            #ifndef KFBX_PLUGIN
                #ifdef _DEBUG
                    memset( mBaseArray+ GetHeaderOffset() ,0,GetArrayCount()*GetTypeSize());
                #endif
            #endif
                SetArrayCount(0);
            }


            inline int      Reserve(int pCapacity)
            {

                #ifndef KFBX_PLUGIN
                    K_ASSERT( pCapacity > 0 );
                #endif

                if( pCapacity )
                {
                    const kUInt lTempNewBlockCount = ( (kUInt) (pCapacity + KFBX_ARRAYUL_BLOCKSIZE - 1 ) / KFBX_ARRAYUL_BLOCKSIZE );
                    const kUInt lNewBlockCount = (lTempNewBlockCount > 1 ? lTempNewBlockCount : 1);

                    int         lArrayCount   = GetArrayCount();
                    int         lBlockCount   = GetBlockCount();

                    const kUInt lOldArraySize = lArrayCount*GetTypeSize();
                    const kUInt lNewArraySize = lNewBlockCount*KFBX_ARRAYUL_BLOCKSIZE*GetTypeSize();

                    if (lNewBlockCount != (kUInt) lBlockCount)
                        mBaseArray = KBaseArrayRealloc(mBaseArray, (size_t) lNewArraySize+ GetHeaderOffset()  );

                    if( lNewBlockCount > (kUInt) lBlockCount ) {
                        memset( ((char*)mBaseArray+ GetHeaderOffset() ) + lOldArraySize, 0, (size_t) (lNewArraySize-lOldArraySize) );
                        SetArrayCount(lArrayCount);
                    } else if (pCapacity < lArrayCount)
                    {
                        memset( ((char*)mBaseArray+ GetHeaderOffset() ) + pCapacity*GetTypeSize(), 0, (size_t) (lNewArraySize-pCapacity*GetTypeSize()) );
                        SetArrayCount(pCapacity);
                    }

                    SetBlockCount(lNewBlockCount);
                }

                return GetBlockCount()*KFBX_ARRAYUL_BLOCKSIZE;
            }


            //  Differ from SetCount because array capacity can be lowered.

            inline void     SetCount (int pCount)
            {
            #ifndef KFBX_PLUGIN
            #ifdef _DEBUG
                if (pCount<0)
                {
                    K_ASSERT_MSG_NOW (_T("ArrayUL : Item count can't be negative"));
                    return ;
                }
            #endif
            #endif
                int lArrayCount = GetArrayCount();
                if (pCount > lArrayCount)
                {
                    AddMultiple( pCount-lArrayCount);
                } else
                {
                    SetArrayCount(pCount);
                }
            }

            inline void     Resize(int pItemCount)
            {
                #ifndef KFBX_PLUGIN
                    K_ASSERT( pItemCount >= 0 );
                #endif

                const kUInt lTempNewBlockCount = ( (kUInt) (pItemCount + KFBX_ARRAYUL_BLOCKSIZE - 1 ) / KFBX_ARRAYUL_BLOCKSIZE );
                const kUInt lNewBlockCount = (lTempNewBlockCount > 1 ? lTempNewBlockCount : 1);

                int         lArrayCount     = GetArrayCount();
                int         lBlockCount   = GetBlockCount();

                const kUInt lOldArraySize   = lArrayCount*GetTypeSize();
                const kUInt lNewArraySize   = lNewBlockCount*KFBX_ARRAYUL_BLOCKSIZE*GetTypeSize();

                if (lNewBlockCount != (kUInt) lBlockCount)
                    mBaseArray = KBaseArrayRealloc(mBaseArray, (size_t) lNewArraySize+ GetHeaderOffset()  );

                if( lNewBlockCount > (kUInt) lBlockCount )
                    memset( ((char*)mBaseArray+ GetHeaderOffset() ) + lOldArraySize, 0, (size_t) (lNewArraySize-lOldArraySize) );
                else if (pItemCount < lArrayCount)
                    memset( ((char*)mBaseArray+ GetHeaderOffset() ) + pItemCount*GetTypeSize(), 0, (size_t) (lNewArraySize-pItemCount*GetTypeSize()) );

                SetBlockCount(lNewBlockCount);
                SetArrayCount(pItemCount);
            }

            inline void     AddMultiple(int pItemCount)
            {
                #ifndef KFBX_PLUGIN
                    K_ASSERT( pItemCount > 0 );
                #endif

                if( pItemCount )
                {
                    int         lArrayCount = GetArrayCount();
                    int         lBlockCount = GetBlockCount();
                    const kUInt lTempNewBlockCount = ( (kUInt) (lArrayCount+pItemCount + KFBX_ARRAYUL_BLOCKSIZE - 1 ) / KFBX_ARRAYUL_BLOCKSIZE );
                    const kUInt lNewBlockCount = (lTempNewBlockCount > 1 ? lTempNewBlockCount : 1);

                    const kUInt lOldArraySize = lArrayCount*GetTypeSize();
                    const kUInt lNewArraySize = lNewBlockCount*KFBX_ARRAYUL_BLOCKSIZE*GetTypeSize();

                    #ifndef KFBX_PLUGIN
                        K_ASSERT( lOldArraySize < lNewArraySize );
                    #endif

                    if( lNewBlockCount > (kUInt) lBlockCount )
                    {
                        mBaseArray = KBaseArrayRealloc(mBaseArray, (size_t) lNewArraySize+ GetHeaderOffset()  );
                        lBlockCount = lNewBlockCount;
                    }

                    memset( ((char*)mBaseArray+ GetHeaderOffset() ) + lOldArraySize, 0, (size_t) (lNewArraySize-lOldArraySize) );
                    SetArrayCount ( lArrayCount + pItemCount );
                    SetBlockCount (lBlockCount);
                }
            }


            inline int  GetTypeSize() const { return mTypeSize.GetTypeSize(); }

        //
        //  WARNING!
        //
        //  Anything beyond these lines may not be documented accurately and is
        //  subject to change without notice.
        //
        #ifndef DOXYGEN_SHOULD_SKIP_THIS

        protected:
            inline KHeader* const   GetHeader() const
            {
                return (KHeader*    const   )mBaseArray;
            }
            inline KHeader*     GetHeader()
            {
                return (KHeader*)mBaseArray;
            }
            inline int GetHeaderOffset() const
            {
                return sizeof(KHeader);
            }
            inline int GetArrayCount() const
            {
                return GetHeader() ? GetHeader()->mArrayCount : 0;
            }
            inline void SetArrayCount(int pArrayCount)
            {
                if (GetHeader()) GetHeader()->mArrayCount=pArrayCount;
            }
            inline int GetBlockCount() const
            {
                return GetHeader() ? GetHeader()->mBlockCount : 0;
            }
            inline void SetBlockCount(int pArrayCount)
            {
                if (GetHeader()) GetHeader()->mBlockCount=pArrayCount;
            }

        protected:
            char*           mBaseArray;
            TypeSize        mTypeSize;

        #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

    };


    #define VC6

    template < class Type > class  KArrayTemplate : public KBaseArray< KBaseArraySizeType<Type> >
    {
        typedef KBaseArray< KBaseArraySizeType<Type> > ParentClass;


    public:
        inline KArrayTemplate()
            : ParentClass (KBaseArraySizeType<Type>())
        {
        }

        inline KArrayTemplate(const KArrayTemplate& pArrayTemplate)
            : ParentClass (KBaseArraySizeType<Type>())
        {
            *this = pArrayTemplate;
        }

        inline ~KArrayTemplate() {}

        inline int InsertAt(int pIndex, Type pItem)
        {
            return ParentClass::InsertAt( pIndex,&pItem );
        }

        inline Type RemoveAt(int pIndex)
        {
            Type tmpItem = GetAt(pIndex);
            ParentClass::RemoveAt( pIndex );
            return tmpItem;
        }

        inline Type RemoveLast()
        {
            return RemoveAt(ParentClass::GetArrayCount()-1);
        }

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

        inline Type &operator[](int pIndex) const
        {
        #if defined(_DEBUG) && !defined(KARCH_ENV_MACOSX)
            if (!ParentClass::ValidateIndex( pIndex ))
            {
                return (Type &)(ParentClass::mBaseArray[(0)*sizeof(Type)+ ParentClass::GetHeaderOffset() ]);
            }
        #endif
            return (Type &)(ParentClass::mBaseArray[(pIndex)*sizeof(Type)+ ParentClass::GetHeaderOffset() ]);
        }

        inline void SetAt(int pIndex, Type pItem)
        {
        #if defined(_DEBUG) && !defined(KARCH_ENV_MACOSX)
            if (!ParentClass::ValidateIndex( pIndex ))
            {
                return;
            }
        #endif
            GetArray()[pIndex] = pItem;
        }

        inline void SetLast(Type pItem)
        {
            SetAt (ParentClass::GetArrayCount()-1, pItem);
        }

        inline Type GetAt(int pIndex) const
        {
        #if defined(_DEBUG) && !defined(KARCH_ENV_MACOSX)
            if (!ParentClass::ValidateIndex( pIndex ))
            {
                return (Type &)(ParentClass::mBaseArray[(0)*sizeof(Type)+ ParentClass::GetHeaderOffset() ]);
            }
        #endif
            return (Type &)(ParentClass::mBaseArray[(pIndex)*sizeof(Type)+ ParentClass::GetHeaderOffset() ]);
        }

        inline Type GetFirst() const
        {
        #ifndef KFBX_PLUGIN
            K_ASSERT( ParentClass::GetArrayCount() >= 1 );
        #endif
            return GetAt(0);
        }

        inline Type GetLast() const
        {
        #ifndef KFBX_PLUGIN
            K_ASSERT( ParentClass::GetArrayCount() >= 1 );
        #endif
            return GetAt(ParentClass::GetArrayCount()-1);
        }

        inline int Find(Type pItem) const
        {
            return FindAfter( -1, pItem );
        }

        inline int FindAfter(int pAfterIndex, Type pItem) const
        {
        #ifndef KFBX_PLUGIN
        #ifdef _DEBUG
            if ( pAfterIndex > ParentClass::GetArrayCount() || pAfterIndex < -1 )
            {
                K_ASSERT_MSG_NOW (_T("ArrayUL : Search Begin Index out of range"));
                return -1;
            }
        #endif
        #endif
            int Count;
            for ( Count=pAfterIndex+1; Count<ParentClass::GetArrayCount(); Count++)
            {
                if (GetAt(Count)==pItem)
                {
                    return Count;
                }
            }
            return -1;
        }

        inline int FindBefore(int pBeforeIndex, Type pItem) const
        {
        #ifndef KFBX_PLUGIN
        #ifdef _DEBUG
            if ( pBeforeIndex > ParentClass::GetArrayCount() || pBeforeIndex <= 0 )
            {
                K_ASSERT_MSG_NOW (_T("ArrayUL : Search Begin Index out of range"));
                return -1;
            }
        #endif
        #endif
            int Count;
            for ( Count=pBeforeIndex-1; Count>=0; Count--)
            {
                if (GetAt(Count)==pItem)
                {
                    return Count;
                }
            }
            return -1;
        }

        inline int Add(Type pItem)
        {
            return InsertAt(ParentClass::GetArrayCount(), pItem);
        }

        inline int AddUnique(Type pItem)
        {
            int lReturnIndex = Find(pItem);
            if (lReturnIndex == -1)
            {
                lReturnIndex = Add(pItem);
            }
            return lReturnIndex;
        }

        inline void AddMultiple( kUInt pItemCount )
        {
            ParentClass::AddMultiple( pItemCount );
        }

        inline void AddArray(KArrayTemplate<Type> &pArray)
        {
            int lSourceIndex, lCount = pArray.GetCount();
            if( lCount == 0 ) return;
            int lDestinationIndex = ParentClass::GetCount();
            AddMultiple(lCount);
            for( lSourceIndex = 0; lSourceIndex < lCount; lSourceIndex++)
            {
                SetAt(lDestinationIndex++, pArray[lSourceIndex]);
            }
        }

        inline void AddArrayNoDuplicate(KArrayTemplate<Type> &pArray)
        {
            int i, lCount = pArray.GetCount();
            for( i = 0; i < lCount; i++)
            {
                Type lItem = pArray[i];
                if (Find(lItem) == -1)
                {
                    Add(lItem);
                }
            }
        }
        inline void RemoveArray(KArrayTemplate<Type> &pArray)
        {
            int lRemoveIndex, lRemoveCount = pArray.GetCount();
            for( lRemoveIndex = 0; lRemoveIndex < lRemoveCount; lRemoveIndex++)
            {
                RemoveIt(pArray[lRemoveIndex]);
            }
        }

        inline Type* GetArray() const
        {
            if (ParentClass::mBaseArray == NULL)
                return NULL;

            return (Type*)(ParentClass::mBaseArray+ ParentClass::GetHeaderOffset()) ;
        }

        inline KArrayTemplate<Type>& operator=(const KArrayTemplate<Type>& pArrayTemplate)
        {
            ParentClass::Clear();

            int i, lCount = pArrayTemplate.GetCount();

            for (i = 0; i < lCount; i++)
            {
                Add(pArrayTemplate[i]);
            }

            return (*this);
        }

        #ifdef KFBX_PLUGIN
            inline operator Type* ()
            {
                return GetArray();
            }
        #endif
    };

    //
    //  WARNING!
    //
    //  Anything beyond these lines may not be documented accurately and is
    //  subject to change without notice.
    //

    #ifndef DOXYGEN_SHOULD_SKIP_THIS

    template <class Type> inline void DeleteAndClear(KArrayTemplate<Type>& Array)
    {
        kUInt lItemCount = Array.GetCount();
        while( lItemCount )
        {
            lItemCount--;
            Type& Item = (Array.operator[](lItemCount));
            delete Item;
            Item = NULL;
        }
        Array.Clear();
    }
/*    template <class Type> inline void DeleteAndClear(KArrayTemplate<Type>& Array)
    {
        kUInt lItemCount = Array.GetCount();
        while( lItemCount )
        {
            lItemCount--;
            Type& Item = (Array.operator[](lItemCount));
            delete Item;
            Item = NULL;
        }
        Array.Clear();
    }
*/
    typedef class KFBX_DLL KArrayTemplate<int *>    KArrayHkInt;
    typedef class KFBX_DLL KArrayTemplate<kUInt *>  KArrayHkUInt;
    typedef class KFBX_DLL KArrayTemplate<double *> KArrayHkDouble;
    typedef class KFBX_DLL KArrayTemplate<float *>  KArrayHkFloat;
    typedef class KFBX_DLL KArrayTemplate<void *>   KArrayVoid;
    typedef class KFBX_DLL KArrayTemplate<char *>   KArrayChar;
    typedef class KFBX_DLL KArrayTemplate<int>      KArraykInt;
    typedef class KFBX_DLL KArrayTemplate<kUInt>    KArraykUInt;
    typedef class KFBX_DLL KArrayTemplate<float>    KArraykFloat;
    typedef class KFBX_DLL KArrayTemplate<double>   KArraykDouble;

    typedef class KFBX_DLL KArrayTemplate<kReference>   KArrayUL;

    #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KARRAYUL_H