1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/* 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)
//
// Reads a null-terminated string until getting a null-terminator.
// writes into the buffer up to the buf_limit.
// Note that this will keep reading the stream out until 0 is read,
// even if buffer is already full.
// Guarantees that output buffer will contain a null-terminator.
void ReadCStr(char *buf, Stream *in, size_t buf_limit);
// Reads N characters into the provided buffer.
// Guarantees that output buffer will contain a null-terminator.
void ReadCStrCount(char *buf, Stream *in, size_t count);
// 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
|
