CUDebug.h

//
//  CUDebug.h
//  Cornell University Game Library (CUGL)
//
//  The SDL_assert functionality is VERY heavy weight.  In addition, it beach
//  balls on OS X.  This module provides debugging functionality that is much
//  more lightweight.  However, you can still access the SDL functionality
//  by setting the alter level to paranoid (assert level 3).
//
//  CUGL zlib License:
//      This software is provided 'as-is', without any express or implied
//      warranty.  In no event will the authors be held liable for any damages
//      arising from the use of this software.
//
//      Permission is granted to anyone to use this software for any purpose,
//      including commercial applications, and to alter it and redistribute it
//      freely, subject to the following restrictions:
//
//      1. The origin of this software must not be misrepresented; you must not
//      claim that you wrote the original software. If you use this software
//      in a product, an acknowledgment in the product documentation would be
//      appreciated but is not required.
//
//      2. Altered source versions must be plainly marked as such, and must not
//      be misrepresented as being the original software.
//
//      3. This notice may not be removed or altered from any source distribution.
//
//  Author: Walker White
//  Version: 5/31/16

#ifndef CU_DEBUG_H
#define CU_DEBUG_H

#include <SDL/SDL.h>
#include "../math/CUMathBase.h"
#include <cassert>

#if defined(__WINDOWS__)
#define CULog(msg,...)          SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_INFO,msg, ##__VA_ARGS__)
#else
#define CULog(msg,args...)      SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_INFO,msg, ##args)
#endif

#if defined(__WINDOWS__)
#define CULogError(msg,...)     SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_ERROR,msg, ##__VA_ARGS__)
#else
#define CULogError(msg,args...)     SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_ERROR,msg, ##args)
#endif

#if defined(__WINDOWS__)
#define CULogCritial(msg,...)       SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_CRITICAL,msg, ##__VA_ARGS__)
#else
#define CULogCritial(msg,args...)   SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_CRITICAL,msg, ##args)
#endif

#if defined(__WINDOWS__)
#define CUWarn(msg,...)     SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_WARN,msg,##__VA_ARGS__)
#else
#define CUWarn(msg,args...)     SDL_LogMessage(SDL_LOG_CATEGORY_APPLICATION,SDL_LOG_PRIORITY_WARN,msg, ##args)
#endif

/* Internal assert code to combine logging with the assert */
#define __cu_assert__(condition,msg,...)  do {  \
        if (!(condition)) {                     \
            CULogError(msg, ##__VA_ARGS__);     \
            assert(condition);                  \
        }                                       \
    } while (0)


// Let's Doxgen the functions before the variable block.

#if SDL_ASSERT_LEVEL == 0   /* assertions disabled */
#   define CUAssert(condition)                      SDL_disabled_assert(condition)
#   define CUAssertLog(condition,msg,args...)       SDL_disabled_assert(condition)
#   define CUAssertAlways(condition)                SDL_disabled_assert(condition)
#   define CUAssertAlwaysLog(condition,msg,args...) SDL_disabled_assert(condition)
#elif SDL_ASSERT_LEVEL == 1  /* release settings. */
#   define CUAssert(condition)                      SDL_disabled_assert(condition)
#   define CUAssertLog(condition,msg,args...)       SDL_disabled_assert(condition)
#   define CUAssertAlways(condition)                SDL_enabled_assert(condition)
#   define CUAssertAlwaysLog(condition,msg,args...) SDL_enabled_assert(condition)
#elif SDL_ASSERT_LEVEL == 2  /* normal settings. */
#   define CUAssert(condition)                      assert(condition)
#   define CUAssertLog(condition,msg,...)           __cu_assert__(condition,msg, ##__VA_ARGS__)
#   define CUAssertAlways(condition)                assert(condition)
#   define CUAssertAlwaysLog(condition,msg,...)     __cu_assert__(condition,msg, ##__VA_ARGS__)
#elif SDL_ASSERT_LEVEL == 3  /* paranoid settings. */
#   define CUAssert(condition)                      SDL_enabled_assert(condition)
#   define CUAssertLog(condition,msg,args...)       SDL_enabled_assert(condition)
#   define CUAssertAlways(condition)                SDL_enabled_assert(condition)
#   define CUAssertAlwaysLog(condition,msg,args...) SDL_enabled_assert(condition)
#else
#   error Unknown assertion level.
#endif

#define CULogGLError() _check_gl_error(__FILE__,__LINE__)

void _check_gl_error(const char *file, int line);

#endif /* CU_DEBUG_H */