actube/src/cw/val.h

#ifndef __KVT_H
#define __KVT_H

#include <stdint.h>
#include <stdio.h>

#include <mavl.h>
#include "mavltypes.h"

#include "bstr.h"


/**
 * @addtogroup ALGOS
 * @{
 */


/**
 * @defgroup KTV KTV Store (Key-Type-Value-Store)
 * @{
 */

//#define CW_KTV_MAX_KEY_LEN 1024

typedef struct cw_Cfg cw_Cfg_t;

/**
 * @struct cw_Val
 * @file ktv.h
 * @brief Structure to store a key-type-value element.
 */
struct cw_Val {
	/** The key for this element. A string. */
	char *key;
	/** Teh type of this element. */
	const struct cw_Type *type;
	/** The value for this element */
	union {
		uint32_t dword;	
		uint16_t word;
		uint8_t byte;
		void *ptr;
		char *str;
		int boolean;
		float float_val;
	} val;
	const void * valguard;
};
typedef struct cw_Val cw_Val_t;




/**
 * @class cw_Type
 * @author 7u83
 * @file val.h
 * @brief Representation of a cw_Type objetc
 */
struct cw_Type {
	/** A human readable name for this type */
	const char *name;

	/** A pointer to a function to delete elements of this type */
	void (*del) (struct cw_Val * data);

	/** A method to put this object to a buffer */
	int (*put) (const struct cw_Val * data, uint8_t * dst);

	/** The get method */
	struct cw_Val *(*get) (struct cw_Val * data, const uint8_t * src, int len);

	/** A pointer to a function to convert elements of this type to a string.
	  * This function is mainly used to store elements to an SQL database
	  * or to json strings 
	  * @param data pointer to KTV object
	  * @param dst buffer where to put the string in
	  * @param max_len maximum length of buffer
	  * @return The number of bytes written to dst
	*/
	int (*to_str) (const struct cw_Val * data, char *dst, int max_len);

	/** Cereate an item of this type from a string, which was previously
	    created by the #del function. */
	struct cw_Val *(*from_str) (struct cw_Val * data, const char *src);

	
	int (*len)(cw_Val_t *);

	void *(*data)(cw_Val_t *);
	const char * (*get_type_name)(cw_Val_t*);
	
	int (*cast)(cw_Val_t *);

	int (*read)(cw_Cfg_t *cfg, const char * key, const uint8_t *src, int len, const void * param);
	int (*write)(cw_Cfg_t ** cfg, const char *key, uint8_t *dst, const void * param);
	
};
typedef struct cw_Type cw_Type_t;


struct cw_ValValRange {
	int min,max;
	const char * name;
};
typedef struct cw_ValValRange cw_ValValRange_t;


struct cw_ValStruct {
	const struct cw_Type * type;
	const char * key;
	int len;
	int position;
	const void * valguard;
};
typedef struct cw_ValStruct cw_ValStruct_t;







#define CW_STRUCT_LEN_WORD	-2
#define CW_STRUCT_LEN_BYTE	-3


#define CW_KTVSTRUCT_L8	-2
#define CW_KTVSTRUCT_L16	-3

struct cw_ValEnum{
	int value;
	const char * name;
	const void * type;
	int (*fun_in)();
	int (*fun_out)();
	void *param;
};
typedef struct cw_ValEnum cw_ValEnum_t;


struct cw_ValIndexed{
	int idxpos;
	void *type;
};
typedef struct cw_ValIndexed cw_ValIndexed_t;


extern const struct cw_Type cw_type_byte;
extern const struct cw_Type cw_type_word;
extern const struct cw_Type cw_type_dword;
extern const struct cw_Type cw_type_bstr16;
extern const struct cw_Type cw_type_bwstr;
extern const struct cw_Type cw_type_str;
extern const struct cw_Type cw_type_ipaddress;
extern const struct cw_Type cw_type_sysptr;
extern const struct cw_Type cw_type_bool;
extern const struct cw_Type cw_type_struct;

#define CW_TYPE_BYTE (&cw_type_byte)
#define CW_TYPE_WORD (&cw_type_word)
#define CW_TYPE_DWORD (&cw_type_dword)
#define CW_TYPE_BSTR16 (&cw_type_bstr16)
#define CW_TYPE_BWSTR (&cw_type_bwstr)
#define CW_TYPE_IPADDRESS (&cw_type_ipaddress)
#define CW_TYPE_SYSPTR (&cw_type_sysptr)
#define CW_TYPE_STR (&cw_type_str)
#define CW_TYPE_BOOL (&cw_type_bool)
#define CW_TYPE_STRUCT (&cw_type_struct)

/*
void cw_kvstore_mavl_delete(const void *data);
 */


/**
 * Create a KTV store 
 * @return a #mavl_t object representing the KTV store
 */
#define cw_ktv_create()\
	mavl_create(cw_ktv_mavlcmp, cw_ktv_mavldel, sizeof(cw_Val_t))
	
#define cw_ktv_create_types_tree()\
	mavl_create(cw_ktv_mavlcmp_type_by_name,NULL,sizeof(struct cw_Type *))

int cw_ktv_read_line (FILE *f, char * key, char * type, char *val);
int cw_ktv_read_file(FILE * file, mavl_t ktv, mavl_t types);
cw_Val_t * cw_ktv_get(mavl_t ktv, const char *key, const cw_Type_t * type);
uint8_t cw_ktv_get_byte(mavl_t ktv,const char *key, uint8_t def);
uint8_t cw_ktv_get_bool(mavl_t ktv,const char *key, uint8_t def);
cw_Val_t * cw_ktv_set_byte(mavl_t ktv,const char * key, uint8_t byte);
cw_Val_t * cw_ktv_set_dword(mavl_t ktv,const char * key, uint32_t dword);
cw_Val_t * cw_ktv_set_word(mavl_t ktv,const char * key, uint16_t word);

bstr16_t cw_ktv_get_bstr16(mavl_t ktv,const char *key, bstr16_t def);

uint16_t cw_ktv_get_word(mavl_t ktv,const char *key, uint16_t def);
uint32_t cw_ktv_get_dword(mavl_t ktv,const char *key, uint32_t def);
void * cw_ktv_get_sysptr(mavl_t ktv,const char *key, void * def);
char * cw_ktv_get_str(mavl_t ktv,const char *key, char * def);

int cw_ktv_idx_get(mavl_t ktv, const char *key);
cw_Val_t * cw_ktv_base_exists(mavl_t ktvstore, const char *basekey);
int cw_ktv_save(mavl_t ktvstore, const char * filename);
cw_Val_t * cw_ktv_cast(cw_Val_t *v,const cw_Type_t * type);

extern const cw_Type_t * cw_ktv_std_types[];
#define CW_KTV_STD_TYPES cw_ktv_std_types



struct cw_Val_Reader {
	const void * data;
	int (*xgetchar)(struct cw_Val_Reader *);
	void (*ungetchar)(struct cw_Val_Reader *, int c);
	int quote;
	int line;
	int pos;
	int prevpos;
	int next;
	int maxlen;
	char error[256];
};

void cw_ktv_init_str_reader(struct cw_Val_Reader *r, const char * str, int len);
int cw_ktv_parse_string(struct cw_Val_Reader *r, char *key, char *type, char *val);
int cw_generic_write_l(cw_Cfg_t **cfg, const struct cw_Type*type, const char *key, uint8_t *dst, const void * param);
void cw_val_destroy(cw_Val_t *val);

/**
 * @}  KTV
 * @}  ALGOS
 */

#endif	/* __KVT_H */