utilstrencodings.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin developers
// Copyright (c) 2017-2022 The PIVX Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef PIVX_UTILSTRENCODINGS_H
#define PIVX_UTILSTRENCODINGS_H
 
#include "support/allocators/secure.h"
#include "span.h"
 
#include <algorithm>
#include <iterator>
#include <stdint.h>
#include <string>
#include <vector>
 
#define BEGIN(a) ((char*)&(a))
#define END(a) ((char*)&((&(a))[1]))
#define UBEGIN(a) ((unsigned char*)&(a))
#define UEND(a) ((unsigned char*)&((&(a))[1]))
#define ARRAYLEN(array) (sizeof(array) / sizeof((array)[0]))
 
enum SafeChars
{
    SAFE_CHARS_DEFAULT, 
    SAFE_CHARS_UA_COMMENT, 
    SAFE_CHARS_FILENAME, 
};
 
std::string SanitizeString(const std::string& str, int rule = SAFE_CHARS_DEFAULT);
 
bool validateURL(const std::string& strURL, std::string& strErr, unsigned int maxSize = 64);
bool validateURL(const std::string& strURL);
 
std::vector<unsigned char> ParseHex(const char* psz);
std::vector<unsigned char> ParseHex(const std::string& str);
signed char HexDigit(char c);
bool IsHex(const std::string& str);
std::vector<unsigned char> DecodeBase64(const char* p, bool* pfInvalid = nullptr);
std::string DecodeBase64(const std::string& str);
std::string EncodeBase64(Span<const unsigned char> input);
std::string EncodeBase64(const std::string& str);
std::vector<unsigned char> DecodeBase32(const char* p, bool* pfInvalid = nullptr);
std::string DecodeBase32(const std::string& str);
 
std::string EncodeBase32(Span<const unsigned char> input, bool pad = true);
 
std::string EncodeBase32(const std::string& str, bool pad = true);
 
std::string i64tostr(int64_t n);
std::string itostr(int n);
int64_t atoi64(const char* psz);
int64_t atoi64(const std::string& str);
int atoi(const std::string& str);
 
constexpr bool IsDigit(char c)
{
    return c >= '0' && c <= '9';
}
 
bool ParseInt32(const std::string& str, int32_t *out);
 
bool ParseInt64(const std::string& str, int64_t *out);
 
bool ParseUInt8(const std::string& str, uint8_t *out);
 
bool ParseUInt32(const std::string& str, uint32_t *out);
 
bool ParseDouble(const std::string& str, double *out);
 
/* Return iterator to first non zero element, or itend */
template <typename T>
T FindFirstNonZero(T itbegin, T itend)
{
    return std::find_if(itbegin, itend, [](unsigned char v) { return v != 0; });
}
 
std::string HexStr(const Span<const uint8_t> s);
inline std::string HexStr(const Span<const char> s) { return HexStr(MakeUCharSpan(s)); }
 
inline std::string ReverseEndianString(std::string in)
{
    std::string out = "";
    unsigned int s = in.size();
    for (unsigned int i = 0; i < s; i += 2) {
        out += in.substr(s - i - 2, 2);
    }
 
    return out;
}
 
std::string FormatParagraph(const std::string in, size_t width = 79, size_t indent = 0);
 
template <typename T>
bool TimingResistantEqual(const T& a, const T& b)
{
    if (b.size() == 0) return a.size() == 0;
    size_t accumulator = a.size() ^ b.size();
    for (size_t i = 0; i < a.size(); i++)
        accumulator |= a[i] ^ b[i % b.size()];
    return accumulator == 0;
}
 
template<int frombits, int tobits, bool pad, typename O, typename I>
bool ConvertBits(const O& outfn, I it, I end) {
    size_t acc = 0;
    size_t bits = 0;
    constexpr size_t maxv = (1 << tobits) - 1;
    constexpr size_t max_acc = (1 << (frombits + tobits - 1)) - 1;
    while (it != end) {
        acc = ((acc << frombits) | *it) & max_acc;
        bits += frombits;
        while (bits >= tobits) {
            bits -= tobits;
            outfn((acc >> bits) & maxv);
        }
        ++it;
    }
    if (pad) {
        if (bits) outfn((acc << (tobits - bits)) & maxv);
    } else if (bits >= frombits || ((acc << (tobits - bits)) & maxv)) {
        return false;
    }
    return true;
}
 
 
bool ParseFixedPoint(const std::string &val, int decimals, int64_t *amount_out);
 
constexpr unsigned char ToLower(unsigned char c)
{
    return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
}
 
std::string ToLower(const std::string& str);
 
void Downcase(std::string& str);
 
constexpr unsigned char ToUpper(unsigned char c)
{
    return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
}
 
std::string ToUpper(const std::string& str);
 
std::string Capitalize(std::string str);
 
bool IsValidUTF8(const std::string& str);
 
#endif // PIVX_UTILSTRENCODINGS_H