kst_file.h

Go to the documentation of this file.

 
#ifndef KST_FILE_H
#define KST_FILE_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "kst_limits.h"
#include "kst_reg.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define KST_FILE_FORMAT 1u

#define KST_FILE_LINE_MAX 64u

#define KST_FILE_LINES_MAX ((unsigned)KST_F_COUNT + 8u)

#define KST_FILE_MAX ((size_t)KST_FILE_LINES_MAX * (KST_FILE_LINE_MAX + 2u))

typedef enum {
    KST_FILE_OK = 0,
    KST_FILE_ERR_ARG = 1,        
    KST_FILE_ERR_OVERSIZED = 2,  
    KST_FILE_ERR_NOT_KST = 3,    
    KST_FILE_ERR_VERSION = 4,    
    KST_FILE_ERR_NEWER = 5,      
    KST_FILE_ERR_TRUNCATED = 6,  
    KST_FILE_ERR_LINE_END = 7,   
    KST_FILE_ERR_MALFORMED = 8,  
    KST_FILE_ERR_REG_COUNT = 9,  
    KST_FILE_ERR_CHECKSUM = 10,  
    KST_FILE_ERR_TRAILING = 11,  
    KST_FILE_ERR_NAME = 12,      
    KST_FILE_ERR_DUPLICATE = 13, 
    KST_FILE_ERR_VALUE = 14,     
    KST_FILE_ERR_TYPE = 15,      
} kst_file_err_t;

typedef enum {
    KST_FILE_VERIFIED = 0,       
    KST_FILE_EDITED_TYPED = 1,   
    KST_FILE_EDITED_UNTYPED = 2, 
} kst_file_kind_t;

typedef struct {
    kst_file_kind_t kind;
    kst_type_t type;
    kst_image_t image;
    kst_field_set_t named;
    kst_field_set_t as_raw;
    int32_t value[KST_F_COUNT];
    uint16_t line[KST_F_COUNT];
} kst_file_t;

size_t kst_file_format(const kst_image_t *img, char *out, size_t out_size);

kst_file_err_t kst_file_parse(const char *text, size_t len, kst_file_t *out,
                              unsigned *line);
 
/* --- a file against a servo ----------------------------------------------- */

typedef enum {
    KST_FILE_LOAD_OK = 0,            
    KST_FILE_LOAD_TYPE_MISMATCH = 1, 
    KST_FILE_LOAD_HARD_LIMIT = 2,    
    KST_FILE_LOAD_ARG = 3,           
} kst_file_verdict_t;

typedef struct {
    kst_file_verdict_t verdict;
    kst_file_kind_t kind;       
    kst_type_t file_type;       
    kst_type_t servo_type;      
    uint8_t named;              
    uint8_t fields;             
    kst_field_set_t editable;   
    kst_field_set_t skipped;    
    kst_rules_t rules;          
    kst_field_id_t hard_field;  
    unsigned hard_line;         
    kst_image_t target;         
} kst_file_load_t;

kst_file_verdict_t kst_file_load(const kst_file_t *file,
                                 const kst_image_t *servo,
                                 const kst_image_t *backup,
                                 kst_file_load_t *out);
 
#ifdef __cplusplus
}
#endif
 
#endif /* KST_FILE_H */