1

/* $Id$ */

     2

     3

#ifndef QUEUE_H

     4

#define QUEUE_H

     5

     6

//#define NOFREE

     7

//#define QUEUE_DEBUG

     8

//#define HASH_DEBUG

     9

//#define HASH_STATS

    10

    11

    12

typedef struct Queue Queue;

    13

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

    14

typedef void* Queue_PopProc(Queue* q);

    15

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

    16

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

    17

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

    18

    19

typedef struct InsSortNode InsSortNode;

    20

struct InsSortNode {

    21

	void* item;

    22

	int priority;

    23

	InsSortNode* next;

    24

};

    25

typedef struct BinaryHeapNode BinaryHeapNode;

    26

	struct BinaryHeapNode {

    27

	void* item;

    28

	int priority;

    29

};

    30

    31

    32

struct Queue{

    33

	/*

    34

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

    35

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

    36

	 */

    37

	Queue_PushProc* push;

    38

	/*

    39

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

    40

	 * is defined by the exact type of queue.

    41

	 */

    42

	Queue_PopProc* pop;

    43

	/*

    44

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

    45

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

    46

	 * if not known.

    47

	 */

    48

	Queue_DeleteProc* del;

    49

    50

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

    51

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

    52

	 * in this way are free()'d.

    53

	 */

    54

	Queue_ClearProc* clear;

    55

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

    56

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

    57

	 * items are free()'d too.

    58

	 */

    59

	Queue_FreeProc* free;

    60

    61

	union {

    62

		struct {

    63

			uint max_size;

    64

			uint size;

    65

			void** elements;

    66

		} stack;

    67

		struct {

    68

			uint max_size;

    69

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

    70

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

    71

			void** elements;

    72

		} fifo;

    73

		struct {

    74

			InsSortNode* first;

    75

		} inssort;

    76

		struct {

    77

			uint max_size;

    78

			uint size;

    79

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

    80

			BinaryHeapNode** elements;

    81

		} binaryheap;

    82

	} data;

    83

    84

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

    85

	 * Queue is deleted. */

    86

	bool freeq;

    87

};

    88

    89

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

    90

void init_Stack(Queue* q, uint max_size);

    91

    92

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

    93

Queue* new_Stack(uint max_size);

    94

    95

/*

    96

 * Fifo

    97

 */

    98

    99

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

   100

 * elements */

   101

void init_Fifo(Queue* q, uint max_size);

   102

   103

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

   104

Queue* new_Fifo(uint max_size);

   105

   106

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

   107

   108

int build_Fifo(void* buffer, uint size);

   109

   110

/*

   111

 * Insertion Sorter

   112

 */

   113

   114

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

   115

 * size */

   116

void init_InsSort(Queue* q);

   117

   118

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

   119

Queue* new_InsSort(void);

   120

   121

/*

   122

 *  Binary Heap

   123

 *  For information, see:

   124

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

   125

 */

   126

   127

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

   128

#define BINARY_HEAP_BLOCKSIZE_BITS 10

   129

   130

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

   131

 * max_size elements */

   132

void init_BinaryHeap(Queue* q, uint max_size);

   133

   134

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

   135

 * elements. */

   136

Queue* new_BinaryHeap(uint max_size);

   137

   138

/*

   139

 * Hash

   140

 */

   141

typedef struct HashNode HashNode;

   142

struct HashNode {

   143

	uint key1;

   144

	uint key2;

   145

	void* value;

   146

	HashNode* next;

   147

};

   148

/**

   149

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

   150

 * the resulting range is clearly defined.

   151

 */

   152

typedef uint Hash_HashProc(uint key1, uint key2);

   153

typedef struct Hash {

   154

	/* The hash function used */

   155

	Hash_HashProc* hash;

   156

	/* The amount of items in the hash */

   157

	uint size;

   158

	/* The number of buckets allocated */

   159

	uint num_buckets;

   160

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

   161

	HashNode* buckets;

   162

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

   163

	 * there are any Nodes in the bucket */

   164

	bool* buckets_in_use;

   165

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

   166

	bool freeb;

   167

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

   168

	bool freeh;

   169

} Hash;

   170

   171

/* Call these function to manipulate a hash */

   172

   173

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

   174

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

   175

 * is _not_ free()'d! */

   176

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

   177

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

   178

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

   179

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

   180

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

   181

 * present. */

   182

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

   183

   184

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

   185

   186

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

   187

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

   188

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

   189

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

   190

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

   191

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

   192

/*

   193

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

   194

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

   195

 * are left in the hash.

   196

 */

   197

void delete_Hash(Hash* h, bool free_values);

   198

/*

   199

 * Cleans the hash, but keeps the memory allocated

   200

 */

   201

void clear_Hash(Hash* h, bool free_values);

   202

/*

   203

 * Gets the current size of the Hash

   204

 */

   205

uint Hash_Size(Hash* h);

   206

   207

#endif /* QUEUE_H */