dictionary_types.h

Go to the documentation of this file.

/******************************************************************************/
/******************************************************************************/

#if !defined(DICTIONARY_TYPES_H_)
#define DICTIONARY_TYPES_H_

#if defined(__cplusplus)
extern "C" {
#endif

#include "../key_value/kv_system.h"

typedef unsigned int ion_dictionary_id_t;

typedef ion_byte_t ion_dict_use_t;

typedef int ion_hash_t;

typedef struct dictionary ion_dictionary_t;

typedef struct dictionary_handler ion_dictionary_handler_t;

typedef char (*ion_dictionary_compare_t)(
    ion_key_t,
    ion_key_t,
    ion_key_size_t
);

typedef struct dictionary_cursor ion_dict_cursor_t;

typedef struct predicate ion_predicate_t;

typedef union predicate_statement ion_predicate_statement_t;

typedef struct dictionary_parent ion_dictionary_parent_t;

typedef enum ION_COMPARISON {
    A_lt_B  = -1,   
    A_equ_B = 0,
    A_gt_B  = 1     
} ion_comparison_t;

enum ION_CURSOR_STATUS {
    cs_invalid_index = -1,  
    cs_invalid_cursor,  
    cs_end_of_results,  
    cs_cursor_initialized,  
    cs_cursor_uninitialized,
    cs_cursor_active,   
    cs_possible_data_inconsistency, 
};

typedef char ion_cursor_status_t;

enum ION_DICTIONARY_STATUS {
    ion_dictionary_status_ok,
    ion_dictionary_status_closed,
    ion_dictionary_status_error,
};

typedef char ion_dictionary_status_t;

typedef struct {
    ion_dictionary_id_t     id;                 
    ion_dict_use_t          use_type;           
    ion_key_type_t          type;                   
    ion_key_size_t          key_size;           
    ion_value_size_t        value_size;         
    ion_dictionary_size_t   dictionary_size;    
    ion_dictionary_type_t   dictionary_type;    
    ion_dictionary_status_t dictionary_status;  
} ion_dictionary_config_info_t;

struct dictionary_handler {
    ion_status_t (*insert)(
        ion_dictionary_t *,
        ion_key_t,
        ion_value_t
    );
    ion_err_t (*create_dictionary)(
        ion_dictionary_id_t,
        ion_key_type_t,
        ion_key_size_t,
        ion_value_size_t,
        ion_dictionary_size_t,
        ion_dictionary_compare_t,
        ion_dictionary_handler_t *,
        ion_dictionary_t *
    );
    ion_status_t (*get)(
        ion_dictionary_t *,
        ion_key_t,
        ion_value_t
    );
    ion_status_t (*update)(
        ion_dictionary_t *,
        ion_key_t,
        ion_value_t
    );
    ion_err_t (*find)(
        ion_dictionary_t *,
        ion_predicate_t *,
        ion_dict_cursor_t **
    );
    ion_status_t (*remove)(
        ion_dictionary_t *,
        ion_key_t
    );
    ion_err_t (*delete_dictionary)(
        ion_dictionary_t *
    );
    ion_err_t (*destroy_dictionary)(
        ion_dictionary_id_t id
    );
    ion_err_t (*open_dictionary)(
        ion_dictionary_handler_t *,
        ion_dictionary_t *,
        ion_dictionary_config_info_t *,
        ion_dictionary_compare_t
    );
    ion_err_t (*close_dictionary)(
        ion_dictionary_t *
    );
};

struct dictionary {
    ion_dictionary_status_t     status; 
    ion_dictionary_parent_t     *instance;  
    ion_dictionary_handler_t    *handler;   
};

struct dictionary_parent {
    ion_key_type_t              key_type;       
    ion_record_info_t           record;     
    ion_dictionary_compare_t    compare;
    ion_dictionary_id_t         id;     
    ion_dictionary_type_t       type;   
};

typedef char ion_predicate_type_t;

enum ION_PREDICATE_TYPE {
    predicate_equality, 
    predicate_range,
    predicate_all_records,  
    predicate_predicate 
};

typedef struct equality_statement {
    ion_key_t equality_value;
} ion_equality_statement_t;

typedef struct range_statement {
    ion_key_t   lower_bound;
    ion_key_t   upper_bound;
} ion_range_statement_t;

typedef struct ion_all_records_statement {
    char unused;
} ion_all_records_statement_t;

typedef struct other_predicate_statement {
    char unused;
} ion_other_predicate_statement_t;

union predicate_statement {
    ion_equality_statement_t        equality;
    ion_range_statement_t           range;
    ion_other_predicate_statement_t other_predicate;
    ion_all_records_statement_t     all_records;
};

struct predicate {
    ion_predicate_type_t        type;
    ion_predicate_statement_t   statement;

    void (*destroy)(
        ion_predicate_t **
    );
};

struct dictionary_cursor {
    ion_cursor_status_t status; 
    ion_dictionary_t    *dictionary;            
    ion_predicate_t     *predicate;             
    ion_cursor_status_t (*next)(
        ion_dict_cursor_t *,
        ion_record_t *record
    );
    void (*destroy)(
        ion_dict_cursor_t **
    );
};

enum ION_WRITE_CONCERN {
    wc_update,  
    wc_insert_unique,   
    wc_duplicate,   
};

typedef char ion_write_concern_t;

typedef struct hash_bucket {
    char        status;             
    ion_byte_t  data[];         
} ion_hash_bucket_t;

typedef void (*ion_handler_initializer_t)(
    ion_dictionary_handler_t *
);

#if defined(__cplusplus)
}
#endif

#endif /* DICTIONARY_TYPES_H_ */