3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef UTIL_STRING_HEADER
21 #define UTIL_STRING_HEADER
23 #include "irrlichttypes_bloated.h"
32 #define STRINGIFY(x) #x
33 #define TOSTRING(x) STRINGIFY(x)
35 // Checks whether a byte is an inner byte for an utf-8 multibyte sequence
36 #define IS_UTF8_MULTB_INNER(x) (((unsigned char)x >= 0x80) && ((unsigned char)x < 0xc0))
38 typedef std::map<std::string, std::string> StringMap;
45 // try not to convert between wide/utf8 encodings; this can result in data loss
46 // try to only convert between them when you need to input/output stuff via Irrlicht
47 std::wstring utf8_to_wide(const std::string &input);
48 std::string wide_to_utf8(const std::wstring &input);
50 // NEVER use those two functions unless you have a VERY GOOD reason to
51 // they just convert between wide and multibyte encoding
52 // multibyte encoding depends on current locale, this is no good, especially on Windows
54 // You must free the returned string!
55 // The returned string is allocated using new
56 wchar_t *narrow_to_wide_c(const char *str);
57 std::wstring narrow_to_wide(const std::string &mbs);
58 std::string wide_to_narrow(const std::wstring &wcs);
60 std::string urlencode(std::string str);
61 std::string urldecode(std::string str);
62 u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask);
63 std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask);
64 size_t mystrlcpy(char *dst, const char *src, size_t size);
65 char *mystrtok_r(char *s, const char *sep, char **lasts);
66 u64 read_seed(const char *str);
67 bool parseColorString(const std::string &value, video::SColor &color, bool quiet);
71 * Returns a copy of \p str with spaces inserted at the right hand side to ensure
72 * that the string is \p len characters in length. If \p str is <= \p len then the
73 * returned string will be identical to str.
75 inline std::string padStringRight(std::string str, size_t len)
78 str.insert(str.end(), len - str.size(), ' ');
84 * Returns a version of \p str with the first occurrence of a string
85 * contained within ends[] removed from the end of the string.
88 * @param ends A NULL- or ""- terminated array of strings to remove from s in
89 * the copy produced. Note that once one of these strings is removed
90 * that no further postfixes contained within this array are removed.
92 * @return If no end could be removed then "" is returned.
94 inline std::string removeStringEnd(const std::string &str,
97 const char **p = ends;
99 for (; *p && (*p)[0] != '\0'; p++) {
100 std::string end = *p;
101 if (str.size() < end.size())
103 if (str.compare(str.size() - end.size(), end.size(), end) == 0)
104 return str.substr(0, str.size() - end.size());
112 * Check two strings for equivalence. If \p case_insensitive is true
113 * then the case of the strings is ignored (default is false).
117 * @param case_insensitive
118 * @return true if the strings match
120 template <typename T>
121 inline bool str_equal(const std::basic_string<T> &s1,
122 const std::basic_string<T> &s2,
123 bool case_insensitive = false)
125 if (!case_insensitive)
128 if (s1.size() != s2.size())
131 for (size_t i = 0; i < s1.size(); ++i)
132 if(tolower(s1[i]) != tolower(s2[i]))
140 * Check whether \p str begins with the string prefix. If \p case_insensitive
141 * is true then the check is case insensitve (default is false; i.e. case is
146 * @param case_insensitive
147 * @return true if the str begins with prefix
149 template <typename T>
150 inline bool str_starts_with(const std::basic_string<T> &str,
151 const std::basic_string<T> &prefix,
152 bool case_insensitive = false)
154 if (str.size() < prefix.size())
157 if (!case_insensitive)
158 return str.compare(0, prefix.size(), prefix) == 0;
160 for (size_t i = 0; i < prefix.size(); ++i)
161 if (tolower(str[i]) != tolower(prefix[i]))
167 * Check whether \p str begins with the string prefix. If \p case_insensitive
168 * is true then the check is case insensitve (default is false; i.e. case is
173 * @param case_insensitive
174 * @return true if the str begins with prefix
176 template <typename T>
177 inline bool str_starts_with(const std::basic_string<T> &str,
179 bool case_insensitive = false)
181 return str_starts_with(str, std::basic_string<T>(prefix),
186 * Splits a string into its component parts separated by the character
189 * @return An std::vector<std::basic_string<T> > of the component parts
191 template <typename T>
192 inline std::vector<std::basic_string<T> > str_split(
193 const std::basic_string<T> &str,
196 std::vector<std::basic_string<T> > parts;
197 std::basic_stringstream<T> sstr(str);
198 std::basic_string<T> part;
200 while (std::getline(sstr, part, delimiter))
201 parts.push_back(part);
209 * @return A copy of \p str converted to all lowercase characters.
211 inline std::string lowercase(const std::string &str)
215 s2.reserve(str.size());
217 for (size_t i = 0; i < str.size(); i++)
218 s2 += tolower(str[i]);
226 * @return A copy of \p str with leading and trailing whitespace removed.
228 inline std::string trim(const std::string &str)
232 while (std::isspace(str[front]))
235 size_t back = str.size();
236 while (back > front && std::isspace(str[back - 1]))
239 return str.substr(front, back - front);
244 * Returns whether \p str should be regarded as (bool) true. Case and leading
245 * and trailing whitespace are ignored. Values that will return
246 * true are "y", "yes", "true" and any number that is not 0.
249 inline bool is_yes(const std::string &str)
251 std::string s2 = lowercase(trim(str));
253 return s2 == "y" || s2 == "yes" || s2 == "true" || atoi(s2.c_str()) != 0;
258 * Converts the string \p str to a signed 32-bit integer. The converted value
259 * is constrained so that min <= value <= max.
261 * @see atoi(3) for limitations
264 * @param min Range minimum
265 * @param max Range maximum
266 * @return The value converted to a signed 32-bit integer and constrained
267 * within the range defined by min and max (inclusive)
269 inline s32 mystoi(const std::string &str, s32 min, s32 max)
271 s32 i = atoi(str.c_str());
282 /// Returns a 64-bit value represented by the string \p str (decimal).
283 inline s64 stoi64(const std::string &str)
285 std::stringstream tmp(str);
291 // MSVC2010 includes it's own versions of these
292 //#if !defined(_MSC_VER) || _MSC_VER < 1600
296 * Returns a 32-bit value reprensented by the string \p str (decimal).
297 * @see atoi(3) for further limitations
299 inline s32 mystoi(const std::string &str)
301 return atoi(str.c_str());
306 * Returns s 32-bit value represented by the wide string \p str (decimal).
307 * @see atoi(3) for further limitations
309 inline s32 mystoi(const std::wstring &str)
311 return mystoi(wide_to_narrow(str));
316 * Returns a float reprensented by the string \p str (decimal).
319 inline float mystof(const std::string &str)
321 return atof(str.c_str());
329 // TODO: Replace with C++11 std::to_string.
331 /// Returns A string representing the value \p val.
332 template <typename T>
333 inline std::string to_string(T val)
335 std::ostringstream oss;
340 /// Returns a string representing the decimal value of the 32-bit value \p i.
341 inline std::string itos(s32 i) { return to_string(i); }
342 /// Returns a string representing the decimal value of the 64-bit value \p i.
343 inline std::string i64tos(s64 i) { return to_string(i); }
344 /// Returns a string representing the decimal value of the float value \p f.
345 inline std::string ftos(float f) { return to_string(f); }
349 * Replace all occurrences of \p pattern in \p str with \p replacement.
351 * @param str String to replace pattern with replacement within.
352 * @param pattern The pattern to replace.
353 * @param replacement What to replace the pattern with.
355 inline void str_replace(std::string &str, const std::string &pattern,
356 const std::string &replacement)
358 std::string::size_type start = str.find(pattern, 0);
359 while (start != str.npos) {
360 str.replace(start, pattern.size(), replacement);
361 start = str.find(pattern, start + replacement.size());
367 * Replace all occurrences of the character \p from in \p str with \p to.
369 * @param str The string to (potentially) modify.
370 * @param from The character in str to replace.
371 * @param to The replacement character.
373 void str_replace(std::string &str, char from, char to);
377 * Check that a string only contains whitelisted characters. This is the
378 * opposite of string_allowed_blacklist().
380 * @param str The string to be checked.
381 * @param allowed_chars A string containing permitted characters.
382 * @return true if the string is allowed, otherwise false.
384 * @see string_allowed_blacklist()
386 inline bool string_allowed(const std::string &str, const std::string &allowed_chars)
388 return str.find_first_not_of(allowed_chars) == str.npos;
393 * Check that a string contains no blacklisted characters. This is the
394 * opposite of string_allowed().
396 * @param str The string to be checked.
397 * @param blacklisted_chars A string containing prohibited characters.
398 * @return true if the string is allowed, otherwise false.
400 * @see string_allowed()
402 inline bool string_allowed_blacklist(const std::string &str,
403 const std::string &blacklisted_chars)
405 return str.find_first_of(blacklisted_chars) == str.npos;
410 * Create a string based on \p from where a newline is forcefully inserted
411 * every \p row_len characters.
413 * @note This function does not honour word wraps and blindy inserts a newline
414 * every \p row_len characters whether it breaks a word or not. It is
415 * intended to be used for, for example, showing paths in the GUI.
417 * @note This function doesn't wrap inside utf-8 multibyte sequences and also
418 * counts multibyte sequences correcly as single characters.
420 * @param from The (utf-8) string to be wrapped into rows.
421 * @param row_len The row length (in characters).
422 * @return A new string with the wrapping applied.
424 inline std::string wrap_rows(const std::string &from,
429 size_t character_idx = 0;
430 for (size_t i = 0; i < from.size(); i++) {
431 if (!IS_UTF8_MULTB_INNER(from[i])) {
432 // Wrap string after last inner byte of char
433 if (character_idx > 0 && character_idx % row_len == 0)
445 * Removes backslashes from an escaped string (FormSpec strings)
447 template <typename T>
448 inline std::basic_string<T> unescape_string(std::basic_string<T> &s)
450 std::basic_string<T> res;
452 for (size_t i = 0; i < s.length(); i++) {
466 * Checks that all characters in \p to_check are a decimal digits.
469 * @return true if to_check is not empty and all characters in to_check are
470 * decimal digits, otherwise false
472 inline bool is_number(const std::string &to_check)
474 for (size_t i = 0; i < to_check.size(); i++)
475 if (!std::isdigit(to_check[i]))
478 return !to_check.empty();
483 * Returns a C-string, either "true" or "false", corresponding to \p val.
485 * @return If \p val is true, then "true" is returned, otherwise "false".
487 inline const char *bool_to_cstr(bool val)
489 return val ? "true" : "false";