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
21  * \ingroup bli
22  * \brief Efficient in-memory storage of multiple similar arrays.
23  */
24
25 typedef struct BArrayState BArrayState;
26 typedef struct BArrayStore BArrayStore;
27
28 BArrayStore *BLI_array_store_create(
29         unsigned int stride, unsigned int chunk_count);
30 void BLI_array_store_destroy(
31         BArrayStore *bs);
32 void BLI_array_store_clear(
33         BArrayStore *bs);
34
35 /* find the memory used by all states (expanded & real) */
36 size_t BLI_array_store_calc_size_expanded_get(
37         const BArrayStore *bs);
38 size_t BLI_array_store_calc_size_compacted_get(
39         const BArrayStore *bs);
40
41 BArrayState *BLI_array_store_state_add(
42         BArrayStore *bs,
43         const void *data, const size_t data_len,
44         const BArrayState *state_reference);
45 void BLI_array_store_state_remove(
46         BArrayStore *bs,
47         BArrayState *state);
48
49 size_t BLI_array_store_state_size_get(
50         BArrayState *state);
51 void BLI_array_store_state_data_get(
52         BArrayState *state,
53         void *data);
54 void *BLI_array_store_state_data_get_alloc(
55         BArrayState *state,
56         size_t *r_data_len);
57
58 /* only for tests */
59 bool BLI_array_store_is_valid(
60         BArrayStore *bs);
61
62 #endif  /* __BLI_ARRAY_STORE_H__ */