MDebug Class Reference

The DEBUG class for the maia. More...

#include <debug.h>

Collaboration diagram for MDebug:

Static Public Member Functions
static void	maiaerror (MString message, MDebugLevel debugLevel)
static void	maiaprint (const MString &message, MDebugLevel debugLevel)
static void	setLevel (MInt debugLevel)
static void	setLevelNotEnabled (const MInt debugLevel)
static void	displayOn ()
static void	displayOff ()

Static Public Attributes
static MString	debugMessage
static const MInt	m_minLevel = MAIA_DEBUG_ASSERTION
static const MInt	m_maxLevel = MAIA_DEBUG_USER5

Static Private Attributes
static MInt	m_debugLevel
static MBool	m_debugOn
static std::basic_string< char >	m_traceSpaces

Detailed Description

This class handles the DEBUG messaging for the maia.

For debugging you mainly use two macros : SET_DEBUG_LEVEL(debuglevel) and DEBUG( message, debuglevel) The SET_DEBUG_LEVEL macro accepts arbitrary or combinations of debug levels, so that you can display only the messages you want to observe. The message that is given to the DEBUG macro is only displayed, if the connected debug level was given to the SET_DEBUG_LEVEL function (as a single value or a combination). If you temporarily want to suppress the DEBUG output you can use the macros DEBUG_DISPLAY_ON and DEBUG_DISPLAY_OFF, which do what their names imply.

The common debug policy in the maia development is that you use MAIA_DEBUG_TRACE only for marking the entry and return point of a function. As long as your code is still experimental use the MAIA_DEBUG_USER levels (choose the numbers at will). If you handover your code, i.e. if it is added to the project all MAIA_DEBUG_USER levels must be removed. All DEBUG output that might be usefull later (i.e. also for other programmers) must be set to MAIA_DEBUG_LEVEL levels.

So (ideally speaking) you should never get code with MAIA_DEBUG_USER levels set and you also should never hand over code which still includes MAIA_DEBUG_USER levels.

------------------------—EXAMPLE :-----------------------------—

SET_DEBUG_LEVEL(MAIA_DEBUG_USER1|MAIA_DEBUG_USER3);

DEBUG ( "Hello", MAIA_DEBUG_USER2 ); // this prints "Hello" if the DEBUG level is set to MAIA_DEBUG_USER2

DEBUG ( "Solver::Solver" << " entry, solverId: " << m_solverId , MAIA_DEBUG_USER2 ); // hint: DEBUG works exactly like cout

--------------------— END OF EXAMPLE :-------------------------—

!!!!!!!!!! Important note !!!!!!!!!!!! SINCE DEBUG IS A MACRO, NEVER BREAK THE LINE IN WHICH YOU USE IT, I.E. DEBUG WON'T WORK WITH ARGUMENTS OF MULTIPLE LINES !

Definition at line 180 of file debug.h.

Member Function Documentation

displayOff()

void MDebug::displayOff ( )

inlinestatic

Definition at line 202 of file debug.h.

{ m_debugOn = false; }

displayOn()

void MDebug::displayOn ( )

inlinestatic

Definition at line 200 of file debug.h.

{ m_debugOn = true; }

maiaerror()

static void MDebug::maiaerror ( MString  message, MDebugLevel  debugLevel  )

static

maiaprint()

void MDebug::maiaprint ( const MString &  message, MDebugLevel  debugLevel  )

inlinestatic

Definition at line 216 of file debug.h.

                                                                            {
  // This function seperates the debug levels and
  // displays the messages which have the right debug level.
  if(m_debugOn) {
    auto a = (MUint)m_maxLevel;
    auto b = (MUint)m_debugLevel;
    ldiv_t adiv;
    do {
      adiv = ldiv(b, a);
      if(adiv.quot == 1 && a == (MUint)debugLevel) {
        if(debugLevel == MAIA_DEBUG_TRACE_OUT) {
          m_traceSpaces.erase(0, 2);
        }
        m_log << m_traceSpaces << "MDebug: "
              << "[" << globalDomainId() << "]:" << message << std::endl;
        if(debugLevel == MAIA_DEBUG_TRACE_IN) {
          m_traceSpaces += "  ";
        }
      }
      if(b >= a) {
        b -= a;
      }
      a = a / 2;
    } while(adiv.rem != 0); // repeat as long as there
    // is a rest and a level
  }
}

setLevel()

void MDebug::setLevel ( MInt  debugLevel )

inlinestatic

Definition at line 204 of file debug.h.

                                            {
  displayOn();
  m_debugLevel = debugLevel;
}

setLevelNotEnabled()

void MDebug::setLevelNotEnabled ( const MInt  debugLevel )

inlinestatic

Definition at line 209 of file debug.h.

                                                            {
  if(debugLevel != 0) {
    cerr0 << "WARNING: trying to set debug level " << debugLevel << " but MAIA_DEBUG_FUNCTION is not enabled."
          << std::endl;
  }
}

Member Data Documentation

debugMessage

MString MDebug::debugMessage

static

Definition at line 182 of file debug.h.

m_debugLevel

MInt MDebug::m_debugLevel

staticprivate

Definition at line 195 of file debug.h.

m_debugOn

MBool MDebug::m_debugOn

staticprivate

Definition at line 196 of file debug.h.

m_maxLevel

const MInt MDebug::m_maxLevel = MAIA_DEBUG_USER5

static

Definition at line 192 of file debug.h.

m_minLevel

const MInt MDebug::m_minLevel = MAIA_DEBUG_ASSERTION

static

Definition at line 191 of file debug.h.

m_traceSpaces

basic_string< char > MDebug::m_traceSpaces

staticprivate

Definition at line 197 of file debug.h.

---

The documentation for this class was generated from the following files:

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/UTIL/debug.h
• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/UTIL/debug.cpp