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) 1994 - 2010 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/fbxfilesdk_def.h>

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

#if defined(KARCH_DEV_MSC) && (KARCH_DEV_MSC <= 1600)
    #if defined(KARCH_ARCH_IA32)
        #define SIZE_OF_STDSTRING 32
    #else
        #define SIZE_OF_STDSTRING 48
    #endif
#elif defined(KARCH_DEV_GNUC)
    #if defined(KARCH_ARCH_IA32)
        #define SIZE_OF_STDSTRING 4
    #else
        #define SIZE_OF_STDSTRING 8
    #endif
#endif

#if !defined(SIZE_OF_STDSTRING)
    #error Unsupported platform
#endif

#define KFBX_KSTRING_OPAQUE_OBJECT_HEADER void* mOpaqueChunk[SIZE_OF_STDSTRING/sizeof(void*)]
#ifndef KFBX_KSTRING_OPAQUE_OBJECT
    #define KFBX_KSTRING_OPAQUE_OBJECT KFBX_KSTRING_OPAQUE_OBJECT_HEADER
#endif

#include <fbxfilesdk/fbxfilesdk_nsbegin.h>

//Conversions between WideChar, UTF8 and ANSI

KFBX_DLL void KFbxUTF8ToWidechar(const char* pInUTF8, wchar_t*& pOutWideChar);

KFBX_DLL void KFbxWideCharToUTF8(const wchar_t* pInWideChar, char*& pOutUTF8 );

#if defined(KARCH_ENV_WIN32)

    KFBX_DLL void KFbxWideCharToAnsi(const wchar_t* pInWideChar, char*& pOutANSI );

    KFBX_DLL void KFbxAnsiToWideChar(const char* inANSI, wchar_t*& pOutWideChar );

    KFBX_DLL void KFbxAnsiToUTF8( const char* inANSI, char*& outUTF8 );

    KFBX_DLL void KFbxUTF8ToAnsi( const char* pInUTF8, char*& outANSI );
#endif

