map.h

/*
Copyright (c) 2020, Marc Sune Clos
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef __CDADA_MAP_H__
#define __CDADA_MAP_H__

#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <cdada/utils.h>

/**
* @file cdada/map.h
* @author Marc Sune<marcdevel (at) gmail.com>
*
* @brief Map (hashmap, hashtable) data structure
*
* `cdada_map` data structure is a collection of unique elements of type `TYPE`
* which have associated a value {key, value}.
* During insertions, a _copy_ of the key `key` and a copy of the pointer value
* `val` will be sotred in the container.
* During accesses (e.g. `cdada_map_find`), if found, a _copy_ of the key is
* stored in the region of memory pointed by `key`, and the (double) pointer
* of value `val` is set.
*
* Uses std::map as a backend
*/

/**
* cdada map structure
*/
typedef void cdada_map_t;

//In case it's included from C++
CDADA_BEGIN_DECLS

//Fwd decl
//See cdada_map_create() for return codes
struct __cdada_map_ops;
cdada_map_t* __cdada_map_create(const uint16_t key_size,
						struct __cdada_map_ops* ops);

/**
* cdada map structure iterator
*
* @param map Map ptr
* @param key Key (immutable)
* @param val Value
* @param opaque A pointer to an opaque object tat will be passed to the callback
*/
typedef void (*cdada_map_it)(const cdada_map_t* map, const void* key,
						void* val,
						void* opaque);

/**
* @brief Create and initialize a map data structure
*
* Allocate and initialize a map structure. Containers will perform  better when
* TYPE has a size of {1,2,4,8,16,32,64,128,256} bytes
*
* For types > 256, use custom containers
*
* @returns Returns a cdada_map object or NULL, if some error is found
*/
#define cdada_map_create(TYPE) \
	__cdada_map_create(sizeof( TYPE ), NULL)

/**
* Destroy a map structure
*
* @returns Return codes:
*          CDADA_SUCCESS: map is destroyed
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_destroy(cdada_map_t* map);

/**
* Clear the contents of the map
*
* @returns Return codes:
*          CDADA_SUCCESS: map is cleared
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_clear(cdada_map_t* map);

/**
* Traverse map
*
* @param map Map
* @param func Traverse function for this specific map
* @param opaque User data (opaque ptr)
*
* @returns Return codes:
*          CDADA_SUCCESS: map was successfully traversed
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_traverse(const cdada_map_t* map, cdada_map_it func,
							void* opaque);

/**
* Reverse traverse map
*
* @param map Map
* @param func Traverse function for this specific map
* @param opaque User data (opaque ptr)
*
* @returns Return codes:
*          CDADA_SUCCESS: map was successfully reverse traversed
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_rtraverse(const cdada_map_t* map, cdada_map_it func,
							void* opaque);

//Map properties

/**
* Is the map empty
*
* @returns Returns true if map is empty else (including invalid) false
*/
bool cdada_map_empty(const cdada_map_t* map);

/**
* Return the size (number of elements) in the map
*
* @returns Returns number of elements. If map is NULL or corrupted, returns 0
*/
uint32_t cdada_map_size(const cdada_map_t* map);

//Element manipulation

