vl_filesys.h

Go to the documentation of this file.

 
#ifndef VL_FILESYS_H
#define VL_FILESYS_H
 
#include "vl_arena.h"
 
typedef enum
{
    VL_FS_SUCCESS = 0, 
    VL_FS_ERROR_ACCESS_DENIED, 
    VL_FS_ERROR_PATH_INVALID, 
    VL_FS_ERROR_NOT_FOUND, 
    VL_FS_ERROR_IO 
} vl_filesys_result;
 
typedef struct vl_filesys_iter_* vl_filesys_iter;
 
#define VL_FS_ITER_INVALID NULL
 
struct vl_filesys_;
 
typedef struct
{
    struct vl_filesys_* sys; 
    vl_pool_idx pathIndex; 
    vl_arena_ptr pathStringPtr; 
} vl_filesys_path;
 
typedef struct
{
    struct vl_filesys_* sys; 
    vl_pool_idx statIndex; 
    vl_bool_t isDirectory; 
    vl_bool_t isReadOnly; 
    vl_memsize_t fileSize; 
    vl_ularge_t createTime; 
    vl_ularge_t modifyTime; 
    vl_ularge_t accessTime; 
    vl_filesys_path filePath; 
    // Assume we're looking at the path "./foo/bar.txt"
    vl_arena_ptr baseName; 
    vl_arena_ptr extension; 
    vl_arena_ptr fullName; 
} vl_filesys_stat;
 
typedef struct vl_filesys_
{
    vl_arena memory; 
    vl_pool statPool; 
    vl_pool pathPool; 
    vl_pool iterPool; 
} vl_filesys;
 
VL_API void vlFSInit(vl_filesys* sys);
 
VL_API void vlFSFree(vl_filesys* sys);
 
VL_API vl_filesys* vlFSNew(void);
 
VL_API void vlFSDelete(vl_filesys* sys);
 
VL_API vl_filesys_stat* vlFSStatNew(vl_filesys* sys);
 
VL_API void vlFSStatDelete(vl_filesys_stat* stat);
 
VL_API vl_filesys_result vlFSStatPath(const vl_filesys_path* path, vl_filesys_stat* result);
 
VL_API vl_filesys_result vlFSStatIter(vl_filesys_iter iter, vl_filesys_stat* result);
 
VL_API vl_filesys_path* vlFSPathNew(vl_filesys* sys, const char* path);
 
VL_API void vlFSPathDelete(vl_filesys_path* path);
 
VL_API vl_filesys_path* vlFSPathClone(const vl_filesys_path* src, vl_filesys_path* dest);
 
VL_API vl_bool_t vlFSPathEquals(const vl_filesys_path* pathA, const vl_filesys_path* pathB);
 
VL_API void vlFSPathSet(vl_filesys_path* path, const char* pathStr);
 
VL_API const vl_transient* vlFSPathString(const vl_filesys_path* path);
 
VL_API void vlFSPathJoin(const vl_filesys_path* base, vl_filesys_path* dest, const char* component);
 
VL_API void vlFSPathNormalize(vl_filesys_path* path);
 
VL_API void vlFSPathParent(const vl_filesys_path* path, vl_filesys_path* parentOut);
 
VL_API void vlFSPathAbsolute(vl_filesys_path* path);
 
VL_API vl_bool_t vlFSPathIsAbsolute(const vl_filesys_path* path);
 
VL_API vl_filesys_result vlFSPathMkDir(const vl_filesys_path* path);
 
VL_API vl_filesys_result vlFSPathRemove(const vl_filesys_path* path);
 
VL_API vl_bool_t vlFSPathExists(const vl_filesys_path* path);
 
VL_API vl_filesys_iter vlFSIterNew(vl_filesys* sys);
 
VL_API void vlFSIterDelete(vl_filesys_iter iter);
 
VL_API vl_filesys_result vlFSIterDir(vl_filesys_iter* iter, const vl_filesys_path* path);
 
VL_API vl_filesys_result vlFSIterDirRecursive(vl_filesys_iter* iterPtr, const vl_filesys_path* path);
 
VL_API vl_bool_t vlFSIterNext(vl_filesys_iter* iter);
 
#endif // VL_FILESYS_H