1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
#ifndef URI_HPP
#define URI_HPP
/**
* @file Uri.hpp
*
* This module declares the Uri::Uri class.
*
* © 2018 by Richard Walters
*/
#include <memory>
#include <stdint.h>
#include <string>
#include <vector>
namespace Uri {
/**
* This class represents a Uniform Resource Identifier (URI),
* as defined in RFC 3986 (https://tools.ietf.org/html/rfc3986).
*/
class Uri {
// Lifecycle management
public:
~Uri() noexcept;
Uri(const Uri& other);
Uri(Uri&&) noexcept;
Uri& operator=(const Uri& other);
Uri& operator=(Uri&&) noexcept;
// Public methods
public:
/**
* This is the default constructor.
*/
Uri();
/**
* This is the equality comparison operator for the class.
*
* @param[in] other
* This is the other URI to which to compare this URI.
*
* @return
* An indication of whether or not the two URIs are
* equal is returned.
*/
bool operator==(const Uri& other) const;
/**
* This is the inequality comparison operator for the class.
*
* @param[in] other
* This is the other URI to which to compare this URI.
*
* @return
* An indication of whether or not the two URIs are
* not equal is returned.
*/
bool operator!=(const Uri& other) const;
/**
* This method builds the URI from the elements parsed
* from the given string rendering of a URI.
*
* @param[in] uriString
* This is the string rendering of the URI to parse.
*
* @return
* An indication of whether or not the URI was
* parsed successfully is returned.
*/
bool ParseFromString(const std::string& uriString);
/**
* This method returns the "scheme" element of the URI.
*
* @return
* The "scheme" element of the URI is returned.
*
* @retval ""
* This is returned if there is no "scheme" element in the URI.
*/
std::string GetScheme() const;
/**
* This method returns the "UserInfo" element of the URI.
*
* @return
* The "UserInfo" element of the URI is returned.
*
* @retval ""
* This is returned if there is no "UserInfo" element in the URI.
*/
std::string GetUserInfo() const;
/**
* This method returns the "host" element of the URI.
*
* @return
* The "host" element of the URI is returned.
*
* @retval ""
* This is returned if there is no "host" element in the URI.
*/
std::string GetHost() const;
/**
* This method returns the "path" element of the URI,
* as a sequence of segments.
*
* @note
* If the first segment of the path is an empty string,
* then the URI has an absolute path.
*
* @return
* The "path" element of the URI is returned
* as a sequence of segments.
*/
std::vector< std::string > GetPath() const;
/**
* This method returns an indication of whether or not the
* URI includes a port number.
*
* @return
* An indication of whether or not the
* URI includes a port number is returned.
*/
bool HasPort() const;
/**
* This method returns the port number element of the URI,
* if it has one.
*
* @return
* The port number element of the URI is returned.
*
* @note
* The returned port number is only valid if the
* HasPort method returns true.
*/
uint16_t GetPort() const;
/**
* This method returns an indication of whether or not
* the URI is a relative reference.
*
* @return
* An indication of whether or not the URI is a
* relative reference is returned.
*/
bool IsRelativeReference() const;
/**
* This method returns an indication of whether or not
* the URI contains a relative path.
*
* @return
* An indication of whether or not the URI contains a
* relative path is returned.
*/
bool ContainsRelativePath() const;
/**
* This method returns an indication of whether or not the
* URI includes a query.
*
* @return
* An indication of whether or not the
* URI includes a query is returned.
*/
bool HasQuery() const;
/**
* This method returns the "query" element of the URI,
* if it has one.
*
* @return
* The "query" element of the URI is returned.
*
* @retval ""
* This is returned if there is no "query" element in the URI.
*/
std::string GetQuery() const;
/**
* This method returns an indication of whether or not the
* URI includes a fragment.
*
* @return
* An indication of whether or not the
* URI includes a fragment is returned.
*/
bool HasFragment() const;
/**
* This method returns the "fragment" element of the URI,
* if it has one.
*
* @return
* The "fragment" element of the URI is returned.
*
* @retval ""
* This is returned if there is no "fragment" element in the URI.
*/
std::string GetFragment() const;
/**
* This method applies the "remove_dot_segments" routine talked about
* in RFC 3986 (https://tools.ietf.org/html/rfc3986) to the path
* segments of the URI, in order to normalize the path
* (apply and remove "." and ".." segments).
*/
void NormalizePath();
/**
* This method resolves the given relative reference, based on the given
* base URI, returning the resolved target URI.
*
* @param[in] relativeReference
* This describes how to get to the target starting at the base.
*
* @return
* The resolved target URI is returned.
*
* @note
* It only makes sense to call this method on an absolute URI
* (in which I mean, the base URI should be absolute,
* as in IsRelativeReference() should return false).
*/
Uri Resolve(const Uri& relativeReference) const;
/**
* This method sets the scheme element of the URI.
*
* @param[in] scheme
* This is the scheme to set for the URI.
*/
void SetScheme(const std::string& scheme);
/**
* This method sets the userinfo element of the URI.
*
* @param[in] userinfo
* This is the userinfo to set for the URI.
*/
void SetUserInfo(const std::string& userinfo);
/**
* This method sets the host element of the URI.
*
* @param[in] host
* This is the host to set for the URI.
*/
void SetHost(const std::string& host);
/**
* This method sets the port element of the URI.
*
* @param[in] port
* This is the port to set for the URI.
*/
void SetPort(uint16_t port);
/**
* This method removes the port element from the URI.
*/
void ClearPort();
/**
* This method sets the path element of the URI.
*
* @param[in] path
* This is the sequence of segments to use to form the path
* to set for the URI.
*
* An empty string segment can be used at the front to
* indicate an absolute path (as opposed to a relative one).
*
* An empty string segment can be used at the back to
* make sure the path ends in a delimiter (forward slash)
* when printed out or when combined with another URI
* via the Resolve() method.
*/
void SetPath(const std::vector< std::string >& path);
/**
* This method removes the query element from the URI.
*/
void ClearQuery();
/**
* This method sets the query element of the URI.
*
* @param[in] query
* This is the query to set for the URI.
*/
void SetQuery(const std::string& query);
/**
* This method removes the fragment element from the URI.
*/
void ClearFragment();
/**
* This method sets the fragment element of the URI.
*
* @param[in] fragment
* This is the fragment to set for the URI.
*/
void SetFragment(const std::string& fragment);
/**
* This method constructs and returns the string
* rendering of the URI, according to the rules
* in RFC 3986 (https://tools.ietf.org/html/rfc3986).
*
* @return
* The string rendering of the URI is returned.
*/
std::string GenerateString() const;
// Private properties
private:
/**
* This is the type of structure that contains the private
* properties of the instance. It is defined in the implementation
* and declared here to ensure that it is scoped inside the class.
*/
struct Impl;
/**
* This contains the private properties of the instance.
*/
std::unique_ptr< Impl > impl_;
};
}
#endif /* URI_HPP */
|
