filesystem.h

Go to the documentation of this file.

 
#ifndef GLCE_ENGINE_CORE_FILESYSTEM_FILESYSTEM_H
#define GLCE_ENGINE_CORE_FILESYSTEM_FILESYSTEM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
 
typedef struct filesystem filesystem_t;
 
typedef enum {
    FILESYSTEM_SUCCESS = 0,         
    FILESYSTEM_INVALID_ARGUMENT,    
    FILESYSTEM_RUNTIME_ERROR,       
    FILESYSTEM_NO_MEMORY,           
    FILESYSTEM_FILE_OPEN_ERROR,     
    FILESYSTEM_FILE_CLOSE_ERROR,    
    FILESYSTEM_UNDEFINED_ERROR,     
    FILESYSTEM_LIMIT_EXCEEDED,      
    FILESYSTEM_EOF,                 
} filesystem_result_t;
 
typedef enum {
    FILESYSTEM_MODE_NONE = 0,               
    FILESYSTEM_MODE_READ,                   
    FILESYSTEM_MODE_WRITE,                  
    FILESYSTEM_MODE_APPEND,                 
    FILESYSTEM_MODE_READ_PLUS,              
    FILESYSTEM_MODE_WRITE_PLUS,             
    FILESYSTEM_MODE_APPEND_PLUS,            
    FILESYSTEM_MODE_READ_BINARY,            
    FILESYSTEM_MODE_WRITE_BINARY,           
    FILESYSTEM_MODE_APPEND_BINARY,          
    FILESYSTEM_MODE_READ_PLUS_BINARY,       
    FILESYSTEM_MODE_WRITE_PLUS_BINARY,      
    FILESYSTEM_MODE_APPEND_PLUS_BINARY,     
} filesystem_open_mode_t;
 
filesystem_result_t filesystem_create(filesystem_t** filesystem_);
 
void filesystem_destroy(filesystem_t** filesystem_);
 
filesystem_result_t filesystem_open(filesystem_t* filesystem_, const char* fullpath_, filesystem_open_mode_t mode_);
 
filesystem_result_t filesystem_close(filesystem_t* filesystem_);
 
filesystem_result_t filesystem_byte_read(filesystem_t* filesystem_, size_t read_bytes_, size_t* result_n_, char* buffer_);
 
const char* filesystem_open_mode_c_str(filesystem_open_mode_t mode_);
 
#ifdef TEST_BUILD
void filesystem_rslt_code_set(filesystem_result_t result_code_);
 
void filesystem_test_param_reset(void);
#endif
 
#ifdef __cplusplus
}
#endif
#endif