OpenTTD Source  12.0-beta2
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) NOACCESS(3);
34 char *strecpy(char *dst, const char *src, const char *last) NOACCESS(3);
35 char *stredup(const char *src, const char *last = nullptr) NOACCESS(2);
36 
37 int CDECL seprintf(char *str, const char *last, const char *format, ...) WARN_FORMAT(3, 4) NOACCESS(2);
38 int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap) WARN_FORMAT(3, 0) NOACCESS(2);
39 
40 char *CDECL str_fmt(const char *str, ...) WARN_FORMAT(1, 2);
41 
42 void StrMakeValidInPlace(char *str, const char *last, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK) NOACCESS(2);
43 [[nodiscard]] std::string StrMakeValid(const std::string &str, StringValidationSettings settings = SVS_REPLACE_WITH_QUESTION_MARK);
45 
46 void str_fix_scc_encoded(char *str, const char *last) NOACCESS(2);
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) NOACCESS(2);
52 void StrTrimInPlace(std::string &str);
53 
54 bool StrStartsWith(const std::string_view str, const std::string_view prefix);
55 bool StrEndsWith(const std::string_view str, const std::string_view suffix);
56 
64 static inline bool StrEmpty(const char *s)
65 {
66  return s == nullptr || s[0] == '\0';
67 }
68 
76 static inline size_t ttd_strnlen(const char *str, size_t maxlen)
77 {
78  const char *t;
79  for (t = str; (size_t)(t - str) < maxlen && *t != '\0'; t++) {}
80  return t - str;
81 }
82 
83 char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);
84 
85 bool IsValidChar(WChar key, CharSetFilter afilter);
86 
87 size_t Utf8Decode(WChar *c, const char *s);
88 size_t Utf8Encode(char *buf, WChar c);
89 size_t Utf8Encode(std::ostreambuf_iterator<char> &buf, WChar c);
90 size_t Utf8TrimString(char *s, size_t maxlen);
91 
92 
93 static inline WChar Utf8Consume(const char **s)
94 {
95  WChar c;
96  *s += Utf8Decode(&c, *s);
97  return c;
98 }
99 
100 template <class Titr>
101 static inline WChar Utf8Consume(Titr &s)
102 {
103  WChar c;
104  s += Utf8Decode(&c, &*s);
105  return c;
106 }
107 
113 static inline int8 Utf8CharLen(WChar c)
114 {
115  if (c < 0x80) return 1;
116  if (c < 0x800) return 2;
117  if (c < 0x10000) return 3;
118  if (c < 0x110000) return 4;
119 
120  /* Invalid valid, we encode as a '?' */
121  return 1;
122 }
123 
124 
132 static inline int8 Utf8EncodedCharLen(char c)
133 {
134  if (GB(c, 3, 5) == 0x1E) return 4;
135  if (GB(c, 4, 4) == 0x0E) return 3;
136  if (GB(c, 5, 3) == 0x06) return 2;
137  if (GB(c, 7, 1) == 0x00) return 1;
138 
139  /* Invalid UTF8 start encoding */
140  return 0;
141 }
142 
143 
144 /* Check if the given character is part of a UTF8 sequence */
145 static inline bool IsUtf8Part(char c)
146 {
147  return GB(c, 6, 2) == 2;
148 }
149 
157 static inline char *Utf8PrevChar(char *s)
158 {
159  char *ret = s;
160  while (IsUtf8Part(*--ret)) {}
161  return ret;
162 }
163 
164 static inline const char *Utf8PrevChar(const char *s)
165 {
166  const char *ret = s;
167  while (IsUtf8Part(*--ret)) {}
168  return ret;
169 }
170 
171 size_t Utf8StringLength(const char *s);
172 size_t Utf8StringLength(const std::string &str);
173 
179 static inline bool Utf16IsLeadSurrogate(uint c)
180 {
181  return c >= 0xD800 && c <= 0xDBFF;
182 }
183 
189 static inline bool Utf16IsTrailSurrogate(uint c)
190 {
191  return c >= 0xDC00 && c <= 0xDFFF;
192 }
193 
200 static inline WChar Utf16DecodeSurrogate(uint lead, uint trail)
201 {
202  return 0x10000 + (((lead - 0xD800) << 10) | (trail - 0xDC00));
203 }
204 
210 static inline WChar Utf16DecodeChar(const uint16 *c)
211 {
212  if (Utf16IsLeadSurrogate(c[0])) {
213  return Utf16DecodeSurrogate(c[0], c[1]);
214  } else {
215  return *c;
216  }
217 }
218 
225 static inline bool IsTextDirectionChar(WChar c)
226 {
227  switch (c) {
228  case CHAR_TD_LRM:
229  case CHAR_TD_RLM:
230  case CHAR_TD_LRE:
231  case CHAR_TD_RLE:
232  case CHAR_TD_LRO:
233  case CHAR_TD_RLO:
234  case CHAR_TD_PDF:
235  return true;
236 
237  default:
238  return false;
239  }
240 }
241 
242 static inline bool IsPrintable(WChar c)
243 {
244  if (c < 0x20) return false;
245  if (c < 0xE000) return true;
246  if (c < 0xE200) return false;
247  return true;
248 }
249 
257 static inline bool IsWhitespace(WChar c)
258 {
259  return c == 0x0020 /* SPACE */ || c == 0x3000; /* IDEOGRAPHIC SPACE */
260 }
261 
262 /* Needed for NetBSD version (so feature) testing */
263 #if defined(__NetBSD__) || defined(__FreeBSD__)
264 #include <sys/param.h>
265 #endif
266 
267 /* strcasestr is available for _GNU_SOURCE, BSD and some Apple */
268 #if defined(_GNU_SOURCE) || (defined(__BSD_VISIBLE) && __BSD_VISIBLE) || (defined(__APPLE__) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))) || defined(_NETBSD_SOURCE)
269 # undef DEFINE_STRCASESTR
270 #else
271 # define DEFINE_STRCASESTR
272 char *strcasestr(const char *haystack, const char *needle);
273 #endif /* strcasestr is available */
274 
275 int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front = false);
276 
277 #endif /* STRING_FUNC_H */
strecat
char * strecat(char *dst, const char *src, const char *last) NOACCESS(3)
Appends characters from one string to another.
Definition: string.cpp:84
Utf8Decode
size_t Utf8Decode(WChar *c, const char *s)
Decode and consume the next UTF-8 encoded character.
Definition: string.cpp:574
stredup
char * stredup(const char *src, const char *last=nullptr) NOACCESS(2)
Create a duplicate of the given string.
Definition: string.cpp:137
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
StrTrimInPlace
void StrTrimInPlace(std::string &str)
Trim the spaces from given string in place, i.e.
Definition: string.cpp:355
Utf8CharLen
static int8 Utf8CharLen(WChar c)
Return the length of a UTF-8 encoded character.
Definition: string_func.h:113
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:616
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:718
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:210
StrMakeValidInPlace
char *CDECL void StrMakeValidInPlace(char *str, const char *last, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK) NOACCESS(2)
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
Definition: string.cpp:255
StrValid
bool StrValid(const char *str, const char *last) NOACCESS(2)
Checks whether the given string is valid, i.e.
Definition: string.cpp:300
StrStartsWith
bool StrStartsWith(const std::string_view str, const std::string_view prefix)
Check whether the given string starts with the given prefix.
Definition: string.cpp:367
Utf8TrimString
size_t Utf8TrimString(char *s, size_t maxlen)
Properly terminate an UTF8 string to some maximum length.
Definition: string.cpp:660
StrEndsWith
bool StrEndsWith(const std::string_view str, const std::string_view suffix)
Check whether the given string ends with the given suffix.
Definition: string.cpp:380
IsValidChar
bool IsValidChar(WChar key, CharSetFilter afilter)
Only allow certain keys.
Definition: string.cpp:476
strtolower
bool strtolower(char *str)
Convert a given ASCII string to lowercase.
Definition: string.cpp:447
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:200
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:417
md5sumToString
char * md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
Convert the md5sum to a hexadecimal string representation.
Definition: string.cpp:553
Utf16IsLeadSurrogate
static bool Utf16IsLeadSurrogate(uint c)
Is the given character a lead surrogate code point?
Definition: string_func.h:179
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:76
StrEmpty
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:64
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:389
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) NOACCESS(3)
Copies characters from one buffer to another.
Definition: string.cpp:112
StrMakeValid
std::string StrMakeValid(const std::string &str, StringValidationSettings settings=SVS_REPLACE_WITH_QUESTION_MARK)
Scans the string for invalid characters and replaces then with a question mark '?' (if not ignored).
Definition: string.cpp:281
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:535
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:257
str_fix_scc_encoded
void str_fix_scc_encoded(char *str, const char *last) NOACCESS(2)
Scan the string for old values of SCC_ENCODED and fix it to it's new, static value.
Definition: string.cpp:169
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:189
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:225
Utf8PrevChar
static char * Utf8PrevChar(char *s)
Retrieve the previous UNICODE character in an UTF-8 encoded string.
Definition: string_func.h:157
Utf8EncodedCharLen
static int8 Utf8EncodedCharLen(char c)
Return the length of an UTF-8 encoded value based on a single char.
Definition: string_func.h:132