OpenTTD Source: src/string_func.h Source File

OpenTTD Source 1.11.0-RC1

string_func.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
24 #ifndef STRING_FUNC_H
25 #define STRING_FUNC_H
26
27 #include <stdarg.h>
28 #include <iosfwd>
29
30 #include "core/bitmath_func.hpp"
31 #include "string_type.h"
32
33 char *strecat(char *dst, const char *src, const char *last);
34 char *strecpy(char *dst, const char *src, const char *last);
35 char *stredup(const char *src, const char *last = nullptr);
36
37 int CDECL seprintf(char *str, const char *last, const char *format, ...) WARN_FORMAT(3, 4);
38 int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap) WARN_FORMAT(3, 0);
39
40 char *CDECL str_fmt(const char *str, ...) WARN_FORMAT(1, 2);
41
42 void str_validate(char *str, const char *last, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
43 std::string str_validate(const std::string &str, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
44 void ValidateString(const char *str);
45
46 void str_fix_scc_encoded(char *str, const char *last);
47 void str_strip_colours(char *str);
48 bool strtolower(char *str);
49 bool strtolower(std::string &str, std::string::size_type offs = 0);
50
51 bool StrValid(const char *str, const char *last);
52
60 static inline bool StrEmpty(const char *s)
61 {
62 return s == nullptr || s[0] == '\0';
63 }
64
72 static inline size_t ttd_strnlen(const char *str, size_t maxlen)
73 {
74 const char *t;
75 for (t = str; (size_t)(t - str) < maxlen && *t != '\0'; t++) {}
76 return t - str;
77 }
78
79 char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);
80
81 bool IsValidChar(WChar key, CharSetFilter afilter);
82
83 size_t Utf8Decode(WChar *c, const char *s);
84 size_t Utf8Encode(char *buf, WChar c);
85 size_t Utf8Encode(std::ostreambuf_iterator<char> &buf, WChar c);
86 size_t Utf8TrimString(char *s, size_t maxlen);
87
88
89 static inline WChar Utf8Consume(const char **s)
90 {
91 WChar c;
92 *s += Utf8Decode(&c, *s);
93 return c;
94 }
95
96 template <class Titr>
97 static inline WChar Utf8Consume(Titr &s)
98 {
99 WChar c;
100 s += Utf8Decode(&c, &*s);
101 return c;
102 }
103
109 static inline int8 Utf8CharLen(WChar c)
110 {
111 if (c < 0x80) return 1;
112 if (c < 0x800) return 2;
113 if (c < 0x10000) return 3;
114 if (c < 0x110000) return 4;
115
116 /* Invalid valid, we encode as a '?' */
117 return 1;
118 }
119
120
128 static inline int8 Utf8EncodedCharLen(char c)
129 {
130 if (GB(c, 3, 5) == 0x1E) return 4;
131 if (GB(c, 4, 4) == 0x0E) return 3;
132 if (GB(c, 5, 3) == 0x06) return 2;
133 if (GB(c, 7, 1) == 0x00) return 1;
134
135 /* Invalid UTF8 start encoding */
136 return 0;
137 }
138
139
140 /* Check if the given character is part of a UTF8 sequence */
141 static inline bool IsUtf8Part(char c)
142 {
143 return GB(c, 6, 2) == 2;
144 }
145
153 static inline char *Utf8PrevChar(char *s)
154 {
155 char *ret = s;
156 while (IsUtf8Part(*--ret)) {}
157 return ret;
158 }
159
160 static inline const char *Utf8PrevChar(const char *s)
161 {
162 const char *ret = s;
163 while (IsUtf8Part(*--ret)) {}
164 return ret;
165 }
166
167 size_t Utf8StringLength(const char *s);
168
174 static inline bool Utf16IsLeadSurrogate(uint c)
175 {
176 return c >= 0xD800 && c <= 0xDBFF;
177 }
178
184 static inline bool Utf16IsTrailSurrogate(uint c)
185 {
186 return c >= 0xDC00 && c <= 0xDFFF;
187 }
188
195 static inline WChar Utf16DecodeSurrogate(uint lead, uint trail)
196 {
197 return 0x10000 + (((lead - 0xD800) << 10) | (trail - 0xDC00));
198 }
199
205 static inline WChar Utf16DecodeChar(const uint16 *c)
206 {
207 if (Utf16IsLeadSurrogate(c[0])) {
208 return Utf16DecodeSurrogate(c[0], c[1]);
209 } else {
210 return *c;
211 }
212 }
213
220 static inline bool IsTextDirectionChar(WChar c)
221 {
222 switch (c) {
223 case CHAR_TD_LRM:
224 case CHAR_TD_RLM:
225 case CHAR_TD_LRE:
226 case CHAR_TD_RLE:
227 case CHAR_TD_LRO:
228 case CHAR_TD_RLO:
229 case CHAR_TD_PDF:
230 return true;
231
232 default:
233 return false;
234 }
235 }
236
237 static inline bool IsPrintable(WChar c)
238 {
239 if (c < 0x20) return false;
240 if (c < 0xE000) return true;
241 if (c < 0xE200) return false;
242 return true;
243 }
244
252 static inline bool IsWhitespace(WChar c)
253 {
254 return c == 0x0020 /* SPACE */ || c == 0x3000; /* IDEOGRAPHIC SPACE */
255 }
256
257 /* Needed for NetBSD version (so feature) testing */
258 #if defined(__NetBSD__) || defined(__FreeBSD__)
259 #include <sys/param.h>
260 #endif
261
262 /* strcasestr is available for _GNU_SOURCE, BSD and some Apple */
263 #if defined(_GNU_SOURCE) || (defined(__BSD_VISIBLE) && __BSD_VISIBLE) || (defined(__APPLE__) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))) || defined(_NETBSD_SOURCE)
264 # undef DEFINE_STRCASESTR
265 #else
266 # define DEFINE_STRCASESTR
267 char *strcasestr(const char *haystack, const char *needle);
268 #endif /* strcasestr is available */
269
270 int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front = false);
271
272 #endif /* STRING_FUNC_H */
Utf8Decode
size_t Utf8Decode(WChar *c, const char *s)
Decode and consume the next UTF-8 encoded character.
Definition: string.cpp:481
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
str_fix_scc_encoded
void str_fix_scc_encoded(char *str, const char *last)
Scan the string for old values of SCC_ENCODED and fix it to it's new, static value.
Definition: string.cpp:169
Utf8CharLen
static int8 Utf8CharLen(WChar c)
Return the length of a UTF-8 encoded character.
Definition: string_func.h:109
CHAR_TD_LRO
static const WChar CHAR_TD_LRO
Force the following characters to be treated as left-to-right characters.
Definition: string_type.h:43
Utf8Encode
size_t Utf8Encode(T buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:523
strnatcmp
int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front=false)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:625
CHAR_TD_RLO
static const WChar CHAR_TD_RLO
Force the following characters to be treated as right-to-left characters.
Definition: string_type.h:44
Utf16DecodeChar
static WChar Utf16DecodeChar(const uint16 *c)
Decode an UTF-16 character.
Definition: string_func.h:205
ValidateString
void ValidateString(const char *str)
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mar...
Definition: string.cpp:267
Utf8TrimString
size_t Utf8TrimString(char *s, size_t maxlen)
Properly terminate an UTF8 string to some maximum length.
Definition: string.cpp:567
IsValidChar
bool IsValidChar(WChar key, CharSetFilter afilter)
Only allow certain keys.
Definition: string.cpp:383
strtolower
bool strtolower(char *str)
Convert a given ASCII string to lowercase.
Definition: string.cpp:354
CHAR_TD_RLE
static const WChar CHAR_TD_RLE
The following text is embedded right-to-left.
Definition: string_type.h:42
Utf16DecodeSurrogate
static WChar Utf16DecodeSurrogate(uint lead, uint trail)
Convert an UTF-16 surrogate pair to the corresponding Unicode character.
Definition: string_func.h:195
str_validate
int CDECL int CDECL char *CDECL void str_validate(char *str, const char *last, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK)
Scans the string for valid characters and if it finds invalid ones, replaces them with a question mar...
Definition: string.cpp:237
bitmath_func.hpp
CHAR_TD_PDF
static const WChar CHAR_TD_PDF
Restore the text-direction state to before the last LRE, RLE, LRO or RLO.
Definition: string_type.h:45
CHAR_TD_LRE
static const WChar CHAR_TD_LRE
The following text is embedded left-to-right.
Definition: string_type.h:41
Utf8StringLength
size_t Utf8StringLength(const char *s)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition: string.cpp:334
StrValid
bool StrValid(const char *str, const char *last)
Checks whether the given string is valid, i.e.
Definition: string.cpp:281
md5sumToString
char * md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
Convert the md5sum to a hexadecimal string representation.
Definition: string.cpp:460
Utf16IsLeadSurrogate
static bool Utf16IsLeadSurrogate(uint c)
Is the given character a lead surrogate code point?
Definition: string_func.h:174
CHAR_TD_RLM
static const WChar CHAR_TD_RLM
The next character acts like a right-to-left character.
Definition: string_type.h:40
ttd_strnlen
static size_t ttd_strnlen(const char *str, size_t maxlen)
Get the length of a string, within a limited buffer.
Definition: string_func.h:72
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:60
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
vseprintf
int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap)
Safer implementation of vsnprintf; same as vsnprintf except:
Definition: string.cpp:61
str_strip_colours
void str_strip_colours(char *str)
Scans the string for colour codes and strips them.
Definition: string.cpp:306
string_type.h
StringValidationSettings
StringValidationSettings
Settings for the string validation.
Definition: string_type.h:48
strecpy
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: string.cpp:112
str_fmt
char *CDECL str_fmt(const char *str,...)
Format, "printf", into a newly allocated string.
Definition: string.cpp:150
seprintf
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:442
stredup
char * stredup(const char *src, const char *last=nullptr)
Create a duplicate of the given string.
Definition: string.cpp:137
CHAR_TD_LRM
static const WChar CHAR_TD_LRM
The next character acts like a left-to-right character.
Definition: string_type.h:39
IsWhitespace
static bool IsWhitespace(WChar c)
Check whether UNICODE character is whitespace or not, i.e.
Definition: string_func.h:252
SVS_REPLACE_WITH_QUESTION_MARK
@ SVS_REPLACE_WITH_QUESTION_MARK
Replace the unknown/bad bits with question marks.
Definition: string_type.h:50
Utf16IsTrailSurrogate
static bool Utf16IsTrailSurrogate(uint c)
Is the given character a lead surrogate code point?
Definition: string_func.h:184
CharSetFilter
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
IsTextDirectionChar
static bool IsTextDirectionChar(WChar c)
Is the given character a text direction character.
Definition: string_func.h:220
Utf8PrevChar
static char * Utf8PrevChar(char *s)
Retrieve the previous UNICODE character in an UTF-8 encoded string.
Definition: string_func.h:153
Utf8EncodedCharLen
static int8 Utf8EncodedCharLen(char c)
Return the length of an UTF-8 encoded value based on a single char.
Definition: string_func.h:128
strecat
char * strecat(char *dst, const char *src, const char *last)
Appends characters from one string to another.
Definition: string.cpp:84