OFIRI.h

/*
 * Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFCharacterSet.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFDictionary OF_GENERIC(KeyType, ObjectType);
@class OFNumber;
@class OFPair OF_GENERIC(FirstType, SecondType);
@class OFString;
 
@interface OFIRI: OFObject <OFCopying, OFMutableCopying>
{
    OFString *_scheme;
    OFString *_Nullable _percentEncodedHost;
    OFNumber *_Nullable _port;
    OFString *_Nullable _percentEncodedUser;
    OFString *_Nullable _percentEncodedPassword;
    OFString *_percentEncodedPath;
    OFString *_Nullable _percentEncodedQuery;
    OFString *_Nullable _percentEncodedFragment;
    OF_RESERVE_IVARS(OFIRI, 4)
}
 
@property (readonly, copy, nonatomic) OFString *scheme;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *host;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *percentEncodedHost;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFNumber *port;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *user;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *percentEncodedUser;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *password;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *percentEncodedPassword;
 
@property (readonly, copy, nonatomic) OFString *path;
 
@property (readonly, copy, nonatomic) OFString *percentEncodedPath;
 
@property (readonly, copy, nonatomic)
    OFArray OF_GENERIC(OFString *) *pathComponents;
 
@property (readonly, copy, nonatomic) OFString *lastPathComponent;
 
@property (readonly, copy, nonatomic) OFString *pathExtension;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *query;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *percentEncodedQuery;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFArray OF_GENERIC(OFPair OF_GENERIC(OFString *, OFString *) *) *queryItems;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic) OFString *fragment;
 
@property OF_NULLABLE_PROPERTY (readonly, copy, nonatomic)
    OFString *percentEncodedFragment;
 
@property (readonly, nonatomic) OFString *string;
 
@property (readonly, nonatomic) OFIRI *IRIByStandardizingPath;
 
@property (readonly, nonatomic) OFIRI *IRIByDeletingLastPathComponent;
 
@property (readonly, nonatomic) OFIRI *IRIByDeletingPathExtension;
 
@property (readonly, nonatomic)
    OFIRI *IRIByAddingPercentEncodingForUnicodeCharacters;
 
#ifdef OF_HAVE_FILES
@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
    OFString *fileSystemRepresentation;
#endif
 
+ (instancetype)IRIWithString: (OFString *)string;
 
+ (instancetype)IRIWithString: (OFString *)string relativeToIRI: (OFIRI *)IRI;
 
#ifdef OF_HAVE_FILES
+ (instancetype)fileIRIWithPath: (OFString *)path;
 
+ (instancetype)fileIRIWithPath: (OFString *)path
            isDirectory: (bool)isDirectory;
#endif
 
- (instancetype)initWithString: (OFString *)string;
 
- (instancetype)initWithString: (OFString *)string relativeToIRI: (OFIRI *)IRI;
 
#ifdef OF_HAVE_FILES
- (instancetype)initFileIRIWithPath: (OFString *)path;
 
- (instancetype)initFileIRIWithPath: (OFString *)path
            isDirectory: (bool)isDirectory;
#endif
 
- (instancetype)init OF_UNAVAILABLE;
 
- (OFIRI *)IRIByAppendingPathComponent: (OFString *)component;
 
- (OFIRI *)IRIByAppendingPathComponent: (OFString *)component
               isDirectory: (bool)isDirectory;
 
- (OFIRI *)IRIByAppendingPathExtension: (OFString *)extension;
@end
 
@interface OFCharacterSet (IRICharacterSets)
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic)
    OFCharacterSet *IRISchemeAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIHostAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIUserAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIPasswordAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIPathAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIQueryAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIQueryKeyValueAllowedCharacterSet;
@property (class, readonly, nonatomic)
    OFCharacterSet *IRIFragmentAllowedCharacterSet;
#endif
 
+ (OFCharacterSet *)IRISchemeAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIHostAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIUserAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIPasswordAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIPathAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIQueryAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIQueryKeyValueAllowedCharacterSet;
 
+ (OFCharacterSet *)IRIFragmentAllowedCharacterSet;
@end
 
#ifdef __cplusplus
extern "C" {
#endif
extern bool _OFIRIIsIPv6Host(OFString *host) OF_VISIBILITY_HIDDEN;
extern void _OFIRIVerifyIsEscaped(OFString *, OFCharacterSet *, bool)
    OF_VISIBILITY_HIDDEN;
#ifdef __cplusplus
}
#endif
 
OF_ASSUME_NONNULL_END
 
#import "OFMutableIRI.h"