string-helper.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2022 Regents of the University of California.
 *
 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
 *
 * ndn-cxx library 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 3 of the License, or (at your option) any later version.
 *
 * ndn-cxx library 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 copies of the GNU General Public License and GNU Lesser
 * General Public License along with ndn-cxx, e.g., in COPYING.md file.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
 */

#ifndef NDN_CXX_UTIL_STRING_HELPER_HPP
#define NDN_CXX_UTIL_STRING_HELPER_HPP

#include "ndn-cxx/encoding/buffer.hpp"
#include "ndn-cxx/util/span.hpp"

namespace ndn {

class StringHelperError : public std::invalid_argument
{
public:
  using std::invalid_argument::invalid_argument;
};

void
printHex(std::ostream& os, uint64_t num, bool wantUpperCase = false);

void
printHex(std::ostream& os, span<const uint8_t> buffer, bool wantUpperCase = true);

[[deprecated("use the overload that takes a span<>")]]
inline void
printHex(std::ostream& os, const uint8_t* buffer, size_t length, bool wantUpperCase = true)
{
  printHex(os, {buffer, length}, wantUpperCase);
}

class AsHex
{
public:
  constexpr explicit
  AsHex(uint64_t val) noexcept
    : m_value(val)
  {
  }

private:
  friend std::ostream&
  operator<<(std::ostream& os, const AsHex& hex)
  {
    printHex(os, hex.m_value, os.flags() & std::ostream::uppercase);
    return os;
  }

private:
  uint64_t m_value;
};

NDN_CXX_NODISCARD std::string
toHex(span<const uint8_t> buffer, bool wantUpperCase = true);

[[deprecated("use the overload that takes a span<>")]]
NDN_CXX_NODISCARD inline std::string
toHex(const uint8_t* buffer, size_t length, bool wantUpperCase = true)
{
  return toHex({buffer, length}, wantUpperCase);
}

shared_ptr<Buffer>
fromHex(const std::string& hexString);

NDN_CXX_NODISCARD constexpr char
toHexChar(unsigned int n, bool wantUpperCase = true) noexcept
{
  return wantUpperCase ?
         "0123456789ABCDEF"[n & 0xf] :
         "0123456789abcdef"[n & 0xf];
}

NDN_CXX_NODISCARD constexpr int
fromHexChar(char c) noexcept
{
  return (c >= '0' && c <= '9') ? int(c - '0') :
         (c >= 'A' && c <= 'F') ? int(c - 'A' + 10) :
         (c >= 'a' && c <= 'f') ? int(c - 'a' + 10) :
         -1;
}

NDN_CXX_NODISCARD std::string
escape(const std::string& str);

void
escape(std::ostream& os, const char* str, size_t len);

NDN_CXX_NODISCARD std::string
unescape(const std::string& str);

void
unescape(std::ostream& os, const char* str, size_t len);

} // namespace ndn

#endif // NDN_CXX_UTIL_STRING_HELPER_HPP