changes to path searching
[blender.git] / source / blender / blenlib / BLI_gsqueue.h
1 /*
2  * A generic structure queue (a queue for fixed length
3  * (generally small) structures.
4  * 
5  * $Id$
6  *
7  * ***** BEGIN GPL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 #ifndef BLI_GSQUEUE_H
34 #define BLI_GSQUEUE_H
35
36 typedef struct _GSQueue GSQueue;
37
38         /**
39          * Create a new GSQueue.
40          * 
41          * @param elem_size The size of the structures in the queue.
42          * @retval The new queue
43          */
44 GSQueue*        BLI_gsqueue_new         (int elem_size);
45
46         /**
47          * Query if the queue is empty
48          */
49 int                     BLI_gsqueue_is_empty(GSQueue *gq);
50
51         /**
52          * Query number elements in the queue
53          */
54 int                     BLI_gsqueue_size(GSQueue *gq);
55
56         /**
57          * Access the item at the head of the queue
58          * without removing it.
59          * 
60          * @param item_r A pointer to an appropriatly
61          * sized structure (the size passed to BLI_gsqueue_new)
62          */
63 void            BLI_gsqueue_peek        (GSQueue *gq, void *item_r);
64
65         /**
66          * Access the item at the head of the queue
67          * and remove it.
68          * 
69          * @param item_r A pointer to an appropriatly
70          * sized structure (the size passed to BLI_gsqueue_new).
71          * Can be NULL if desired.
72          */
73 void            BLI_gsqueue_pop         (GSQueue *gq, void *item_r);
74
75         /**
76          * Push an element onto the tail of the queue.
77          * 
78          * @param item A pointer to an appropriatly
79          * sized structure (the size passed to BLI_gsqueue_new).
80          */
81 void            BLI_gsqueue_push        (GSQueue *gq, void *item);
82
83         /**
84          * Push an element back onto the head of the queue (so
85          * it would be returned from the next call to BLI_gsqueue_pop).
86          * 
87          * @param item A pointer to an appropriatly
88          * sized structure (the size passed to BLI_gsqueue_new).
89          */
90 void            BLI_gsqueue_pushback    (GSQueue *gq, void *item);
91
92         /**
93          * Free the queue
94          */
95 void            BLI_gsqueue_free        (GSQueue *gq);
96
97 #endif /* BLI_GSQUEUE_H */
98