OFIRIHandler.h

/*
 * Copyright (c) 2008-2026 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 "OFFileManager.h"
#import "OFObject.h"
#import "OFString.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFData;
@class OFDate;
@class OFIRI;
@class OFIRIHandler;
@class OFStream;

@protocol OFIRIHandlerDelegate <OFObject>
- (void)IRIHandler: (OFIRIHandler *)IRIHandler
  didOpenItemAtIRI: (OFIRI *)IRI
        stream: (nullable OF_KINDOF(OFStream *))stream
     exception: (nullable id)exception;
@end

@interface OFIRIHandler: OFObject
{
    OFString *_scheme;
    OF_RESERVE_IVARS(OFIRIHandler, 4)
}

@property (readonly, nonatomic) OFString *scheme;

+ (bool)registerClass: (Class)class_ forScheme: (OFString *)scheme;

+ (OFIRIHandler *)handlerForIRI: (OFIRI *)IRI;

+ (OF_KINDOF(OFStream *))openItemAtIRI: (OFIRI *)IRI mode: (OFString *)mode;

+ (void)asyncOpenItemAtIRI: (OFIRI *)IRI
              mode: (OFString *)mode
          delegate: (id <OFIRIHandlerDelegate>)delegate;
 
- (instancetype)init OF_UNAVAILABLE;

- (instancetype)initWithScheme: (OFString *)scheme OF_DESIGNATED_INITIALIZER;

- (OF_KINDOF(OFStream *))openItemAtIRI: (OFIRI *)IRI mode: (OFString *)mode;

- (void)asyncOpenItemAtIRI: (OFIRI *)IRI
              mode: (OFString *)mode
          delegate: (id <OFIRIHandlerDelegate>)delegate;

- (OFFileAttributes)attributesOfItemAtIRI: (OFIRI *)IRI;

- (void)setAttributes: (OFFileAttributes)attributes ofItemAtIRI: (OFIRI *)IRI;

- (bool)fileExistsAtIRI: (OFIRI *)IRI;

- (bool)directoryExistsAtIRI: (OFIRI *)IRI;

- (void)createDirectoryAtIRI: (OFIRI *)IRI;

- (OFArray OF_GENERIC(OFIRI *) *)contentsOfDirectoryAtIRI: (OFIRI *)IRI;

- (void)removeItemAtIRI: (OFIRI *)IRI;

- (void)linkItemAtIRI: (OFIRI *)source toIRI: (OFIRI *)destination;

- (void)createSymbolicLinkAtIRI: (OFIRI *)IRI
        withDestinationPath: (OFString *)target;

- (bool)copyItemAtIRI: (OFIRI *)source toIRI: (OFIRI *)destination;

- (bool)moveItemAtIRI: (OFIRI *)source toIRI: (OFIRI *)destination;

- (OFData *)extendedAttributeDataForName: (OFString *)name
                 ofItemAtIRI: (OFIRI *)IRI
    OF_DEPRECATED(ObjFW, 1, 1,
    "Use -[getExtendedAttributeData:andType:forName:ofItemAtIRI:] instead");

- (void)getExtendedAttributeData: (OFData *_Nonnull *_Nonnull)data
             andType: (id _Nullable *_Nullable)type
             forName: (OFString *)name
             ofItemAtIRI: (OFIRI *)IRI;

- (void)setExtendedAttributeData: (OFData *)data
             forName: (OFString *)name
             ofItemAtIRI: (OFIRI *)IRI
    OF_DEPRECATED(ObjFW, 1, 1,
    "Use -[setExtendedAttributeData:andType:forName:ofItemAtIRI:] instead");

- (void)setExtendedAttributeData: (OFData *)data
             andType: (nullable id)type
             forName: (OFString *)name
             ofItemAtIRI: (OFIRI *)IRI;

- (void)removeExtendedAttributeForName: (OFString *)name
               ofItemAtIRI: (OFIRI *)IRI;
@end
 
OF_ASSUME_NONNULL_END