blob: dc59f06fa936f5b3fa41bcfa70c0d4921ddee4e3 [file] [log] [blame]
Jeff Thompson47eecfc2013-07-07 22:56:46 -07001/**
2 * @author: Jeff Thompson
3 * See COPYING for copyright and distribution information.
Jeff Thompson9c41dfe2013-06-27 12:10:25 -07004 */
5
6#ifndef NDN_NAME_HPP
Jeff Thompson2d27e2f2013-08-09 12:55:00 -07007#define NDN_NAME_HPP
Jeff Thompson9c41dfe2013-06-27 12:10:25 -07008
9#include <vector>
Jeff Thompson443398d2013-07-02 19:45:46 -070010#include <string>
Jeff Thompsonec7789a2013-08-21 11:08:36 -070011#include <sstream>
Jeff Thompson53412192013-08-06 13:35:50 -070012#include "c/name.h"
13#include "encoding/binary-xml-wire-format.hpp"
Jeff Thompson9c41dfe2013-06-27 12:10:25 -070014
15namespace ndn {
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070016
Jeff Thompson9c41dfe2013-06-27 12:10:25 -070017class Name {
18public:
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070019 class Component {
20 public:
21 /**
22 * Create a new Name::Component with an empty value.
23 */
24 Component()
25 {
26 }
27
28 /**
29 * Create a new Name::Component, copying the given value.
30 * @param value The value byte array.
31 */
32 Component(const std::vector<unsigned char> &value)
33 : value_(value)
34 {
35 }
36
37 /**
38 * Create a new Name::Component, copying the given value.
39 * @param value Pointer to the value byte array.
40 * @param valueLen Length of value.
41 */
Jeff Thompsona166b732013-08-27 16:09:29 -070042 Component(const unsigned char *value, unsigned int valueLen)
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070043 : value_(value, value + valueLen)
44 {
45 }
46
47 /**
48 * Set the componentStruct to point to this component, without copying any memory.
49 * WARNING: The resulting pointer in componentStruct is invalid after a further use of this object which could reallocate memory.
50 * @param componentStruct The C ndn_NameComponent struct to receive the pointer.
51 */
52 void get(struct ndn_NameComponent &componentStruct) const
53 {
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070054 componentStruct.valueLength = value_.size();
Jeff Thompson38d0e082013-08-12 18:07:44 -070055 if (value_.size() > 0)
56 componentStruct.value = (unsigned char *)&value_[0];
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070057 }
58
59 /**
60 * Set this component value by decoding the escapedString between first and last according to the NDN URI Scheme.
61 * If the escaped string is "", "." or ".." then return false, which means this component value was not changed, and
62 * the component should be skipped in a URI name.
63 * @param first Pointer to the beginning of the escaped string
64 * @param last Pointer to the first character past the end of the escaped string
65 * @return True for success, false if escapedString is not a valid escaped component.
66 */
67 bool setFromEscapedString(const char *first, const char *last);
68
69 const std::vector<unsigned char> &getValue() const { return value_; }
Jeff Thompson8aac1992013-08-12 17:26:02 -070070
71 /**
72 * Set this component to the encoded segment number.
73 * @param segment The segment number.
74 */
75 void setSegment(unsigned long segment);
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070076
77 private:
78 std::vector<unsigned char> value_;
79 };
80
Jeff Thompson443398d2013-07-02 19:45:46 -070081 /**
82 * Create a new Name with no components.
83 */
Jeff Thompson016ed642013-07-02 14:39:06 -070084 Name() {
85 }
Jeff Thompson443398d2013-07-02 19:45:46 -070086
87 /**
Jeff Thompson3f2175b2013-07-31 17:12:47 -070088 * Create a new Name, copying the name components.
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070089 * @param components A vector of Component
Jeff Thompson3f2175b2013-07-31 17:12:47 -070090 */
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -070091 Name(const std::vector<Component> &components)
Jeff Thompson3f2175b2013-07-31 17:12:47 -070092 : components_(components)
93 {
94 }
95
96 /**
Jeff Thompson443398d2013-07-02 19:45:46 -070097 * Parse the uri according to the NDN URI Scheme and create the name with the components.
Jeff Thompson3f2175b2013-07-31 17:12:47 -070098 * @param uri The URI string.
Jeff Thompson443398d2013-07-02 19:45:46 -070099 */
Jeff Thompson67515bd2013-08-15 17:43:22 -0700100 Name(const char *uri)
101 {
102 set(uri);
103 }
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -0700104
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700105 /**
Jeff Thompson016ed642013-07-02 14:39:06 -0700106 * Set the nameStruct to point to the components in this name, without copying any memory.
107 * WARNING: The resulting pointers in nameStruct are invalid after a further use of this object which could reallocate memory.
Jeff Thompson3f2175b2013-07-31 17:12:47 -0700108 * @param nameStruct A C ndn_Name struct where the components array is already allocated.
Jeff Thompson016ed642013-07-02 14:39:06 -0700109 */
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700110 void get(struct ndn_Name &nameStruct) const;
Jeff Thompson016ed642013-07-02 14:39:06 -0700111
112 /**
Jeff Thompson8b27e3a2013-07-03 18:19:53 -0700113 * Clear this name, and set the components by copying from the name struct.
Jeff Thompson3f2175b2013-07-31 17:12:47 -0700114 * @param nameStruct A C ndn_Name struct
Jeff Thompsonb468c312013-07-01 17:50:14 -0700115 */
Jeff Thompsondd3d2292013-07-10 11:59:44 -0700116 void set(const struct ndn_Name &nameStruct);
Jeff Thompsonb468c312013-07-01 17:50:14 -0700117
118 /**
Jeff Thompson67515bd2013-08-15 17:43:22 -0700119 * Parse the uri according to the NDN URI Scheme and set the name with the components.
120 * @param uri The URI string.
121 */
122 void set(const char *uri);
123
124 /**
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700125 * Add a new component, copying from value of length valueLength.
126 */
Jeff Thompsona166b732013-08-27 16:09:29 -0700127 void addComponent(const unsigned char *value, unsigned int valueLength) {
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -0700128 components_.push_back(Component(value, valueLength));
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700129 }
Jeff Thompsonf72b1ac2013-08-16 16:44:41 -0700130
131 /**
132 * Add a new component, copying from value.
133 */
134 void addComponent(const std::vector<unsigned char> &value) {
135 components_.push_back(value);
136 }
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700137
138 /**
139 * Clear all the components.
140 */
141 void clear() {
142 components_.clear();
143 }
144
145 /**
146 * Get the number of components.
Jeff Thompson3f2175b2013-07-31 17:12:47 -0700147 * @return The number of components.
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700148 */
Jeff Thompsond345a5b2013-07-08 16:18:23 -0700149 unsigned int getComponentCount() const {
Jeff Thompsone5f839b2013-06-28 12:50:38 -0700150 return components_.size();
151 }
152
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -0700153 const Component &getComponent(unsigned int i) const { return components_[i]; }
Jeff Thompson443398d2013-07-02 19:45:46 -0700154
Jeff Thompsone6063512013-07-01 15:11:28 -0700155 /**
156 * Encode this name as a URI.
Jeff Thompson3f2175b2013-07-31 17:12:47 -0700157 * @return The encoded URI.
Jeff Thompsone6063512013-07-01 15:11:28 -0700158 */
Jeff Thompson21844fc2013-08-08 14:52:51 -0700159 std::string toUri() const;
Jeff Thompsone6063512013-07-01 15:11:28 -0700160
Jeff Thompson21844fc2013-08-08 14:52:51 -0700161 /**
162 * @deprecated Use toUri().
163 */
164 std::string to_uri() const
165 {
166 return toUri();
167 }
Jeff Thompson8aac1992013-08-12 17:26:02 -0700168
169 /**
170 * Append a component with the encoded segment number.
171 * @param segment The segment number.
172 */
173 void appendSegment(unsigned long segment)
174 {
175 components_.push_back(Component());
176 components_.back().setSegment(segment);
177 }
Jeff Thompsoncc35cd42013-08-20 12:23:14 -0700178
Jeff Thompsonec7789a2013-08-21 11:08:36 -0700179 /**
180 * Check if the N components of this name are the same as the first N components of the given name.
181 * @param name The Name to check.
182 * @return true if this matches the given name, otherwise false. This always returns true if this name is empty.
183 */
Jeff Thompson15dc9642013-08-27 17:19:35 -0700184 bool match(const Name &name) const;
Jeff Thompsonec7789a2013-08-21 11:08:36 -0700185
186 /**
187 * Write the value to result, escaping characters according to the NDN URI Scheme.
188 * This also adds "..." to a value with zero or more ".".
189 * @param value the buffer with the value to escape
190 * @param result the string stream to write to.
191 */
192 static void toEscapedString(const std::vector<unsigned char> &value, std::ostringstream &result);
Jeff Thompson21844fc2013-08-08 14:52:51 -0700193
Jeff Thompson9c41dfe2013-06-27 12:10:25 -0700194private:
Jeff Thompson5a6b5ab2013-08-05 15:43:47 -0700195 std::vector<Component> components_;
Jeff Thompson9c41dfe2013-06-27 12:10:25 -0700196};
197
198}
199
200#endif
201