kstring.h

Go to the documentation of this file.

#ifndef _FBXSDK_KSTRING_H_
#define _FBXSDK_KSTRING_H_

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

 Copyright © 1995 - 2007 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 <kbaselib_h.h>

#if defined(KARCH_ENV_WIN32)

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

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

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

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

    #define 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 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 <kbaselib_nsbegin.h>

#if !defined(KARCH_ENV_WIN32)    
    KBASELIB_DLL void UTF8_to_ANSI( const char* pSrc, char* pDest, int pDestSize, char pSubstitute = '.' );
#endif

    #define KStringStaticSize 64

    class KBASELIB_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, int pNbRepeat = 1);

        KString(const char* pCharPtr, int pLength);

        KString(const int pValue);

        KString(const float pValue);

        KString(const double pValue);

        ~KString();



        bool IsOK() const;

        KString &Invalidate();

        int GetLen() const;

        bool IsEmpty() const;

        KString  &Empty();   



        char& operator[](int pIndex);

        char operator[](int pIndex) const;    

        operator const char*() const;

        char* ToChars() const;

        char* Buffer();     

        char* GetBuffer();



        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(int pLen, const char* pStr);



        const KString& Append(const char* pStr); 

        const KString& AppendN(const char* pStr, int 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 KBASELIB_DLL KString operator+(const KString& pKStr1, const KString& pKStr2);

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

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

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

        friend KBASELIB_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(int pFirst, int pCount) const;

        KString Mid(int pFirst) const;

        KString Left(int pCount) const;

        KString Right(int pCount) const;



        enum PaddingType { eRight, eLeft, eBoth };

        KString Pad(PaddingType pPadding, int 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, int pStartPosition = 0) const; 

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

        int ReverseFind(char pChar) const;

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

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



        int GetTokenCount(const char* pSpans);

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


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

    #ifndef DOXYGEN_SHOULD_SKIP_THIS

    private:

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

        void Init();
        void FreeBuffer();
        void FreeBuffer(char *&pOldData);

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

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

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

    #endif // #ifndef DOXYGEN_SHOULD_SKIP_THIS

    };

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

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

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

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

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


    // Strip the first and last character of a string assuming they are quotation marks.
    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 );
        }
    }

#include <kbaselib_nsend.h>

#endif // #define _FBXSDK_KSTRING_H_