added peek functions
[IRC.git] / Robust / src / Runtime / Queue.h
1 #ifndef QUEUE_H
2 #define QUEUE_H
3
4 struct Queue {
5   struct QueueItem * head;
6   struct QueueItem * tail;
7 };
8
9 struct QueueItem {
10   void * objectptr;
11   struct Queue * queue;
12   struct QueueItem * next;
13   struct QueueItem * prev;
14 };
15
16 #define isEmpty(x) ((x)->head==NULL)
17
18 struct Queue * createQueue();
19 void freeQueue(struct Queue * q);
20
21 struct QueueItem * addNewItem(struct Queue * queue, void * ptr);
22 struct QueueItem * addNewItemBack(struct Queue * queue, void * ptr);
23 #ifdef MULTICORE
24 struct QueueItem * addNewItem_I(struct Queue * queue, void * ptr);
25 #endif
26
27 struct QueueItem * getTail(struct Queue * queue);
28 struct QueueItem * getHead(struct Queue * queue);
29 struct QueueItem * getNextQueueItem(struct QueueItem * qi);
30
31 struct QueueItem * findItem(struct Queue * queue, void * ptr);
32
33 void removeItem(struct Queue * queue, struct QueueItem * item);
34
35 void * getItem(struct Queue * queue);
36 void * getItemBack(struct Queue * queue);
37
38 void * peekItem(struct Queue * queue);
39 void * peekItemBack(struct Queue * queue);
40
41
42 // for debugging, only included if macro is defined
43 #ifdef DEBUG_QUEUE
44
45 // returns 1 if queue's pointers are valid, 0 otherwise
46 int assertQueue(struct Queue * queue);
47
48 // use this to print head, tail and next, prev of each item
49 void printQueue(struct Queue * queue);
50 #endif
51
52 #endif