Functions
void	MallocError (size_t size)
	Function to exit with an error message after malloc() or calloc() have failed. More...

void	ReallocError (size_t size)
	Function to exit with an error message after realloc() have failed. More...

void	CheckAllocationConstraints (size_t element_size, size_t num_elements)
	Checks whether allocating memory would overflow size_t. More...

template<typename T >
void	CheckAllocationConstraints (size_t num_elements)
	Checks whether allocating memory would overflow size_t. More...

template<typename T >
T *	MallocT (size_t num_elements)
	Simplified allocation function that allocates the specified number of elements of the given type. More...

template<typename T >
T *	CallocT (size_t num_elements)
	Simplified allocation function that allocates the specified number of elements of the given type. More...

template<typename T >
T *	ReallocT (T *t_ptr, size_t num_elements)
	Simplified reallocation function that allocates the specified number of elements of the given type. More...

Detailed Description

Functions related to the allocation of memory

Definition in file alloc_func.hpp.

Function Documentation

◆ CallocT()

template<typename T >

T* CallocT ( size_t num_elements )

inline

Simplified allocation function that allocates the specified number of elements of the given type.

It also explicitly casts it to the requested type.

Note: throws an error when there is no memory anymore.; the memory contains all zero values.

Template Parameters

T	the type of the variable(s) to allocation.

Parameters

num_elements the number of elements to allocate of the given type.

Returns: nullptr when num_elements == 0, non-nullptr otherwise.

Definition at line 85 of file alloc_func.hpp.

◆ CheckAllocationConstraints() [1/2]

void CheckAllocationConstraints	(	size_t	element_size,
		size_t	num_elements
	)

inline

Checks whether allocating memory would overflow size_t.

Parameters

element_size	Size of the structure to allocate.
num_elements	Number of elements to allocate.

Definition at line 29 of file alloc_func.hpp.

References MallocError().

Referenced by CheckAllocationConstraints().

◆ CheckAllocationConstraints() [2/2]

template<typename T >

void CheckAllocationConstraints ( size_t num_elements )

inline

Checks whether allocating memory would overflow size_t.

Template Parameters

T	Structure to allocate.

Parameters

num_elements Number of elements to allocate.

Definition at line 41 of file alloc_func.hpp.

References CheckAllocationConstraints().

◆ MallocError()

void MallocError ( size_t size )

Function to exit with an error message after malloc() or calloc() have failed.

Parameters

size	number of bytes we tried to allocate

Definition at line 20 of file alloc_func.cpp.

Referenced by ScriptAllocator::CheckAllocation(), and CheckAllocationConstraints().

◆ MallocT()

template<typename T >

T* MallocT ( size_t num_elements )

inline

Simplified allocation function that allocates the specified number of elements of the given type.

It also explicitly casts it to the requested type.

Note: throws an error when there is no memory anymore.; the memory contains garbage data (i.e. possibly non-zero values).

Template Parameters

T	the type of the variable(s) to allocation.

Parameters

num_elements the number of elements to allocate of the given type.

Returns: nullptr when num_elements == 0, non-nullptr otherwise.

Definition at line 57 of file alloc_func.hpp.

◆ ReallocError()

void ReallocError ( size_t size )

Function to exit with an error message after realloc() have failed.

Parameters

size	number of bytes we tried to allocate

Definition at line 29 of file alloc_func.cpp.

◆ ReallocT()

template<typename T >

T* ReallocT	(	T *	t_ptr,
		size_t	num_elements
	)

inline

Simplified reallocation function that allocates the specified number of elements of the given type.

It also explicitly casts it to the requested type. It extends/shrinks the memory allocation given in t_ptr.

Note: throws an error when there is no memory anymore.; the pointer to the data may change, but the data will remain valid.

Template Parameters

T	the type of the variable(s) to allocation.

Parameters

t_ptr	the previous allocation to extend/shrink.
num_elements	the number of elements to allocate of the given type.

Returns: nullptr when num_elements == 0, non-nullptr otherwise.

Definition at line 111 of file alloc_func.hpp.