NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
string-helper.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_UTIL_STRING_HELPER_HPP
23 #define NDN_UTIL_STRING_HELPER_HPP
24 
26 
27 namespace ndn {
28 
29 class Buffer;
30 
31 class StringHelperError : public std::invalid_argument
32 {
33 public:
34  explicit
35  StringHelperError(const std::string& what)
36  : std::invalid_argument(what)
37  {
38  }
39 };
40 
52 class AsHex
53 {
54 public:
55  constexpr explicit
56  AsHex(uint64_t val) noexcept
57  : m_value(val)
58  {
59  }
60 
61 private:
62  uint64_t m_value;
63 
64  friend std::ostream& operator<<(std::ostream&, const AsHex&);
65 };
66 
67 std::ostream&
68 operator<<(std::ostream& os, const AsHex& hex);
69 
79 void
80 printHex(std::ostream& os, uint64_t num, bool wantUpperCase = false);
81 
101 void
102 printHex(std::ostream& os, const uint8_t* buffer, size_t length, bool wantUpperCase = true);
103 
111 void
112 printHex(std::ostream& os, const Buffer& buffer, bool wantUpperCase = true);
113 
132 std::string
133 toHex(const uint8_t* buffer, size_t length, bool wantUpperCase = true);
134 
141 std::string
142 toHex(const Buffer& buffer, bool wantUpperCase = true);
143 
150 shared_ptr<Buffer>
151 fromHex(const std::string& hexString);
152 
156 constexpr char
157 toHexChar(unsigned int n, bool wantUpperCase = true) noexcept
158 {
159  return wantUpperCase ?
160  "0123456789ABCDEF"[n & 0xf] :
161  "0123456789abcdef"[n & 0xf];
162 }
163 
167 constexpr int
168 fromHexChar(char c) noexcept
169 {
170  return (c >= '0' && c <= '9') ? int(c - '0') :
171  (c >= 'A' && c <= 'F') ? int(c - 'A' + 10) :
172  (c >= 'a' && c <= 'f') ? int(c - 'a' + 10) :
173  -1;
174 }
175 
192 std::string
193 escape(const std::string& str);
194 
195 void
196 escape(std::ostream& os, const char* str, size_t len);
197 
211 std::string
212 unescape(const std::string& str);
213 
214 void
215 unescape(std::ostream& os, const char* str, size_t len);
216 
217 } // namespace ndn
218 
219 #endif // NDN_UTIL_STRING_HELPER_HPP
Copyright (c) 2011-2015 Regents of the University of California.
std::string toHex(const uint8_t *buffer, size_t length, bool wantUpperCase)
Return a string containing the hex representation of the bytes in buffer.
std::ostream & operator<<(std::ostream &os, const Data &data)
Definition: data.cpp:322
Helper class to convert a number to hexadecimal format, for use with stream insertion operators.
StringHelperError(const std::string &what)
friend std::ostream & operator<<(std::ostream &, const AsHex &)
import common constructs for ndn-cxx library internal use
shared_ptr< Buffer > fromHex(const std::string &hexString)
Convert the hex string to buffer.
std::string unescape(const std::string &str)
Decode a percent-encoded string.
constexpr char toHexChar(unsigned int n, bool wantUpperCase=true) noexcept
Convert (the least significant nibble of) n to the corresponding hex character.
std::string escape(const std::string &str)
Percent-encode a string.
constexpr int fromHexChar(char c) noexcept
Convert the hex character c to an integer in [0, 15], or -1 if it's not a hex character.
void printHex(std::ostream &os, uint64_t num, bool wantUpperCase)
Output the hex representation of num to the output stream os.
constexpr AsHex(uint64_t val) noexcept