minetest/src/util/string.h

764 lines
19 KiB
C
Raw Normal View History

/*
2013-02-24 18:40:43 +01:00
Minetest
2013-02-24 19:38:45 +01:00
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program 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. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#pragma once
2014-10-03 06:11:21 +02:00
#include "irrlichttypes_bloated.h"
2019-09-10 15:11:26 +02:00
#include "irrString.h"
#include <cstdlib>
#include <string>
#include <cstring>
#include <vector>
#include <map>
#include <sstream>
#include <iomanip>
2014-06-29 16:57:50 +02:00
#include <cctype>
#include <unordered_map>
class Translations;
2014-06-25 19:04:47 +02:00
#define STRINGIFY(x) #x
#define TOSTRING(x) STRINGIFY(x)
// Checks whether a value is an ASCII printable character
#define IS_ASCII_PRINTABLE_CHAR(x) \
(((unsigned int)(x) >= 0x20) && \
( (unsigned int)(x) <= 0x7e))
// Checks whether a byte is an inner byte for an utf-8 multibyte sequence
#define IS_UTF8_MULTB_INNER(x) \
(((unsigned char)(x) >= 0x80) && \
( (unsigned char)(x) <= 0xbf))
// Checks whether a byte is a start byte for an utf-8 multibyte sequence
#define IS_UTF8_MULTB_START(x) \
(((unsigned char)(x) >= 0xc2) && \
( (unsigned char)(x) <= 0xf4))
// Given a start byte x for an utf-8 multibyte sequence
// it gives the length of the whole sequence in bytes.
#define UTF8_MULTB_START_LEN(x) \
(((unsigned char)(x) < 0xe0) ? 2 : \
(((unsigned char)(x) < 0xf0) ? 3 : 4))
typedef std::unordered_map<std::string, std::string> StringMap;
struct FlagDesc {
const char *name;
u32 flag;
};
// Try to avoid converting between wide and UTF-8 unless you need to
// input/output stuff via Irrlicht
std::wstring utf8_to_wide(const std::string &input);
std::string wide_to_utf8(const std::wstring &input);
// You must free the returned string!
// The returned string is allocated using new[]
wchar_t *utf8_to_wide_c(const char *str);
std::string urlencode(const std::string &str);
std::string urldecode(const std::string &str);
u32 readFlagString(std::string str, const FlagDesc *flagdesc, u32 *flagmask);
std::string writeFlagString(u32 flags, const FlagDesc *flagdesc, u32 flagmask);
size_t mystrlcpy(char *dst, const char *src, size_t size);
char *mystrtok_r(char *s, const char *sep, char **lasts);
u64 read_seed(const char *str);
bool parseColorString(const std::string &value, video::SColor &color, bool quiet,
unsigned char default_alpha = 0xff);
/**
* Returns a copy of \p str with spaces inserted at the right hand side to ensure
* that the string is \p len characters in length. If \p str is <= \p len then the
* returned string will be identical to str.
*/
inline std::string padStringRight(std::string str, size_t len)
{
if (len > str.size())
str.insert(str.end(), len - str.size(), ' ');
return str;
}
/**
* Returns a version of \p str with the first occurrence of a string
* contained within ends[] removed from the end of the string.
*
* @param str
* @param ends A NULL- or ""- terminated array of strings to remove from s in
* the copy produced. Note that once one of these strings is removed
* that no further postfixes contained within this array are removed.
*
* @return If no end could be removed then "" is returned.
*/
inline std::string removeStringEnd(const std::string &str,
const char *ends[])
{
const char **p = ends;
for (; *p && (*p)[0] != '\0'; p++) {
std::string end = *p;
if (str.size() < end.size())
continue;
if (str.compare(str.size() - end.size(), end.size(), end) == 0)
return str.substr(0, str.size() - end.size());
}
return "";
}
/**
* Check two strings for equivalence. If \p case_insensitive is true
* then the case of the strings is ignored (default is false).
*
* @param s1
* @param s2
* @param case_insensitive
* @return true if the strings match
*/
template <typename T>
inline bool str_equal(const std::basic_string<T> &s1,
const std::basic_string<T> &s2,
bool case_insensitive = false)
{
if (!case_insensitive)
return s1 == s2;
if (s1.size() != s2.size())
return false;
for (size_t i = 0; i < s1.size(); ++i)
if(tolower(s1[i]) != tolower(s2[i]))
return false;
return true;
}
/**
* Check whether \p str begins with the string prefix. If \p case_insensitive
* is true then the check is case insensitve (default is false; i.e. case is
* significant).
*
* @param str
* @param prefix
* @param case_insensitive
* @return true if the str begins with prefix
*/
template <typename T>
inline bool str_starts_with(const std::basic_string<T> &str,
const std::basic_string<T> &prefix,
bool case_insensitive = false)
{
if (str.size() < prefix.size())
return false;
if (!case_insensitive)
return str.compare(0, prefix.size(), prefix) == 0;
for (size_t i = 0; i < prefix.size(); ++i)
if (tolower(str[i]) != tolower(prefix[i]))
return false;
return true;
}
/**
* Check whether \p str begins with the string prefix. If \p case_insensitive
* is true then the check is case insensitve (default is false; i.e. case is
* significant).
*
* @param str
* @param prefix
* @param case_insensitive
* @return true if the str begins with prefix
*/
template <typename T>
inline bool str_starts_with(const std::basic_string<T> &str,
const T *prefix,
bool case_insensitive = false)
{
return str_starts_with(str, std::basic_string<T>(prefix),
case_insensitive);
}
2017-01-31 18:05:03 +01:00
/**
* Check whether \p str ends with the string suffix. If \p case_insensitive
* is true then the check is case insensitve (default is false; i.e. case is
* significant).
*
* @param str
* @param suffix
* @param case_insensitive
* @return true if the str begins with suffix
*/
template <typename T>
inline bool str_ends_with(const std::basic_string<T> &str,
const std::basic_string<T> &suffix,
bool case_insensitive = false)
{
if (str.size() < suffix.size())
return false;
size_t start = str.size() - suffix.size();
if (!case_insensitive)
return str.compare(start, suffix.size(), suffix) == 0;
for (size_t i = 0; i < suffix.size(); ++i)
if (tolower(str[start + i]) != tolower(suffix[i]))
return false;
return true;
}
/**
* Check whether \p str ends with the string suffix. If \p case_insensitive
* is true then the check is case insensitve (default is false; i.e. case is
* significant).
*
* @param str
* @param suffix
* @param case_insensitive
* @return true if the str begins with suffix
*/
template <typename T>
inline bool str_ends_with(const std::basic_string<T> &str,
const T *suffix,
bool case_insensitive = false)
{
return str_ends_with(str, std::basic_string<T>(suffix),
case_insensitive);
}
/**
* Splits a string into its component parts separated by the character
* \p delimiter.
*
* @return An std::vector<std::basic_string<T> > of the component parts
*/
template <typename T>
inline std::vector<std::basic_string<T> > str_split(
const std::basic_string<T> &str,
T delimiter)
{
std::vector<std::basic_string<T> > parts;
std::basic_stringstream<T> sstr(str);
std::basic_string<T> part;
while (std::getline(sstr, part, delimiter))
2014-09-28 10:10:43 +02:00
parts.push_back(part);
2014-09-28 10:10:43 +02:00
return parts;
}
/**
* @param str
* @return A copy of \p str converted to all lowercase characters.
*/
inline std::string lowercase(const std::string &str)
{
std::string s2;
s2.reserve(str.size());
for (char i : str)
s2 += tolower(i);
return s2;
}
/**
* @param str
* @return A copy of \p str with leading and trailing whitespace removed.
*/
inline std::string trim(const std::string &str)
{
size_t front = 0;
2022-01-30 04:50:43 +01:00
size_t back = str.size();
2022-01-30 04:50:43 +01:00
while (front < back && std::isspace(str[front]))
++front;
while (back > front && std::isspace(str[back - 1]))
--back;
return str.substr(front, back - front);
}
/**
* Returns whether \p str should be regarded as (bool) true. Case and leading
* and trailing whitespace are ignored. Values that will return
* true are "y", "yes", "true" and any number that is not 0.
* @param str
*/
inline bool is_yes(const std::string &str)
{
std::string s2 = lowercase(trim(str));
return s2 == "y" || s2 == "yes" || s2 == "true" || atoi(s2.c_str()) != 0;
}
/**
* Converts the string \p str to a signed 32-bit integer. The converted value
* is constrained so that min <= value <= max.
*
* @see atoi(3) for limitations
*
* @param str
* @param min Range minimum
* @param max Range maximum
* @return The value converted to a signed 32-bit integer and constrained
* within the range defined by min and max (inclusive)
*/
inline s32 mystoi(const std::string &str, s32 min, s32 max)
{
s32 i = atoi(str.c_str());
if (i < min)
i = min;
if (i > max)
i = max;
return i;
}
/**
* Returns a 32-bit value reprensented by the string \p str (decimal).
* @see atoi(3) for further limitations
*/
inline s32 mystoi(const std::string &str)
{
return atoi(str.c_str());
}
/**
* Returns a float reprensented by the string \p str (decimal).
* @see atof(3)
*/
inline float mystof(const std::string &str)
{
return atof(str.c_str());
}
#define stoi mystoi
#define stof mystof
/// Returns a value represented by the string \p val.
template <typename T>
inline T from_string(const std::string &str)
{
std::stringstream tmp(str);
T t;
tmp >> t;
return t;
}
/// Returns a 64-bit signed value represented by the string \p str (decimal).
inline s64 stoi64(const std::string &str) { return from_string<s64>(str); }
#if __cplusplus < 201103L
namespace std {
/// Returns a string representing the value \p val.
template <typename T>
inline string to_string(T val)
{
ostringstream oss;
oss << val;
return oss.str();
}
#define DEFINE_STD_TOSTRING_FLOATINGPOINT(T) \
template <> \
inline string to_string<T>(T val) \
{ \
ostringstream oss; \
oss << std::fixed \
<< std::setprecision(6) \
<< val; \
return oss.str(); \
}
DEFINE_STD_TOSTRING_FLOATINGPOINT(float)
DEFINE_STD_TOSTRING_FLOATINGPOINT(double)
DEFINE_STD_TOSTRING_FLOATINGPOINT(long double)
#undef DEFINE_STD_TOSTRING_FLOATINGPOINT
/// Returns a wide string representing the value \p val
template <typename T>
inline wstring to_wstring(T val)
{
2021-12-02 00:54:12 +01:00
return utf8_to_wide(to_string(val));
}
}
#endif
/// Returns a string representing the decimal value of the 32-bit value \p i.
inline std::string itos(s32 i) { return std::to_string(i); }
/// Returns a string representing the decimal value of the 64-bit value \p i.
inline std::string i64tos(s64 i) { return std::to_string(i); }
// std::to_string uses the '%.6f' conversion, which is inconsistent with
// std::ostream::operator<<() and impractical too. ftos() uses the
// more generic and std::ostream::operator<<()-compatible '%G' format.
/// Returns a string representing the decimal value of the float value \p f.
inline std::string ftos(float f)
{
std::ostringstream oss;
oss << f;
return oss.str();
}
/**
* Replace all occurrences of \p pattern in \p str with \p replacement.
*
* @param str String to replace pattern with replacement within.
* @param pattern The pattern to replace.
* @param replacement What to replace the pattern with.
*/
inline void str_replace(std::string &str, const std::string &pattern,
const std::string &replacement)
{
std::string::size_type start = str.find(pattern, 0);
while (start != str.npos) {
str.replace(start, pattern.size(), replacement);
start = str.find(pattern, start + replacement.size());
}
}
/**
* Escapes characters [ ] \ , ; that can not be used in formspecs
*/
inline void str_formspec_escape(std::string &str)
{
str_replace(str, "\\", "\\\\");
str_replace(str, "]", "\\]");
str_replace(str, "[", "\\[");
str_replace(str, ";", "\\;");
str_replace(str, ",", "\\,");
}
/**
* Replace all occurrences of the character \p from in \p str with \p to.
*
* @param str The string to (potentially) modify.
* @param from The character in str to replace.
* @param to The replacement character.
*/
void str_replace(std::string &str, char from, char to);
/**
* Check that a string only contains whitelisted characters. This is the
* opposite of string_allowed_blacklist().
*
* @param str The string to be checked.
* @param allowed_chars A string containing permitted characters.
* @return true if the string is allowed, otherwise false.
*
* @see string_allowed_blacklist()
*/
inline bool string_allowed(const std::string &str, const std::string &allowed_chars)
{
return str.find_first_not_of(allowed_chars) == str.npos;
}
/**
* Check that a string contains no blacklisted characters. This is the
* opposite of string_allowed().
*
* @param str The string to be checked.
* @param blacklisted_chars A string containing prohibited characters.
* @return true if the string is allowed, otherwise false.
* @see string_allowed()
*/
inline bool string_allowed_blacklist(const std::string &str,
const std::string &blacklisted_chars)
{
return str.find_first_of(blacklisted_chars) == str.npos;
}
/**
* Create a string based on \p from where a newline is forcefully inserted
* every \p row_len characters.
*
* @note This function does not honour word wraps and blindy inserts a newline
* every \p row_len characters whether it breaks a word or not. It is
* intended to be used for, for example, showing paths in the GUI.
*
* @note This function doesn't wrap inside utf-8 multibyte sequences and also
* counts multibyte sequences correcly as single characters.
*
* @param from The (utf-8) string to be wrapped into rows.
* @param row_len The row length (in characters).
* @return A new string with the wrapping applied.
*/
inline std::string wrap_rows(const std::string &from,
unsigned row_len)
{
std::string to;
size_t character_idx = 0;
for (size_t i = 0; i < from.size(); i++) {
if (!IS_UTF8_MULTB_INNER(from[i])) {
2015-06-19 18:04:11 +02:00
// Wrap string after last inner byte of char
if (character_idx > 0 && character_idx % row_len == 0)
to += '\n';
character_idx++;
}
to += from[i];
}
return to;
}
/**
* Removes backslashes from an escaped string (FormSpec strings)
*/
template <typename T>
inline std::basic_string<T> unescape_string(const std::basic_string<T> &s)
{
std::basic_string<T> res;
for (size_t i = 0; i < s.length(); i++) {
if (s[i] == '\\') {
i++;
if (i >= s.length())
break;
}
res += s[i];
}
return res;
}
/**
* Remove all escape sequences in \p s.
*
* @param s The string in which to remove escape sequences.
* @return \p s, with escape sequences removed.
*/
template <typename T>
std::basic_string<T> unescape_enriched(const std::basic_string<T> &s)
{
std::basic_string<T> output;
size_t i = 0;
while (i < s.length()) {
if (s[i] == '\x1b') {
++i;
if (i == s.length()) continue;
if (s[i] == '(') {
++i;
while (i < s.length() && s[i] != ')') {
if (s[i] == '\\') {
++i;
}
++i;
}
++i;
} else {
++i;
}
continue;
}
output += s[i];
++i;
}
return output;
}
template <typename T>
std::vector<std::basic_string<T> > split(const std::basic_string<T> &s, T delim)
{
std::vector<std::basic_string<T> > tokens;
std::basic_string<T> current;
bool last_was_escape = false;
for (size_t i = 0; i < s.length(); i++) {
T si = s[i];
if (last_was_escape) {
current += '\\';
current += si;
last_was_escape = false;
} else {
if (si == delim) {
tokens.push_back(current);
current = std::basic_string<T>();
last_was_escape = false;
} else if (si == '\\') {
last_was_escape = true;
} else {
current += si;
last_was_escape = false;
}
}
}
//push last element
tokens.push_back(current);
return tokens;
}
std::wstring translate_string(const std::wstring &s, Translations *translations);
2017-01-31 18:05:03 +01:00
std::wstring translate_string(const std::wstring &s);
inline std::wstring unescape_translate(const std::wstring &s) {
return unescape_enriched(translate_string(s));
}
/**
* Checks that all characters in \p to_check are a decimal digits.
*
* @param to_check
* @return true if to_check is not empty and all characters in to_check are
* decimal digits, otherwise false
*/
inline bool is_number(const std::string &to_check)
2014-06-25 19:04:47 +02:00
{
for (char i : to_check)
if (!std::isdigit(i))
return false;
2014-06-25 19:04:47 +02:00
return !to_check.empty();
}
2014-06-25 19:04:47 +02:00
/**
* Returns a C-string, either "true" or "false", corresponding to \p val.
*
* @return If \p val is true, then "true" is returned, otherwise "false".
*/
inline const char *bool_to_cstr(bool val)
{
return val ? "true" : "false";
2014-06-25 19:04:47 +02:00
}
2021-03-17 19:03:00 +01:00
/**
* Converts a duration in seconds to a pretty-printed duration in
* days, hours, minutes and seconds.
*
* @param sec duration in seconds
* @return pretty-printed duration
*/
inline const std::string duration_to_string(int sec)
{
2021-03-17 19:03:00 +01:00
std::ostringstream ss;
const char *neg = "";
if (sec < 0) {
sec = -sec;
neg = "-";
}
int total_sec = sec;
int min = sec / 60;
sec %= 60;
int hour = min / 60;
min %= 60;
2021-03-17 19:03:00 +01:00
int day = hour / 24;
hour %= 24;
if (day > 0) {
ss << neg << day << "d";
if (hour > 0 || min > 0 || sec > 0)
ss << " ";
}
if (hour > 0) {
2021-03-17 19:03:00 +01:00
ss << neg << hour << "h";
2021-03-15 01:59:52 +01:00
if (min > 0 || sec > 0)
ss << " ";
}
if (min > 0) {
2021-03-17 19:03:00 +01:00
ss << neg << min << "min";
2021-03-15 01:59:52 +01:00
if (sec > 0)
ss << " ";
}
2021-03-17 19:03:00 +01:00
if (sec > 0 || total_sec == 0) {
ss << neg << sec << "s";
}
return ss.str();
}
/**
* Joins a vector of strings by the string \p delimiter.
*
* @return A std::string
*/
inline std::string str_join(const std::vector<std::string> &list,
const std::string &delimiter)
{
std::ostringstream oss;
bool first = true;
for (const auto &part : list) {
if (!first)
oss << delimiter;
oss << part;
first = false;
}
return oss.str();
}
2019-09-10 15:11:26 +02:00
/**
* Create a UTF8 std::string from a irr::core::stringw.
2019-09-10 15:11:26 +02:00
*/
inline std::string stringw_to_utf8(const irr::core::stringw &input)
{
std::wstring str(input.c_str());
return wide_to_utf8(str);
}
2019-09-10 15:11:26 +02:00
/**
* Create a irr::core:stringw from a UTF8 std::string.
*/
inline irr::core::stringw utf8_to_stringw(const std::string &input)
{
std::wstring str = utf8_to_wide(input);
return irr::core::stringw(str.c_str());
}
/**
* Sanitize the name of a new directory. This consists of two stages:
* 1. Check for 'reserved filenames' that can't be used on some filesystems
* and add a prefix to them
* 2. Remove 'unsafe' characters from the name by replacing them with '_'
*/
std::string sanitizeDirName(const std::string &str, const std::string &optional_prefix);
/**
* Prints a sanitized version of a string without control characters.
* '\t' and '\n' are allowed, as are UTF-8 control characters (e.g. RTL).
* ASCII control characters are replaced with their hex encoding in angle
* brackets (e.g. "a\x1eb" -> "a<1e>b").
*/
void safe_print_string(std::ostream &os, const std::string &str);