idmap.h File Reference

#include <gwenhywfar/types.h>
#include <stdio.h>

Go to the source code of this file.

Macros for Typesafe ID maps
#define	GWEN_IDMAP_FUNCTION_DEFS(t, pr)   GWEN_IDMAP_FUNCTION_LIB_DEFS(t, pr, GWEN_DUMMY_EMPTY_ARG)
#define	GWEN_IDMAP_FUNCTION_LIB_DEFS(t, pr, decl)
#define	GWEN_IDMAP_FUNCTIONS(t, pr)
Typedefs
typedef GWEN_IDMAP	GWEN_IDMAP
Enumerations
enum	GWEN_IDMAP_ALGO { GWEN_IdMapAlgo_Unknown = 0, GWEN_IdMapAlgo_Hex4 }
enum	GWEN_IDMAP_RESULT { GWEN_IdMapResult_Ok = 0, GWEN_IdMapResult_NoFit, GWEN_IdMapResult_NotFound }
Functions
GWENHYWFAR_API void	GWEN_IdMap_Clear (GWEN_IDMAP *map)
GWENHYWFAR_API void	GWEN_IdMap_Dump (GWEN_IDMAP *map, FILE *f, int indent)
GWENHYWFAR_API void *	GWEN_IdMap_Find (GWEN_IDMAP *map, GWEN_TYPE_UINT32 id)
GWENHYWFAR_API void	GWEN_IdMap_free (GWEN_IDMAP *map)
GWENHYWFAR_API GWEN_IDMAP_RESULT	GWEN_IdMap_GetFirst (const GWEN_IDMAP *map, GWEN_TYPE_UINT32 *pid)
GWENHYWFAR_API GWEN_IDMAP_RESULT	GWEN_IdMap_GetNext (const GWEN_IDMAP *map, GWEN_TYPE_UINT32 *pid)
GWENHYWFAR_API GWEN_TYPE_UINT32	GWEN_IdMap_GetSize (const GWEN_IDMAP *map)
GWENHYWFAR_API GWEN_IDMAP_RESULT	GWEN_IdMap_Insert (GWEN_IDMAP *map, GWEN_TYPE_UINT32 id, void *ptr)
GWENHYWFAR_API GWEN_IDMAP *	GWEN_IdMap_new (GWEN_IDMAP_ALGO algo)
GWENHYWFAR_API GWEN_IDMAP_RESULT	GWEN_IdMap_Remove (GWEN_IDMAP *map, GWEN_TYPE_UINT32 id)

---

Define Documentation

#define GWEN_IDMAP_FUNCTION_DEFS	(	t,
		pr		)	GWEN_IDMAP_FUNCTION_LIB_DEFS(t, pr, GWEN_DUMMY_EMPTY_ARG)

#define GWEN_IDMAP_FUNCTION_LIB_DEFS	(	t,
		pr,
		decl		)

Value:

typedef GWEN_IDMAP t##_IDMAP;                                       \
                                                                      \
  decl t##_IDMAP *pr##_IdMap_new(GWEN_IDMAP_ALGO algo);               \
  decl void pr##_IdMap_free(t##_IDMAP *l);                            \
  decl void pr##_IdMap_freeAll(t##_IDMAP *l);                         \
  decl void pr##_IdMap_FreeItems(t##_IDMAP *l);                       \
  decl GWEN_IDMAP_RESULT pr##_IdMap_Insert(t##_IDMAP *l,              \
                                           GWEN_TYPE_UINT32 id,       \
                                           t* ptr);                   \
  decl GWEN_IDMAP_RESULT pr##_IdMap_Remove(t##_IDMAP *l,              \
                                           GWEN_TYPE_UINT32 id);      \
  decl t* pr##_IdMap_Find(t##_IDMAP *l, GWEN_TYPE_UINT32 id);         \
  decl GWEN_IDMAP_RESULT pr##_IdMap_GetFirst(const t##_IDMAP *map,    \
                                              GWEN_TYPE_UINT32 *pid); \
  decl GWEN_IDMAP_RESULT pr##_IdMap_GetNext(const t##_IDMAP *map,     \
                                             GWEN_TYPE_UINT32 *pid);  \
  decl GWEN_TYPE_UINT32 pr##_IdMap_GetSize(const GWEN_IDMAP *map);    \
  decl void pr##_IdMap_Clear(GWEN_IDMAP *l);

Necessary for MSVC compiler because it does not accept a left-out macro argument.

#define GWEN_IDMAP_FUNCTIONS	(	t,
		pr		)

---

Typedef Documentation

typedef struct GWEN_IDMAP GWEN_IDMAP

---

Enumeration Type Documentation

enum GWEN_IDMAP_ALGO

Enumerator:

GWEN_IdMapAlgo_Unknown
GWEN_IdMapAlgo_Hex4

enum GWEN_IDMAP_RESULT

Enumerator:

GWEN_IdMapResult_Ok
GWEN_IdMapResult_NoFit
GWEN_IdMapResult_NotFound

---

Function Documentation

GWENHYWFAR_API void GWEN_IdMap_Clear

(

GWEN_IDMAP *

map

)

GWENHYWFAR_API void GWEN_IdMap_Dump	(	GWEN_IDMAP *	map,
		FILE *	f,
		int	indent
	)

GWENHYWFAR_API void* GWEN_IdMap_Find	(	GWEN_IDMAP *	map,
		GWEN_TYPE_UINT32	id
	)

GWENHYWFAR_API void GWEN_IdMap_free

(

GWEN_IDMAP *

map

)

GWENHYWFAR_API GWEN_IDMAP_RESULT GWEN_IdMap_GetFirst	(	const GWEN_IDMAP *	map,
		GWEN_TYPE_UINT32 *	pid
	)

Return the first id in the map.

Parameters:

	map	map to browse
	pid	pointer to a variable to receive the first id in the map. Upon return this variable will be updated to the first id in the map if the result is GWEN_IdMapResult_Ok.

GWENHYWFAR_API GWEN_IDMAP_RESULT GWEN_IdMap_GetNext	(	const GWEN_IDMAP *	map,
		GWEN_TYPE_UINT32 *	pid
	)

Return the next id in the map.

Parameters:

	map	map to browse
	pid	pointer to the id retrieved via GWEN_IdMap_GetFirst. Upon return this variable will be updated to the next id in the map if the result is GWEN_IdMapResult_Ok.

GWENHYWFAR_API GWEN_TYPE_UINT32 GWEN_IdMap_GetSize

(

const GWEN_IDMAP *

map

)

GWENHYWFAR_API GWEN_IDMAP_RESULT GWEN_IdMap_Insert	(	GWEN_IDMAP *	map,
		GWEN_TYPE_UINT32	id,
		void *	ptr
	)

GWENHYWFAR_API GWEN_IDMAP* GWEN_IdMap_new

(

GWEN_IDMAP_ALGO

algo

)

GWENHYWFAR_API GWEN_IDMAP_RESULT GWEN_IdMap_Remove	(	GWEN_IDMAP *	map,
		GWEN_TYPE_UINT32	id
	)

---