//Old macros to convert between WideChar, UTF8 and ANSI
#if defined(KARCH_ENV_WIN32)
    // DEPREACTED! Use KFbxUTF8ToWidechar instead
    #define KFBX_UTF8_to_WIDECHAR( inUTF8,out_UTF8_to_WIDECHAR ) \
        wchar_t* out_UTF8_to_WIDECHAR = NULL;\
        KFbxPointerFreeGuard out_UTF8_to_WIDECHAR##PointerFreeGuard; \
        if((char*)inUTF8 != NULL) { \
        out_UTF8_to_WIDECHAR = (wchar_t *)FbxSdkMalloc((strlen((char*)inUTF8) + (size_t)1) * sizeof(wchar_t)); \
        out_UTF8_to_WIDECHAR##PointerFreeGuard.SetPointer((void*)out_UTF8_to_WIDECHAR);\
        MultiByteToWideChar( CP_UTF8, 0, inUTF8, -1, out_UTF8_to_WIDECHAR, (int)((strlen((char*)inUTF8) + 1)) ); \
        }

    // DEPREACTED! Use KFbxWideCharToUTF8 instead
    #define KFBX_WIDECHAR_to_UTF8( inWideChar,out_WIDECHAR_to_UTF8 )  \
        char* out_WIDECHAR_to_UTF8 = NULL; \
        KFbxPointerFreeGuard out_WIDECHAR_to_UTF8##PointerFreeGuard; \
        if((wchar_t*)inWideChar != NULL) { \
        out_WIDECHAR_to_UTF8 = (char *) FbxSdkMalloc((wcslen((wchar_t *)inWideChar)+1) * sizeof(wchar_t)); \
        out_WIDECHAR_to_UTF8##PointerFreeGuard.SetPointer((void*) out_WIDECHAR_to_UTF8);\
        WideCharToMultiByte( CP_UTF8,0,inWideChar,-1,out_WIDECHAR_to_UTF8, (int)((wcslen((wchar_t *)inWideChar)+1) * sizeof(wchar_t)),NULL,NULL); \
        }

    // DEPREACTED! Use KFbxWideCharToAnsi instead
    #define KFBX_WIDECHAR_to_ANSI( inWideChar,out_WIDECHAR_to_ANSI )  \
        char* out_WIDECHAR_to_ANSI = NULL; \
        KFbxPointerFreeGuard out_WIDECHAR_to_ANSI##PointerFreeGuard; \
        if((wchar_t*)inWideChar != NULL) { \
        out_WIDECHAR_to_ANSI = (char *) FbxSdkMalloc((wcslen((wchar_t *)inWideChar)+1) * sizeof(wchar_t)); \
        out_WIDECHAR_to_ANSI##PointerFreeGuard.SetPointer((void*) out_WIDECHAR_to_ANSI); \
        WideCharToMultiByte( CP_ACP,0,inWideChar,-1,out_WIDECHAR_to_ANSI,(int)((wcslen((wchar_t *)inWideChar)+1) * sizeof(wchar_t)),NULL,NULL); \
        }

    // DEPREACTED! Use KFbxAnsiToWideChar instead
    #define KFBX_ANSI_to_WIDECHAR( inANSI,out_ANSI_to_WIDECHAR ) \
        wchar_t* out_ANSI_to_WIDECHAR = NULL; \
        KFbxPointerFreeGuard out_ANSI_to_WIDECHAR##PointerFreeGuard;\
        if((char*)inANSI != NULL) { \
        out_ANSI_to_WIDECHAR = (wchar_t *)FbxSdkMalloc((strlen((char*)inANSI)+1) * sizeof(wchar_t)); \
        out_ANSI_to_WIDECHAR##PointerFreeGuard.SetPointer((void*) out_ANSI_to_WIDECHAR); \
        MultiByteToWideChar( CP_ACP, 0, inANSI, -1, out_ANSI_to_WIDECHAR, (int)((strlen((char*)inANSI) + 1)) ); \
        }

    // DEPREACTED! Use KFbxAnsiToUTF8 instead
    #define KFBX_ANSI_to_UTF8( inANSI,outUTF8 )  \
        char* outUTF8 = NULL; \
        KFbxPointerFreeGuard outUTF8##PointerFreeGuard; \
        if((char*)inANSI != NULL){ \
        size_t temp_len = strlen((char*)inANSI) + (size_t)1;\
        outUTF8 = (char *) FbxSdkMalloc(temp_len); \
        outUTF8##PointerFreeGuard.SetPointer((void*) outUTF8);\
        wchar_t* temp_ANSI_to_UTF8_WideChar = (wchar_t *)FbxSdkMalloc(temp_len * sizeof(wchar_t)); \
        MultiByteToWideChar( CP_ACP, 0, inANSI, -1, temp_ANSI_to_UTF8_WideChar, (int)(temp_len)); \
        WideCharToMultiByte( CP_UTF8, 0, temp_ANSI_to_UTF8_WideChar, -1, outUTF8, (int)(temp_len), NULL, NULL);\
        FbxSdkFree(temp_ANSI_to_UTF8_WideChar);}\

    // DEPREACTED! Use KFbxUTF8ToAnsi instead
    #define KFBX_UTF8_to_ANSI( inUTF8,outANSI )  \
        char* outANSI = NULL; \
        KFbxPointerFreeGuard outANSI##PointerFreeGuard; \
        if((char*)inUTF8 != NULL){ \
        size_t temp_len = strlen((char*)inUTF8) + (size_t)1;\
        outANSI = (char *) FbxSdkMalloc(temp_len); \
        outANSI##PointerFreeGuard.SetPointer((void*) outANSI);\
        wchar_t* temp_UTF8_to_ANSI_WideChar = (wchar_t *)FbxSdkMalloc(temp_len * sizeof(wchar_t));\
        MultiByteToWideChar( CP_UTF8, 0, inUTF8, -1, temp_UTF8_to_ANSI_WideChar, (int)(temp_len)); \
        WideCharToMultiByte( CP_ACP, 0, temp_UTF8_to_ANSI_WideChar, -1, outANSI, (int)(temp_len), NULL, NULL);\
        FbxSdkFree(temp_UTF8_to_ANSI_WideChar);} \

    #pragma deprecated(KFBX_UTF8_to_WIDECHAR, KFBX_WIDECHAR_to_UTF8, KFBX_WIDECHAR_to_ANSI, KFBX_ANSI_to_WIDECHAR, KFBX_ANSI_to_UTF8, KFBX_UTF8_to_ANSI)
#endif

class KFBX_DLL KString
{
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();

        void Destroy();


        size_t GetLen() const;

        bool IsEmpty() const;

        KString& Empty();

        char& operator[](int pIndex);

        char operator[](int pIndex) const;

        char* Buffer();

        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& 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);

        const KString& operator+=(double pValue);

        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;

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

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

        operator const char*() const;

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

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

        int Compare(const char* pStr) const;

        int CompareNoCase(const char* pStr) const;

        void Swap(KString& pStr);

        KString Upper() const;

        KString Lower() 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;

        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(const char* pFind, const char* pReplaceBy);

        bool ReplaceAll(char pFind, char pReplaceBy);

        int GetTokenCount(const char* pSpans) const;

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

private:
    KFBX_KSTRING_OPAQUE_OBJECT;
};

KFBX_INCOMPATIBLE_WITH_KARRAYTEMPLATE(KString);

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

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

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

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

#include <fbxfilesdk/fbxfilesdk_nsend.h>

#endif // FBXFILESDK_COMPONENTS_KBASELIB_KLIB_KSTRING_H