xfileoperation.h

//
//  xfileoperation.h
// These functions are declared in macos_fileoperation, win_fileoperation...
//
//  Created by Mootools on 20/05/2016.
//  Copyright © 2016 Mootools. All rights reserved.
//
 
#ifndef xfileoperation_h
#define xfileoperation_h
 
#include "XTime.h"
#include "XFile.h"
 
BEGIN_MOOTOOLS_NAMESPACE
 
//////////////////////////////////////////////////////////////
// File access - Open / close file
//
//bool xFileOpen(FILE **f, const CXString& name, const CXString& mode);
#define XFILE_ERROR ((fileuint)-1)
 
xFileHandle xFileOpen(const CXString& name, unsigned int mode);
bool xFileClose(xFileHandle handle); // Return true if handle is NULL or file handle succeed to be closed.
fileuint xFileRead(xFileHandle handle, void *buffer, fileuint maxByteToRead); // return the effective number of byte read. XFILE_ERROR means an error
fileuint xFileWrite(xFileHandle handle, const void *buffer, fileuint byteToWrite); // Return the effective number of byte written. XFILE_ERROR or less means an error
bool xFileFlush(xFileHandle handle);
bool xFileIsValid(xFileHandle handle); // Return true if the handle is valid, false if null or invalid.
fileuint xFileSeek(xFileHandle handle, longint position, CXFile::SeekPosition mode); // Position the file pointer. Return the position or XFILE_ERROR
fileuint xFileGetPosition(xFileHandle handle); // Get file pointer position. Return the position or XFILE_ERROR
fileuint xFileGetSize(xFileHandle handle); // Return file size or XFILE_ERROR
bool xFileSetSize(xFileHandle handle, fileuint size);
 
xFileHandle xFileGetHandleFromStream(FILE *stream); // Get an O/S file handle from a FILE stream, NULL if fails
FILE *xFileGetStreamFromHandle(xFileHandle fileHandle, unsigned int mode); // Get a file handle from a FILE stream, NULL if fails
 
///////////////////////////////////////////
// Basic file operation Copy / Delete files
bool xFileRename(const CXString& srcfile, const CXString& newfile);
bool xFileCopy(const CXString& srcfile, const CXString& newfile, bool dontOverwrite);
bool xFileDelete(const CXString& file);
bool xDirectoryCreate(const CXString& dir);
bool xDirectoryRemove(const CXString& dir); // Remove directory, fails if directory is not empty
 
//////////////////////////////////////////////////////////
// Get file information and find file on disk
//
 
typedef enum  XFILE_ATTRIBUTE XEnumType(unsigned int)
{
    XFILE_ATTRIBUTE_INVALID = 0, // filename is invalid
    XFILE_ATTRIBUTE_NORMAL = 0x01,
    XFILE_ATTRIBUTE_READONLY = 0x02,
    XFILE_ATTRIBUTE_HIDDEN = 0x04,
    XFILE_ATTRIBUTE_DIRECTORY = 0x08,
} XFILE_ATTRIBUTE;
 
typedef struct xFileInfo
{
    unsigned int attributes; // XFILE_ATTRIBUTE combination, XFILE_ATTRIBUTE_INVALID if file does not exists
    fileuint size; // -1 if file does not exist
} xFileInfo;
 
typedef struct xFileFindInfo
{
    CXString filename;
    xFileInfo fileinfo;
} xFileFindInfo;
 
bool xFileGetInfo(const CXString& filename, xFileInfo& info); // Get file info, return false if file does not exists.
xFileFindHandle xFileFindInit(const CXString& filename, xFileFindInfo *info); // info is optionnal. If not provided, we only check the existence of the file
bool xFileFindNext(xFileFindHandle handle, xFileFindInfo *info);  // info is optionnal. If not provided, we only check the existence of the file
bool xFileFindClose(xFileFindHandle handle);
 
typedef enum
{
    XFILE_TIME_CREATED = 1,
    XFILE_TIME_MODIFIED,
    XFILE_TIME_ACCESS,
} XFILE_TIMETYPE;
 
//////////////////////////////////////////////////////////
// Information on file
//
 
bool xFileGetTime(CXTime& filetime, const CXString& file, XFILE_TIMETYPE type);
bool xFileSetTime(const CXTime& time, const CXString& filename, XFILE_TIMETYPE type);
 
//////////////////////////////////////////////////////////
// Special features - running context
//
bool xFileGetTmpFolder(CXString& tmpfolder); // Return true if tmp folder is support by the OS, false if not. tmpFolder value is set to the tmp directory or a tmp folder in the application directory
bool xFileGetCurrentDirectory(CXString& currentfolder); // Return true if current folder is support by the OS or previously set by xFileSetCurrentDirectory, false if not. currentfolder value is set to the current OS directory or the application directory with a slash termination
bool xFileSetCurrentDirectory(const CXString& newcurrentfolder); // Set the current directory. Return true if it succeed
 
CXString xFileGetRunningApplicationName(); // Return the path of the running application in lower case string, including the path
CXFileException::FileExceptionType xFileGetLastErrorException(); // Return an OS error code related to file operation. If no error code is not supported by the OS return CXFileException::none
 
END_MOOTOOLS_NAMESPACE
 
#endif /* xfileoperation_h */