pool.h File Reference

#include "mupdf/fitz/system.h"
#include "mupdf/fitz/context.h"

Include dependency graph for pool.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	fz_pool_alloc_struct(CTX, POOL, TYPE)
#define	fz_new_pool_array(CTX, POOL, TYPE, INIT)

Typedefs
typedef struct fz_pool	fz_pool
typedef struct fz_pool_array	fz_pool_array

Functions
fz_pool *	fz_new_pool (fz_context *ctx)
void *	fz_pool_alloc (fz_context *ctx, fz_pool *pool, size_t size)
char *	fz_pool_strdup (fz_context *ctx, fz_pool *pool, const char *s)
char *	fz_pool_strndup (fz_context *ctx, fz_pool *pool, const char *s, size_t n)
size_t	fz_pool_size (fz_context *ctx, fz_pool *pool)
void	fz_drop_pool (fz_context *ctx, fz_pool *pool)
fz_pool_array *	fz_new_pool_array_imp (fz_context *ctx, fz_pool *pool, size_t size, size_t initial)
void *	fz_pool_array_append (fz_context *ctx, fz_pool_array *arr, size_t *idx)
void *	fz_pool_array_lookup (fz_context *ctx, fz_pool_array *arr, size_t idx)
size_t	fz_pool_array_len (fz_context *ctx, fz_pool_array *arr)

Macro Definition Documentation

fz_new_pool_array

#define fz_new_pool_array	(		CTX,
			POOL,
			TYPE,
			INIT )

Value:

    fz_new_pool_array_imp(CTX, POOL, sizeof(TYPE), INIT);

Create a new pool array for a given type, with a given initial size.

fz_pool_alloc_struct

#define fz_pool_alloc_struct	(		CTX,
			POOL,
			TYPE )

Value:

    ((TYPE*)Memento_label(fz_pool_alloc(CTX, POOL, sizeof(TYPE)), #TYPE))

Typedef Documentation

fz_pool

typedef struct fz_pool fz_pool

Simple pool allocators.

Allocate from the pool, which can then be freed at once.

fz_pool_array

typedef struct fz_pool_array fz_pool_array

Routines to handle a 'variable length array' within the pool.

Appending to the array, and looking up items within the array are O(log n) operations.

Function Documentation

fz_drop_pool()

void fz_drop_pool	(	fz_context *	ctx,
		fz_pool *	pool )

Drop a pool, freeing and invalidating all storage returned from the pool.

fz_new_pool()

fz_pool * fz_new_pool

(

fz_context *

ctx

)

Create a new pool to allocate from.

fz_new_pool_array_imp()

fz_pool_array * fz_new_pool_array_imp	(	fz_context *	ctx,
		fz_pool *	pool,
		size_t	size,
		size_t	initial )

fz_pool_alloc()

void * fz_pool_alloc	(	fz_context *	ctx,
		fz_pool *	pool,
		size_t	size )

Allocate a block of size bytes from the pool. Block will be inited to 0's.

fz_pool_array_append()

void * fz_pool_array_append	(	fz_context *	ctx,
		fz_pool_array *	arr,
		size_t *	idx )

Append an element to the end of the array.

Returns a pointer to the new element (initially all 0's), and (optionally) the index of that element.

fz_pool_array_len()

size_t fz_pool_array_len	(	fz_context *	ctx,
		fz_pool_array *	arr )

Get the length of the array.

fz_pool_array_lookup()

void * fz_pool_array_lookup	(	fz_context *	ctx,
		fz_pool_array *	arr,
		size_t	idx )

Lookup an element in the array.

fz_pool_size()

size_t fz_pool_size	(	fz_context *	ctx,
		fz_pool *	pool )

The current size of the pool.

The number of bytes of storage currently allocated to the pool. This is the total of the storage used for the blocks making up the pool, rather then total of the allocated blocks so far, so it will increase in 'lumps'. from the pool, then the pool size may still be X

fz_pool_strdup()

char * fz_pool_strdup	(	fz_context *	ctx,
		fz_pool *	pool,
		const char *	s )

strdup equivalent allocating from the pool.

fz_pool_strndup()

char * fz_pool_strndup	(	fz_context *	ctx,
		fz_pool *	pool,
		const char *	s,
		size_t	n )

strndup equivalent allocating from the pool.