doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / blenlib / intern / dynamiclist.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Jiri Hnidek.
21  *
22  * Documentation of Two way dynamic list with access array can be found at:
23  *
24  * http://wiki.blender.org/bin/view.pl/Blenderwiki/DynamicListWithAccessArray
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #ifndef B_DYNAMIC_LIST_H
30 #define B_DYNAMIC_LIST_H
31
32 #define PAGE_SIZE 4
33
34 struct ListBase;
35
36 /*
37  * Access array using realloc 
38  */
39 typedef struct DynamicArray{
40         unsigned int count;             /* count of items in list */
41         unsigned int max_item_index;    /* max available index */
42         unsigned int last_item_index;   /* max used index */
43         void **items;                   /* dynamicaly allocated array of pointers
44                                            pointing at items in list */
45 } DynamicArray;
46
47 /*
48  * Two way dynamic list with access array
49  */
50 typedef struct DynamicList {
51         struct DynamicArray da;         /* access array */
52         struct ListBase lb;             /* two way linked dynamic list */
53 } DynamicList;
54
55 #endif