Files
tomato-testing/toxcore/tox_memory.h
Green Sky 596ea37298 Squashed 'external/toxcore/c-toxcore/' changes from 640e6cace..e58eb27a8
e58eb27a8 fix(toxav): remove extra copy of video frame on encode Tested and works, but there might be alignment issues and other stuff.
206ea3530 refactor: Explicitly pass dependencies to constructors.
7cefa93cf fix(toxencryptsave): Wipe salt and passkey after usage.
7c3be2342 refactor: Add file/line to tox-bootstrapd logging.
f84e8cdce refactor: Move loglogdata out of network.c.
390f7db06 refactor: Move random and memory OS-specifics to `os_*` files.
REVERT: 640e6cace fix(toxav): remove extra copy of video frame on encode Tested and works, but there might be alignment issues and other stuff.

git-subtree-dir: external/toxcore/c-toxcore
git-subtree-split: e58eb27a84f9fa0cd996868e079f39e90a5c04b6
2025-11-04 21:18:05 +01:00

76 lines
2.2 KiB
C

/* SPDX-License-Identifier: GPL-3.0-or-later
* Copyright © 2016-2025 The TokTok team.
* Copyright © 2013 Tox project.
*/
/**
* Memory allocation and deallocation functions.
*/
#ifndef C_TOXCORE_TOXCORE_TOX_MEMORY_H
#define C_TOXCORE_TOXCORE_TOX_MEMORY_H
#include <stdint.h> // uint*_t
#include "tox_attributes.h"
#ifdef __cplusplus
extern "C" {
#endif
/** @brief Functions wrapping standard C memory allocation functions. */
typedef struct Tox_Memory_Funcs Tox_Memory_Funcs;
/**
* @brief A dynamic memory allocator.
*/
typedef struct Tox_Memory Tox_Memory;
/**
* @brief Allocates a new allocator using itself to allocate its own memory.
*
* The passed `user_data` is stored and passed to allocator callbacks. It must
* outlive the `Tox_Memory` object, since it may be used by the callback invoked
* in `tox_memory_free`.
*
* @return NULL if allocation fails.
*/
Tox_Memory *_Nullable tox_memory_new(const Tox_Memory_Funcs *_Nonnull funcs, void *_Nullable user_data);
/**
* @brief Destroys the allocator using its own deallocation function.
*
* The stored `user_data` will not be deallocated.
*/
void tox_memory_free(Tox_Memory *_Nullable mem);
/**
* @brief Allocate an array of a given size for built-in types.
*
* The array will not be initialised. Supported built-in types are
* `uint8_t`, `int8_t`, and `int16_t`.
*/
void *_Nullable tox_memory_malloc(const Tox_Memory *_Nonnull mem, uint32_t size);
/**
* @brief Allocate a single zero-initialised object.
*
* Always use as `(T *)tox_memory_alloc(mem, sizeof(T))`. Unlike `calloc`, this
* does not support allocating arrays. Use `malloc` and `memset` for that.
*
* @param mem The memory allocator.
* @param size Size in bytes of each element.
*/
void *_Nullable tox_memory_alloc(const Tox_Memory *_Nonnull mem, uint32_t size);
/** @brief Resize a memory chunk vector. */
void *_Nullable tox_memory_realloc(const Tox_Memory *_Nonnull mem, void *_Nullable ptr, uint32_t size);
/** @brief Free an array, object, or object vector. */
void tox_memory_dealloc(const Tox_Memory *_Nonnull mem, void *_Nullable ptr);
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* C_TOXCORE_TOXCORE_TOX_MEMORY_H */