mirror of
https://github.com/libretro/scummvm.git
synced 2025-02-02 08:55:45 +00:00
110 lines
4.4 KiB
C++
110 lines
4.4 KiB
C++
/* 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 AGS_SHARED_UTIL_STRING_UTILS_H
|
|
#define AGS_SHARED_UTIL_STRING_UTILS_H
|
|
|
|
#include "ags/shared/util/string_types.h"
|
|
|
|
namespace AGS3 {
|
|
|
|
namespace AGS {
|
|
namespace Shared {
|
|
class Stream;
|
|
} // namespace Shared
|
|
} // namespace AGS
|
|
|
|
using namespace AGS; // FIXME later
|
|
|
|
//=============================================================================
|
|
|
|
namespace AGS {
|
|
namespace Shared {
|
|
namespace StrUtil {
|
|
|
|
enum ConversionError {
|
|
kNoError, // conversion successful
|
|
kFailed, // conversion failed (e.g. wrong format)
|
|
kOutOfRange // the resulting value is out of range
|
|
};
|
|
|
|
// Convert integer to string, by printing its value
|
|
String IntToString(int val);
|
|
// Tries to convert whole string into integer value;
|
|
// returns def_val on failure
|
|
int StringToInt(const String &s, int def_val = 0);
|
|
// Tries to convert whole string into integer value;
|
|
// Returns error code if any non-digit character was met or if value is out
|
|
// of range; the 'val' variable will be set with resulting integer, or
|
|
// def_val on failure
|
|
ConversionError StringToInt(const String &s, int &val, int def_val);
|
|
// Tries to convert whole string into float value;
|
|
// returns def_val on failure
|
|
float StringToFloat(const String &s, float def_val = 0.f);
|
|
|
|
// A simple unescape string implementation, unescapes '\\x' into '\x'.
|
|
String Unescape(const String &s);
|
|
// Converts a classic wildcard search pattern into C++11 compatible regex pattern
|
|
String WildcardToRegex(const String &wildcard);
|
|
|
|
// Serialize and unserialize unterminated string prefixed with 32-bit length;
|
|
// length is presented as 32-bit integer integer
|
|
String ReadString(Stream *in);
|
|
void ReadString(char *cstr, Stream *in, size_t buf_limit);
|
|
void ReadString(char **cstr, Stream *in);
|
|
void ReadString(String &s, Stream *in);
|
|
void SkipString(Stream *in);
|
|
void WriteString(const String &s, Stream *out);
|
|
void WriteString(const char *cstr, Stream *out);
|
|
void WriteString(const char *cstr, size_t len, Stream *out);
|
|
|
|
// Serialize and unserialize string as c-string (null-terminated sequence)
|
|
void ReadCStr(char *buf, Stream *in, size_t buf_limit);
|
|
// Reads a null-terminated string and !! mallocs !! a char buffer for it;
|
|
// returns nullptr if the read string is empty.
|
|
// Buffer is hard-limited to 1024 bytes, including null-terminator.
|
|
// Strictly for compatibility with the C lib code!
|
|
char * ReadMallocCStrOrNull(Stream *in);
|
|
void SkipCStr(Stream *in);
|
|
void WriteCStr(const char *cstr, Stream *out);
|
|
void WriteCStr(const String &s, Stream *out);
|
|
|
|
// Serialize and unserialize a string map, both keys and values are read using ReadString
|
|
void ReadStringMap(StringMap &map, Stream *in);
|
|
void WriteStringMap(const StringMap &map, Stream *out);
|
|
|
|
// Convert utf-8 string to ascii/ansi representation;
|
|
// writes into out_cstr buffer limited by out_sz bytes; returns bytes written.
|
|
size_t ConvertUtf8ToAscii(const char *mbstr, const char *loc_name, char *out_cstr, size_t out_sz);
|
|
// Convert utf-8 string to wide-string (16-bit char);
|
|
// writes into out_wcstr buffer limited by out_sz *wchars*; returns *wchars* written.
|
|
size_t ConvertUtf8ToWstr(const char *mbstr, wchar_t *out_wcstr, size_t out_sz);
|
|
// Convert wide-string to utf-8 string;
|
|
// writes into out_mbstr buffer limited by out_sz *bytes*; returns *bytes* written.
|
|
size_t ConvertWstrToUtf8(const wchar_t *wcstr, char *out_mbstr, size_t out_sz);
|
|
|
|
} // namespace StrUtil
|
|
} // namespace Shared
|
|
} // namespace AGS
|
|
} // namespace AGS3
|
|
|
|
#endif
|