kstring.h

Go to the documentation of this file.

#ifndef FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KSTRING_H
#define FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KSTRING_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 <string.h>

// FBX includes
#include <fbxfilesdk/components/kbaselib/kbaselib_h.h>
#include <fbxfilesdk/components/kbaselib/klib/kscopedptr.h>


#if defined(KARCH_ENV_WIN32)

// Conversions between WideChar, UTF8 and ANSI
    #define KFBX_UTF8_to_WIDECHAR( inUTF8,outWideChar ) \
        wchar_t outWideChar[1024]; \
        MultiByteToWideChar( CP_UTF8, 0, inUTF8, -1, outWideChar, 1024 );

    #define KFBX_WIDECHAR_to_UTF8( inWideChar,outUTF8 ) \
        char outUTF8[1024]; \
        WideCharToMultiByte( CP_UTF8,0,inWideChar,-1,outUTF8,1024,NULL,NULL);

    #define KFBX_WIDECHAR_to_ANSI( inWideChar,outANSI ) \
        char outANSI[1024]; \
        WideCharToMultiByte( CP_ACP,0,inWideChar,-1,outANSI,1024,NULL,NULL);

    #define KFBX_ANSI_to_WIDECHAR( inANSI,outWideChar ) \
        wchar_t outWideChar[1024]; \
        MultiByteToWideChar( CP_ACP, 0, inANSI, -1, outWideChar, 1024 );

    #define KFBX_ANSI_to_UTF8( inANSI,outUTF8 ) { \
        wchar_t tempWideChar[1024]; \
        MultiByteToWideChar( CP_ACP, 0, inANSI, -1, tempWideChar, 1024); \
        WideCharToMultiByte( CP_UTF8, 0, tempWideChar, -1, outUTF8, 1024, NULL, NULL); \
    }

    #define KFBX_UTF8_to_ANSI( inUTF8,outANSI, dummy, dummy1 ) { \
        wchar_t tempWideChar[1024]; \
        MultiByteToWideChar( CP_UTF8, 0, inUTF8, -1, tempWideChar, 1024); \
        WideCharToMultiByte( CP_ACP, 0, tempWideChar, -1, outANSI, 1024, NULL, NULL); \
    }
#endif



#include <fbxfilesdk/fbxfilesdk_nsbegin.h>
class KMemoryAllocator;

#if !defined(KARCH_ENV_WIN32)
    KFBX_DLL void KFBX_UTF8_to_ANSI( const char* pSrc, char* pDest, size_t pDestSize, char pSubstitute = '.' );
#endif

