Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_array_store.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 #ifndef __BLI_ARRAY_STORE_H__
18 #define __BLI_ARRAY_STORE_H__
19
20 /** \file \ingroup bli
21  *  \brief Efficient in-memory storage of multiple similar arrays.
22  */
23
24 typedef struct BArrayState BArrayState;
25 typedef struct BArrayStore BArrayStore;
26
27 BArrayStore *BLI_array_store_create(
28         unsigned int stride, unsigned int chunk_count);
29 void BLI_array_store_destroy(
30         BArrayStore *bs);
31 void BLI_array_store_clear(
32         BArrayStore *bs);
33
34 /* find the memory used by all states (expanded & real) */
35 size_t BLI_array_store_calc_size_expanded_get(
36         const BArrayStore *bs);
37 size_t BLI_array_store_calc_size_compacted_get(
38         const BArrayStore *bs);
39
40 BArrayState *BLI_array_store_state_add(
41         BArrayStore *bs,
42         const void *data, const size_t data_len,
43         const BArrayState *state_reference);
44 void BLI_array_store_state_remove(
45         BArrayStore *bs,
46         BArrayState *state);
47
48 size_t BLI_array_store_state_size_get(
49         BArrayState *state);
50 void BLI_array_store_state_data_get(
51         BArrayState *state,
52         void *data);
53 void *BLI_array_store_state_data_get_alloc(
54         BArrayState *state,
55         size_t *r_data_len);
56
57 /* only for tests */
58 bool BLI_array_store_is_valid(
59         BArrayStore *bs);
60
61 #endif  /* __BLI_ARRAY_STORE_H__ */