OFFileManager.h

Go to the documentation of this file.

/*
 * 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 "OFObject.h"
#import "OFDictionary.h"

OF_ASSUME_NONNULL_BEGIN

#ifdef OF_HAVE_FILES
# if (defined(OF_HAVE_CHMOD) && !defined(OF_NINTENDO_DS)) || defined(DOXYGEN)
#  define OF_FILE_MANAGER_SUPPORTS_PERMISSIONS
# endif
# if defined(OF_HAVE_CHOWN) || defined(DOXYGEN)
#  define OF_FILE_MANAGER_SUPPORTS_OWNER
# endif
# if (defined(OF_HAVE_LINK) && !defined(OF_AMIGAOS) && \
    !defined(OF_NINTENDO_DS)) || defined(OF_WINDOWS) || defined(DOXYGEN)
#  define OF_FILE_MANAGER_SUPPORTS_LINKS
# endif
# if (defined(OF_HAVE_SYMLINK) && !defined(OF_AMIGAOS) && \
    !defined(OF_NINTENDO_DS)) || defined(OF_WINDOWS) || defined(DOXYGEN)
#  define OF_FILE_MANAGER_SUPPORTS_SYMLINKS
# endif
# if defined(OF_LINUX) || defined(OF_MACOS) || defined(OF_FREEBSD) || \
    defined(OF_NETBSD) || defined(OF_HAIKU) || defined(OF_SOLARIS) || \
    defined(DOXYGEN)
#  define OF_FILE_MANAGER_SUPPORTS_EXTENDED_ATTRIBUTES
# endif
#endif

@class OFArray OF_GENERIC(ObjectType);
@class OFConstantString;
@class OFDate;
@class OFIRI;
@class OFNumber;
@class OFString;

typedef enum {
    OFFileAmigaDeleteProtected  = 0x0001,
    OFFileAmigaExecuteProtected = 0x0002,
    OFFileAmigaWriteProtected   = 0x0004,
    OFFileAmigaReadProtected    = 0x0008,
    OFFileAmigaArchived         = 0x0010,
    OFFileAmigaPure             = 0x0020,
    OFFileAmigaScript           = 0x0040,
    OFFileAmigaHold             = 0x0080,
    OFFileAmigaGroupDeletable   = 0x0100,
    OFFileAmigaGroupExecutable  = 0x0200,
    OFFileAmigaGroupWritable    = 0x0400,
    OFFileAmigaGroupReadable    = 0x0800,
    OFFileAmigaOtherDeletable   = 0x1000,
    OFFileAmigaOtherExecutable  = 0x2000,
    OFFileAmigaOtherWritable    = 0x4000,
    OFFileAmigaOtherReadable    = 0x8000
} OFFileAmigaProtectionMask;

typedef enum {
    OFFileMSDOSAttributeReadOnly    = 0x01,
    OFFileMSDOSAttributeHidden      = 0x02,
    OFFileMSDOSAttributeSystem      = 0x04,
    OFFileMSDOSAttributeVolumeLabel = 0x08,
    OFFileMSDOSAttributeDirectory   = 0x10,
    OFFileMSDOSAttributeArchive     = 0x20,
} OFFileMSDOSAttributesMask;

typedef OFConstantString *OFFileAttributeKey;

typedef OFConstantString *OFFileAttributeType;

typedef OFDictionary OF_GENERIC(OFFileAttributeKey, id) *OFFileAttributes;

typedef OFMutableDictionary OF_GENERIC(OFFileAttributeKey, id)
    *OFMutableFileAttributes;

#ifdef __cplusplus
extern "C" {
#endif

extern const OFFileAttributeKey OFFileSize;

extern const OFFileAttributeKey OFFileType;

extern const OFFileAttributeKey OFFilePOSIXPermissions;

extern const OFFileAttributeKey OFFileOwnerAccountID;

extern const OFFileAttributeKey OFFileGroupOwnerAccountID;

extern const OFFileAttributeKey OFFileOwnerAccountName;

extern const OFFileAttributeKey OFFileGroupOwnerAccountName;

extern const OFFileAttributeKey OFFileLastAccessDate;

extern const OFFileAttributeKey OFFileModificationDate;

extern const OFFileAttributeKey OFFileStatusChangeDate;

extern const OFFileAttributeKey OFFileCreationDate;

extern const OFFileAttributeKey OFFileSymbolicLinkDestination;

extern const OFFileAttributeKey OFFileExtendedAttributesNames;

extern const OFFileAttributeKey OFFileAmigaProtection;

extern const OFFileAttributeKey OFFileAmigaComment;

extern const OFFileAttributeKey OFFileMSDOSAttributes;

extern const OFFileAttributeType OFFileTypeRegular;

extern const OFFileAttributeType OFFileTypeDirectory;

extern const OFFileAttributeType OFFileTypeSymbolicLink;

extern const OFFileAttributeType OFFileTypeFIFO;

extern const OFFileAttributeType OFFileTypeCharacterSpecial;

extern const OFFileAttributeType OFFileTypeBlockSpecial;

extern const OFFileAttributeType OFFileTypeSocket;

extern const OFFileAttributeType OFFileTypeUnknown;
#ifdef __cplusplus
}
#endif

#ifndef OF_FILE_MANAGER_M
OF_SUBCLASSING_RESTRICTED
#endif
@interface OFFileManager: OFObject
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nonatomic) OFFileManager *defaultManager;
#endif

#ifdef OF_HAVE_FILES

@property (readonly, nonatomic) OFString *currentDirectoryPath;

@property (readonly, nonatomic) OFIRI *currentDirectoryIRI;
#endif

+ (OFFileManager *)defaultManager;

#ifdef OF_HAVE_FILES

- (OFFileAttributes)attributesOfItemAtPath: (OFString *)path;
#endif

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

#ifdef OF_HAVE_FILES

- (void)setAttributes: (OFFileAttributes)attributes
     ofItemAtPath: (OFString *)path;
#endif

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

#ifdef OF_HAVE_FILES

- (bool)fileExistsAtPath: (OFString *)path;
#endif

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

#ifdef OF_HAVE_FILES

- (bool)directoryExistsAtPath: (OFString *)path;
#endif

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

#ifdef OF_HAVE_FILES

- (void)createDirectoryAtPath: (OFString *)path;

- (void)createDirectoryAtPath: (OFString *)path
        createParents: (bool)createParents;
#endif

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

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

#ifdef OF_HAVE_FILES

- (OFArray OF_GENERIC(OFString *) *)contentsOfDirectoryAtPath: (OFString *)path;
#endif

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

#ifdef OF_HAVE_FILES

- (OFArray OF_GENERIC(OFString *) *)subpathsOfDirectoryAtPath: (OFString *)path;

- (void)changeCurrentDirectoryPath: (OFString *)path;

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

- (void)copyItemAtPath: (OFString *)source toPath: (OFString *)destination;
#endif

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

#ifdef OF_HAVE_FILES

- (void)moveItemAtPath: (OFString *)source toPath: (OFString *)destination;
#endif

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

#ifdef OF_HAVE_FILES

- (void)removeItemAtPath: (OFString *)path;
#endif

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

#ifdef OF_FILE_MANAGER_SUPPORTS_LINKS

- (void)linkItemAtPath: (OFString *)source toPath: (OFString *)destination;
#endif

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

#ifdef OF_FILE_MANAGER_SUPPORTS_SYMLINKS

- (void)createSymbolicLinkAtPath: (OFString *)path
         withDestinationPath: (OFString *)target;
#endif

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

#ifdef OF_FILE_MANAGER_SUPPORTS_EXTENDED_ATTRIBUTES

- (OFData *)extendedAttributeDataForName: (OFString *)name
                ofItemAtPath: (OFString *)path;

- (void)getExtendedAttributeData: (OFData *_Nonnull *_Nonnull)data
             andType: (id _Nullable *_Nullable)type
             forName: (OFString *)name
            ofItemAtPath: (OFString *)path;
#endif

- (OFData *)extendedAttributeDataForName: (OFString *)name
                 ofItemAtIRI: (OFIRI *)IRI;

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

#ifdef OF_FILE_MANAGER_SUPPORTS_EXTENDED_ATTRIBUTES

- (void)setExtendedAttributeData: (OFData *)data
             forName: (OFString *)name
            ofItemAtPath: (OFString *)path;

- (void)setExtendedAttributeData: (OFData *)data
             andType: (nullable id)type
             forName: (OFString *)name
            ofItemAtPath: (OFString *)path;
#endif

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

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

#ifdef OF_FILE_MANAGER_SUPPORTS_EXTENDED_ATTRIBUTES

- (void)removeExtendedAttributeForName: (OFString *)name
              ofItemAtPath: (OFString *)path;
#endif

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

@interface OFDictionary (FileAttributes)
@property (readonly, nonatomic) unsigned long long fileSize;

@property (readonly, nonatomic) OFFileAttributeType fileType;

@property (readonly, nonatomic) unsigned long filePOSIXPermissions;

@property (readonly, nonatomic) unsigned long fileOwnerAccountID;

@property (readonly, nonatomic) unsigned long fileGroupOwnerAccountID;

@property (readonly, nonatomic) OFString *fileOwnerAccountName;

@property (readonly, nonatomic) OFString *fileGroupOwnerAccountName;

@property (readonly, nonatomic) OFDate *fileLastAccessDate;

@property (readonly, nonatomic) OFDate *fileModificationDate;

@property (readonly, nonatomic) OFDate *fileStatusChangeDate;

@property (readonly, nonatomic) OFDate *fileCreationDate;

@property (readonly, nonatomic) OFString *fileSymbolicLinkDestination;

@property (readonly, nonatomic)
    OFArray OF_GENERIC(OFString *) *fileExtendedAttributesNames;

@property (readonly, nonatomic) OFFileAmigaProtectionMask fileAmigaProtection;

@property (readonly, nonatomic) OFString *fileAmigaComment;

@property (readonly, nonatomic) OFFileMSDOSAttributesMask fileMSDOSAttributes;
@end

OF_ASSUME_NONNULL_END