strencodings.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_UTIL_STRENCODINGS_H
#define BITCOIN_UTIL_STRENCODINGS_H
 
#include <span.h>
 
#include <cstdint>
#include <iterator>
#include <string>
#include <vector>
 
enum SafeChars {
    SAFE_CHARS_DEFAULT,
    SAFE_CHARS_UA_COMMENT,
    SAFE_CHARS_FILENAME,
    SAFE_CHARS_URI,
};
 
std::string SanitizeString(const std::string &str,
                           int rule = SAFE_CHARS_DEFAULT);
std::vector<uint8_t> ParseHex(const char *psz);
std::vector<uint8_t> ParseHex(const std::string &str);
signed char HexDigit(char c);
bool IsHex(const std::string &str);
bool IsHexNumber(const std::string &str);
std::vector<uint8_t> DecodeBase64(const char *p, bool *pf_invalid = nullptr);
std::string DecodeBase64(const std::string &str, bool *pf_invalid = nullptr);
std::string EncodeBase64(Span<const uint8_t> input);
inline std::string EncodeBase64(Span<const std::byte> input) {
    return EncodeBase64(MakeUCharSpan(input));
}
inline std::string EncodeBase64(const std::string &str) {
    return EncodeBase64(MakeUCharSpan(str));
}
std::vector<uint8_t> DecodeBase32(const char *p, bool *pf_invalid = nullptr);
std::string DecodeBase32(const std::string &str, bool *pf_invalid = nullptr);
 
std::string EncodeBase32(Span<const uint8_t> input, bool pad = true);
 
std::string EncodeBase32(const std::string &str, bool pad = true);
 
void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut);
int64_t atoi64(const std::string &str);
int atoi(const std::string &str);
 
constexpr bool IsDigit(char c) {
    return c >= '0' && c <= '9';
}
 
constexpr inline bool IsSpace(char c) noexcept {
    return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' ||
           c == '\v';
}
 
[[nodiscard]] bool ParseInt32(const std::string &str, int32_t *out);
 
[[nodiscard]] bool ParseInt64(const std::string &str, int64_t *out);
 
[[nodiscard]] bool ParseUInt8(const std::string &str, uint8_t *out);
 
[[nodiscard]] bool ParseUInt16(const std::string &str, uint16_t *out);
 
[[nodiscard]] bool ParseUInt32(const std::string &str, uint32_t *out);
 
[[nodiscard]] bool ParseUInt64(const std::string &str, uint64_t *out);
 
[[nodiscard]] bool ParseDouble(const std::string &str, double *out);
 
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 HexStr(const Span<const std::byte> s) {
    return HexStr(MakeUCharSpan(s));
}
 
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 |= size_t(a[i] ^ b[i % b.size()]);
    }
    return accumulator == 0;
}
 
[[nodiscard]] bool ParseFixedPoint(const std::string &val, int decimals,
                                   int64_t *amount_out);
 
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;
}
 
constexpr char ToLower(char c) {
    return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
}
 
std::string ToLower(const std::string &str);
 
constexpr char ToUpper(char c) {
    return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
}
 
std::string ToUpper(const std::string &str);
 
std::string Capitalize(std::string str);
 
#endif // BITCOIN_UTIL_STRENCODINGS_H