summaryrefslogtreecommitdiff
path: root/core/fxcrt/fx_memory.h
diff options
context:
space:
mode:
authordsinclair <dsinclair@chromium.org>2016-09-29 13:59:29 -0700
committerCommit bot <commit-bot@chromium.org>2016-09-29 13:59:29 -0700
commita52ab741019342fbca0468e43a01deb44fa5f1bd (patch)
tree9b1deef3b8deb23d65bf56348b220fe59dcd3169 /core/fxcrt/fx_memory.h
parent8a4e286e686c3027f382afb07d3ddcec4610fdd9 (diff)
downloadpdfium-a52ab741019342fbca0468e43a01deb44fa5f1bd.tar.xz
Move core/fxcrt/include to core/fxcrt
BUG=pdfium:611 Review-Url: https://codereview.chromium.org/2382723003
Diffstat (limited to 'core/fxcrt/fx_memory.h')
-rw-r--r--core/fxcrt/fx_memory.h112
1 files changed, 112 insertions, 0 deletions
diff --git a/core/fxcrt/fx_memory.h b/core/fxcrt/fx_memory.h
new file mode 100644
index 0000000000..beb194fbda
--- /dev/null
+++ b/core/fxcrt/fx_memory.h
@@ -0,0 +1,112 @@
+// Copyright 2014 PDFium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
+
+#ifndef CORE_FXCRT_FX_MEMORY_H_
+#define CORE_FXCRT_FX_MEMORY_H_
+
+#include "core/fxcrt/fx_system.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// For external C libraries to malloc through PDFium. These may return nullptr.
+void* FXMEM_DefaultAlloc(size_t byte_size, int flags);
+void* FXMEM_DefaultRealloc(void* pointer, size_t new_size, int flags);
+void FXMEM_DefaultFree(void* pointer, int flags);
+
+#ifdef __cplusplus
+} // extern "C"
+
+#include <stdlib.h>
+#include <limits>
+#include <memory>
+#include <new>
+
+NEVER_INLINE void FX_OutOfMemoryTerminate();
+
+inline void* FX_SafeRealloc(void* ptr, size_t num_members, size_t member_size) {
+ if (num_members < std::numeric_limits<size_t>::max() / member_size) {
+ return realloc(ptr, num_members * member_size);
+ }
+ return nullptr;
+}
+
+inline void* FX_AllocOrDie(size_t num_members, size_t member_size) {
+ // TODO(tsepez): See if we can avoid the implicit memset(0).
+ if (void* result = calloc(num_members, member_size)) {
+ return result;
+ }
+ FX_OutOfMemoryTerminate(); // Never returns.
+ return nullptr; // Suppress compiler warning.
+}
+
+inline void* FX_AllocOrDie2D(size_t w, size_t h, size_t member_size) {
+ if (w < std::numeric_limits<size_t>::max() / h) {
+ return FX_AllocOrDie(w * h, member_size);
+ }
+ FX_OutOfMemoryTerminate(); // Never returns.
+ return nullptr; // Suppress compiler warning.
+}
+
+inline void* FX_ReallocOrDie(void* ptr,
+ size_t num_members,
+ size_t member_size) {
+ if (void* result = FX_SafeRealloc(ptr, num_members, member_size)) {
+ return result;
+ }
+ FX_OutOfMemoryTerminate(); // Never returns.
+ return nullptr; // Suppress compiler warning.
+}
+
+// Never returns nullptr.
+#define FX_Alloc(type, size) (type*)FX_AllocOrDie(size, sizeof(type))
+#define FX_Alloc2D(type, w, h) (type*)FX_AllocOrDie2D(w, h, sizeof(type))
+#define FX_Realloc(type, ptr, size) \
+ (type*)FX_ReallocOrDie(ptr, size, sizeof(type))
+
+// May return nullptr.
+#define FX_TryAlloc(type, size) (type*)calloc(size, sizeof(type))
+#define FX_TryRealloc(type, ptr, size) \
+ (type*)FX_SafeRealloc(ptr, size, sizeof(type))
+
+#define FX_Free(ptr) free(ptr)
+
+// The FX_ArraySize(arr) macro returns the # of elements in an array arr.
+// The expression is a compile-time constant, and therefore can be
+// used in defining new arrays, for example. If you use FX_ArraySize on
+// a pointer by mistake, you will get a compile-time error.
+//
+// One caveat is that FX_ArraySize() doesn't accept any array of an
+// anonymous type or a type defined inside a function.
+#define FX_ArraySize(array) (sizeof(ArraySizeHelper(array)))
+
+// This template function declaration is used in defining FX_ArraySize.
+// Note that the function doesn't need an implementation, as we only
+// use its type.
+template <typename T, size_t N>
+char (&ArraySizeHelper(T (&array)[N]))[N];
+
+// Used with std::unique_ptr to FX_Free raw memory.
+struct FxFreeDeleter {
+ inline void operator()(void* ptr) const { FX_Free(ptr); }
+};
+
+// Used with std::unique_ptr to Release() objects that can't be deleted.
+template <class T>
+struct ReleaseDeleter {
+ inline void operator()(T* ptr) const { ptr->Release(); }
+};
+
+// Used to help transfer ownership of a raw pointer to std::unique_ptr.
+template <typename T>
+std::unique_ptr<T> WrapUnique(T* ptr) {
+ return std::unique_ptr<T>(ptr);
+}
+
+#endif // __cplusplus
+
+#endif // CORE_FXCRT_FX_MEMORY_H_