OpenTTD
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 
29 #include "core/bitmath_func.hpp"
30 #include "string_type.h"
31 
32 char *strecat(char *dst, const char *src, const char *last);
33 char *strecpy(char *dst, const char *src, const char *last);
34 char *stredup(const char *src, const char *last = nullptr);
35 
36 int CDECL seprintf(char *str, const char *last, const char *format, ...) WARN_FORMAT(3, 4);
37 int CDECL vseprintf(char *str, const char *last, const char *format, va_list ap);
38 
39 char *CDECL str_fmt(const char *str, ...) WARN_FORMAT(1, 2);
40 
42 void ValidateString(const char *str);
43 
44 void str_fix_scc_encoded(char *str, const char *last);
45 void str_strip_colours(char *str);
46 bool strtolower(char *str);
47 
48 bool StrValid(const char *str, const char *last);
49 
57 static inline bool StrEmpty(const char *s)
58 {
59  return s == nullptr || s[0] == '\0';
60 }
61 
69 static inline size_t ttd_strnlen(const char *str, size_t maxlen)
70 {
71  const char *t;
72  for (t = str; (size_t)(t - str) < maxlen && *t != '\0'; t++) {}
73  return t - str;
74 }
75 
76 char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);
77 
78 bool IsValidChar(WChar key, CharSetFilter afilter);
79 
80 size_t Utf8Decode(WChar *c, const char *s);
81 size_t Utf8Encode(char *buf, WChar c);
82 size_t Utf8TrimString(char *s, size_t maxlen);
83 
84 
85 static inline WChar Utf8Consume(const char **s)
86 {
87  WChar c;
88  *s += Utf8Decode(&c, *s);
89  return c;
90 }
91 
97 static inline int8 Utf8CharLen(WChar c)
98 {
99  if (c < 0x80) return 1;
100  if (c < 0x800) return 2;
101  if (c < 0x10000) return 3;
102  if (c < 0x110000) return 4;
103 
104  /* Invalid valid, we encode as a '?' */
105  return 1;
106 }
107 
108 
116 static inline int8 Utf8EncodedCharLen(char c)
117 {
118  if (GB(c, 3, 5) == 0x1E) return 4;
119  if (GB(c, 4, 4) == 0x0E) return 3;
120  if (GB(c, 5, 3) == 0x06) return 2;
121  if (GB(c, 7, 1) == 0x00) return 1;
122 
123  /* Invalid UTF8 start encoding */
124  return 0;
125 }
126 
127 
128 /* Check if the given character is part of a UTF8 sequence */
129 static inline bool IsUtf8Part(char c)
130 {
131  return GB(c, 6, 2) == 2;
132 }
133 
141 static inline char *Utf8PrevChar(char *s)
142 {
143  char *ret = s;
144  while (IsUtf8Part(*--ret)) {}
145  return ret;
146 }
147 
148 static inline const char *Utf8PrevChar(const char *s)
149 {
150  const char *ret = s;
151  while (IsUtf8Part(*--ret)) {}
152  return ret;
153 }
154 
155 size_t Utf8StringLength(const char *s);
156 
162 static inline bool Utf16IsLeadSurrogate(uint c)
163 {
164  return c >= 0xD800 && c <= 0xDBFF;
165 }
166 
172 static inline bool Utf16IsTrailSurrogate(uint c)
173 {
174  return c >= 0xDC00 && c <= 0xDFFF;
175 }
176 
183 static inline WChar Utf16DecodeSurrogate(uint lead, uint trail)
184 {
185  return 0x10000 + (((lead - 0xD800) << 10) | (trail - 0xDC00));
186 }
187 
193 static inline WChar Utf16DecodeChar(const uint16 *c)
194 {
195  if (Utf16IsLeadSurrogate(c[0])) {
196  return Utf16DecodeSurrogate(c[0], c[1]);
197  } else {
198  return *c;
199  }
200 }
201 
208 static inline bool IsTextDirectionChar(WChar c)
209 {
210  switch (c) {
211  case CHAR_TD_LRM:
212  case CHAR_TD_RLM:
213  case CHAR_TD_LRE:
214  case CHAR_TD_RLE:
215  case CHAR_TD_LRO:
216  case CHAR_TD_RLO:
217  case CHAR_TD_PDF:
218  return true;
219 
220  default:
221  return false;
222  }
223 }
224 
225 static inline bool IsPrintable(WChar c)
226 {
227  if (c < 0x20) return false;
228  if (c < 0xE000) return true;
229  if (c < 0xE200) return false;
230  return true;
231 }
232 
240 static inline bool IsWhitespace(WChar c)
241 {
242  return c == 0x0020 /* SPACE */ || c == 0x3000; /* IDEOGRAPHIC SPACE */
243 }
244 
245 /* Needed for NetBSD version (so feature) testing */
246 #if defined(__NetBSD__) || defined(__FreeBSD__)
247 #include <sys/param.h>
248 #endif
249 
250 /* strcasestr is available for _GNU_SOURCE, BSD and some Apple */
251 #if defined(_GNU_SOURCE) || (defined(__BSD_VISIBLE) && __BSD_VISIBLE) || (defined(__APPLE__) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))) || defined(_NETBSD_SOURCE)
252 # undef DEFINE_STRCASESTR
253 #else
254 # define DEFINE_STRCASESTR
255 char *strcasestr(const char *haystack, const char *needle);
256 #endif /* strcasestr is available */
257 
258 int strnatcmp(const char *s1, const char *s2, bool ignore_garbage_at_front = false);
259 
260 #endif /* STRING_FUNC_H */
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:310
char *CDECL str_fmt(const char *str,...)
Format, "printf", into a newly allocated string.
Definition: string.cpp:149
static const WChar CHAR_TD_LRM
The next character acts like a left-to-right character.
Definition: string_type.h:39
bool IsValidChar(WChar key, CharSetFilter afilter)
Only allow certain keys.
Definition: string.cpp:348
static const WChar CHAR_TD_LRE
The following text is embedded left-to-right.
Definition: string_type.h:41
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:407
char * md5sumToString(char *buf, const char *last, const uint8 md5sum[16])
Convert the md5sum to a hexadecimal string representation.
Definition: string.cpp:425
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:20
static bool IsWhitespace(WChar c)
Check whether UNICODE character is whitespace or not, i.e.
Definition: string_func.h:240
char * strecpy(char *dst, const char *src, const char *last)
Copies characters from one buffer to another.
Definition: depend.cpp:66
static bool IsTextDirectionChar(WChar c)
Is the given character a text direction character.
Definition: string_func.h:208
char * strecat(char *dst, const char *src, const char *last)
Appends characters from one string to another.
Definition: string.cpp:83
Functions related to bit mathematics.
StringValidationSettings
Settings for the string validation.
Definition: string_type.h:48
static int8 Utf8EncodedCharLen(char c)
Return the length of an UTF-8 encoded value based on a single char.
Definition: string_func.h:116
size_t Utf8Decode(WChar *c, const char *s)
Decode and consume the next UTF-8 encoded character.
Definition: string.cpp:446
static WChar Utf16DecodeChar(const uint16 *c)
Decode an UTF-16 character.
Definition: string_func.h:193
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:243
size_t Utf8TrimString(char *s, size_t maxlen)
Properly terminate an UTF8 string to some maximum length.
Definition: string.cpp:520
bool strtolower(char *str)
Convert a given ASCII string to lowercase.
Definition: string.cpp:330
static int8 Utf8CharLen(WChar c)
Return the length of a UTF-8 encoded character.
Definition: string_func.h:97
int CDECL 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:60
static const WChar CHAR_TD_RLE
The following text is embedded right-to-left.
Definition: string_type.h:42
CharSetFilter
Valid filter types for IsValidChar.
Definition: string_type.h:26
static WChar Utf16DecodeSurrogate(uint lead, uint trail)
Convert an UTF-16 surrogate pair to the corresponding Unicode character.
Definition: string_func.h:183
size_t Utf8Encode(char *buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:486
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
static bool Utf16IsTrailSurrogate(uint c)
Is the given character a lead surrogate code point?
Definition: string_func.h:172
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:194
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:69
static bool StrEmpty(const char *s)
Check if a string buffer is empty.
Definition: string_func.h:57
void str_strip_colours(char *str)
Scans the string for colour codes and strips them.
Definition: string.cpp:282
Replace the unknown/bad bits with question marks.
Definition: string_type.h:50
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
static const WChar CHAR_TD_RLM
The next character acts like a right-to-left character.
Definition: string_type.h:40
static char * Utf8PrevChar(char *s)
Retrieve the previous UNICODE character in an UTF-8 encoded string.
Definition: string_func.h:141
bool StrValid(const char *str, const char *last)
Checks whether the given string is valid, i.e.
Definition: string.cpp:257
static bool Utf16IsLeadSurrogate(uint c)
Is the given character a lead surrogate code point?
Definition: string_func.h:162
Types for strings.
void str_fix_scc_encoded(char *str, const char *last)
Scan the string for old values of SCC_ENCODED and fix it to it&#39;s new, static value.
Definition: string.cpp:168
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
static const WChar CHAR_TD_LRO
Force the following characters to be treated as left-to-right characters.
Definition: string_type.h:43
static const WChar CHAR_TD_RLO
Force the following characters to be treated as right-to-left characters.
Definition: string_type.h:44
char * stredup(const char *src, const char *last=nullptr)
Create a duplicate of the given string.
Definition: string.cpp:136
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:578