OFFile.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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.
 */

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#include <sys/types.h>
#include <sys/stat.h>

#import "OFSeekableStream.h"

OF_ASSUME_NONNULL_BEGIN

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

#if defined(_WIN32)
typedef struct __stat64 of_stat_t;
#elif defined(OF_HAVE_OFF64_T)
typedef struct stat64 of_stat_t;
#else
typedef struct stat of_stat_t;
#endif

@interface OFFile: OFSeekableStream
{
    int  _fd;
    bool _atEndOfStream;
}

+ (instancetype)fileWithPath: (OFString*)path
            mode: (OFString*)mode;

+ (instancetype)fileWithFileDescriptor: (int)fd;

+ (OFString*)currentDirectoryPath;

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

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

#ifdef OF_HAVE_SYMLINK

+ (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_HAVE_CHMOD

+ (void)changePermissionsOfItemAtPath: (OFString*)path
              permissions: (mode_t)permissions;
#endif

#ifdef OF_HAVE_CHOWN

+ (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_HAVE_LINK

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

#ifdef OF_HAVE_SYMLINK

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

+ (OFString*)destinationOfSymbolicLinkAtPath: (OFString*)path;
#endif

- initWithPath: (OFString*)path
      mode: (OFString*)mode;

- initWithFileDescriptor: (int)fd;
@end

#ifdef __cplusplus
extern "C" {
#endif
extern int of_stat(OFString *path, of_stat_t *buffer);
extern int of_lstat(OFString *path, of_stat_t *buffer);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END