1

#ifndef QUEUE_H

     2

#define QUEUE_H

     3

     4

//#define NOFREE

     5

//#define QUEUE_DEBUG

     6

//#define HASH_DEBUG

     7

     8

     9

typedef struct Queue Queue;

    10

typedef bool Queue_PushProc(Queue* q, void* item, int priority);

    11

typedef void* Queue_PopProc(Queue* q);

    12

typedef bool Queue_DeleteProc(Queue* q, void* item, int priority);

    13

typedef void Queue_ClearProc(Queue* q, bool free_values);

    14

typedef void Queue_FreeProc(Queue* q, bool free_values);

    15

    16

typedef struct InsSortNode InsSortNode;

    17

struct InsSortNode {

    18

	void* item;

    19

	int priority;

    20

	InsSortNode* next;

    21

};

    22

typedef struct BinaryHeapNode BinaryHeapNode;

    23

	struct BinaryHeapNode {

    24

	void* item;

    25

	int priority;

    26

};

    27

    28

    29

struct Queue{

    30

	/*

    31

	 * Pushes an element into the queue, at the appropriate place for the queue.

    32

	 * Requires the queue pointer to be of an appropriate type, of course.

    33

	 */

    34

	Queue_PushProc* push;

    35

	/*

    36

	 * Pops the first element from the queue. What exactly is the first element,

    37

	 * is defined by the exact type of queue.

    38

	 */

    39

	Queue_PopProc* pop;

    40

	/*

    41

	 * Deletes the item from the queue. priority should be specified if

    42

	 * known, which speeds up the deleting for some queue's. Should be -1

    43

	 * if not known.

    44

	 */

    45

	Queue_DeleteProc* del;

    46

    47

	/* Clears the queue, by removing all values from it. It's state is

    48

	 * effectively reset. If free_items is true, each of the items cleared

    49

	 * in this way are free()'d.

    50

	 */

    51

	Queue_ClearProc* clear;

    52

	/* Frees the queue, by reclaiming all memory allocated by it. After

    53

	 * this it is no longer usable. If free_items is true, any remaining

    54

	 * items are free()'d too. 

    55

	 */

    56

	Queue_FreeProc* free;

    57

    58

	union {

    59

		struct {

    60

			uint max_size;

    61

			uint size;

    62

			void** elements;

    63

		} stack;

    64

		struct {

    65

			uint max_size;

    66

			uint head; /* The index where the last element should be inserted */

    67

			uint tail; /* The index where the next element should be read */

    68

			void** elements;

    69

		} fifo;

    70

		struct {

    71

			InsSortNode* first;

    72

		} inssort;

    73

		struct {

    74

			uint max_size;

    75

			uint size;

    76

			uint blocks; /* The amount of blocks for which space is reserved in elements */

    77

			BinaryHeapNode** elements;

    78

		} binaryheap;

    79

	} data;

    80

    81

	/* If true, this struct will be free'd when the

    82

	 * Queue is deleted. */

    83

	bool freeq;

    84

};

    85

    86

/* Initializes a stack and allocates internal memory. */

    87

void init_Stack(Queue* q, uint max_size);

    88

    89

/* Allocate a new stack with a maximum of max_size elements. */

    90

Queue* new_Stack(uint max_size);

    91

    92

/*

    93

 * Fifo

    94

 */

    95

    96

/* Initializes a fifo and allocates internal memory for maximum of max_size

    97

 * elements */

    98

void init_Fifo(Queue* q, uint max_size);

    99

   100

/* Allocate a new fifo and initializes it with a maximum of max_size elements. */

   101

Queue* new_Fifo(uint max_size);

   102

   103

Queue* new_Fifo_in_buffer(uint max_size, void* buffer);

   104

   105

int build_Fifo(void* buffer, uint size);

   106

   107

/*

   108

 * Insertion Sorter

   109

 */

   110

   111

