vfs.h

Go to the documentation of this file.

 
#pragma once
 
#include "assets/kasset_types.h"
#include "defines.h"
#include "strings/kname.h"
 
struct kpackage;
struct kasset;
struct kasset_metadata;
struct vfs_state;
 
typedef struct vfs_config {
    const char** text_user_types;
    const char* manifest_file_path;
} vfs_config;
 
typedef enum vfs_asset_flag_bits {
    VFS_ASSET_FLAG_NONE = 0,
    VFS_ASSET_FLAG_BINARY_BIT = 0x01,
} vfs_asset_flag_bits;
 
typedef u32 vfs_asset_flags;
 
typedef enum vfs_request_result {
    VFS_REQUEST_RESULT_SUCCESS = 0,
    VFS_REQUEST_RESULT_FILE_DOES_NOT_EXIST,
    VFS_REQUEST_RESULT_NOT_IN_PACKAGE,
    VFS_REQUEST_RESULT_PACKAGE_DOES_NOT_EXIST,
    VFS_REQUEST_RESULT_READ_ERROR,
    VFS_REQUEST_RESULT_WRITE_ERROR,
    VFS_REQUEST_RESULT_INTERNAL_FAILURE,
} vfs_request_result;
 
typedef struct vfs_asset_data {
    kname asset_name;
    kname package_name;
    const char* path;
 
    u64 size;
    union {
        const char* text;
        const void* bytes;
    };
    vfs_asset_flags flags;
 
    vfs_request_result result;
 
    u32 context_size;
 
    void* context;
} vfs_asset_data;
 
typedef void (*PFN_on_asset_loaded_callback)(struct vfs_state* vfs, vfs_asset_data asset_data);
 
typedef struct vfs_state {
    // darray
    struct kpackage* packages;
} vfs_state;
 
typedef struct vfs_request_info {
    kname package_name;
    kname asset_name;
    b8 is_binary;
    u32 context_size;
    const void* context;
 
    PFN_on_asset_loaded_callback vfs_callback;
} vfs_request_info;
 
KAPI b8 vfs_initialize(u64* memory_requirement, vfs_state* out_state, const vfs_config* config);
 
KAPI void vfs_shutdown(vfs_state* state);
 
KAPI void vfs_request_asset(vfs_state* state, vfs_request_info info);
 
KAPI vfs_asset_data vfs_request_asset_sync(vfs_state* state, vfs_request_info info);
 
KAPI const char* vfs_path_for_asset(vfs_state* state, kname package_name, kname asset_name);
 
KAPI const char* vfs_source_path_for_asset(vfs_state* state, kname package_name, kname asset_name);
 
KAPI void vfs_request_direct_from_disk(vfs_state* state, const char* path, b8 is_binary, u32 context_size, const void* context, PFN_on_asset_loaded_callback callback);
 
KAPI void vfs_request_direct_from_disk_sync(vfs_state* state, const char* path, b8 is_binary, u32 context_size, const void* context, vfs_asset_data* out_data);
 
KAPI b8 vfs_asset_write_binary(vfs_state* state, kname asset_name, kname package_name, u64 size, const void* data);
 
KAPI b8 vfs_asset_write_text(vfs_state* state, kname asset_name, kname package_name, const char* text);
 
KAPI void vfs_asset_data_cleanup(vfs_asset_data* data);
 
#if KOHI_HOT_RELOAD
KAPI u32 vfs_asset_watch(vfs_state* state, kname asset_name, kname package_name, b8 is_binary);
 
KAPI b8 vfs_asset_unwatch(vfs_state* state, u32 watch_id);
#endif