kst_store.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "card_tree.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define KST_STORE_DIR CARD_KST_CONF

#define KST_STORE_EXT ".TXT"

#define KST_STORE_BASE_MAX 32

#define KST_STORE_NAME_MAX (KST_STORE_BASE_MAX + 4 + 1)

#define KST_STORE_FIRST 1
#define KST_STORE_LAST  999

#define KST_STORE_PRESET_MAX 7

#define KST_STORE_RECORD "KST"

typedef enum {
    KST_STORE_NAME_OK = 0,
    KST_STORE_NAME_EMPTY = 1,    
    KST_STORE_NAME_TOO_LONG = 2, 
    KST_STORE_NAME_BAD_CHAR = 3, 
    KST_STORE_NAME_RESERVED = 4, 
    KST_STORE_NAME_EDGE = 5,     
} kst_store_name_t;

typedef enum {
    KST_STORE_OK = 0,
    KST_STORE_ARG = 1,          
    KST_STORE_NO_CARD = 2,      
    KST_STORE_LIST_ERROR = 3,   
    KST_STORE_NO_NUMBER = 4,    
    KST_STORE_BAD_NAME = 5,     
    KST_STORE_EXISTS = 6,       
    KST_STORE_CARD_FULL = 7,
    KST_STORE_WRITE_ERROR = 8,
    KST_STORE_NOT_FOUND = 9,    
    KST_STORE_TOO_LARGE = 10,   
    KST_STORE_READ_ERROR = 11,
    KST_STORE_DENIED = 12,      
} kst_store_t;

typedef enum {
    KST_STORE_IO_OK = 0,
    KST_STORE_IO_EXISTS,   
    KST_STORE_IO_FULL,     
    KST_STORE_IO_ERROR,    
    KST_STORE_IO_DENIED,   
} kst_store_io_result_t;

typedef void (*kst_store_visit_fn)(const char *name, bool is_dir,
                                   void *visit_ctx);

typedef struct {
    void *ctx;                  
    bool (*mounted)(void *ctx);
    bool (*walk)(void *ctx, kst_store_visit_fn visit, void *visit_ctx);
    int32_t (*size)(void *ctx, const char *name);
    int32_t (*read)(void *ctx, const char *name, char *buf, size_t cap);
    kst_store_io_result_t (*create)(void *ctx, const char *name,
                                    const char *data, size_t len);
} kst_store_io_t;

typedef struct {
    char name[KST_STORE_NAME_MAX];  
} kst_store_entry_t;

kst_store_name_t kst_store_name_check(const char *base);

bool kst_store_file_name(const char *base, char *out, size_t out_size);

kst_store_t kst_store_preset(const kst_store_io_t *io, char *base,
                             size_t base_size);

kst_store_t kst_store_save(const kst_store_io_t *io, const char *base,
                           const char *text, size_t len,
                           kst_store_name_t *why);

kst_store_t kst_store_list(const kst_store_io_t *io,
                           kst_store_entry_t *entries, size_t cap,
                           size_t *count, size_t *total, size_t *skipped);

kst_store_t kst_store_list_after(const kst_store_io_t *io, const char *after,
                                 kst_store_entry_t *entries, size_t cap,
                                 size_t *count, size_t *total,
                                 size_t *skipped);

kst_store_t kst_store_load(const kst_store_io_t *io, const char *name,
                           char *buf, size_t cap, size_t *len);
 
#ifdef __cplusplus
}
#endif