/**
* Insert an element (a copy of `key` and pointer `val`) in the map
*
* @param map Map pointer
* @param key Key. The key type _must_ have all bytes initialized
* @param val Pointer to the value
*
* @returns Return codes:
*          CDADA_SUCCESS: element is inserted
*          CDADA_E_EXISTS: element exists
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_insert(cdada_map_t* map, const void* key, void* val);

/**
* Insert or replace an element (a copy of `key` and pointer `val`) in the map
*
* @param map Map pointer
* @param key Key. The key type _must_ have all bytes initialized
* @param val Pointer to the value
* @param prev_val If not NULL, when replacing a value the previous value will be
*                 set here, regardless if the operation is successful or not
*
* @returns Return codes:
*          CDADA_SUCCESS: element is inserted
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_insert_replace(cdada_map_t* map, const void* key, void* val,
							void** prev_val);

/**
* Erase an element in the map
*
* @param map Map pointer
* @param key Key. The key type _must_ have all bytes initialized
*
* @returns Return codes:
*          CDADA_SUCCESS: element was successfully erased
*          CDADA_E_NOT_FOUND: no element `key` was found
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_erase(cdada_map_t* map, const void* key);

/**
* Find a key in the map
*
* @param map Map pointer
* @param key Key to search
* @param val NULL if only want to check presence. If not NULL, and element is
*                 found, *val will be set to the value pointer
*
* @returns Return codes:
*          CDADA_SUCCESS: element was successfully erased
*          CDADA_E_NOT_FOUND: no element `key` was found
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_find(const cdada_map_t* map, const void* key, void** val);

/**
* Get the Nth element of the map, starting with 0
* @param map Map pointer
* @param pos Position in the map [0..size)
* @param key The key to be filled-in
* @param value The value pointer to be filled-in
*
* @returns Return codes:
*          CDADA_SUCCESS: element and value were retrieved
*          CDADA_E_EMPTY: map has no elements
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_NOT_FOUND: no element on that position (>= size)
*          CDADA_E_INVALID: map is NULL or corrupted or val is NULL
*/
int cdada_map_get_pos(const cdada_map_t* map, const uint32_t pos, void* key,
								void** val);

/**
* Get the first element in the map
* @param map Map pointer
* @param key If map has elements, a copy of the first element key will be stored
*            in *key
* @param val If map has elements, *val will be set to the value pointer
*
* @returns Return codes:
*          CDADA_SUCCESS: first element was retrieved
*          CDADA_E_EMPTY: map has no elements
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_first(const cdada_map_t* map, void* key, void** val);

/**
* Get the last element in the map
* @param map Map pointer
* @param key If map has elements, a copy of the first element key will be stored
*            in *key
* @param val If map has elements, *val will be set to the value pointer
*
* @returns Return codes:
*          CDADA_SUCCESS: last element was retrieved
*          CDADA_E_EMPTY: map has no elements
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_last(const cdada_map_t* map, void* key, void** val);

/**
* Dump to a string the contents of the map
*
* @param map Map object
* @param size Size of the buffer
* @param buffer Buffer. If NULL, necessary bytes, including '\0' will be map in
*               'size_used'
* @param size_used If buffer != NULL, the number of bytes written else number of
*                  bytes necessary to write, including '\0'
*
* @returns Return codes:
*          CDADA_SUCCESS: map was dumped to buffer
*          CDADA_E_INCOMPLETE: not enough room in buffer
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_dump(cdada_map_t* map, uint32_t size, char* buffer,
							uint32_t* bytes_used);

/**
* @brief Print the contents of the map
*
* @param map Map object
* @param stream stdout or stderr
*
* @returns Return codes:
*          CDADA_SUCCESS: map was dumped to `stream`
*          CDADA_E_MEM: out of memory
*          CDADA_E_UNKNOWN: corrupted map or internal error (bug)
*          CDADA_E_INVALID: map is NULL or corrupted
*/
int cdada_map_print(cdada_map_t* map, FILE *stream);

//Custom types

/**
* Forward declare custom time ops
*/
#define CDADA_MAP_CUSTOM_TYPE_DECL(TYPE) \
	extern struct __cdada_map_ops __cdada_map_autogen_##TYPE

/**
* @brief Create a map with a custom type, with a dedicated std::map
*
* Requires instantiating CDADA_MAP_CUSTOM_GEN() or
* CDADA_MAP_CUSTOM_GEN_NO_MEMCP() once in a C++ compilation unit
*/
#define cdada_map_create_custom(TYPE) \
	__cdada_map_create(sizeof( TYPE ), & __cdada_map_autogen_##TYPE )

CDADA_END_DECLS

#endif //__CDADA_MAP_H__