(svn r11691) -Codechange: move+rename helpers.hpp and only include it when it is really needed.

1 files changed, 84 insertions, 0 deletions

diff --git a/src/core/alloc_func.hpp b/src/core/alloc_func.hpp
new file mode 100644
index 000000000..5d88e64e8
--- /dev/null
+++ b/src/core/alloc_func.hpp
@@ -0,0 +1,84 @@
+/* $Id$ */
+
+/** @file alloc_func.hpp Functions related to the allocation of memory */
+
+#ifndef ALLOC_FUNC_HPP
+#define ALLOC_FUNC_HPP
+
+/**
+ * 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.
+ * @note the memory contains garbage data (i.e. possibly non-zero values).
+ * @param T the type of the variable(s) to allocation.
+ * @param num_elements the number of elements to allocate of the given type.
+ * @return NULL when num_elements == 0, non-NULL otherwise.
+ */
+template <typename T> FORCEINLINE T* MallocT(size_t num_elements)
+{
+	/*
+	 * MorphOS cannot handle 0 elements allocations, or rather that always
+	 * returns NULL. So we do that for *all* allocations, thus causing it
+	 * to behave the same on all OSes.
+	 */
+	if (num_elements == 0) return NULL;
+
+	T *t_ptr = (T*)malloc(num_elements * sizeof(T));
+	if (t_ptr == NULL) error("Out of memory. Cannot allocate %i bytes", num_elements * sizeof(T));
+	return t_ptr;
+}
+
+/**
+ * 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.
+ * @note the memory contains all zero values.
+ * @param T the type of the variable(s) to allocation.
+ * @param num_elements the number of elements to allocate of the given type.
+ * @return NULL when num_elements == 0, non-NULL otherwise.
+ */
+template <typename T> FORCEINLINE T* CallocT(size_t num_elements)
+{
+	/*
+	 * MorphOS cannot handle 0 elements allocations, or rather that always
+	 * returns NULL. So we do that for *all* allocations, thus causing it
+	 * to behave the same on all OSes.
+	 */
+	if (num_elements == 0) return NULL;
+
+	T *t_ptr = (T*)calloc(num_elements, sizeof(T));
+	if (t_ptr == NULL) error("Out of memory. Cannot allocate %i bytes", num_elements * sizeof(T));
+	return t_ptr;
+}
+
+/**
+ * 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.
+ * @note the memory contains all zero values.
+ * @param T the type of the variable(s) to allocation.
+ * @param t_ptr the previous allocation to extend/shrink.
+ * @param num_elements the number of elements to allocate of the given type.
+ * @return NULL when num_elements == 0, non-NULL otherwise.
+ */
+template <typename T> FORCEINLINE T* ReallocT(T *t_ptr, size_t num_elements)
+{
+	/*
+	 * MorphOS cannot handle 0 elements allocations, or rather that always
+	 * returns NULL. So we do that for *all* allocations, thus causing it
+	 * to behave the same on all OSes.
+	 */
+	if (num_elements == 0) {
+		free(t_ptr);
+		return NULL;
+	}
+
+	t_ptr = (T*)realloc(t_ptr, num_elements * sizeof(T));
+	if (t_ptr == NULL) error("Out of memory. Cannot reallocate %i bytes", num_elements * sizeof(T));
+	return t_ptr;
+}
+
+#endif /* ALLOC_FUNC_HPP */