le_fs.h

Go to the documentation of this file.

#ifndef LE_FS_H_INCLUDE_GUARD
#define LE_FS_H_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_FS_ACCESS_MODE_MAX 127

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef int le_fs_AccessMode_t;

#define LE_FS_RDONLY 0x1        
#define LE_FS_WRONLY 0x2        
#define LE_FS_RDWR   0x4        
#define LE_FS_CREAT  0x8        
#define LE_FS_TRUNC  0x10       
#define LE_FS_APPEND 0x20       
#define LE_FS_SYNC   0x40       

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_FS_SEEK_SET = 0, 
    LE_FS_SEEK_CUR = 1, 
    LE_FS_SEEK_END = 2  
}
le_fs_Position_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_fs_File* le_fs_FileRef_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Open
(
    const char* filePath,          
    le_fs_AccessMode_t accessMode, 
    le_fs_FileRef_t* fileRefPtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Close
(
    le_fs_FileRef_t fileRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Read
(
    le_fs_FileRef_t fileRef, 
    uint8_t* bufPtr,         
    size_t* bufSizePtr       
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Write
(
    le_fs_FileRef_t fileRef, 
    const uint8_t* bufPtr,   
    size_t bufSize           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Seek
(
    le_fs_FileRef_t fileRef,   
    int32_t offset,            
    le_fs_Position_t position, 
    int32_t* currentOffsetPtr  
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_GetSize
(
    const char* filePath, 
    size_t* sizePtr       
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Delete
(
    const char* filePath 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_Move
(
    const char* srcPath, 
    const char* destPath 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM le_result_t le_fs_RemoveDirRecursive
(
    const char* dirPathPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_API_FILESYSTEM bool le_fs_Exists
(
    const char* filePathPtr     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API LE_API_FILESYSTEM le_result_t le_fs_GetExecutablePath
(
    char    *dirPathPtr,    
    size_t   dirPathSize,   
    char    *exeNamePtr,    
    size_t   exeNameSize    
);

#endif // LE_FS_H_INCLUDE_GUARD