ustr.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef COMMON_USTR_H
#define COMMON_USTR_H

#include "common/scummsys.h"
#include "common/util.h"
#include "common/str-enc.h"
#include "common/str-base.h"

namespace Common {

class String;

typedef char32_t u32char_type_t;

class U32String : public BaseString<u32char_type_t> {
public:
    typedef uint32 unsigned_type; 
public:
    constexpr U32String() : BaseString<u32char_type_t>() {}

    explicit U32String(const value_type *str) : BaseString<u32char_type_t>(str) {}

    U32String(const value_type *str, uint32 len) : BaseString<u32char_type_t>(str, len) {}

    WARN_DEPRECATED("Use u32char_type_t instead of uint32")
    explicit U32String(const uint32 *str) : BaseString<u32char_type_t>((const value_type *) str) {}
    WARN_DEPRECATED("Use u32char_type_t instead of uint32")
    U32String(const uint32 *str, uint32 len) : BaseString<u32char_type_t>((const value_type *) str, len) {}
    WARN_DEPRECATED("Use u32char_type_t instead of uint32")
    U32String(const uint32 *beginP, const uint32 *endP) : BaseString<u32char_type_t>((const value_type *) beginP, (const value_type *) endP) {}

    U32String(const value_type *beginP, const value_type *endP) : BaseString<u32char_type_t>(beginP, endP) {}

    U32String(const U32String &str) : BaseString<u32char_type_t>(str) {}

    U32String(U32String &&str) : BaseString<u32char_type_t>(static_cast<BaseString<u32char_type_t> &&>(str)) {}

    explicit U32String(const char *str, CodePage page = kUtf8);

    U32String(const char *str, uint32 len, CodePage page = kUtf8);

    U32String(const char *beginP, const char *endP, CodePage page = kUtf8);

    U32String(const String &str, CodePage page = kUtf8);

    explicit constexpr U32String(value_type c) : BaseString<u32char_type_t>(c) {}

    U32String &operator=(const U32String &str);

    U32String &operator=(U32String &&str);

    U32String &operator=(const String &str);

    U32String &operator=(const value_type *str);

    U32String &operator=(const char *str);

    U32String &operator=(value_type c);

    U32String &operator+=(const U32String &str);

    U32String &operator+=(const value_type *str);

    U32String &operator+=(value_type c);

    using BaseString<value_type>::operator==;
    using BaseString<value_type>::operator!=;

    bool operator==(const String &x) const;

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

    bool operator!=(const String &x) const;

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

    String encode(CodePage page = kUtf8) const;

    StringEncodingResult encode(String &outString, CodePage page, char errorChar) const;

    template<class... TParam>
    static U32String format(const U32String &fmt, TParam... param);

    static U32String format(const char *fmt, ...);

    static int vformat(const value_type *fmt, const value_type *fmtEnd, U32String &output, va_list args);

    U32String substr(size_t pos = 0, size_t len = npos) const;

    WARN_DEPRECATED("Use c_str() instead")
    const uint32 *u32_str() const {   
        return (const uint32 *) _str;
    }

    static Common::U32String decodeUTF16BE(const uint16 *start, uint len);

    static Common::U32String decodeUTF16LE(const uint16 *start, uint len);

    static Common::U32String decodeUTF16Native(const uint16 *start, uint len);

    uint16 *encodeUTF16BE(uint *len = nullptr) const;

    uint16 *encodeUTF16LE(uint *len = nullptr) const;

    uint16 *encodeUTF16Native(uint *len = nullptr) const;

    U32String transcodeChineseT2S() const;

private:
    static U32String formatInternal(const U32String *fmt, ...);

    static value_type* ustr_helper_itoa(int num, value_type* str, uint base);

    static value_type* ustr_helper_uitoa(uint num, value_type* str, uint base);

    void decodeInternal(const char *str, uint32 len, CodePage page);
    void decodeOneByte(const char *str, uint32 len, CodePage page);
    void decodeWindows932(const char *src, uint32 len);
    void decodeWindows936(const char *src, uint32 len);
    void decodeWindows949(const char *src, uint32 len);
    void decodeWindows950(const char *src, uint32 len);
    void decodeJohab(const char *src, uint32 len);
    void decodeUTF8(const char *str, uint32 len);

    friend class String;
};

template<class... TParam>
inline U32String U32String::format(const U32String &fmt, TParam... param) {
    return formatInternal(&fmt, Common::forward<TParam>(param)...);
}

U32String operator+(const U32String &x, const U32String &y);

U32String operator+(const U32String &x, U32String::value_type y);

U32String toPrintable(const U32String &src, bool keepNewLines = true);

} // End of namespace Common

#endif