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