Tools/Debugging/Debugging.h

Go to the documentation of this file.

/**
* @file Tools/Debugging/Debugging.h
*
* Macros and functions for debugging
* 
* @author Martin Lötzsch
*/ 
#ifndef __Debugging_h_
#define __Debugging_h_

// Please don't include GTAssert.h here. GTAssert.h includes afx.h in the Win32 version,
// which makes it a bit slow and is not needed in the most files where Debugging.h is used.
// M.L.
//#include "Platform/GTAssert.h"

#include "Tools/Debugging/DebugKeyTable.h"
#include "Tools/MessageQueue/OutMessage.h"
#include "Tools/Debugging/DebugRequest.h"
#include "Tools/Debugging/DebugDataTable.h"

/**
* Sets a pointer to an OutMessage and to a DebugKeyTable to be used by the macros.
*
* @param queue A pointer to an OutMessage.
* @param table A pointer to a DebugKeyTable.
*/
void initDebugging(OutMessage* queue, DebugKeyTable* table, DebugRequestTable* debugRequestTable);

/**
* Returns a reference to a process wide OutMessage.
*/
OutMessage& getDebugOut();

/**
* Returns a reference to a process wide debug key table
*/
DebugKeyTable& getDebugKeyTable();

/**
* Returns a reference to a process wide debug request table
*/
DebugRequestTable& getDebugRequestTable();


#ifdef NDEBUG

#define INFO(key,type,format,expression) /**/
#define OUTPUT(type,format,expression) /**/
#define WATCH(key,type,format,expression) /**/
#define DEBUG_RESPONSE(description, expression) /**/
#define DEBUG_RESPONSE_NOT(description, expression) { expression }
#define NOT_POLLABLE_DEBUG_RESPONSE(description, expression) /**/
#define DEBUG_CHECK_CRASH /**/

#else //NDEBUG

/**
* A macro for sending debug messages depending on a debug key.
*
* @param key A key from the DebugKeyTable::debugKeyID enum.
* @param type The type of the message from the MessageID enum in MessageIDs.h
* @param format The message format of the message (bin or text)
* @param expression A streamable expression
*
* Examples:
* <pre>
* INFO(sendImages,idImage,bin,myImage);
* INFO(sendInterestingValue,idInterestingValue,text,"value: " << value);
* INFO(sendWorldState,idWorldState,bin,worldState);
* </pre>
*/
#define INFO(key,type,format,expression) \
  if (getDebugKeyTable().isActive(DebugKeyTable::key)) {\
    getDebugOut().format << expression;\
    getDebugOut().finishMessage(type);\
  }\

/**
* A macro for sending debug messages.
*
* @param type The type of the message from the MessageID enum in MessageIDs.h
* @param format The message format of the message (bin or text)
* @param expression A streamable expression
*
* Examples:
* <pre>
* OUTPUT(idImage, bin, *pMyImage);
* OUTPUT(idText, text, "MyObject::myFunction() invoked");
* OUTPUT(idText, text, "i: " << i << ", j:" << j);
* </pre>
*/
#define OUTPUT(type,format,expression) \
  { getDebugOut().format << expression;\
  getDebugOut().finishMessage(type); }

#define DEBUG_RESPONSE(description, expression) \
{\
  if(getDebugRequestTable().poll && getDebugRequestTable().notYetPolled(description)) \
  { \
    OUTPUT(idDebugResponse, text, description << \
           int(getDebugRequestTable().isActive(description) && !getDebugRequestTable().once(description))); \
  } \
  if(getDebugRequestTable().isActive(description)) \
  { \
    if(getDebugRequestTable().once(description)) \
      getDebugRequestTable().disable(description); \
    expression \
  } \
}

#define NOT_POLLABLE_DEBUG_RESPONSE(description, expression) \
{\
  if(getDebugRequestTable().isActive(description)) \
  { \
    if(getDebugRequestTable().once(description)) \
      getDebugRequestTable().disable(description); \
    expression \
  } \
}

#define DEBUG_RESPONSE_NOT(description, expression) \
{\
  if(getDebugRequestTable().poll && getDebugRequestTable().notYetPolled(description)) \
  { \
    OUTPUT(idDebugResponse, text, description << \
           int(getDebugRequestTable().isActive(description) && !getDebugRequestTable().once(description))); \
  } \
  if(! (getDebugRequestTable().isActive(description))) \
  { \
    if(getDebugRequestTable().once(description)) \
      getDebugRequestTable().disable(description); \
    expression \
  } \
}

#if defined(_WIN32) && !defined(SIMROBOT)

/**
* A macro for sending debug messages that differs between Windows and Aperios.
* The parameters equal to the parameters if the INFO macro.
* Different from INFO, the output is sent automatically on the WIN32 platform
*/
#define WATCH(key,type,format,expression) \
  OUTPUT(type,format,expression);


#else

/**
* A macro for sending debug messages that differs between Windows and Aperios.
* The parameters equal to the parameters if the INFO macro.
* Different from INFO, the output is sent automatically on the WIN32 platform
*/
#define WATCH(key,type,format,expression) \
  INFO(key,type,format,expression);

#endif

#include <iostream>

#define DEBUG_CHECK_CRASH { if (SystemCall::getCurrentSystemTime () - entryTime > 2000) {std::cout << "breakpoint in " << __FILE__ << ":" << __LINE__ << "; \n  was executed more than 2 seconds\n"; while (true); };  };

#endif //NDEBUG

#endif //__Debugging_h_

---