dictionary.h

Go to the documentation of this file.

/*
 * For more information, see `docs/set.md`.
 * Lots of relevant information is shared between the two structures.
 */
 
#ifndef CLIBS_DICTIONARY_H
#define CLIBS_DICTIONARY_H
 
#include "../item_print_functions.h"
 
 
typedef struct dictionary Dictionary;
 
 
enum DictRemoveRV {
    DICTREMOVE_REMOVED   = 0,
    DICTREMOVE_NOT_FOUND = 1,
};
 
enum DictInsertRV {
    DICTINSERT_INSERTED = 0,
    DICTINSERT_WAS_IN   = 1,
};
 
 
struct dictionary *dict_init( void );
 

int dict_item_key_cmp( const void *, const void * );
int dict_item_val_cmp( const void *, const void * );
int dict_item_cmp( const void *, const void * );
 
int dict_insert_f( struct dictionary *,
                   const void *key,
                   size_t key_size,
                   const void *val,
                   size_t val_size,
                   PrintFunction key_print,
                   PrintFunction val_print );

int dict_insert( struct dictionary *,
                 const void *key,
                 size_t key_size,
                 const void *val,
                 size_t val_size );
 
bool dict_has_key( const struct dictionary *, const void *key, size_t key_size );
 
const void *dict_get_val( const struct dictionary *, const void *key, size_t key_size );
 
int dict_set_val( struct dictionary *,
                  const void *key,
                  size_t key_size,
                  const void *val,
                  size_t val_size );
 
enum DictRemoveRV dict_remove( struct dictionary *,
                               const void *key_data,
                               size_t key_size );
 
 
/* -------- SIZE/CAP -------- */
 
size_t dict_size( const struct dictionary * );
 
/* -------- DESTRUCTOR -------- */
 
void dict_destroy( struct dictionary * );
 
 
/* -------- PRINT -------- */
 
#define dict_printn( DICTIONARY )         \
    do                                    \
    {                                     \
        printf( "\"" #DICTIONARY "\" " ); \
        dict_print( DICTIONARY );         \
    }                                     \
    while ( 0 )
 
#define dict_printn_as( DICTIONARY, KEY_PRINT_FUNC, VAL_PRINT_FUNC ) \
    do                                                               \
    {                                                                \
        printf( "\"" #DICTIONARY "\" " );                            \
        dict_print_as( DICTIONARY, KEY_PRINT_FUNC, VAL_PRINT_FUNC ); \
    }                                                                \
    while ( 0 )

void dict_print( const struct dictionary * );
void dict_print_as( const struct dictionary *,
                    PrintFunction key_print,
                    PrintFunction val_print );
 
#endif //CLIBS_DICTIONARY_H