ra8_io_fsfmt.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_fs.h"
#include "ra8_fs_meta.h"

typedef enum : uint8_t {
  k_ra8_io_fsfmt_max = 8, 
} ra8_io_fsfmt_limits_t;

typedef enum : uint16_t {
  k_ra8_io_fsfmt_fat_max_name_utf8   = 741U, 
  k_ra8_io_fsfmt_exfat_max_name_utf8 = 192U, 
} ra8_io_fsfmt_name_limit_t;

typedef struct {
  uint32_t directory_workspace_bytes; 
  uint16_t max_name_len;              
  uint16_t max_open_directories;      
  uint8_t  directory_workspace_align; 
  bool     read_only;                 
  bool     supports_mkdir;            
  bool     supports_rmdir;            
  bool     supports_streaming_write;  
  bool     supports_timestamps;       
  bool     supports_free_space;       
  bool     supports_dir_cursor;       
  bool     supports_sync;             
  bool     atomic_rename;             
  bool     durable_sync;              
  bool     unicode_names;             
  bool     case_sensitive;            
} ra8_io_fsfmt_caps_t;

typedef bool (*ra8_io_fsfmt_probe_fn_t)(const ra8_fs_backend_t* backend);

typedef ra8_err_t (*ra8_io_fsfmt_mount_fn_t)(const ra8_fs_backend_t* backend, void** out_mount);
typedef ra8_err_t (*ra8_io_fsfmt_unmount_fn_t)(void* mount_ctx);
typedef ra8_err_t (*ra8_io_fsfmt_open_fn_t)(void*         mount_ctx,
                                            const char*   path,
                                            ra8_fs_mode_t mode,
                                            void**        out_file);
typedef ra8_err_t (*ra8_io_fsfmt_close_fn_t)(void* file_ctx);
typedef ra8_err_t (*ra8_io_fsfmt_read_fn_t)(void*     file_ctx,
                                            void*     buf,
                                            uint32_t  bytes,
                                            uint32_t* out_read);
typedef ra8_err_t (*ra8_io_fsfmt_write_fn_t)(void* file_ctx, const void* buf, uint32_t bytes);
typedef ra8_err_t (*ra8_io_fsfmt_seek_fn_t)(void* file_ctx, uint64_t offset_bytes);
typedef ra8_err_t (*ra8_io_fsfmt_tell_fn_t)(const void* file_ctx, uint64_t* out_offset);
typedef ra8_err_t (*ra8_io_fsfmt_size_fn_t)(const void* file_ctx, uint64_t* out_bytes);
typedef ra8_err_t (*ra8_io_fsfmt_sync_fn_t)(void* file_ctx);
typedef ra8_err_t (*ra8_io_fsfmt_stat_fn_t)(void* mount_ctx, const char* path, ra8_fs_stat_t* out);
typedef ra8_err_t (*ra8_io_fsfmt_listdir_fn_t)(void*               mount_ctx,
                                               const char*         path,
                                               ra8_fs_listdir_cb_t cb,
                                               void*               cb_ctx);
typedef ra8_err_t (*ra8_io_fsfmt_dir_open_fn_t)(void*       mount_ctx,
                                                const char* path,
                                                void*       directory_state,
                                                uint32_t    state_bytes);
typedef ra8_err_t (*ra8_io_fsfmt_dir_next_fn_t)(void*            directory_state,
                                                ra8_fs_dirent_t* out,
                                                bool*            out_entry);
typedef ra8_err_t (*ra8_io_fsfmt_dir_close_fn_t)(void* directory_state);
typedef ra8_err_t (*ra8_io_fsfmt_path_fn_t)(void* mount_ctx, const char* path);
typedef ra8_err_t (*ra8_io_fsfmt_rename_fn_t)(void*       mount_ctx,
                                              const char* old_path,
                                              const char* new_path);
typedef ra8_err_t (*ra8_io_fsfmt_space_fn_t)(void* mount_ctx, ra8_fs_space_t* out);

typedef struct {
  ra8_io_fsfmt_probe_fn_t     probe;      
  ra8_io_fsfmt_mount_fn_t     mount;      
  ra8_io_fsfmt_unmount_fn_t   unmount;    
  ra8_io_fsfmt_open_fn_t      open;       
  ra8_io_fsfmt_close_fn_t     close;      
  ra8_io_fsfmt_read_fn_t      read;       
  ra8_io_fsfmt_write_fn_t     write;      
  ra8_io_fsfmt_seek_fn_t      seek;       
  ra8_io_fsfmt_tell_fn_t      tell;       
  ra8_io_fsfmt_size_fn_t      size;       
  ra8_io_fsfmt_sync_fn_t      sync;       
  ra8_io_fsfmt_stat_fn_t      stat;       
  ra8_io_fsfmt_listdir_fn_t   listdir;    
  ra8_io_fsfmt_dir_open_fn_t  dir_open;   
  ra8_io_fsfmt_dir_next_fn_t  dir_next;   
  ra8_io_fsfmt_dir_close_fn_t dir_close;  
  ra8_io_fsfmt_path_fn_t      unlink;     
  ra8_io_fsfmt_rename_fn_t    rename;     
  ra8_io_fsfmt_path_fn_t      mkdir;      
  ra8_io_fsfmt_path_fn_t      rmdir;      
  ra8_io_fsfmt_space_fn_t     free_space; 
} ra8_io_fsfmt_ops_t;

typedef struct ra8_io_fsfmt {
  const char*               name; 
  ra8_io_fsfmt_caps_t       caps; 
  const ra8_io_fsfmt_ops_t* ops;  
} ra8_io_fsfmt_t;

[[nodiscard]] ra8_err_t ra8_io_fsfmt_init(void);

[[nodiscard]] ra8_err_t ra8_io_fsfmt_register(const ra8_io_fsfmt_t* fmt);

[[nodiscard]] ra8_err_t ra8_io_fsfmt_get_builtin(ra8_fs_type_t type, const ra8_io_fsfmt_t** out);

[[nodiscard]] ra8_err_t ra8_io_fsfmt_probe(const ra8_fs_backend_t* backend,
                                           const ra8_io_fsfmt_t**  out);
 
#ifdef __cplusplus
}
#endif