str.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_STRING_H
#define COMMON_STRING_H

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

#include <stdarg.h>

namespace Common {

class U32String;

class String : public BaseString<char> {
public:
    typedef unsigned char unsigned_type;

    constexpr String() : BaseString<char>() {}

    String(const char *str) : BaseString<char>(str) {}

    String(const char *str, uint32 len) : BaseString<char>(str, len) {}

    String(const char *beginP, const char *endP) : BaseString<char>(beginP, endP) {}

    String(const String &str) : BaseString<char>(str) {}

    String(String &&str) : BaseString<char>(static_cast<BaseString<char> &&>(str)) {}

    explicit String(char c);

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

    String &operator=(const char *str);
    String &operator=(const String &str);
    String &operator=(String &&str);
    String &operator=(char c);
    String &operator+=(const char *str);
    String &operator+=(const String &str);
    String &operator+=(char c);

    bool equalsIgnoreCase(const String &x) const;
    int compareToIgnoreCase(const String &x) const; // stricmp clone

    bool equalsIgnoreCase(const char *x) const;
    int compareToIgnoreCase(const char *x) const;   // stricmp clone
    int compareDictionary(const String &x) const;
    int compareDictionary(const char *x) const;

    bool hasSuffix(const String &x) const;
    bool hasSuffix(const char *x) const;
    bool hasSuffixIgnoreCase(const String &x) const;
    bool hasSuffixIgnoreCase(const char *x) const;

    bool hasPrefix(const String &x) const;
    bool hasPrefix(const char *x) const;
    bool hasPrefixIgnoreCase(const String &x) const;
    bool hasPrefixIgnoreCase(const char *x) const;

    using BaseString<value_type>::contains;
    bool contains(const String &x) const;
    bool contains(const char *x) const;

    bool matchString(const char *pat, bool ignoreCase = false, const char *wildcardExclusions = NULL) const;
    bool matchString(const String &pat, bool ignoreCase = false, const char *wildcardExclusions = NULL) const;

    static String format(MSVC_PRINTF const char *fmt, ...) GCC_PRINTF(1, 2);

    static String vformat(const char *fmt, va_list args);

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

    String forEachLine(String(*func)(const String, va_list args), ...) const;

    U32String decode(CodePage page = kUtf8) const;

protected:
    StringEncodingResult encodeUTF8(const U32String &src, char errorChar);
    StringEncodingResult encodeWindows932(const U32String &src, char errorChar);
    StringEncodingResult encodeWindows936(const U32String &src, char errorChar);
    StringEncodingResult encodeWindows949(const U32String &src, char errorChar);
    StringEncodingResult encodeWindows950(const U32String &src, bool translit, char errorChar);
    StringEncodingResult encodeJohab(const U32String &src, char errorChar);
    StringEncodingResult encodeOneByte(const U32String &src, CodePage page, bool translit, char errorChar);
    StringEncodingResult encodeInternal(const U32String &src, CodePage page, char errorChar);
    StringEncodingResult translitChar(U32String::value_type point, char errorChar);

    friend class U32String;
};

// Append two strings to form a new (temp) string
String operator+(const String &x, const String &y);

String operator+(const char *x, const String &y);
String operator+(const String &x, const char *y);

String operator+(const String &x, char y);
String operator+(char x, const String &y);

// Some useful additional comparison operators for Strings
bool operator==(const char *x, const String &y);
bool operator!=(const char *x, const String &y);

// Utility functions to remove leading and trailing whitespaces
extern char *ltrim(char *t);
extern char *rtrim(char *t);
extern char *trim(char *t);


String lastPathComponent(const String &path, const char sep);

String firstPathComponents(const String &path, const char sep);

String normalizePath(const String &path, const char sep);


bool matchString(const char *str, const char *pat, bool ignoreCase = false, const char *wildcardExclusions = NULL);

void replace(Common::String &source, const Common::String &what, const Common::String &with);

String tag2string(uint32 tag, bool nonPrintable = false);

void strcpy_s(char *dst, size_t size, const char *src);

template<typename T, size_t N>
FORCEINLINE void strcpy_s(T (&dst)[N], const char *src) {
    STATIC_ASSERT(sizeof(T) == sizeof(char), T_is_not_compatible_with_char);
    strcpy_s((char *)dst, N, src);
}

void strcat_s(char *dst, size_t size, const char *src);

template<typename T, size_t N>
FORCEINLINE void strcat_s(T (&dst)[N], const char *src) {
    STATIC_ASSERT(sizeof(T) == sizeof(char), T_is_not_compatible_with_char);
    strcat_s((char *)dst, N, src);
}

int vsprintf_s(char *dst, size_t size, const char *format, va_list ap) GCC_PRINTF(3, 0);

template<typename T, size_t N>
FORCEINLINE GCC_PRINTF(2, 0) int vsprintf_s(T (&dst)[N], const char *format, va_list ap) {
    STATIC_ASSERT(sizeof(T) == sizeof(char), T_is_not_compatible_with_char);
    return vsprintf_s((char *)dst, N, format, ap);
}

int sprintf_s(char *dst, size_t size, MSVC_PRINTF const char *format, ...) GCC_PRINTF(3, 4);

template<typename T, size_t N>
inline GCC_PRINTF(2, 3) int sprintf_s(T (&dst)[N], MSVC_PRINTF const char *format, ...) {
    STATIC_ASSERT(sizeof(T) == sizeof(char), T_is_not_compatible_with_char);
    int ret;
    va_list ap;
    va_start(ap, format);
    ret = vsprintf_s((char *)dst, N, format, ap);
    va_end(ap);
    return ret;
}

size_t strlcpy(char *dst, const char *src, size_t size);

size_t strlcat(char *dst, const char *src, size_t size);

size_t strnlen(const char *src, size_t maxSize);

#define tag2str(x)  Common::tag2string(x).c_str()

#define tag2strP(x) Common::tag2string(x, true).c_str()

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

String percentEncodeString(const String &src);

} // End of namespace Common

extern int scumm_stricmp(const char *s1, const char *s2);
extern int scumm_strnicmp(const char *s1, const char *s2, uint n);
extern char *scumm_strdup(const char *in);

extern int scumm_compareDictionary(const char *s1, const char *s2);
extern const char *scumm_skipArticle(const char *s1);

extern const char *scumm_strcasestr(const char *s, const char *find);

#endif