OFFile.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   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>

#import "OFSeekableStream.h"

@class OFArray;
@class OFDate;

#ifdef __cplusplus
extern "C" {
#endif
extern void of_log(OFConstantString*, ...);
#ifdef __cplusplus
}
#endif

@interface OFFile: OFSeekableStream
{
    int  fd;
    BOOL closable;
    BOOL atEndOfStream;
}

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

+ (instancetype)fileWithFileDescriptor: (int)fileDescriptor;

+ (OFString*)currentDirectoryPath;

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

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

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

+ (void)createDirectoryAtPath: (OFString*)path
        createParents: (BOOL)createParents;

+ (OFArray*)filesInDirectoryAtPath: (OFString*)path;

+ (void)changeToDirectoryAtPath: (OFString*)path;

+ (off_t)sizeOfFileAtPath: (OFString*)path;

+ (OFDate*)modificationDateOfFileAtPath: (OFString*)path;

#ifndef _PSP

+ (void)changeModeOfFileAtPath: (OFString*)path
              mode: (mode_t)mode;
#endif

#if !defined(_WIN32) && !defined(_PSP)

+ (void)changeOwnerOfFileAtPath: (OFString*)path
              owner: (OFString*)owner
              group: (OFString*)group;
#endif

+ (void)copyFileAtPath: (OFString*)source
        toPath: (OFString*)destination;

+ (void)renameFileAtPath: (OFString*)source
          toPath: (OFString*)destination;

+ (void)deleteFileAtPath: (OFString*)path;

+ (void)deleteDirectoryAtPath: (OFString*)path;

#ifndef _WIN32

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

#if !defined(_WIN32) && !defined(_PSP)

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

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

- initWithFileDescriptor: (int)fileDescriptor;
@end

#ifdef __cplusplus
extern "C" {
#endif
extern OFStream *of_stdin;
extern OFStream *of_stdout;
extern OFStream *of_stderr;
#ifdef __cplusplus
}
#endif