src/util/string.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef UTIL_STRING_HEADER
  21 #define UTIL_STRING_HEADER
  22
  23 #include "irrlichttypes_bloated.h"
  24 #include <stdlib.h>
  25 #include <string>
  26 #include <cstring>
  27 #include <vector>
  28 #include <sstream>
  29 #include <cctype>
  30
  31 #define STRINGIFY(x) #x
  32 #define TOSTRING(x) STRINGIFY(x)
  33
  34 struct FlagDesc {
  35         const char *name;
  36         u32 flag;
  37 };
  38
  39
  40 // You must free the returned string!
  41 // The returned string is allocated using new
  42 wchar_t *narrow_to_wide_c(const char *str);
  43
  44 std::wstring narrow_to_wide(const std::string &mbs);
  45 std::string wide_to_narrow(const std::wstring &wcs);
  46
  47 std::string urlencode(std::string str);
  48 std::string urldecode(std::string str);
  49 u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask);
  50 std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask);
  51 size_t mystrlcpy(char *dst, const char *src, size_t size);
  52 char *mystrtok_r(char *s, const char *sep, char **lasts);
  53 u64 read_seed(const char *str);
  54 bool parseColorString(const std::string &value, video::SColor &color, bool quiet);
  55
  56
  57 /**
  58  * Returns a copy of \p str with spaces inserted at the right hand side to ensure
  59  * that the string is \p len characters in length. If \p str is <= \p len then the
  60  * returned string will be identical to str.
  61  */
  62 inline std::string padStringRight(std::string str, size_t len)
  63 {
  64         if (len > str.size())
  65                 str.insert(str.end(), len - str.size(), ' ');
  66
  67         return str;
  68 }
  69
  70 /**
  71  * Returns a version of \p str with the first occurrence of a string
  72  * contained within ends[] removed from the end of the string.
  73  *
  74  * @param str
  75  * @param ends A NULL- or ""- terminated array of strings to remove from s in
  76  *      the copy produced.  Note that once one of these strings is removed
  77  *      that no further postfixes contained within this array are removed.
  78  *
  79  * @return If no end could be removed then "" is returned.
  80  */
  81 inline std::string removeStringEnd(const std::string &str,
  82                 const char *ends[])
  83 {
  84         const char **p = ends;
  85
  86         for (; *p && (*p)[0] != '\0'; p++) {
  87                 std::string end = *p;
  88                 if (str.size() < end.size())
  89                         continue;
  90                 if (str.compare(str.size() - end.size(), end.size(), end) == 0)
  91                         return str.substr(0, str.size() - end.size());
  92         }
  93
  94         return "";
  95 }
  96
  97
  98 /**
  99  * Check two strings for equivalence.  If \p case_insensitive is true
 100  * then the case of the strings is ignored (default is false).
 101  *
 102  * @param s1
 103  * @param s2
 104  * @param case_insensitive
 105  * @return true if the strings match
 106  */
 107 template <typename T>
 108 inline bool str_equal(const std::basic_string<T> &s1,
 109                 const std::basic_string<T> &s2,
 110                 bool case_insensitive = false)
 111 {
 112         if (!case_insensitive)
 113                 return s1 == s2;
 114
 115         if (s1.size() != s2.size())
 116                 return false;
 117
 118         for (size_t i = 0; i < s1.size(); ++i)
 119                 if(tolower(s1[i]) != tolower(s2[i]))
 120                         return false;
 121
 122         return true;
 123 }
 124
 125
 126 /**
 127  * Check whether \p str begins with the string prefix. If \p case_insensitive
 128  * is true then the check is case insensitve (default is false; i.e. case is
 129  * significant).
 130  *
 131  * @param str
 132  * @param prefix
 133  * @param case_insensitive
 134  * @return true if the str begins with prefix
 135  */
 136 template <typename T>
 137 inline bool str_starts_with(const std::basic_string<T> &str,
 138                 const std::basic_string<T> &prefix,
 139                 bool case_insensitive = false)
 140 {
 141         if (str.size() < prefix.size())
 142                 return false;
 143
 144         if (!case_insensitive)
 145                 return str.compare(0, prefix.size(), prefix) == 0;
 146
 147         for (size_t i = 0; i < prefix.size(); ++i)
 148                 if (tolower(str[i]) != tolower(prefix[i]))
 149                         return false;
 150         return true;
 151 }
 152
 153 /**
 154  * Check whether \p str begins with the string prefix. If \p case_insensitive
 155  * is true then the check is case insensitve (default is false; i.e. case is
 156  * significant).
 157  *
 158  * @param str
 159  * @param prefix
 160  * @param case_insensitive
 161  * @return true if the str begins with prefix
 162  */
 163 template <typename T>
 164 inline bool str_starts_with(const std::basic_string<T> &str,
 165                 const T *prefix,
 166                 bool case_insensitive = false)
 167 {
 168         return str_starts_with(str, std::basic_string<T>(prefix),
 169                         case_insensitive);
 170 }
 171
 172 /**
 173  * Splits a string into its component parts separated by the character
 174  * \p delimiter.
 175  *
 176  * @return An std::vector<std::basic_string<T> > of the component parts
 177  */
 178 template <typename T>
 179 inline std::vector<std::basic_string<T> > str_split(
 180                 const std::basic_string<T> &str,
 181                 T delimiter)
 182 {
 183         std::vector<std::basic_string<T> > parts;
 184         std::basic_stringstream<T> sstr(str);
 185         std::basic_string<T> part;
 186
 187         while (std::getline(sstr, part, delimiter))
 188                 parts.push_back(part);
 189
 190         return parts;
 191 }
 192
 193
 194 /**
 195  * @param str
 196  * @return A copy of \p str converted to all lowercase characters.
 197  */
 198 inline std::string lowercase(const std::string &str)
 199 {
 200         std::string s2;
 201
 202         s2.reserve(str.size());
 203
 204         for (size_t i = 0; i < str.size(); i++)
 205                 s2 += tolower(str[i]);
 206
 207         return s2;
 208 }
 209
 210
 211 /**
 212  * @param str
 213  * @return A copy of \p str with leading and trailing whitespace removed.
 214  */
 215 inline std::string trim(const std::string &str)
 216 {
 217         size_t front = 0;
 218
 219         while (std::isspace(str[front]))
 220                 ++front;
 221
 222         size_t back = str.size();
 223         while (back > front && std::isspace(str[back - 1]))
 224                 --back;
 225
 226         return str.substr(front, back - front);
 227 }
 228
 229
 230 /**
 231  * Returns whether \p str should be regarded as (bool) true.  Case and leading
 232  * and trailing whitespace are ignored.  Values that will return
 233  * true are "y", "yes", "true" and any number that is not 0.
 234  * @param str
 235  */
 236 inline bool is_yes(const std::string &str)
 237 {
 238         std::string s2 = lowercase(trim(str));
 239
 240         return s2 == "y" || s2 == "yes" || s2 == "true" || atoi(s2.c_str()) != 0;
 241 }
 242
 243
 244 /**
 245  * Converts the string \p str to a signed 32-bit integer. The converted value
 246  * is constrained so that min <= value <= max.
 247  *
 248  * @see atoi(3) for limitations
 249  *
 250  * @param str
 251  * @param min Range minimum
 252  * @param max Range maximum
 253  * @return The value converted to a signed 32-bit integer and constrained
 254  *      within the range defined by min and max (inclusive)
 255  */
 256 inline s32 mystoi(const std::string &str, s32 min, s32 max)
 257 {
 258         s32 i = atoi(str.c_str());
 259
 260         if (i < min)
 261                 i = min;
 262         if (i > max)
 263                 i = max;
 264
 265         return i;
 266 }
 267
 268
 269 /// Returns a 64-bit value represented by the string \p str (decimal).
 270 inline s64 stoi64(const std::string &str)
 271 {
 272         std::stringstream tmp(str);
 273         s64 t;
 274         tmp >> t;
 275         return t;
 276 }
 277
 278 // MSVC2010 includes it's own versions of these
 279 //#if !defined(_MSC_VER) || _MSC_VER < 1600
 280
 281
 282 /**
 283  * Returns a 32-bit value reprensented by the string \p str (decimal).
 284  * @see atoi(3) for further limitations
 285  */
 286 inline s32 mystoi(const std::string &str)
 287 {
 288         return atoi(str.c_str());
 289 }
 290
 291
 292 /**
 293  * Returns s 32-bit value represented by the wide string \p str (decimal).
 294  * @see atoi(3) for further limitations
 295  */
 296 inline s32 mystoi(const std::wstring &str)
 297 {
 298         return mystoi(wide_to_narrow(str));
 299 }
 300
 301
 302 /**
 303  * Returns a float reprensented by the string \p str (decimal).
 304  * @see atof(3)
 305  */
 306 inline float mystof(const std::string &str)
 307 {
 308         return atof(str.c_str());
 309 }
 310
 311 //#endif
 312
 313 #define stoi mystoi
 314 #define stof mystof
 315
 316 // TODO: Replace with C++11 std::to_string.
 317
 318 /// Returns A string representing the value \p val.
 319 template <typename T>
 320 inline std::string to_string(T val)
 321 {
 322         std::ostringstream oss;
 323         oss << val;
 324         return oss.str();
 325 }
 326
 327 /// Returns a string representing the decimal value of the 32-bit value \p i.
 328 inline std::string itos(s32 i) { return to_string(i); }
 329 /// Returns a string representing the decimal value of the 64-bit value \p i.
 330 inline std::string i64tos(s64 i) { return to_string(i); }
 331 /// Returns a string representing the decimal value of the float value \p f.
 332 inline std::string ftos(float f) { return to_string(f); }
 333
 334
 335 /**
 336  * Replace all occurrences of \p pattern in \p str with \p replacement.
 337  *
 338  * @param str String to replace pattern with replacement within.
 339  * @param pattern The pattern to replace.
 340  * @param replacement What to replace the pattern with.
 341  */
 342 inline void str_replace(std::string &str, const std::string &pattern,
 343                 const std::string &replacement)
 344 {
 345         std::string::size_type start = str.find(pattern, 0);
 346         while (start != str.npos) {
 347                 str.replace(start, pattern.size(), replacement);
 348                 start = str.find(pattern, start + replacement.size());
 349         }
 350 }
 351
 352
 353 /**
 354  * Replace all occurrences of the character \p from in \p str with \p to.
 355  *
 356  * @param str The string to (potentially) modify.
 357  * @param from The character in str to replace.
 358  * @param to The replacement character.
 359  */
 360 void str_replace(std::string &str, char from, char to);
 361
 362
 363 /**
 364  * Check that a string only contains whitelisted characters. This is the
 365  * opposite of string_allowed_blacklist().
 366  *
 367  * @param str The string to be checked.
 368  * @param allowed_chars A string containing permitted characters.
 369  * @return true if the string is allowed, otherwise false.
 370  *
 371  * @see string_allowed_blacklist()
 372  */
 373 inline bool string_allowed(const std::string &str, const std::string &allowed_chars)
 374 {
 375         return str.find_first_not_of(allowed_chars) == str.npos;
 376 }
 377
 378
 379 /**
 380  * Check that a string contains no blacklisted characters. This is the
 381  * opposite of string_allowed().
 382  *
 383  * @param str The string to be checked.
 384  * @param blacklisted_chars A string containing prohibited characters.
 385  * @return true if the string is allowed, otherwise false.
 386
 387  * @see string_allowed()
 388  */
 389 inline bool string_allowed_blacklist(const std::string &str,
 390                 const std::string &blacklisted_chars)
 391 {
 392         return str.find_first_of(blacklisted_chars) == str.npos;
 393 }
 394
 395
 396 /**
 397  * Create a string based on \p from where a newline is forcefully inserted
 398  * every \p row_len characters.
 399  *
 400  * @note This function does not honour word wraps and blindy inserts a newline
 401  *      every \p row_len characters whether it breaks a word or not.  It is
 402  *      intended to be used for, for example, showing paths in the GUI.
 403  *
 404  * @param from The string to be wrapped into rows.
 405  * @param row_len The row length (in characters).
 406  * @return A new string with the wrapping applied.
 407  */
 408 inline std::string wrap_rows(const std::string &from,
 409                 unsigned row_len)
 410 {
 411         std::string to;
 412
 413         for (size_t i = 0; i < from.size(); i++) {
 414                 if (i != 0 && i % row_len == 0)
 415                         to += '\n';
 416                 to += from[i];
 417         }
 418
 419         return to;
 420 }
 421
 422
 423 /**
 424  * Removes backslashes from an escaped string (FormSpec strings)
 425  */
 426 template <typename T>
 427 inline std::basic_string<T> unescape_string(std::basic_string<T> &s)
 428 {
 429         std::basic_string<T> res;
 430
 431         for (size_t i = 0; i < s.length(); i++) {
 432                 if (s[i] == '\\') {
 433                         i++;
 434                         if (i >= s.length())
 435                                 break;
 436                 }
 437                 res += s[i];
 438         }
 439
 440         return res;
 441 }
 442
 443
 444 /**
 445  * Checks that all characters in \p to_check are a decimal digits.
 446  *
 447  * @param to_check
 448  * @return true if to_check is not empty and all characters in to_check are
 449  *      decimal digits, otherwise false
 450  */
 451 inline bool is_number(const std::string &to_check)
 452 {
 453         for (size_t i = 0; i < to_check.size(); i++)
 454                 if (!std::isdigit(to_check[i]))
 455                         return false;
 456
 457         return !to_check.empty();
 458 }
 459
 460
 461 /**
 462  * Returns a C-string, either "true" or "false", corresponding to \p val.
 463  *
 464  * @return If \p val is true, then "true" is returned, otherwise "false".
 465  */
 466 inline const char *bool_to_cstr(bool val)
 467 {
 468         return val ? "true" : "false";
 469 }
 470
 471 #endif