fdebug.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : SDK Base
// Version     : 1.0
//
// Category    : Helpers
// Filename    : base/source/fdebug.h
// Created by  : Steinberg, 1995
// Description : There are 2 levels of debugging messages:
//                   DEVELOPMENT               During development
//                   RELEASE                   Program is shipping.
//
//-----------------------------------------------------------------------------
// LICENSE
// (c) 2021, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
// 
//   * Redistributions of source code must retain the above copyright notice, 
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation 
//     and/or other materials provided with the distribution.
//   * Neither the name of the Steinberg Media Technologies nor the names of its
//     contributors may be used to endorse or promote products derived from this 
//     software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#pragma once
 
#include "pluginterfaces/base/ftypes.h"
#include <cstring>
 
#if SMTG_OS_MACOS
#include <new>
#endif

bool AmIBeingDebugged ();
 
//-----------------------------------------------------------------------------
// development / release
//-----------------------------------------------------------------------------
#if !defined (DEVELOPMENT) && !defined (RELEASE) 
        #ifdef _DEBUG
                #define DEVELOPMENT 1
        #elif defined (NDEBUG)
                #define RELEASE 1
        #else
                #error DEVELOPMENT, RELEASE, _DEBUG, or NDEBUG  must be defined!
        #endif
#endif
 
//-----------------------------------------------------------------------------
#if SMTG_OS_WINDOWS

#if DEVELOPMENT && defined(_MSC_VER)
#pragma warning(disable : 4291)
#pragma warning(disable : 4985)
#endif
 
#endif // SMTG_OS_WINDOWS
 
#if DEVELOPMENT
//-----------------------------------------------------------------------------
#define SMTG_ASSERT(f) \
        if (!(f))          \
                FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f);

#define SMTG_WARNING(comment) FDebugPrint ("%s(%d) : %s\n", __FILE__, __LINE__, comment);

#define SMTG_PRINTSYSERROR FPrintLastError (__FILE__, __LINE__);

#define SMTG_DEBUGSTR(s) FDebugBreak (s);

#define SMTG_VERIFY(f) SMTG_ASSERT (f)

#define SMTG_VERIFY_IS(f, r) \
        if ((f) != (r))          \
                FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f);

#define SMTG_VERIFY_NOT(f, r) \
        if ((f) == (r))           \
                FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f);


#define SMTG_DBPRT0(a) FDebugPrint (a);
#define SMTG_DBPRT1(a, b) FDebugPrint (a, b);
#define SMTG_DBPRT2(a, b, c) FDebugPrint (a, b, c);
#define SMTG_DBPRT3(a, b, c, d) FDebugPrint (a, b, c, d);
#define SMTG_DBPRT4(a, b, c, d, e) FDebugPrint (a, b, c, d, e);
#define SMTG_DBPRT5(a, b, c, d, e, f) FDebugPrint (a, b, c, d, e, f);

void FDebugPrint (const char* format, ...);
void FDebugBreak (const char* format, ...);
void FPrintLastError (const char* file, int line);

using AssertionHandler = bool (*) (const char* message);
extern AssertionHandler gAssertionHandler;
extern AssertionHandler gPreAssertionHook;
using DebugPrintLogger = void (*) (const char* message);
extern DebugPrintLogger gDebugPrintLogger;

#if SMTG_OS_MACOS
void* operator new (size_t, int, const char*, int);
void* operator new[] (size_t, int, const char*, int);
void operator delete (void* p, int, const char* file, int line);
void operator delete[] (void* p, int, const char* file, int line);
#ifndef NEW
#define NEW new (1, __FILE__, __LINE__)
#define NEWVEC new (1, __FILE__, __LINE__)
#endif
 
#define DEBUG_NEW DEBUG_NEW_LEAKS
 
#elif SMTG_OS_WINDOWS && defined(_MSC_VER)
#ifndef NEW
void* operator new (size_t, int, const char*, int);
#define NEW new (1, __FILE__, __LINE__)
#define NEWVEC new (1, __FILE__, __LINE__)
#endif
 
#else
#ifndef NEW
#define NEW new
#define NEWVEC new
#endif
#endif
 
#else
#define SMTG_ASSERT(f)
#define SMTG_WARNING(s)
#define SMTG_PRINTSYSERROR
#define SMTG_DEBUGSTR(s)
#define SMTG_VERIFY(f) f;
#define SMTG_VERIFY_IS(f, r) f;
#define SMTG_VERIFY_NOT(f, r) f;
 
#define SMTG_DBPRT0(a)
#define SMTG_DBPRT1(a, b)
#define SMTG_DBPRT2(a, b, c)
#define SMTG_DBPRT3(a, b, c, d)
#define SMTG_DBPRT4(a, b, c, d, e)
#define SMTG_DBPRT5(a, b, c, d, e, f)
 
#ifndef NEW
#define NEW new
#define NEWVEC new
 
#endif
#endif
 
// replace #if SMTG_CPPUNIT_TESTING
bool isSmtgUnitTesting ();
void setSmtgUnitTesting ();
 
#if !SMTG_RENAME_ASSERT
#if SMTG_OS_WINDOWS
#undef ASSERT
#endif
 
#define ASSERT                          SMTG_ASSERT
#define WARNING                         SMTG_WARNING
#define DEBUGSTR                        SMTG_DEBUGSTR
#define VERIFY                          SMTG_VERIFY
#define VERIFY_IS                       SMTG_VERIFY_IS
#define VERIFY_NOT                      SMTG_VERIFY_NOT
#define PRINTSYSERROR           SMTG_PRINTSYSERROR
 
#define DBPRT0                          SMTG_DBPRT0
#define DBPRT1                          SMTG_DBPRT1
#define DBPRT2                          SMTG_DBPRT2
#define DBPRT3                          SMTG_DBPRT3
#define DBPRT4                          SMTG_DBPRT4
#define DBPRT5                          SMTG_DBPRT5
#endif