MuPDF X.Y.Z

fitz/pool.h

Index

typedef

macro

function

Pool

typedef fz_pool

typedef struct fz_pool fz_pool

Simple pool allocators.

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

function fz_new_pool

fz_pool *
fz_new_pool (
        fz_context *ctx
)

Create a new pool to allocate from.

function 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.

macro fz_pool_alloc_struct

#define fz_pool_alloc_struct(CTX, POOL, TYPE)

function fz_pool_strdup

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

strdup equivalent allocating from the pool.

function 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.

function fz_pool_asprintf

char *
fz_pool_asprintf (
        fz_context *ctx,
        fz_pool *pool,
        const char *fmt,
        ...
)

asprintf equivalent allocating from the pool.

function 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

function 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.

typedef 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.

macro fz_new_pool_array

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

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

function 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
)

function 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.

function 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.

function fz_pool_array_len

size_t
fz_pool_array_len (
        fz_context *ctx,
        fz_pool_array *arr
)

Get the length of the array.