ugfx/src/gos/gos_x_heap.h
2015-11-27 10:14:45 +10:00

45 lines
1.4 KiB
C

/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.org/license.html
*/
#ifndef _GOS_X_HEAP_H
#define _GOS_X_HEAP_H
#if GOS_NEED_X_HEAP || defined(__DOXYGEN__)
/*===========================================================================*/
/* Type definitions */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#if GFX_OS_HEAP_SIZE != 0 || defined(__DOXYGEN__)
/**
* @brief Take a chunk of memory and add it to the available heap
* @note Memory added must obviously not already be on the heap.
* @note It is allowable to add multiple non-contiguous blocks of memory
* to the heap. If however it is contiguous with a previously added block
* it will get merged with the existing block in order to allow
* allocations that span the boundary.
* @pre GFX_OS_HEAP_SIZE != 0 and an operating system that uses the
* internal ugfx heap allocator rather than its own allocator.
*/
void gfxAddHeapBlock(void *ptr, size_t sz);
#endif
void *gfxAlloc(size_t sz);
void *gfxRealloc(void *ptr, size_t oldsz, size_t newsz);
void gfxFree(void *ptr);
#ifdef __cplusplus
}
#endif
#endif /* GOS_NEED_X_HEAP */
#endif /* _GOS_X_HEAP_H */