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
|
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFURL.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFMutableURL OFMutableURL.h ObjFW/OFMutableURL.h
*
* @brief A class for parsing URLs and accessing parts of it.
*/
@interface OFMutableURL: OFURL
{
OF_RESERVE_IVARS(OFMutableURL, 4)
}
/**
* @brief The scheme part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *scheme;
/**
* @brief The scheme part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The scheme being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedScheme;
/**
* @brief The host part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *host;
/**
* @brief The host part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The host being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedHost;
/**
* @brief The port part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFNumber *port;
/**
* @brief The user part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *user;
/**
* @brief The user part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The user being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedUser;
/**
* @brief The password part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *password;
/**
* @brief The password part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The password being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedPassword;
/**
* @brief The path part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *path;
/**
* @brief The path part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The path being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedPath;
/**
* @brief The path of the URL split into components.
*
* The first component must always be empty to designate the root.
*
* @throw OFInvalidFormatException The path components being set are not in the
* correct format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFArray OF_GENERIC(OFString *) *pathComponents;
/**
* @brief The query part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *query;
/**
* @brief The query part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The query being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedQuery;
/**
* @brief The query part of the URL as a dictionary.
*
* For example, a query like `key1=value1&key2=value2` would correspond to the
* following dictionary:
*
* @{
* @"key1": @"value1",
* @"key2": @"value2"
* }
*
* @throw OFInvalidFormatException The query is not in the correct format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFDictionary OF_GENERIC(OFString *, OFString *) *queryDictionary;
/**
* @brief The fragment part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *fragment;
/**
* @brief The fragment part of the URL in URL-encoded form.
*
* Setting this retains the original URL-encoding used - if more characters
* than necessary are URL-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The fragment being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *URLEncodedFragment;
/**
* @brief Creates a new mutable URL.
*
* @return A new, autoreleased OFMutableURL
*/
+ (instancetype)URL;
/**
* @brief Appends the specified path component.
*
* @param component The component to append
*/
- (void)appendPathComponent: (OFString *)component;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
|
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFURI.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFMutableURI OFMutableURI.h ObjFW/OFMutableURI.h
*
* @brief A class for parsing URIs and accessing parts of it.
*/
@interface OFMutableURI: OFURI
{
OF_RESERVE_IVARS(OFMutableURI, 4)
}
/**
* @brief The scheme part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *scheme;
/**
* @brief The scheme part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The scheme being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedScheme;
/**
* @brief The host part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *host;
/**
* @brief The host part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The host being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedHost;
/**
* @brief The port part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFNumber *port;
/**
* @brief The user part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *user;
/**
* @brief The user part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The user being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedUser;
/**
* @brief The password part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *password;
/**
* @brief The password part of the URI in URI-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The password being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedPassword;
/**
* @brief The path part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *path;
/**
* @brief The path part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The path being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedPath;
/**
* @brief The path of the URI split into components.
*
* The first component must always be empty to designate the root.
*
* @throw OFInvalidFormatException The path components being set are not in the
* correct format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFArray OF_GENERIC(OFString *) *pathComponents;
/**
* @brief The query part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *query;
/**
* @brief The query part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The query being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedQuery;
/**
* @brief The query part of the URI as a dictionary.
*
* For example, a query like `key1=value1&key2=value2` would correspond to the
* following dictionary:
*
* @{
* @"key1": @"value1",
* @"key2": @"value2"
* }
*
* @throw OFInvalidFormatException The query is not in the correct format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFDictionary OF_GENERIC(OFString *, OFString *) *queryDictionary;
/**
* @brief The fragment part of the URI.
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic) OFString *fragment;
/**
* @brief The fragment part of the URI in percent-encoded form.
*
* Setting this retains the original percent-encoding used - if more characters
* than necessary are percent-encoded, it is kept this way.
*
* @throw OFInvalidFormatException The fragment being set is not in the correct
* format
*/
@property OF_NULLABLE_PROPERTY (readwrite, copy, nonatomic)
OFString *percentEncodedFragment;
/**
* @brief Creates a new mutable URI.
*
* @return A new, autoreleased OFMutableURI
*/
+ (instancetype)URI;
/**
* @brief Appends the specified path component.
*
* @param component The component to append
*/
- (void)appendPathComponent: (OFString *)component;
|