9
3

DetourAlloc.h 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. //
  2. // Copyright (c) 2009-2010 Mikko Mononen memon@inside.org
  3. //
  4. // This software is provided 'as-is', without any express or implied
  5. // warranty. In no event will the authors be held liable for any damages
  6. // arising from the use of this software.
  7. // Permission is granted to anyone to use this software for any purpose,
  8. // including commercial applications, and to alter it and redistribute it
  9. // freely, subject to the following restrictions:
  10. // 1. The origin of this software must not be misrepresented; you must not
  11. // claim that you wrote the original software. If you use this software
  12. // in a product, an acknowledgment in the product documentation would be
  13. // appreciated but is not required.
  14. // 2. Altered source versions must be plainly marked as such, and must not be
  15. // misrepresented as being the original software.
  16. // 3. This notice may not be removed or altered from any source distribution.
  17. //
  18. #ifndef DETOURALLOCATOR_H
  19. #define DETOURALLOCATOR_H
  20. #include <stddef.h>
  21. /// Provides hint values to the memory allocator on how long the
  22. /// memory is expected to be used.
  23. enum dtAllocHint
  24. {
  25. DT_ALLOC_PERM, ///< Memory persist after a function call.
  26. DT_ALLOC_TEMP ///< Memory used temporarily within a function.
  27. };
  28. /// A memory allocation function.
  29. // @param[in] size The size, in bytes of memory, to allocate.
  30. // @param[in] rcAllocHint A hint to the allocator on how long the memory is expected to be in use.
  31. // @return A pointer to the beginning of the allocated memory block, or null if the allocation failed.
  32. /// @see dtAllocSetCustom
  33. typedef void* (dtAllocFunc)(size_t size, dtAllocHint hint);
  34. /// A memory deallocation function.
  35. /// @param[in] ptr A pointer to a memory block previously allocated using #dtAllocFunc.
  36. /// @see dtAllocSetCustom
  37. typedef void (dtFreeFunc)(void* ptr);
  38. /// Sets the base custom allocation functions to be used by Detour.
  39. /// @param[in] allocFunc The memory allocation function to be used by #dtAlloc
  40. /// @param[in] freeFunc The memory de-allocation function to be used by #dtFree
  41. void dtAllocSetCustom(dtAllocFunc *allocFunc, dtFreeFunc *freeFunc);
  42. /// Allocates a memory block.
  43. /// @param[in] size The size, in bytes of memory, to allocate.
  44. /// @param[in] hint A hint to the allocator on how long the memory is expected to be in use.
  45. /// @return A pointer to the beginning of the allocated memory block, or null if the allocation failed.
  46. /// @see dtFree
  47. void* dtAlloc(size_t size, dtAllocHint hint);
  48. /// Deallocates a memory block.
  49. /// @param[in] ptr A pointer to a memory block previously allocated using #dtAlloc.
  50. /// @see dtAlloc
  51. void dtFree(void* ptr);
  52. #endif