Sergey Sharybin
35b61a7512
Instead of having ifdef __GNUC__ all over the headers to use special compiler's hints use a special file where all things like this are concentrated. Makes code easier to follow and allows to manage special attributes in more efficient way. Thanks Campbell for review!
92 lines
3.3 KiB
C++
92 lines
3.3 KiB
C++
/*
|
|
* ***** 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,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
* 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 *****
|
|
*/
|
|
|
|
#ifndef __BLI_MEMPOOL_H__
|
|
#define __BLI_MEMPOOL_H__
|
|
|
|
/** \file BLI_mempool.h
|
|
* \ingroup bli
|
|
* \author Geoffrey Bantle
|
|
* \brief Simple fast memory allocator for fixed size chunks.
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
struct BLI_mempool;
|
|
struct BLI_mempool_chunk;
|
|
|
|
typedef struct BLI_mempool BLI_mempool;
|
|
|
|
/* 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.*/
|
|
|
|
BLI_mempool *BLI_mempool_create(unsigned int esize, unsigned int totelem,
|
|
unsigned int pchunk, unsigned int flag) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
|
|
void *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
|
|
void *BLI_mempool_calloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
|
|
void BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
|
|
void BLI_mempool_clear_ex(BLI_mempool *pool,
|
|
const int totelem_reserve) ATTR_NONNULL(1);
|
|
void BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
|
|
void BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
|
|
int BLI_mempool_count(BLI_mempool *pool) ATTR_NONNULL(1);
|
|
void *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
|
|
|
|
void BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
|
|
void **BLI_mempool_as_tableN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
|
|
void BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
|
|
void *BLI_mempool_as_arrayN(BLI_mempool *pool, const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
|
|
|
|
/** iteration stuff. note: this may easy to produce bugs with **/
|
|
/* private structure */
|
|
typedef struct BLI_mempool_iter {
|
|
BLI_mempool *pool;
|
|
struct BLI_mempool_chunk *curchunk;
|
|
unsigned int curindex;
|
|
} BLI_mempool_iter;
|
|
|
|
/* flag */
|
|
enum {
|
|
BLI_MEMPOOL_SYSMALLOC = (1 << 0),
|
|
BLI_MEMPOOL_ALLOW_ITER = (1 << 1)
|
|
};
|
|
|
|
void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter) ATTR_NONNULL();
|
|
void *BLI_mempool_iterstep(BLI_mempool_iter *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __BLI_MEMPOOL_H__ */
|