debug_macro.h

Go to the documentation of this file.

/*
**  Command & Conquer Generals Zero Hour(tm)
**  Copyright 2025 Electronic Arts Inc.
**
**  This program is free software: you can redistribute it and/or modify
**  it under the terms of the GNU General Public License as published by
**  the Free Software Foundation, either version 3 of the License, or
**  (at your option) any later version.
**
**  This program is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**  GNU General Public License for more details.
**
**  You should have received a copy of the GNU General Public License
**  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// $File: //depot/GeneralsMD/Staging/code/Libraries/Source/debug/debug_macro.h $
// $Author: mhoffe $
// $Revision: #2 $
// $DateTime: 2003/07/09 10:57:23 $
//
// ©2003 Electronic Arts
//
// Debugging macros
#ifdef _MSC_VER
#  pragma once
#endif
#ifndef DEBUG_MACRO_H // Include guard
#define DEBUG_MACRO_H
 
// I'm putting the documentation for the following macros
// here because Doxygen otherwise includes the values of each macro
// in the documentation. I don't want that (it would expose some
// internals) so I'm putting all comments for the following macros
// here...
#ifdef DOXYGEN // defined if Doxygen is running


  #define DASSERT(expr) 

  #define DASSERT_MSG(expr,msg) 

  #define DCTASSERT(expr)

  #define DCHECK(expr) 

  #define DCHECK_MSG(expr,msg) 

  #define DFAIL_IF(cond)

  #define DFAIL_IF_MSG(cond,msg)

  #define DLOG(what) 

  #define DLOG_DESCR(descr)

  #define DLOG_GROUP(group,what) 

  #define DLOG_GROUP_DESCR(group,descr)

  #define DCRASH(msg) 

  #define DCRASH_RELEASE(msg) 

  #define DFAIL() 

  #define D_ISLOG() 

  #define D_ISLOG_GROUP(group) 

 
#elif defined(_DEBUG) || defined(_INTERNAL)
 
  #define DASSERT(expr) \
    ((void)( Debug::SkipNext() || \
             (expr) || \
             Debug::AssertBegin(__FILE__,__LINE__,#expr).AssertDone() ))
 
  #define DASSERT_MSG(expr,msg) \
    ((void)( Debug::SkipNext() || \
             (expr) || \
             ( Debug::AssertBegin(__FILE__,__LINE__,#expr) << ": " << msg ).AssertDone() ))
 
  #define DCHECK(expr) \
    ( (expr) || \
      Debug::SkipNext() || \
      Debug::CheckBegin(__FILE__,__LINE__,#expr).CheckDone() ) 
 
  #define DCHECK_MSG(expr,msg) \
    ( (expr) || \
      Debug::SkipNext() || \
      ( Debug::CheckBegin(__FILE__,__LINE__,#expr) << ": " << msg ).CheckDone() ) 
 
  #define DFAIL_IF(cond) \
    if (!DCHECK(!(cond)))
 
  #define DFAIL_IF_MSG(cond,msg) \
    if (!DCHECK_MSG(!(cond),msg))
 
  #define DLOG(what) \
    ((void)( Debug::SkipNext() || \
             ( Debug::LogBegin(__FILE__) << what ).LogDone() ))
 
  #define DLOG_DESCR(descr) \
    static Debug::LogDescription _LogDescr_FILE(__FILE__,descr);
 
  #define DLOG_GROUP(group,what) \
    ((void)( Debug::SkipNext() || \
             ( Debug::LogBegin(#group) << what ).LogDone() ))
 
  #define DLOG_GROUP_DESCR(group,descr) \
    static Debug::LogDescription(#group,descr) _LogDescr_Grp_##group
 
  #define DCRASH(msg) \
    (Debug::SkipNext() || (Debug::CrashBegin(__FILE__,__LINE__) << msg).CrashDone(false))
 
  #define DCRASH_RELEASE(msg) \
    (Debug::SkipNext(),(Debug::CrashBegin(__FILE__,__LINE__) << msg).CrashDone(true))
 
  #define DFAIL() \
    Debug::AssertBegin(__FILE__,__LINE__,NULL).AssertDone()
 
  #define D_ISLOG() \
    Debug::IsLogEnabled(__FILE__) 
 
  #define D_ISLOG_GROUP(group) \
    Debug::IsLogEnabled(#group)
 
#else
 
  #define DASSERT(expr)           ((void)0)
  #define DASSERT_MSG(expr,msg)   ((void)0)
  #define DCHECK(expr)            (expr)
  #define DCHECK_MSG(expr,msg)    (expr)
  #define DFAIL_IF(cond)          if (cond) 
  #define DFAIL_IF_MSG(cond,msg)  if (cond)
  #define DLOG(what)              ((void)0)
  #define DLOG_DESCR(descr)
  #define DLOG_GROUP(group,what)  ((void)0)
  #define DLOG_GROUP_DESCR(g,d)
  #define DCRASH(msg)             ((void)0)
  #define DCRASH_RELEASE(msg)     (Debug::SkipNext(),(Debug::CrashBegin(NULL,0) << msg).CrashDone(true))
  #define DFAIL()                 ((void)0)
  #define D_ISLOG()               false
  #define D_ISLOG_GROUP(group)    false
 
#endif
 
// put these helper templates in a namespace...
namespace _Debug
{
  template<bool> struct StaticAssertionFailed;
  template<> struct StaticAssertionFailed<true> {};
  template<int x> struct StaticAssertionTest {};
 
  #define DCTASSERT(expr)         typedef ::_Debug::StaticAssertionTest< \
                                    sizeof(::_Debug::StaticAssertionFailed< (bool)(expr) >) \
                                    > DebugStaticAssertTypedef__;
};
 
// These are stolen from the WW3D Debug file. REALLY useful. :-)
#define STRING_IT(a) #a                                                                               
#define TOKEN_IT(a) STRING_IT(,##a)

#define MESSAGE(a) message (__FILE__ "(" TOKEN_IT(__LINE__) ") : " a)
 
#endif // DEBUG_MACRO_H