xstringoperation.h

Go to the documentation of this file.

//! @file xstringoperation.h
//! @brief strings low level functions and conversion. Some are declared in macos_stringoperation, win_stringoperation...
//!
//!  Created by Mootools on 20/05/2016.
//!  Copyright © 2016 Mootools. All rights reserved.
//////////////////////////////////////////////////////////////////////////////////
 
#ifndef xstring_operation_h
#define xstring_operation_h
 
BEGIN_MOOTOOLS_NAMESPACE
 
// On Windows xStringEncoding can be one of these value or a code page
typedef enum XEnumType( unsigned int)
{
    xStringDefaultEncoding = (unsigned int)-1, // Use for converting to default OS encoding (for converting from CXStringA <-> CXStringW)
    xStringAnsi = 1, // char encoding
    xStringUtf8, // char encoding (Mac OS default)
    xStringUtf16, // wchar_t encoding (Windows default)
    xStringUtf32, // wchar_t encoding (not supported)
} xStringEncoding;
 
#define IsStringEncodingUnicode(encodingValue) ((bool)((encodingValue == xStringUtf16) || (encodingValue == xStringUtf32)))
 
DLL_TOOLSFUNCTION CXString xLoadString(unsigned int resourceID); // Must be exported as accessed through a CXString template
DLL_TOOLSFUNCTION SIZET xUTF8ToUTF16(const unsigned char *utf8, unsigned short *utf16);
DLL_TOOLSFUNCTION SIZET xUTF16ToUTF32(const unsigned short *utf16, SIZET charcount, unsigned int *utf32);
 
// String conversions
 
// Forward declarations of our classes. They are defined later.
class XCA2A;
class XCA2W;
class XCW2A;
class XCW2W;
 
// typedefs for the well known text conversions
typedef XCA2W XA2W;
typedef XCW2A XW2A;
typedef XCW2W XW2W;
typedef XCA2A XA2A;
 
#ifdef _UNICODE
    typedef XCA2W XA2T;
    typedef XCW2A XT2A;
    typedef XCW2W XT2W;
    typedef XCW2W XW2T;
#else
    typedef XCA2A XA2T;
    typedef XCA2A XT2A;
    typedef XCA2W XT2W;
    typedef XCW2A XW2T;
#endif
 
typedef XT2A XCT2A;
typedef XT2W XCT2W;
typedef XA2T XCA2T;
typedef XW2T XCW2T;
 
bool XFASTCA2W(CXCharArrayW& buffer, LPCSTR pStr, xStringEncoding srcAnsiEncoding = xStringDefaultEncoding);
 
//! @class XCA2W
//! @brief Conversion from ansi / utf8 (char) to unicode (wchar_t)
//! @details Allows to get a CXStringW from a CXStringA for example.
class DLL_TOOLSFUNCTION XCA2W
{
public:
#ifdef __WINDOWS__
    // Windows : ansi source might be ansi, code page, or utf8
    // unicode destination is always windows default unicode (utf16)
    XCA2W(LPCSTR pStr, xStringEncoding srcAnsiEncoding = xStringDefaultEncoding);
#else
    // Macos & Linux: ansi source is always UTF8.
    // Unicode conversion might be done from 16 or 32 bits (Macos only) unicode string
    XCA2W(LPCSTR pStr, xStringEncoding srcAnsiEncoding = xStringDefaultEncoding);
#endif
 
    ~XCA2W() {}
    operator LPCWSTR() { return isValid ? buffer.data() : NULL; }
 
private:
    CXCharArrayW buffer;
    bool isValid;
};
class DLL_TOOLSFUNCTION XCA2W {…};
 
bool XFASTCW2A(CXCharArrayA& buffer, LPCWSTR pWstr, xStringEncoding dstAnsiEncoding = xStringDefaultEncoding);
 
//! @class XCW2A
//! @brief Conversion from unicode (wchar_t) to ansi / utf8 (char)
//! @details Allows to get a CXStringA from a CXStringW for example.
class DLL_TOOLSFUNCTION XCW2A
{
public:
#ifdef __WINDOWS__
    // Windows : ansi destination might be ansi, code page, or utf8
    // unicode source is always windows default unicode (utf16)
    XCW2A(LPCWSTR pWStr, xStringEncoding dstAnsiEncoding = xStringDefaultEncoding);
#else
    // Macos & Linux: ansi destination is always UTF8.
    // Unicode conversion might be done from 16 or 32 bits (Macos only) unicode string
    XCW2A(LPCWSTR pWStr, xStringEncoding dstAnsiEncoding = xStringDefaultEncoding);
#endif
 
    ~XCW2A() {}
    operator LPCSTR() { return isValid ? buffer.data() : NULL; }
 
private:
    CXCharArrayA buffer;
    bool isValid;
};
class DLL_TOOLSFUNCTION XCW2A {…};
 
// Does not perform ANSI conversion yet, return the string itself
class DLL_TOOLSFUNCTION XCW2W
{
public:
    XCW2W(LPCWSTR pWStr, xStringEncoding encoding = xStringDefaultEncoding);
    operator LPCWSTR() { return (LPWSTR)m_pWStr; }
 
private:
    LPCWSTR m_pWStr;
};
 
// Does not perform ANSI conversion yet, return the string itself
class DLL_TOOLSFUNCTION XCA2A
{
public:
    XCA2A(LPCSTR pStr, xStringEncoding encoding = xStringDefaultEncoding);
    operator LPCSTR() { return (LPSTR)m_pStr; }
 
private:
    LPCSTR m_pStr;
};
 
END_MOOTOOLS_NAMESPACE
 
#endif /* xstring_operation_h */