Filling in branch from trunk
[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/BL DUAL 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. The Blender
13  * Foundation also sells licenses for use in proprietary software under
14  * the Blender License.  See http://www.blender.org/BL/ for information
15  * about this.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  *
26  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
27  * All rights reserved.
28  *
29  * The Original Code is: all of this file.
30  *
31  * Contributor(s): none yet.
32  *
33  * ***** END GPL/BL DUAL LICENSE BLOCK *****
34  */
35
36 #ifndef BLI_GSQUEUE_H
37 #define BLI_GSQUEUE_H
38
39 typedef struct _GSQueue GSQueue;
40
41         /**
42          * Create a new GSQueue.
43          * 
44          * @param elem_size The size of the structures in the queue.
45          * @retval The new queue
46          */
47 GSQueue*        BLI_gsqueue_new         (int elem_size);
48
49         /**
50          * Query if the queue is empty
51          */
52 int                     BLI_gsqueue_is_empty(GSQueue *gq);
53
54         /**
55          * Access the item at the head of the queue
56          * without removing it.
57          * 
58          * @param item_r A pointer to an appropriatly
59          * sized structure (the size passed to BLI_gsqueue_new)
60          */
61 void            BLI_gsqueue_peek        (GSQueue *gq, void *item_r);
62
63         /**
64          * Access the item at the head of the queue
65          * and remove it.
66          * 
67          * @param item_r A pointer to an appropriatly
68          * sized structure (the size passed to BLI_gsqueue_new).
69          * Can be NULL if desired.
70          */
71 void            BLI_gsqueue_pop         (GSQueue *gq, void *item_r);
72
73         /**
74          * Push an element onto the tail of the queue.
75          * 
76          * @param item A pointer to an appropriatly
77          * sized structure (the size passed to BLI_gsqueue_new).
78          */
79 void            BLI_gsqueue_push        (GSQueue *gq, void *item);
80
81         /**
82          * Push an element back onto the head of the queue (so
83          * it would be returned from the next call to BLI_gsqueue_pop).
84          * 
85          * @param item A pointer to an appropriatly
86          * sized structure (the size passed to BLI_gsqueue_new).
87          */
88 void            BLI_gsqueue_pushback    (GSQueue *gq, void *item);
89
90         /**
91          * Free the queue
92          */
93 void            BLI_gsqueue_free        (GSQueue *gq);
94
95 #endif /* BLI_GSQUEUE_H */
96