Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
| 2 | /** |
| 3 | * Copyright (C) 2013 Regents of the University of California. |
| 4 | * @author: Jeff Thompson <jefft0@remap.ucla.edu> |
| 5 | * @author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 6 | * @author: Zhenkai Zhu <zhenkai@cs.ucla.edu> |
| 7 | * See COPYING for copyright and distribution information. |
| 8 | */ |
| 9 | |
| 10 | #ifndef NDN_NAME_COMPONENT_HPP |
| 11 | #define NDN_NAME_COMPONENT_HPP |
| 12 | |
| 13 | #include "common.hpp" |
| 14 | #include "encoding/block.hpp" |
| 15 | #include "encoding/encoding-buffer.hpp" |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 16 | #include "util/string-helper.hpp" |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 17 | |
| 18 | namespace ndn { |
| 19 | namespace name { |
| 20 | |
| 21 | /** |
| 22 | * A Name::Component holds a read-only name component value. |
| 23 | */ |
| 24 | class Component : public Block |
| 25 | { |
| 26 | public: |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 27 | /** |
Alexander Afanasyev | 2a7f720 | 2014-04-23 14:25:29 -0700 | [diff] [blame] | 28 | * @brief Error that can be thrown from name::Component |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 29 | */ |
Alexander Afanasyev | 2a7f720 | 2014-04-23 14:25:29 -0700 | [diff] [blame] | 30 | class Error : public Block::Error |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 31 | { |
| 32 | public: |
| 33 | explicit |
| 34 | Error(const std::string& what) |
Alexander Afanasyev | 2a7f720 | 2014-04-23 14:25:29 -0700 | [diff] [blame] | 35 | : Block::Error(what) |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 36 | { |
| 37 | } |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 38 | }; |
| 39 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 40 | /** |
| 41 | * Create a new Name::Component with a null value. |
| 42 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 43 | Component(); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 44 | |
Alexander Afanasyev | 52eb20d | 2014-02-06 18:25:54 -0800 | [diff] [blame] | 45 | /** |
| 46 | * @brief Directly create component from wire block |
| 47 | * |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 48 | * Any block can be implicitly converted to name::Component |
| 49 | * |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 50 | * @throws Error if wire.type() is not Tlv::Component |
Alexander Afanasyev | 52eb20d | 2014-02-06 18:25:54 -0800 | [diff] [blame] | 51 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 52 | Component(const Block& wire); |
| 53 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 54 | /** |
| 55 | * Create a new Name::Component, taking another pointer to the Blob value. |
| 56 | * @param value A blob with a pointer to an immutable array. The pointer is copied. |
| 57 | */ |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 58 | explicit |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 59 | Component(const ConstBufferPtr& buffer); |
| 60 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 61 | /** |
| 62 | * Create a new Name::Component, copying the given value. |
| 63 | * @param value The value byte array. |
| 64 | */ |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 65 | explicit |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 66 | Component(const Buffer& value); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 67 | |
| 68 | /** |
| 69 | * Create a new Name::Component, copying the given value. |
| 70 | * @param value Pointer to the value byte array. |
| 71 | * @param valueLen Length of value. |
| 72 | */ |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 73 | Component(const uint8_t* value, size_t valueLen); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 74 | |
| 75 | template<class InputIterator> |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 76 | Component(InputIterator begin, InputIterator end); |
Alexander Afanasyev | 52eb20d | 2014-02-06 18:25:54 -0800 | [diff] [blame] | 77 | |
| 78 | explicit |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 79 | Component(const char* str); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 80 | |
Alexander Afanasyev | 52eb20d | 2014-02-06 18:25:54 -0800 | [diff] [blame] | 81 | explicit |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 82 | Component(const std::string& str); |
| 83 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 84 | /** |
| 85 | * @brief Fast encoding or block size estimation |
| 86 | */ |
| 87 | template<bool T> |
| 88 | size_t |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 89 | wireEncode(EncodingImpl<T>& block) const; |
| 90 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 91 | /** |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 92 | * @brief Encode to a wire format |
| 93 | */ |
| 94 | inline const Block& |
| 95 | wireEncode() const; |
| 96 | |
| 97 | /** |
| 98 | * @brief Decode from the wire format |
| 99 | */ |
| 100 | inline void |
| 101 | wireDecode(const Block& wire); |
| 102 | |
| 103 | /** |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 104 | * Make a Blob value by decoding the escapedString between beginOffset and endOffset according to the NDN URI Scheme. |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 105 | * If the escaped string is "", "." or ".." then return a Blob with a null pointer, |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 106 | * which means the component should be skipped in a URI name. |
| 107 | * @param escapedString The escaped string. It does not need to be null-terminated because we only scan to endOffset. |
| 108 | * @param beginOffset The offset in escapedString of the beginning of the portion to decode. |
| 109 | * @param endOffset The offset in escapedString of the end of the portion to decode. |
| 110 | * @return The Blob value. If the escapedString is not a valid escaped component, then the Blob is a null pointer. |
| 111 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 112 | static Component |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 113 | fromEscapedString(const char* escapedString, size_t beginOffset, size_t endOffset); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 114 | |
| 115 | /** |
| 116 | * Make a Blob value by decoding the escapedString according to the NDN URI Scheme. |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 117 | * If the escaped string is "", "." or ".." then return a Blob with a null pointer, |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 118 | * which means the component should be skipped in a URI name. |
| 119 | * @param escapedString The null-terminated escaped string. |
| 120 | * @return The Blob value. If the escapedString is not a valid escaped component, then the Blob is a null pointer. |
| 121 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 122 | static Component |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 123 | fromEscapedString(const char* escapedString) |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 124 | { |
| 125 | return fromEscapedString(escapedString, 0, ::strlen(escapedString)); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Make a Blob value by decoding the escapedString according to the NDN URI Scheme. |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 130 | * If the escaped string is "", "." or ".." then return a Blob with a null pointer, |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 131 | * which means the component should be skipped in a URI name. |
| 132 | * @param escapedString The escaped string. |
| 133 | * @return The Blob value. If the escapedString is not a valid escaped component, then the Blob is a null pointer. |
| 134 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 135 | static Component |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 136 | fromEscapedString(const std::string& escapedString) |
| 137 | { |
| 138 | return fromEscapedString(escapedString.c_str()); |
| 139 | } |
| 140 | |
| 141 | /** |
| 142 | * Write the value to result, escaping characters according to the NDN URI Scheme. |
| 143 | * This also adds "..." to a value with zero or more ".". |
| 144 | * @param value the buffer with the value to escape |
| 145 | * @param result the string stream to write to. |
| 146 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 147 | void |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 148 | toEscapedString(std::ostream& result) const; |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 149 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 150 | /** |
| 151 | * Convert the value by escaping characters according to the NDN URI Scheme. |
| 152 | * This also adds "..." to a value with zero or more ".". |
| 153 | * @param value the buffer with the value to escape |
| 154 | * @return The escaped string. |
| 155 | */ |
| 156 | inline std::string |
| 157 | toEscapedString() const |
| 158 | { |
| 159 | std::ostringstream result; |
| 160 | toEscapedString(result); |
| 161 | return result.str(); |
| 162 | } |
Alexander Afanasyev | 52eb20d | 2014-02-06 18:25:54 -0800 | [diff] [blame] | 163 | |
| 164 | inline void |
| 165 | toUri(std::ostream& result) const |
| 166 | { |
| 167 | return toEscapedString(result); |
| 168 | } |
| 169 | |
| 170 | inline std::string |
| 171 | toUri() const |
| 172 | { |
| 173 | return toEscapedString(); |
| 174 | } |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 175 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 176 | /** |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 177 | * @brief Interpret this name component as nonNegativeInteger |
| 178 | * |
| 179 | * @see http://named-data.net/doc/ndn-tlv/tlv.html#non-negative-integer-encoding |
| 180 | * |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 181 | * @return The integer number. |
| 182 | */ |
| 183 | uint64_t |
| 184 | toNumber() const; |
| 185 | |
| 186 | /** |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 187 | * @brief An alias for toNumber() |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 188 | */ |
| 189 | uint64_t |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 190 | toVersion() const; |
| 191 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 192 | /** |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 193 | * @brief An alias for toNumber() |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 194 | */ |
| 195 | uint64_t |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 196 | toSegment() const; |
| 197 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 198 | /** |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 199 | * @brief Create a component encoded as nonNegativeInteger |
| 200 | * |
| 201 | * @see http://named-data.net/doc/ndn-tlv/tlv.html#non-negative-integer-encoding |
| 202 | * |
| 203 | * @param number The non-negative number |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 204 | * @return The component value. |
| 205 | */ |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 206 | static Component |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 207 | fromNumber(uint64_t number); |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 208 | |
| 209 | /** |
| 210 | * Check if this is the same component as other. |
| 211 | * @param other The other Component to compare with. |
| 212 | * @return true if the components are equal, otherwise false. |
| 213 | */ |
| 214 | bool |
| 215 | equals(const Component& other) const |
| 216 | { |
| 217 | if (value_size() != other.value_size()) |
| 218 | return false; |
Alexander Afanasyev | 60c8681 | 2014-02-20 15:19:33 -0800 | [diff] [blame] | 219 | if (value_size() == 0 /* == other.value_size()*/) |
| 220 | return true; |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 221 | |
Alexander Afanasyev | 60c8681 | 2014-02-20 15:19:33 -0800 | [diff] [blame] | 222 | // somehow, behavior is wrong on OSX 10.9 when component is empty |
| 223 | // (probably some bug in STL...) |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 224 | return std::equal(value_begin(), value_end(), other.value_begin()); |
| 225 | } |
| 226 | |
| 227 | bool |
| 228 | empty() const |
| 229 | { |
| 230 | return !hasValue(); |
| 231 | } |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 232 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 233 | /** |
| 234 | * Check if this is the same component as other. |
| 235 | * @param other The other Component to compare with. |
| 236 | * @return true if the components are equal, otherwise false. |
| 237 | */ |
| 238 | bool |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 239 | operator==(const Component& other) const { return equals(other); } |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 240 | |
| 241 | /** |
| 242 | * Check if this is not the same component as other. |
| 243 | * @param other The other Component to compare with. |
| 244 | * @return true if the components are not equal, otherwise false. |
| 245 | */ |
| 246 | bool |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 247 | operator!=(const Component& other) const { return !equals(other); } |
| 248 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 249 | /** |
| 250 | * Compare this to the other Component using NDN canonical ordering. |
| 251 | * @param other The other Component to compare with. |
| 252 | * @return 0 If they compare equal, -1 if *this comes before other in the canonical ordering, or |
| 253 | * 1 if *this comes after other in the canonical ordering. |
| 254 | * |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 255 | * @see http://named-data.net/doc/ndn-tlv/name.html#canonical-order |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 256 | */ |
| 257 | int |
| 258 | compare(const Component& other) const; |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 259 | |
| 260 | /** |
| 261 | * Return true if this is less than or equal to the other Component in the NDN canonical ordering. |
| 262 | * @param other The other Component to compare with. |
| 263 | * |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 264 | * @see http://named-data.net/doc/ndn-tlv/name.html#canonical-order |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 265 | */ |
| 266 | bool |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 267 | operator<=(const Component& other) const { return compare(other) <= 0; } |
| 268 | |
| 269 | /** |
| 270 | * Return true if this is less than the other Component in the NDN canonical ordering. |
| 271 | * @param other The other Component to compare with. |
| 272 | * |
| 273 | * @see http://named-data.net/doc/ndn-tlv/name.html#canonical-order |
| 274 | */ |
| 275 | bool |
| 276 | operator<(const Component& other) const { return compare(other) < 0; } |
| 277 | |
| 278 | /** |
| 279 | * Return true if this is less than or equal to the other Component in the NDN canonical ordering. |
| 280 | * @param other The other Component to compare with. |
| 281 | * |
| 282 | * @see http://named-data.net/doc/ndn-tlv/name.html#canonical-order |
| 283 | */ |
| 284 | bool |
| 285 | operator>=(const Component& other) const { return compare(other) >= 0; } |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 286 | |
| 287 | /** |
| 288 | * Return true if this is greater than the other Component in the NDN canonical ordering. |
| 289 | * @param other The other Component to compare with. |
| 290 | * |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 291 | * @see http://named-data.net/doc/ndn-tlv/name.html#canonical-order |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 292 | */ |
| 293 | bool |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 294 | operator>(const Component& other) const { return compare(other) > 0; } |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 295 | |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 296 | // |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 297 | // !!! MUST NOT INCLUDE ANY DATA HERE !!! |
| 298 | // |
| 299 | // This class is just a helper and is directly reinterpret_cast'ed from Block |
| 300 | }; |
| 301 | |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 302 | inline std::ostream& |
| 303 | operator << (std::ostream& os, const Component& component) |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 304 | { |
| 305 | component.toEscapedString(os); |
| 306 | return os; |
| 307 | } |
| 308 | |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 309 | inline |
| 310 | Component::Component() |
| 311 | : Block(Tlv::NameComponent) |
| 312 | { |
| 313 | } |
| 314 | |
| 315 | inline |
| 316 | Component::Component(const Block& wire) |
| 317 | : Block(wire) |
| 318 | { |
| 319 | if (type() != Tlv::NameComponent) |
| 320 | throw Error("Constructing name component from non name component TLV wire block"); |
| 321 | } |
| 322 | |
| 323 | inline |
| 324 | Component::Component(const ConstBufferPtr& buffer) |
| 325 | : Block (Tlv::NameComponent, buffer) |
| 326 | { |
| 327 | } |
| 328 | |
| 329 | inline |
| 330 | Component::Component(const Buffer& value) |
| 331 | : Block (Tlv::NameComponent, ConstBufferPtr(new Buffer(value))) |
| 332 | { |
| 333 | } |
| 334 | |
| 335 | inline |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 336 | Component::Component(const uint8_t* value, size_t valueLen) |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 337 | : Block (Tlv::NameComponent, ConstBufferPtr(new Buffer(value, valueLen))) |
| 338 | { |
| 339 | } |
| 340 | |
| 341 | template<class InputIterator> |
| 342 | inline |
| 343 | Component::Component(InputIterator begin, InputIterator end) |
| 344 | : Block (Tlv::NameComponent, ConstBufferPtr(new Buffer(begin, end))) |
| 345 | { |
| 346 | } |
| 347 | |
| 348 | inline |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 349 | Component::Component(const char* str) |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 350 | : Block (Tlv::NameComponent, ConstBufferPtr(new Buffer(str, ::strlen(str)))) |
| 351 | { |
| 352 | } |
| 353 | |
| 354 | inline |
| 355 | Component::Component(const std::string& str) |
| 356 | : Block (Tlv::NameComponent, ConstBufferPtr(new Buffer(str.begin(), str.end()))) |
| 357 | { |
| 358 | } |
| 359 | |
| 360 | |
| 361 | inline Component |
| 362 | Component::fromEscapedString(const char* escapedString, size_t beginOffset, size_t endOffset) |
| 363 | { |
| 364 | std::string trimmedString(escapedString + beginOffset, escapedString + endOffset); |
| 365 | trim(trimmedString); |
| 366 | std::string value = unescape(trimmedString); |
| 367 | |
| 368 | if (value.find_first_not_of(".") == std::string::npos) { |
| 369 | // Special case for component of only periods. |
| 370 | if (value.size() <= 2) |
| 371 | // Zero, one or two periods is illegal. Ignore this component. |
| 372 | return Component(); |
| 373 | else |
| 374 | // Remove 3 periods. |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 375 | return Component(reinterpret_cast<const uint8_t*>(&value[3]), value.size() - 3); |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 376 | } |
| 377 | else |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 378 | return Component(reinterpret_cast<const uint8_t*>(&value[0]), value.size()); |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 379 | } |
| 380 | |
| 381 | |
| 382 | inline void |
| 383 | Component::toEscapedString(std::ostream& result) const |
| 384 | { |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 385 | const uint8_t* valuePtr = value(); |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 386 | size_t valueSize = value_size(); |
| 387 | |
| 388 | bool gotNonDot = false; |
| 389 | for (unsigned i = 0; i < valueSize; ++i) { |
| 390 | if (valuePtr[i] != 0x2e) { |
| 391 | gotNonDot = true; |
| 392 | break; |
| 393 | } |
| 394 | } |
| 395 | if (!gotNonDot) { |
| 396 | // Special case for component of zero or more periods. Add 3 periods. |
| 397 | result << "..."; |
| 398 | for (size_t i = 0; i < valueSize; ++i) |
| 399 | result << '.'; |
| 400 | } |
| 401 | else { |
| 402 | // In case we need to escape, set to upper case hex and save the previous flags. |
| 403 | std::ios::fmtflags saveFlags = result.flags(std::ios::hex | std::ios::uppercase); |
| 404 | |
| 405 | for (size_t i = 0; i < valueSize; ++i) { |
| 406 | uint8_t x = valuePtr[i]; |
| 407 | // Check for 0-9, A-Z, a-z, (+), (-), (.), (_) |
| 408 | if ((x >= 0x30 && x <= 0x39) || (x >= 0x41 && x <= 0x5a) || |
| 409 | (x >= 0x61 && x <= 0x7a) || x == 0x2b || x == 0x2d || |
| 410 | x == 0x2e || x == 0x5f) |
| 411 | result << x; |
| 412 | else { |
| 413 | result << '%'; |
| 414 | if (x < 16) |
| 415 | result << '0'; |
| 416 | result << (unsigned int)x; |
| 417 | } |
| 418 | } |
| 419 | |
| 420 | // Restore. |
| 421 | result.flags(saveFlags); |
| 422 | } |
| 423 | } |
| 424 | |
Alexander Afanasyev | 4b98e8c | 2014-03-22 19:10:19 -0700 | [diff] [blame] | 425 | |
| 426 | inline Component |
| 427 | Component::fromNumber(uint64_t number) |
| 428 | { |
| 429 | /// \todo Change to Tlv::NumberComponent |
| 430 | return nonNegativeIntegerBlock(Tlv::NameComponent, number); |
| 431 | } |
| 432 | |
| 433 | |
| 434 | inline uint64_t |
| 435 | Component::toNumber() const |
| 436 | { |
| 437 | /// \todo Check if Component is of Tlv::NumberComponent type |
| 438 | return readNonNegativeInteger(static_cast<const Block&>(*this)); |
| 439 | } |
| 440 | |
| 441 | |
| 442 | inline uint64_t |
| 443 | Component::toVersion() const |
| 444 | { |
| 445 | return toNumber(); |
| 446 | } |
| 447 | |
| 448 | inline uint64_t |
| 449 | Component::toSegment() const |
| 450 | { |
| 451 | return toNumber(); |
| 452 | } |
| 453 | |
Alexander Afanasyev | 1dd95c5 | 2014-03-22 19:11:36 -0700 | [diff] [blame] | 454 | inline int |
| 455 | Component::compare(const Component& other) const |
| 456 | { |
| 457 | // Imitate ndn_Exclude_compareComponents. |
| 458 | if (value_size() < other.value_size()) |
| 459 | return -1; |
| 460 | if (value_size() > other.value_size()) |
| 461 | return 1; |
| 462 | |
| 463 | if (value_size() == 0) |
| 464 | return 0; |
| 465 | |
| 466 | // The components are equal length. Just do a byte compare. |
| 467 | return std::memcmp(value(), other.value(), value_size()); |
| 468 | } |
| 469 | |
| 470 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 471 | template<bool T> |
| 472 | inline size_t |
| 473 | Component::wireEncode(EncodingImpl<T>& block) const |
| 474 | { |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 475 | size_t totalLength = 0; |
Alexander Afanasyev | 380420b | 2014-02-09 20:52:29 -0800 | [diff] [blame] | 476 | if (value_size() > 0) |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 477 | totalLength += block.prependByteArray (value(), value_size()); |
| 478 | totalLength += block.prependVarNumber (value_size()); |
| 479 | totalLength += block.prependVarNumber (Tlv::NameComponent); |
| 480 | return totalLength; |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 481 | } |
| 482 | |
Alexander Afanasyev | fdbfc6d | 2014-04-14 15:12:11 -0700 | [diff] [blame] | 483 | /** |
| 484 | * @brief Encode to a wire format |
| 485 | */ |
| 486 | inline const Block& |
| 487 | Component::wireEncode() const |
| 488 | { |
| 489 | if (this->hasWire()) |
| 490 | return *this; |
| 491 | |
| 492 | EncodingEstimator estimator; |
| 493 | size_t estimatedSize = wireEncode(estimator); |
| 494 | |
| 495 | EncodingBuffer buffer(estimatedSize, 0); |
| 496 | wireEncode(buffer); |
| 497 | |
| 498 | const_cast<Component&>(*this) = buffer.block(); |
| 499 | return *this; |
| 500 | } |
| 501 | |
| 502 | /** |
| 503 | * @brief Decode from the wire format |
| 504 | */ |
| 505 | inline void |
| 506 | Component::wireDecode(const Block& wire) |
| 507 | { |
| 508 | if (wire.type() != Tlv::NameComponent) |
| 509 | throw Error("wireDecode name component from non name component TLV wire block"); |
| 510 | |
| 511 | *this = wire; |
| 512 | } |
| 513 | |
| 514 | |
Alexander Afanasyev | 95e8c2f | 2014-02-06 17:29:30 -0800 | [diff] [blame] | 515 | } // namespace name |
| 516 | } // namespace ndn |
| 517 | |
| 518 | #endif // NDN_NAME_COMPONENT_HPP |