/* Initializes a inssort and allocates internal memory. There is no maximum

   112

 * size */

   113

void init_InsSort(Queue* q);

   114

   115

/* Allocate a new fifo and initializes it. There is no maximum size */

   116

Queue* new_InsSort();

   117

   118

/*

   119

 *  Binary Heap

   120

 *  For information, see:

   121

 *   http://www.policyalmanac.org/games/binaryHeaps.htm

   122

 */

   123

   124

/* The amount of elements that will be malloc'd at a time */

   125

#define BINARY_HEAP_BLOCKSIZE_BITS 10

   126

   127

/* Initializes a binary heap and allocates internal memory for maximum of

   128

 * max_size elements */

   129

void init_BinaryHeap(Queue* q, uint max_size);

   130

   131

/* Allocate a new binary heap and initializes it with a maximum of max_size

   132

 * elements. */

   133

Queue* new_BinaryHeap(uint max_size);

   134

   135

/*

   136

 * Hash

   137

 */

   138

typedef struct HashNode HashNode;

   139

struct HashNode {

   140

	uint key1;

   141

	uint key2;

   142

	void* value;

   143

	HashNode* next;

   144

};

   145

/* Generates a hash code from the given key pair. You should make sure that

   146

 * the resulting range is clearly defined.

   147

 */

   148

typedef uint Hash_HashProc(uint key1, uint key2);

   149

typedef struct Hash {

   150

	/* The hash function used */

   151

	Hash_HashProc* hash;

   152

	/* The amount of items in the hash */

   153

	uint size;

   154

	/* The number of buckets allocated */

   155

	uint num_buckets;

   156

	/* A pointer to an array of num_buckets buckets. */

   157

	HashNode* buckets;

   158

	/* A pointer to an array of numbuckets booleans, which will be true if

   159

	 * there are any Nodes in the bucket */

   160

	bool* buckets_in_use;

   161

	/* If true, buckets will be freed in delete_hash */

   162

	bool freeb;

   163

	/* If true, the pointer to this struct will be freed in delete_hash */

   164

	bool freeh;

   165

} Hash;

   166

   167

/* Call these function to manipulate a hash */

   168

   169

/* Deletes the value with the specified key pair from the hash and returns

   170

 * that value. Returns NULL when the value was not present. The value returned

   171

 * is _not_ free()'d! */

   172

void* Hash_Delete(Hash* h, uint key1, uint key2);

   173

/* Sets the value associated with the given key pair to the given value.

   174

 * Returns the old value if the value was replaced, NULL when it was not yet present. */

   175

void* Hash_Set(Hash* h, uint key1, uint key2, void* value);

   176

/* Gets the value associated with the given key pair, or NULL when it is not

   177

 * present. */

   178

void* Hash_Get(Hash* h, uint key1, uint key2);

   179

   180

/* Call these function to create/destroy a hash */

   181

   182

/* Builds a new hash, with num_buckets buckets. Make sure that hash() always

   183

 * returns a hash less than num_buckets! Call delete_hash after use */

   184

Hash* new_Hash(Hash_HashProc* hash, int num_buckets);

   185

/* Builds a new hash in an existing struct. Make sure that hash() always

   186

 * returns a hash less than num_buckets! Call delete_hash after use */

   187

void init_Hash(Hash* h, Hash_HashProc* hash, int num_buckets);

   188

/*

   189

 * Deletes the hash and cleans up. Only cleans up memory allocated by new_Hash

   190

 * & friends. If free is true, it will call free() on all the values that

   191

 * are left in the hash.

   192

 */

   193

void delete_Hash(Hash* h, bool free_values);

   194

/*

   195

 * Cleans the hash, but keeps the memory allocated

   196

 */

   197

void clear_Hash(Hash* h, bool free_values);

   198

/*

   199

 * Gets the current size of the Hash

   200

 */

   201

uint Hash_Size(Hash* h);

   202

   203

#endif /* QUEUE_H */