Differences From Artifact [08c79490ee]:
- File
src/OFURL.h
— part of check-in
[ef614a225d]
at
2020-09-26 21:58:39
on branch trunk
— Don't require __COUNTER__ for OF_RESERVE_IVARS
__COUNTER__ does not exist in GCC 4.2, and Apple GCC 4.2 is still the
newest compiler available for macOS 10.5. (user: js, size: 10031) [annotate] [blame] [check-ins using]
To Artifact [7ab8abd7a3]:
- File src/OFURL.h — part of check-in [163a4a5a2e] at 2020-10-03 11:35:41 on branch trunk — Use /** */ instead of /*! */ for documentation (user: js, size: 10031) [annotate] [blame] [check-ins using]
| ︙ | ︙ | |||
21 22 23 24 25 26 27 | OF_ASSUME_NONNULL_BEGIN @class OFArray OF_GENERIC(ObjectType); @class OFNumber; @class OFString; | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 |
OF_ASSUME_NONNULL_BEGIN
@class OFArray OF_GENERIC(ObjectType);
@class OFNumber;
@class OFString;
/**
* @class OFURL OFURL.h ObjFW/OFURL.h
*
* @brief A class for parsing URLs and accessing parts of it.
*/
@interface OFURL: OFObject <OFCopying, OFMutableCopying, OFSerialization>
{
OFString *_Nullable _URLEncodedScheme, *_Nullable _URLEncodedHost;
OFNumber *_Nullable _port;
OFString *_Nullable _URLEncodedUser, *_Nullable _URLEncodedPassword;
OFString *_Nullable _URLEncodedPath;
OFString *_Nullable _URLEncodedQuery, *_Nullable _URLEncodedFragment;
OF_RESERVE_IVARS(OFURL, 4)
}
/**
* @brief The scheme part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *scheme;
/**
* @brief The scheme part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedScheme;
/**
* @brief The host part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *host;
/**
* @brief The host part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedHost;
/**
* @brief The port part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFNumber *port;
/**
* @brief The user part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *user;
/**
* @brief The user part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedUser;
/**
* @brief The password part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *password;
/**
* @brief The password part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedPassword;
/**
* @brief The path part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *path;
/**
* @brief The path part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedPath;
/**
* @brief The path of the URL split into components.
*
* The first component must always be `/` to designate the root.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFArray OF_GENERIC(OFString *) *pathComponents;
/**
* @brief The last path component of the URL.
*
* Returns the empty string if the path is the root.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *lastPathComponent;
/**
* @brief The query part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *query;
/**
* @brief The query part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedQuery;
/**
* @brief The fragment part of the URL.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *fragment;
/**
* @brief The fragment part of the URL in URL-encoded form.
*/
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
OFString *URLEncodedFragment;
/**
* @brief The URL as a string.
*/
@property (readonly, nonatomic) OFString *string;
/**
* @brief The URL with relative sub paths resolved.
*/
@property (readonly, nonatomic) OFURL *URLByStandardizingPath;
#ifdef OF_HAVE_FILES
/**
* @brief The local file system representation for a file URL.
*
* @note This only exists for URLs with the file scheme and throws an exception
* otherwise.
*
*/
@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
OFString *fileSystemRepresentation;
#endif
/**
* @brief Creates a new URL with the specified string.
*
* @param string A string describing a URL
* @return A new, autoreleased OFURL
*/
+ (instancetype)URLWithString: (OFString *)string;
/**
* @brief Creates a new URL with the specified string relative to the
* specified URL.
*
* @param string A string describing a URL
* @param URL An URL to which the string is relative
* @return A new, autoreleased OFURL
*/
+ (instancetype)URLWithString: (OFString *)string
relativeToURL: (OFURL *)URL;
#ifdef OF_HAVE_FILES
/**
* @brief Creates a new URL with the specified local file path.
*
* If a directory exists at the specified path, a slash is appended if there is
* no slash yet.
*
* @param path The local file path
* @return A new, autoreleased OFURL
*/
+ (instancetype)fileURLWithPath: (OFString *)path;
/**
* @brief Creates a new URL with the specified local file path.
*
* @param path The local file path
* @param isDirectory Whether the path is a directory, in which case a slash is
* appened if there is no slash yet
* @return An Initialized OFURL
*/
+ (instancetype)fileURLWithPath: (OFString *)path
isDirectory: (bool)isDirectory;
#endif
/**
* @brief Initializes an already allocated OFURL with the specified string.
*
* @param string A string describing a URL
* @return An initialized OFURL
*/
- (instancetype)initWithString: (OFString *)string;
/**
* @brief Initializes an already allocated OFURL with the specified string and
* relative URL.
*
* @param string A string describing a URL
* @param URL A URL to which the string is relative
* @return An initialized OFURL
*/
- (instancetype)initWithString: (OFString *)string
relativeToURL: (OFURL *)URL;
#ifdef OF_HAVE_FILES
/**
* @brief Initializes an already allocated OFURL with the specified local file
* path.
*
* If a directory exists at the specified path, a slash is appended if there is
* no slash yet.
*
* @param path The local file path
* @return An initialized OFURL
*/
- (instancetype)initFileURLWithPath: (OFString *)path;
/**
* @brief Initializes an already allocated OFURL with the specified local file
* path.
*
* @param path The local file path
* @param isDirectory Whether the path is a directory, in which case a slash is
* appened if there is no slash yet
* @return An Initialized OFURL
*/
- (instancetype)initFileURLWithPath: (OFString *)path
isDirectory: (bool)isDirectory;
#endif
/**
* @brief Returns a new URL with the specified path component appended.
*
* If the URL is a file URL, the file system is queried whether the appended
* component is a directory.
*
* @param component The path component to append. If it starts with the slash,
* the component is not appended, but replaces the path
* instead.
* @return A new URL with the specified path component appended
*/
- (OFURL *)URLByAppendingPathComponent: (OFString *)component;
/**
* @brief Returns a new URL with the specified path component appended.
*
* @param component The path component to append. If it starts with the slash,
* the component is not appended, but replaces the path
* instead.
* @param isDirectory Whether the appended component is a directory, meaning
* that the URL path should have a trailing slash
|
| ︙ | ︙ | |||
289 290 291 292 293 294 295 |
OFCharacterSet *URLPathAllowedCharacterSet;
@property (class, readonly, nonatomic)
OFCharacterSet *URLQueryAllowedCharacterSet;
@property (class, readonly, nonatomic)
OFCharacterSet *URLFragmentAllowedCharacterSet;
#endif
| | | | | | | | | 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 343 344 345 |
OFCharacterSet *URLPathAllowedCharacterSet;
@property (class, readonly, nonatomic)
OFCharacterSet *URLQueryAllowedCharacterSet;
@property (class, readonly, nonatomic)
OFCharacterSet *URLFragmentAllowedCharacterSet;
#endif
/**
* @brief Returns the characters allowed in the scheme part of a URL.
*
* @return The characters allowed in the scheme part of a URL.
*/
+ (OFCharacterSet *)URLSchemeAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the host part of a URL.
*
* @return The characters allowed in the host part of a URL.
*/
+ (OFCharacterSet *)URLHostAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the user part of a URL.
*
* @return The characters allowed in the user part of a URL.
*/
+ (OFCharacterSet *)URLUserAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the password part of a URL.
*
* @return The characters allowed in the password part of a URL.
*/
+ (OFCharacterSet *)URLPasswordAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the path part of a URL.
*
* @return The characters allowed in the path part of a URL.
*/
+ (OFCharacterSet *)URLPathAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the query part of a URL.
*
* @return The characters allowed in the query part of a URL.
*/
+ (OFCharacterSet *)URLQueryAllowedCharacterSet;
/**
* @brief Returns the characters allowed in the fragment part of a URL.
*
* @return The characters allowed in the fragment part of a URL.
*/
+ (OFCharacterSet *)URLFragmentAllowedCharacterSet;
@end
|
| ︙ | ︙ |