archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
901dea87a1266479d3b7aab6cfd2d5fbf6adc393
blender-archive/source/blender/blenlib/BLI_mempool.h

163 lines
4.0 KiB
C++
Raw Normal View History

doxygen: add blenlib under core as module.
2011-02-18 13:58:08 +00:00
/*
-> Moving Pooling Alloctor to BlenLib Bmesh's pooling allocator is probably usefull for other parts of blender as well, so I am moving it to BlenLib.
2008-07-04 17:32:55 +00:00
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
correct fsf address
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-> Moving Pooling Alloctor to BlenLib Bmesh's pooling allocator is probably usefull for other parts of blender as well, so I am moving it to BlenLib.
2008-07-04 17:32:55 +00:00
*
* The Original Code is Copyright (C) 2008 Blender Foundation.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): Geoffrey Bantle.
*
* ***** END GPL LICENSE BLOCK *****
*/
unify include guard defines, __$FILENAME__ without the underscores these clogged up the namespace for autocompleation which was annoying.
2012-02-17 18:59:41 +00:00
#ifndef __BLI_MEMPOOL_H__
#define __BLI_MEMPOOL_H__
-> Moving Pooling Alloctor to BlenLib Bmesh's pooling allocator is probably usefull for other parts of blender as well, so I am moving it to BlenLib.
2008-07-04 17:32:55 +00:00
Code cleanup: file operations merged into single header, some function names made less cryptic and changed to indicate if they work on files or directories.
2011-10-22 15:35:49 +00:00
/** \file BLI_mempool.h
doxygen: add blenlib under core as module.
2011-02-18 13:58:08 +00:00
* \ingroup bli
* \author Geoffrey Bantle
header comment cleanup, explain whats the difference between confusingly named drarnode.c and node_draw.c.
2012-07-14 15:29:45 +00:00
* \brief Simple fast memory allocator for fixed size chunks.
doxygen: add blenlib under core as module.
2011-02-18 13:58:08 +00:00
*/
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
#ifdef __cplusplus
extern "C"
{
#endif
-> Moving Pooling Alloctor to BlenLib Bmesh's pooling allocator is probably usefull for other parts of blender as well, so I am moving it to BlenLib.
2008-07-04 17:32:55 +00:00
struct BLI_mempool;
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
struct BLI_mempool_chunk;
typedef struct BLI_mempool BLI_mempool;
Code Cleanup: remove non existing function declarations. added some missing functions too - which are not used yep but should be there for api completeness. * CDDM_set_mloop * CDDM_set_mpoly * BLI_mempool_count
2012-02-29 15:00:37 +00:00
/* allow_iter allows iteration on this mempool. note: this requires that the
* first four bytes of the elements never contain the character string
* 'free'. use with care.*/
-> Moving Pooling Alloctor to BlenLib Bmesh's pooling allocator is probably usefull for other parts of blender as well, so I am moving it to BlenLib.
2008-07-04 17:32:55 +00:00
mempool internal change, use unsigned ints where possible (less overhead), also quiet compiler warning for BLI_LINKSTACK_FREE macro.
2013-08-30 21:32:57 +00:00
BLI_mempool *BLI_mempool_create(unsigned int esize, unsigned int totelem,
unsigned int pchunk, unsigned int flag)
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
#ifdef __GNUC__
use gcc malloc attribute for low level allocation functions, prevents gcc from checking if resulting pointers alias existing pointers, also use sentinel attribute for uiButGetStrInfo so incorrect usage gives a warning.
2013-08-05 20:57:13 +00:00
__attribute__((malloc))
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
__attribute__((warn_unused_result))
#endif
;
void *BLI_mempool_alloc(BLI_mempool *pool)
#ifdef __GNUC__
use gcc malloc attribute for low level allocation functions, prevents gcc from checking if resulting pointers alias existing pointers, also use sentinel attribute for uiButGetStrInfo so incorrect usage gives a warning.
2013-08-05 20:57:13 +00:00
__attribute__((malloc))
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
__attribute__((warn_unused_result))
__attribute__((nonnull(1)))
#endif
;
void *BLI_mempool_calloc(BLI_mempool *pool)
#ifdef __GNUC__
use gcc malloc attribute for low level allocation functions, prevents gcc from checking if resulting pointers alias existing pointers, also use sentinel attribute for uiButGetStrInfo so incorrect usage gives a warning.
2013-08-05 20:57:13 +00:00
__attribute__((malloc))
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
__attribute__((warn_unused_result))
__attribute__((nonnull(1)))
#endif
;
void BLI_mempool_free(BLI_mempool *pool, void *addr)
#ifdef __GNUC__
__attribute__((nonnull(1, 2)))
#endif
;
clearing the mempool can now keep more then a single element reserved.
2013-08-25 16:16:38 +00:00
void BLI_mempool_clear_ex(BLI_mempool *pool,
const int totelem_reserve)
#ifdef __GNUC__
__attribute__((nonnull(1)))
#endif
;
fix leak in BLI_ghash_clear(). was never freeing entries, add BLI_mempool_clear utility function.
2013-08-25 14:58:26 +00:00
void BLI_mempool_clear(BLI_mempool *pool)
#ifdef __GNUC__
__attribute__((nonnull(1)))
#endif
;
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
void BLI_mempool_destroy(BLI_mempool *pool)
#ifdef __GNUC__
__attribute__((nonnull(1)))
#endif
;
int BLI_mempool_count(BLI_mempool *pool)
#ifdef __GNUC__
__attribute__((nonnull(1)))
#endif
;
mempool internal change, use unsigned ints where possible (less overhead), also quiet compiler warning for BLI_LINKSTACK_FREE macro.
2013-08-30 21:32:57 +00:00
void *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index)
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
#ifdef __GNUC__
__attribute__((warn_unused_result))
__attribute__((nonnull(1)))
#endif
;
mempool api cleanup: differentiate mempool functions that allocate a pointer lookup table from allocating the data as a contiguous array, call these functions BLI_mempool_as_table(), BLI_mempool_as_array(), the N prefixed versions of these functions return newly allocated arrays.
2013-08-04 19:40:50 +00:00
void BLI_mempool_as_table(BLI_mempool *pool, void **data)
utility function to get a mempool as a pointer array.
2013-01-19 03:51:17 +00:00
#ifdef __GNUC__
mempool api cleanup: differentiate mempool functions that allocate a pointer lookup table from allocating the data as a contiguous array, call these functions BLI_mempool_as_table(), BLI_mempool_as_array(), the N prefixed versions of these functions return newly allocated arrays.
2013-08-04 19:40:50 +00:00
__attribute__((nonnull(1, 2)))
#endif
;
void **BLI_mempool_as_tableN(BLI_mempool *pool, const char *allocstr)
#ifdef __GNUC__
use gcc malloc attribute for low level allocation functions, prevents gcc from checking if resulting pointers alias existing pointers, also use sentinel attribute for uiButGetStrInfo so incorrect usage gives a warning.
2013-08-05 20:57:13 +00:00
__attribute__((malloc))
mempool api cleanup: differentiate mempool functions that allocate a pointer lookup table from allocating the data as a contiguous array, call these functions BLI_mempool_as_table(), BLI_mempool_as_array(), the N prefixed versions of these functions return newly allocated arrays.
2013-08-04 19:40:50 +00:00
__attribute__((warn_unused_result))
__attribute__((nonnull(1, 2)))
#endif
;
void BLI_mempool_as_array(BLI_mempool *pool, void *data)
#ifdef __GNUC__
__attribute__((nonnull(1, 2)))
utility function to get a mempool as a pointer array.
2013-01-19 03:51:17 +00:00
#endif
;
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
mempool api cleanup: differentiate mempool functions that allocate a pointer lookup table from allocating the data as a contiguous array, call these functions BLI_mempool_as_table(), BLI_mempool_as_array(), the N prefixed versions of these functions return newly allocated arrays.
2013-08-04 19:40:50 +00:00
void *BLI_mempool_as_arrayN(BLI_mempool *pool, const char *allocstr)
style cleanup
2013-01-30 21:17:38 +00:00
#ifdef __GNUC__
use gcc malloc attribute for low level allocation functions, prevents gcc from checking if resulting pointers alias existing pointers, also use sentinel attribute for uiButGetStrInfo so incorrect usage gives a warning.
2013-08-05 20:57:13 +00:00
__attribute__((malloc))
style cleanup
2013-01-30 21:17:38 +00:00
__attribute__((warn_unused_result))
__attribute__((nonnull(1, 2)))
#endif
;
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
/** iteration stuff. note: this may easy to produce bugs with **/
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
/* private structure */
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
typedef struct BLI_mempool_iter {
BLI_mempool *pool;
struct BLI_mempool_chunk *curchunk;
mempool internal change, use unsigned ints where possible (less overhead), also quiet compiler warning for BLI_LINKSTACK_FREE macro.
2013-08-30 21:32:57 +00:00
unsigned int curindex;
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
} BLI_mempool_iter;
Code Cleanup: update to mempool, use flag rather then bool args.
2012-03-01 22:59:18 +00:00
/* flag */
enum {
BLI_MEMPOOL_SYSMALLOC = (1 << 0),
BLI_MEMPOOL_ALLOW_ITER = (1 << 1)
};
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter)
#ifdef __GNUC__
__attribute__((nonnull(1, 2)))
#endif
;
void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
#ifdef __GNUC__
__attribute__((warn_unused_result))
__attribute__((nonnull(1)))
#endif
;
merge mempool changes from bmesh (adds mempool iterator).
2011-11-16 19:31:42 +00:00
#ifdef __cplusplus
}
#endif
-> UV and VCOL support for bevel (editmode) BMesh and the bevel code now support UVs/VCOLS. The offset is fixed at this time, but will be made dynamic later.
2008-07-08 02:22:37 +00:00
use gcc attributes for BLI alloc functions
2012-07-14 12:47:49 +00:00
#endif /* __BLI_MEMPOOL_H__ */
Copy Permalink