OFFileManager.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * 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 "OFObject.h"
#import "OFSeekableStream.h"

OF_ASSUME_NONNULL_BEGIN

#if defined(OF_HAVE_CHMOD) && !defined(OF_MORPHOS)
# define OF_FILE_MANAGER_SUPPORTS_PERMISSIONS
#endif
#if defined(OF_HAVE_CHOWN) && !defined(OF_MORPHOS)
# define OF_FILE_MANAGER_SUPPORTS_OWNER
#endif
#if (defined(OF_HAVE_LINK) && !defined(OF_MORPHOS)) || defined(OF_WINDOWS)
# define OF_FILE_MANAGER_SUPPORTS_LINKS
#endif
#if (defined(OF_HAVE_SYMLINK) && !defined(OF_MORPHOS)) || defined(OF_WINDOWS)
# define OF_FILE_MANAGER_SUPPORTS_SYMLINKS
#endif

@class OFArray OF_GENERIC(ObjectType);
@class OFDate;

@interface OFFileManager: OFObject
+ (OFFileManager *)defaultManager;

- (OFString *)currentDirectoryPath;

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

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

#ifdef OF_FILE_MANAGER_SUPPORTS_SYMLINKS

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

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

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

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

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

- (of_offset_t)sizeOfFileAtPath: (OFString *)path;

- (OFDate *)accessTimeOfItemAtPath: (OFString *)path;

- (OFDate *)modificationTimeOfItemAtPath: (OFString *)path;

- (OFDate *)statusChangeTimeOfItemAtPath: (OFString *)path;

#ifdef OF_FILE_MANAGER_SUPPORTS_PERMISSIONS

- (uint16_t)permissionsOfItemAtPath: (OFString *)path;

- (void)changePermissionsOfItemAtPath: (OFString *)path
              permissions: (uint16_t)permissions;
#endif

#ifdef OF_FILE_MANAGER_SUPPORTS_OWNER

- (void)getOwner: (OFString *__autoreleasing _Nonnull *_Nullable)owner
       group: (OFString *__autoreleasing _Nonnull *_Nullable)group
    ofItemAtPath: (OFString *)path;

- (void)changeOwnerOfItemAtPath: (OFString *)path
              owner: (OFString *)owner
              group: (OFString *)group;
#endif

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

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

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

#ifdef OF_FILE_MANAGER_SUPPORTS_LINKS

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

#ifdef OF_FILE_MANAGER_SUPPORTS_SYMLINKS

- (void)createSymbolicLinkAtPath: (OFString *)destination
         withDestinationPath: (OFString *)source;

- (OFString *)destinationOfSymbolicLinkAtPath: (OFString *)path;
#endif
@end

OF_ASSUME_NONNULL_END