//  #define UseKStringStatic
    #ifdef UseKStringStatic
        #define KStringStaticSize 64
    #endif

    class KFBX_DLL KString
    {
        public:

                static KString      *Create();
                static KString      *Create(KString *pString);
                void                Destroy();
                static KString* DestroyIfEmpty(KString *pString);
                static KString* StringOrEmpty(KString *pString);

        public:

                KString();

                KString(const KString& pStr);

                KString(const char* pStr);

                KString(char pChar, size_t pNbRepeat = 1);

                KString(const char* pCharPtr, size_t pLength);

                KString(const int pValue);

                KString(const float pValue);

                KString(const double pValue);

                ~KString();


                inline bool IsOK() const;

                KString &Invalidate();

                inline size_t GetLen() const;

                inline bool IsEmpty() const;

                KString  &Empty();


                char& operator[](int pIndex);

                char operator[](int pIndex) const;

                inline operator const char*() const;

                inline char* Buffer();

                inline const char* Buffer()const;



                const KString& operator=(const KString& pStr);

                const KString& operator=(char pChar);

                const KString& operator=(const char* pStr);

                const KString& operator=(int  pValue);

                const KString& operator=(float pValue);

                const KString& operator=(double pValue);

                const KString& Copy(size_t pLen, const char* pStr);

                void Swap(KString& pStr);


                const KString& Append(const char* pStr);

                const KString& AppendN(const char* pStr, size_t pLength);

                const KString& operator+=(const KString& pKStr);

                const KString& operator+=(char pChar);

                const KString& operator+=(const char* pStr);

                const KString& operator+=(int pValue);

                const KString& operator+=(float pValue);

                friend KFBX_DLL KString operator+(const KString& pKStr1, const KString& pKStr2);

                friend KFBX_DLL KString operator+(const KString& pKStr, char pChar);

                friend KFBX_DLL KString operator+(const KString& pKStr, const char* pStr);

                friend KFBX_DLL KString operator+(const KString& pKStr, int pValue);

                friend KFBX_DLL KString operator+(const KString& pKStr, float pValue);


                int Compare(const char * pStr) const;

                int CompareNoCase( const char * pStr ) const;

                bool operator==(const KString &pStr) const;

                bool operator!=(const KString &pStr) const;

                bool operator< (const KString &pStr) const;

                bool operator<=(const KString &pStr) const;

                bool operator>=(const KString &pStr) const;

                bool operator> (const KString &pStr) const;

                bool operator==(const char *pStr) const;

                bool operator!=(const char *pStr) const;

                bool operator< (const char *pStr) const;

                bool operator<=(const char *pStr) const;

                bool operator>=(const char *pStr) const;

                bool operator> (const char *pStr) const;


                KString Mid(size_t pFirst, size_t pCount) const;

                KString Mid(size_t pFirst) const;

                KString Left(size_t pCount) const;

                KString Right(size_t pCount) const;



                enum PaddingType 
                { 
                    eRight,
                    eLeft, 
                    eBoth
                };

                KString Pad(PaddingType pPadding, size_t pLen, char pCar = ' ') const;

                KString UnPad(PaddingType pPadding) const;



                KString Upper() const;

                KString Lower() const;

                KString Reverse() const;

                KString ConvertToUnix() const;

                KString ConvertToWindows() const;

                int Find(char pChar, size_t pStartPosition = 0) const;

                int Find(const char* pStrSub, size_t pStartPosition = 0) const;

                int ReverseFind(char pChar) const;

                int FindOneOf(const char * pStrCharSet, size_t pStartPosition = 0) const;

                bool FindAndReplace(const char* pFind, const char* pReplaceBy, size_t pStartPosition = 0);

                bool ReplaceAll( char pFind, char pReplaceBy );


                int GetTokenCount(const char* pSpans) const;

                KString GetToken(int pTokenIndex, const char* pSpans) const;

            public:
                static KMemoryAllocator* AllocatorGet();
                static void AllocatorPurge();
                static void  AllocatorRelease();

        //  WARNING!
        //  Anything beyond these lines may not be documented accurately and is
        //  subject to change without notice.
        #ifndef DOXYGEN_SHOULD_SKIP_THIS
        private:
            void Init();
            void FreeBuffer();
            void FreeBuffer(char *&pOldData);

            bool AllocCopy(KString& pDest, size_t pCopyLen, size_t pCopyIndex) const;
            bool AllocBuffer(size_t pLen);
            bool AllocBuffer(size_t pLen, char *&pOldData);

            bool AssignCopy(size_t pSrcLen, const char * pSrcData);
            bool ConcatCopy(size_t pSrc1Len, const char * pSrc1Data,
                            size_t pSrc2Len, const char * pSrc2Data);
            bool ConcatInPlace(size_t pSrcLen, const char * pSrcData);

            bool IsIn(char pChar, const char* pString) const;

            static KScopedPtr<KMemoryAllocator> mMemoryPool;

        // Lengths/sizes in characters.
        // Note: an extra character is always allocated.
        private:
            char*       mData; // Actual string (zero terminated).
            size_t      mDataLen; // Does not include terminating 0.
            size_t      mAllocLen; // Does not include terminating 0.
            #ifdef UseKStringStatic
                char    mStaticData[KStringStaticSize]; // Actual static string (zero terminated) used as long as the string is smaller than KStringStaticSize
            #endif

            static char ksNilString[1];    // Used when strlen == 0;
            static char ksErrorString[1];  // Used on allocation errors, so

        #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

    };

    KFBX_DLL KString operator+(const KString& pKStr1, const KString& pKStr2);

    KFBX_DLL KString operator+(const KString& pKStr, char pChar);

    KFBX_DLL KString operator+(const KString& pKStr, const char* pStr);

    KFBX_DLL KString operator+(const KString& pKStr, int pValue);

    KFBX_DLL KString operator+(const KString& pKStr, float pValue);


    inline void StripQuotationMarks(  KString& str)
    {
        str = str.Mid( 1, str.GetLen() - 2 );
    }

    inline void RemoveChar( KString& pString, char lToRemove )
    {
        int lPos = pString.ReverseFind( lToRemove );

        while( lPos >= 0 )
        {
            pString = pString.Left( lPos ) + pString.Mid( lPos + 1 );
            lPos = pString.ReverseFind( lToRemove );
        }
    }

    // ---- inline definition ----------------------------------------------


    inline bool KString::IsOK()const{ return mData != ksErrorString; }
    inline size_t KString::GetLen() const { return mDataLen; }
    inline bool KString::IsEmpty()const { return( GetLen() == 0 ); }

    inline char *KString::Buffer() { return mData; }
    inline const char *KString::Buffer()const{ return mData; }
    inline KString::operator const char *() const{ return mData; }

    class KStringCompare
    {
        public:
            inline int operator()(KString const &pKeyA, KString const &pKeyB) const
            {
                return (pKeyA < pKeyB) ? -1 : ((pKeyB < pKeyA) ? 1 : 0);
            }
    };

    class KCharCompare
    {
        public:
            inline int operator()(char const* pKeyA, char const* pKeyB) const
            {
                return strcmp( pKeyA, pKeyB );
            }
    };

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KSTRING_H