common.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include "fs/fs.h"
 
#include <stddef.h>
 
typedef struct map_t map_t;
typedef struct arena_t arena_t;
 
typedef struct fs_inode_t
{
    os_dirent_t type;
    const char *name;
    char data[];
} fs_inode_t;
 
typedef struct fs_iter_t
{
    fs_t *fs;
    const fs_inode_t *dir;
    fs_inode_t *current;
    char data[];
} fs_iter_t;
 
typedef struct inode_result_t
{
    fs_inode_t *node;
    os_error_t error;
} inode_result_t;
 
typedef fs_inode_t *(*fs_query_node_t)(fs_t *fs, const fs_inode_t *node, const char *name);
typedef io_t *(*fs_query_file_t)(fs_t *fs, fs_inode_t *node, os_access_t flags);
 
typedef inode_result_t (*fs_file_create_t)(fs_t *fs, fs_inode_t *node, const char *name);
typedef os_error_t (*fs_file_delete_t)(fs_t *fs, fs_inode_t *node, const char *name);
 
typedef inode_result_t (*fs_dir_create_t)(fs_t *fs, fs_inode_t *node, const char *name);
typedef os_error_t (*fs_dir_delete_t)(fs_t *fs, fs_inode_t *node, const char *name);
 
typedef os_error_t (*fs_iter_begin_t)(fs_t *fs, const fs_inode_t *dir, fs_iter_t *iter);
typedef os_error_t (*fs_iter_next_t)(fs_iter_t *iter);
typedef os_error_t (*fs_iter_end_t)(fs_iter_t *iter);
 
typedef void (*fs_delete_t)(fs_t *fs);
 
typedef struct fs_callbacks_t
{
    fs_query_node_t pfn_query_node;
 
    fs_query_file_t pfn_query_file;
 
    fs_dir_create_t pfn_create_dir;
    fs_dir_delete_t pfn_delete_dir;
 
    fs_file_create_t pfn_create_file;
    fs_file_delete_t pfn_delete_file;
 
    fs_iter_begin_t pfn_iter_begin;
    fs_iter_next_t pfn_iter_next;
    fs_iter_end_t pfn_iter_end;
 
    size_t iter_size;
    size_t inode_size;
} fs_callbacks_t;
 
typedef struct fs_t
{
    const fs_callbacks_t *cb; 
    arena_t *arena;
    fs_inode_t *root; 
 
    char data[];
} fs_t;
 
// inode api
 
CT_LOCAL extern fs_inode_t gInvalidFileNode;
 
CT_LOCAL fs_inode_t *inode_file(fs_t *fs, const char *name, const void *data);
CT_LOCAL fs_inode_t *inode_dir(fs_t *fs, const char *name, const void *data);
CT_LOCAL fs_inode_t *inode_new(fs_t *fs, os_dirent_t type, const char *name, const void *data);
 
CT_LOCAL void *inode_data(fs_inode_t *inode);
CT_LOCAL CT_CONSTFN bool inode_is(const fs_inode_t *inode, os_dirent_t type);
CT_LOCAL CT_CONSTFN const char *inode_name(const fs_inode_t *inode);
 
CT_LOCAL void *iter_data(fs_iter_t *iter);
 
// helpers
CT_LOCAL os_error_t mkdir_recursive(const char *path, arena_t *arena);
 
// fs api
 
CT_LOCAL fs_t *fs_new(
    void *root,
    const fs_callbacks_t *cb,
    const void *data,
    size_t size,
    arena_t *arena);
 
CT_LOCAL void *fs_data(fs_t *fs);