gimbal_ext.h

Go to the documentation of this file.

 
#ifndef GIMBAL_EXT_H
#define GIMBAL_EXT_H
 
#include "../core/gimbal_typedefs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define GBL_META_LOG_LEVEL_TABLE (                                              \
        ( GBL_LOG_LEVEL, LogLevel, "Log Message Severity Level", gblLogLevelString),               \
        (                                                                       \
            (GBL_LOG_LEVEL_DEBUG,       0x1,    Debug,      "Debug"),           \
            (GBL_LOG_LEVEL_VERBOSE,     0x2,    Verbose,    "Verbose"),         \
            (GBL_LOG_LEVEL_INFO,        0x4,    Info,       "Info"),            \
            (GBL_LOG_LEVEL_WARNING,     0x8,    Warning,    "Warning"),         \
            (GBL_LOG_LEVEL_ERROR,       0x10,   Error,      "Error"),           \
            (GBL_LOG_LEVEL_COUNT,       0x5,    Count,      "# of Levels")      \
        )                                                                       \
    )
 
GBL_ENUM_TABLE_DECLARE(GBL_META_LOG_LEVEL_TABLE);
 
 
 
GBL_FORWARD_DECLARE_STRUCT(GblStackFrame);
 
typedef GBL_RESULT (*GblExtLogWriteFn)      (const GblStackFrame*, GBL_LOG_LEVEL, const char*, va_list);
typedef GBL_RESULT (*GblExtLogPushFn)       (const GblStackFrame*);
typedef GBL_RESULT (*GblExtLogPopFn)        (const GblStackFrame*, uint32_t);
 
//Custom allocators
typedef GBL_RESULT (*GblExtMemAllocFn)      (const GblStackFrame*, GblSize, GblSize, const char*, void**);
typedef GBL_RESULT (*GblExtMemReallocFn)    (const GblStackFrame*, void*, GblSize, GblSize, void**);
typedef GBL_RESULT (*GblExtMemFreeFn)       (const GblStackFrame*, void*);
 
//define all extension points and shit in one centralized location
 
 
 
/*Call everything through these top-level macros so that user
  is able to override them at compile-time + use inline functions
 
 
 
GBL_EXT_EVENT_HANDLER
    a. user-defined macro (compile-time polymorphic)
    b. gblExtEventHandler
        1. user-defined implementation (link-time polymorphic)
        2. dynamic implementation   (run-time polymorphic)gimbal_types.h"
            a. calls context function pointer
            b. calls event handler
            c. falls back to default */
 
#ifndef GBL_EXT_EVENT_HANDLER
#   define GBL_EXT_EVENT_HANDLER    gblExtEventHandler
#endif
 
/* ==== SERIOUSLY CONSIDER MAKING THIS SHIT TAKE SOURCE CONTEXT INFO
    actually give context a pointer to latest
*/
#ifndef GBL_EXT_MALLOC
#   define GBL_EXT_MALLOC           gblExtMemAlloc
#endif
 
#ifndef GBL_EXT_REALLOC
#   define GBL_EXT_REALLOC          gblExtMemRealloc
#endif
 
#ifndef GBL_EXT_FREE
#   define GBL_EXT_FREE             gblExtMemFree
#endif
 
#ifndef GBL_EXT_LOG_WRITE
#   define GBL_EXT_LOG_WRITE        gblExtLogWrite
#endif
 
#ifndef GBL_EXT_LOG_PUSH
#   define GBL_EXT_LOG_PUSH         gblExtLogPush
#endif
 
#ifndef GBL_EXT_LOG_POP
#   define GBL_EXT_LOG_POP          gblExtLogPop
#endif
 
#ifndef GBL_EXT_RESULT_STRING
#   define GBL_EXT_RESULT_STRING    gblExtResultString
#endif
 
 
GBL_EXPORT GBL_RESULT gblExtLogWrite       (const GblStackFrame* pFrame, GBL_LOG_LEVEL level, const char* pFmt, va_list varArgs);
GBL_EXPORT GBL_RESULT gblExtLogPush        (const GblStackFrame* pFrame);
GBL_EXPORT GBL_RESULT gblExtLogPop         (const GblStackFrame* pFrame, uint32_t count);
 
GBL_EXPORT GBL_RESULT gblExtMemAlloc       (const GblStackFrame* pFrame, GblSize size, GblSize alignment, const char* pDebugInfoString, void** ppData);
GBL_EXPORT GBL_RESULT gblExtMemRealloc     (const GblStackFrame* pFrame, void* pData, GblSize newSize, GblSize newAlign, void** ppNewData);
GBL_EXPORT GBL_RESULT gblExtMemFree        (const GblStackFrame* pFrame, void* pData);
 
GBL_EXPORT GBL_RESULT gblExtCallRecordSet  (const GblStackFrame* pFrame, const GblCallRecord* pRecord) GBL_NOEXCEPT;
 
 
#ifdef __cplusplus
}
#endif
 
#endif // GIMBAL_EXT_H