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