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 std::wstring narrow_to_wide(const std::string& mbs);
  40 std::string wide_to_narrow(const std::wstring& wcs);
  41
  42 static inline std::string padStringRight(std::string s, size_t len)
  43 {
  44         if(len > s.size())
  45                 s.insert(s.end(), len - s.size(), ' ');
  46         return s;
  47 }
  48
  49 // ends: NULL- or ""-terminated array of strings
  50 // Returns "" if no end could be removed.
  51 static inline std::string removeStringEnd(const std::string &s, const char *ends[])
  52 {
  53         const char **p = ends;
  54         for(; (*p) && (*p)[0] != '\0'; p++){
  55                 std::string end = *p;
  56                 if(s.size() < end.size())
  57                         continue;
  58                 if(s.substr(s.size()-end.size(), end.size()) == end)
  59                         return s.substr(0, s.size() - end.size());
  60         }
  61         return "";
  62 }
  63
  64 // Tests if two strings are equal, optionally case insensitive
  65 inline bool str_equal(const std::wstring& s1, const std::wstring& s2,
  66                 bool case_insensitive = false)
  67 {
  68         if(case_insensitive)
  69         {
  70                 if(s1.size() != s2.size())
  71                         return false;
  72                 for(size_t i = 0; i < s1.size(); ++i)
  73                         if(tolower(s1[i]) != tolower(s2[i]))
  74                                 return false;
  75                 return true;
  76         }
  77         else
  78         {
  79                 return s1 == s2;
  80         }
  81 }
  82
  83 // Tests if the second string is a prefix of the first, optionally case insensitive
  84 inline bool str_starts_with(const std::wstring& str, const std::wstring& prefix,
  85                 bool case_insensitive = false)
  86 {
  87         if(str.size() < prefix.size())
  88                 return false;
  89         if(case_insensitive)
  90         {
  91                 for(size_t i = 0; i < prefix.size(); ++i)
  92                         if(tolower(str[i]) != tolower(prefix[i]))
  93                                 return false;
  94         }
  95         else
  96         {
  97                 for(size_t i = 0; i < prefix.size(); ++i)
  98                         if(str[i] != prefix[i])
  99                                 return false;
 100         }
 101         return true;
 102 }
 103
 104 // Split a string using the given delimiter. Returns a vector containing
 105 // the component parts.
 106 inline std::vector<std::wstring> str_split(const std::wstring &str, wchar_t delimiter)
 107 {
 108         std::vector<std::wstring> parts;
 109         std::wstringstream sstr(str);
 110         std::wstring part;
 111         while(std::getline(sstr, part, delimiter))
 112                 parts.push_back(part);
 113         return parts;
 114 }
 115
 116 inline std::vector<std::string> str_split(const std::string &str, char delimiter) {
 117
 118         std::vector<std::string> parts;
 119         std::stringstream sstr(str);
 120         std::string part;
 121         while(std::getline(sstr, part, delimiter))
 122                 parts.push_back(part);
 123         return parts;
 124 }
 125
 126 inline std::string lowercase(const std::string &s)
 127 {
 128         std::string s2;
 129         for(size_t i = 0; i < s.size(); i++)
 130                 s2[i] = tolower(s.at(i));
 131         return s2;
 132 }
 133
 134 inline std::string trim(const std::string &s)
 135 {
 136         size_t front = 0;
 137         while(s[front] == ' '    ||
 138               s[front] == '\t'   ||
 139               s[front] == '\r'   ||
 140               s[front] == '\n'
 141              )
 142                 ++front;
 143
 144         size_t back = s.size();
 145         while(back > front &&
 146               (s[back-1] == ' '  ||
 147                s[back-1] == '\t' ||
 148                s[back-1] == '\r' ||
 149                s[back-1] == '\n'
 150               )
 151              )
 152                 --back;
 153
 154         return s.substr(front, back - front);
 155 }
 156
 157 inline bool is_yes(const std::string &s)
 158 {
 159         std::string s2 = lowercase(trim(s));
 160         if(s2 == "y" || s2 == "yes" || s2 == "true" || atoi(s2.c_str()) != 0)
 161                 return true;
 162         return false;
 163 }
 164
 165 inline s32 mystoi(const std::string &s, s32 min, s32 max)
 166 {
 167         s32 i = atoi(s.c_str());
 168         if(i < min)
 169                 i = min;
 170         if(i > max)
 171                 i = max;
 172         return i;
 173 }
 174
 175 inline s64 stoi64(const std::string &s) {
 176         std::stringstream tmp(s);
 177         s64 t;
 178         tmp >> t;
 179         return t;
 180 }
 181
 182 // MSVC2010 includes it's own versions of these
 183 //#if !defined(_MSC_VER) || _MSC_VER < 1600
 184
 185 inline s32 mystoi(const std::string &s)
 186 {
 187         return atoi(s.c_str());
 188 }
 189
 190 inline s32 mystoi(const std::wstring &s)
 191 {
 192         return atoi(wide_to_narrow(s).c_str());
 193 }
 194
 195 inline float mystof(const std::string &s)
 196 {
 197         // This crap causes a segfault in certain cases on MinGW
 198         /*float f;
 199         std::istringstream ss(s);
 200         ss>>f;
 201         return f;*/
 202         // This works in that case
 203         return atof(s.c_str());
 204 }
 205
 206 //#endif
 207
 208 #define stoi mystoi
 209 #define stof mystof
 210
 211 inline std::string itos(s32 i)
 212 {
 213         std::ostringstream o;
 214         o<<i;
 215         return o.str();
 216 }
 217
 218 inline std::string i64tos(s64 i) {
 219         std::ostringstream o;
 220         o<<i;
 221         return o.str();
 222 }
 223
 224 inline std::string ftos(float f)
 225 {
 226         std::ostringstream o;
 227         o<<f;
 228         return o.str();
 229 }
 230
 231 inline void str_replace(std::string & str, std::string const & pattern,
 232                 std::string const & replacement)
 233 {
 234         std::string::size_type start = str.find(pattern, 0);
 235         while(start != str.npos)
 236         {
 237                 str.replace(start, pattern.size(), replacement);
 238                 start = str.find(pattern, start+replacement.size());
 239         }
 240 }
 241
 242 inline void str_replace_char(std::string & str, char from, char to)
 243 {
 244         for(unsigned int i=0; i<str.size(); i++)
 245         {
 246                 if(str[i] == from)
 247                         str[i] = to;
 248         }
 249 }
 250
 251 /*
 252         Checks if a string contains only supplied characters
 253 */
 254 inline bool string_allowed(const std::string &s, const std::string &allowed_chars)
 255 {
 256         for(u32 i=0; i<s.size(); i++)
 257         {
 258                 bool confirmed = false;
 259                 for(u32 j=0; j<allowed_chars.size(); j++)
 260                 {
 261                         if(s[i] == allowed_chars[j])
 262                         {
 263                                 confirmed = true;
 264                                 break;
 265                         }
 266                 }
 267                 if(confirmed == false)
 268                         return false;
 269         }
 270         return true;
 271 }
 272
 273 /*
 274         Checks if a string contains no blacklisted characters (opposite
 275         function of string_allowed())
 276 */
 277 inline bool string_allowed_blacklist(const std::string & s, const std::string & blacklisted_chars)
 278 {
 279         for(unsigned int i = 0; i < s.length(); i++)
 280         {
 281                 bool invalid = false;
 282                 for(unsigned int j = 0; j < blacklisted_chars.length(); j++)
 283                 {
 284                         if(s[i] == blacklisted_chars[j])
 285                         {
 286                                 invalid = true;
 287                                 break;
 288                         }
 289                 }
 290                 if(invalid)
 291                         return false;
 292         }
 293         return true;
 294 }
 295
 296 /*
 297         Forcefully wraps string into rows using \n
 298         (no word wrap, used for showing paths in gui)
 299 */
 300 inline std::string wrap_rows(const std::string &from, u32 rowlen)
 301 {
 302         std::string to;
 303         for(u32 i=0; i<from.size(); i++)
 304         {
 305                 if(i != 0 && i%rowlen == 0)
 306                         to += '\n';
 307                 to += from[i];
 308         }
 309         return to;
 310 }
 311
 312 /*
 313         Removes all \\ from a string that had been escaped (FormSpec strings)
 314 */
 315 inline std::string unescape_string(std::string &s)
 316 {
 317         std::string res;
 318
 319         for (size_t i = 0; i < s.length(); i++) {
 320                 if (s[i] == '\\')
 321                         i++;
 322                 res += s[i];
 323         }
 324
 325         return res;
 326 }
 327
 328 inline bool is_number(const std::string& tocheck)
 329 {
 330         std::string::const_iterator iter = tocheck.begin();
 331
 332         while (iter != tocheck.end() && std::isdigit(*iter)) {
 333                 ++iter;
 334         }
 335
 336         return ((!tocheck.empty()) && (iter == tocheck.end()));
 337 }
 338
 339 std::string translatePassword(std::string playername, std::wstring password);
 340 std::string urlencode(std::string str);
 341 std::string urldecode(std::string str);
 342 u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask);
 343 std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask);
 344 size_t mystrlcpy(char *dst, const char *src, size_t size);
 345 char *mystrtok_r(char *s, const char *sep, char **lasts);
 346 u64 read_seed(const char *str);
 347 bool parseColorString(const std::string &value, video::SColor &color, bool quiet);
 348
 349 #endif
 350