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"
31 #define STRINGIFY(x) #x
32 #define TOSTRING(x) STRINGIFY(x)
39 // You must free the returned string!
40 const wchar_t *narrow_to_wide_c(const char *mbs);
42 std::wstring narrow_to_wide(const std::string& mbs);
43 std::string wide_to_narrow(const std::wstring& wcs);
44 std::string translatePassword(std::string playername, std::wstring password);
45 std::string urlencode(std::string str);
46 std::string urldecode(std::string str);
47 u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask);
48 std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask);
49 size_t mystrlcpy(char *dst, const char *src, size_t size);
50 char *mystrtok_r(char *s, const char *sep, char **lasts);
51 u64 read_seed(const char *str);
52 bool parseColorString(const std::string &value, video::SColor &color, bool quiet);
56 * Returns a copy of \p str with spaces inserted at the right hand side to ensure
57 * that the string is \p len characters in length. If \p str is <= \p len then the
58 * returned string will be identical to str.
60 inline std::string padStringRight(std::string str, size_t len)
63 str.insert(str.end(), len - str.size(), ' ');
69 * Returns a version of \p str with the first occurrence of a string
70 * contained within ends[] removed from the end of the string.
73 * @param ends A NULL- or ""- terminated array of strings to remove from s in
74 * the copy produced. Note that once one of these strings is removed
75 * that no further postfixes contained within this array are removed.
77 * @return If no end could be removed then "" is returned.
79 inline std::string removeStringEnd(const std::string &str,
82 const char **p = ends;
84 for (; *p && (*p)[0] != '\0'; p++) {
86 if (str.size() < end.size())
88 if (str.compare(str.size() - end.size(), end.size(), end) == 0)
89 return str.substr(0, str.size() - end.size());
97 * Check two strings for equivalence. If \p case_insensitive is true
98 * then the case of the strings is ignored (default is false).
102 * @param case_insensitive
103 * @return true if the strings match
105 template <typename T>
106 inline bool str_equal(const std::basic_string<T> &s1,
107 const std::basic_string<T> &s2,
108 bool case_insensitive = false)
110 if (!case_insensitive)
113 if (s1.size() != s2.size())
116 for (size_t i = 0; i < s1.size(); ++i)
117 if(tolower(s1[i]) != tolower(s2[i]))
125 * Check whether \p str begins with the string prefix. If \p case_insensitive
126 * is true then the check is case insensitve (default is false; i.e. case is
131 * @param case_insensitive
132 * @return true if the str begins with prefix
134 template <typename T>
135 inline bool str_starts_with(const std::basic_string<T> &str,
136 const std::basic_string<T> &prefix,
137 bool case_insensitive = false)
139 if (str.size() < prefix.size())
142 if (!case_insensitive)
143 return str.compare(0, prefix.size(), prefix) == 0;
145 for (size_t i = 0; i < prefix.size(); ++i)
146 if (tolower(str[i]) != tolower(prefix[i]))
153 * Splits a string into its component parts separated by the character
156 * @return An std::vector<std::basic_string<T> > of the component parts
158 template <typename T>
159 inline std::vector<std::basic_string<T> > str_split(
160 const std::basic_string<T> &str,
163 std::vector<std::basic_string<T> > parts;
164 std::basic_stringstream<T> sstr(str);
165 std::basic_string<T> part;
167 while (std::getline(sstr, part, delimiter))
168 parts.push_back(part);
176 * @return A copy of \p str converted to all lowercase characters.
178 inline std::string lowercase(const std::string &str)
182 s2.reserve(str.size());
184 for (size_t i = 0; i < str.size(); i++)
185 s2 += tolower(str[i]);
193 * @return A copy of \p str with leading and trailing whitespace removed.
195 inline std::string trim(const std::string &str)
199 while (std::isspace(str[front]))
202 size_t back = str.size();
203 while (back > front && std::isspace(str[back - 1]))
206 return str.substr(front, back - front);
211 * Returns whether \p str should be regarded as (bool) true. Case and leading
212 * and trailing whitespace are ignored. Values that will return
213 * true are "y", "yes", "true" and any number that is not 0.
216 inline bool is_yes(const std::string &str)
218 std::string s2 = lowercase(trim(str));
220 return s2 == "y" || s2 == "yes" || s2 == "true" || atoi(s2.c_str()) != 0;
225 * Converts the string \p str to a signed 32-bit integer. The converted value
226 * is constrained so that min <= value <= max.
228 * @see atoi(3) for limitations
231 * @param min Range minimum
232 * @param max Range maximum
233 * @return The value converted to a signed 32-bit integer and constrained
234 * within the range defined by min and max (inclusive)
236 inline s32 mystoi(const std::string &str, s32 min, s32 max)
238 s32 i = atoi(str.c_str());
249 /// Returns a 64-bit value represented by the string \p str (decimal).
250 inline s64 stoi64(const std::string &str)
252 std::stringstream tmp(str);
258 // MSVC2010 includes it's own versions of these
259 //#if !defined(_MSC_VER) || _MSC_VER < 1600
263 * Returns a 32-bit value reprensented by the string \p str (decimal).
264 * @see atoi(3) for further limitations
266 inline s32 mystoi(const std::string &str)
268 return atoi(str.c_str());
273 * Returns s 32-bit value represented by the wide string \p str (decimal).
274 * @see atoi(3) for further limitations
276 inline s32 mystoi(const std::wstring &str)
278 return mystoi(wide_to_narrow(str));
283 * Returns a float reprensented by the string \p str (decimal).
286 inline float mystof(const std::string &str)
288 return atof(str.c_str());
296 // TODO: Replace with C++11 std::to_string.
298 /// Returns A string representing the value \p val.
299 template <typename T>
300 inline std::string to_string(T val)
302 std::ostringstream oss;
307 /// Returns a string representing the decimal value of the 32-bit value \p i.
308 inline std::string itos(s32 i) { return to_string(i); }
309 /// Returns a string representing the decimal value of the 64-bit value \p i.
310 inline std::string i64tos(s64 i) { return to_string(i); }
311 /// Returns a string representing the decimal value of the float value \p f.
312 inline std::string ftos(float f) { return to_string(f); }
316 * Replace all occurrences of \p pattern in \p str with \p replacement.
318 * @param str String to replace pattern with replacement within.
319 * @param pattern The pattern to replace.
320 * @param replacement What to replace the pattern with.
322 inline void str_replace(std::string &str, const std::string &pattern,
323 const std::string &replacement)
325 std::string::size_type start = str.find(pattern, 0);
326 while (start != str.npos) {
327 str.replace(start, pattern.size(), replacement);
328 start = str.find(pattern, start + replacement.size());
334 * Replace all occurrences of the character \p from in \p str with \p to.
336 * @param str The string to (potentially) modify.
337 * @param from The character in str to replace.
338 * @param to The replacement character.
340 void str_replace(std::string &str, char from, char to);
344 * Check that a string only contains whitelisted characters. This is the
345 * opposite of string_allowed_blacklist().
347 * @param str The string to be checked.
348 * @param allowed_chars A string containing permitted characters.
349 * @return true if the string is allowed, otherwise false.
351 * @see string_allowed_blacklist()
353 inline bool string_allowed(const std::string &str, const std::string &allowed_chars)
355 return str.find_first_not_of(allowed_chars) == str.npos;
360 * Check that a string contains no blacklisted characters. This is the
361 * opposite of string_allowed().
363 * @param str The string to be checked.
364 * @param blacklisted_chars A string containing prohibited characters.
365 * @return true if the string is allowed, otherwise false.
367 * @see string_allowed()
369 inline bool string_allowed_blacklist(const std::string &str,
370 const std::string &blacklisted_chars)
372 return str.find_first_of(blacklisted_chars) == str.npos;
377 * Create a string based on \p from where a newline is forcefully inserted
378 * every \p row_len characters.
380 * @note This function does not honour word wraps and blindy inserts a newline
381 * every \p row_len characters whether it breaks a word or not. It is
382 * intended to be used for, for example, showing paths in the GUI.
384 * @param from The string to be wrapped into rows.
385 * @param row_len The row length (in characters).
386 * @return A new string with the wrapping applied.
388 inline std::string wrap_rows(const std::string &from,
393 for (size_t i = 0; i < from.size(); i++) {
394 if (i != 0 && i % row_len == 0)
404 * Removes backslashes from an escaped string (FormSpec strings)
406 template <typename T>
407 inline std::basic_string<T> unescape_string(std::basic_string<T> &s)
409 std::basic_string<T> res;
411 for (size_t i = 0; i < s.length(); i++) {
425 * Checks that all characters in \p to_check are a decimal digits.
428 * @return true if to_check is not empty and all characters in to_check are
429 * decimal digits, otherwise false
431 inline bool is_number(const std::string &to_check)
433 for (size_t i = 0; i < to_check.size(); i++)
434 if (!std::isdigit(to_check[i]))
437 return !to_check.empty();
442 * Returns a C-string, either "true" or "false", corresponding to \p val.
444 * @return If \p val is true, then "true" is returned, otherwise "false".
446 inline const char *bool_to_cstr(bool val)
448 return val ? "true" : "false";