/** SGX

The   sss    gggg x   x   
     s      g      x x    Engine
      sss   g  gg   x
         s  g   g  x x          Copyright 1995-2009.
     ssss    gggg x   x         Steven Goodwin. All Rights Reserved.
    
This version has been released under the GNU Public License v2.0.

Please see the license files for details.

File: sgx/include/sgx/core/helpers/trace.hpp

*/

#ifndef SGX_CORE_HELPERS_TRACE_HPP
#define SGX_CORE_HELPERS_TRACE_HPP	1

#include "sgx/core/stl/stl.hpp"

#define SGX_ERR_REPORT_NONE  6
#define SGX_ERR_REPORT_ALL   0

#define SGX_ERR_FATAL       5
#define SGX_ERR_ERROR       4
#define SGX_ERR_WARNING     3
#define SGX_ERR_MESSAGE     2
#define SGX_ERR_INFO        1

#define SID_FATAL(Msg)      SGX_ERR_FATAL,__FILE__,__LINE__,Msg
#define SID_ERROR(Msg)      SGX_ERR_ERROR,__FILE__,__LINE__,Msg
#define SID_WARNING(Msg)    SGX_ERR_WARNING,__FILE__,__LINE__,Msg
#define SID_MESSAGE(Msg)    SGX_ERR_MESSAGE,__FILE__,__LINE__,Msg
#define SID_INFO(Msg)       SGX_ERR_INFO,__FILE__,__LINE__,Msg

#define SID(Msg)            SID_WARNING(Msg)

//
// Low-level, platform-specific, output
// There must be an implementation of this, present. Even if
// it's only the null driver version.
//
typedef void (*cbfnOutputTrace)(const char *pMessage);
void sgxOutputTraceMessage(const char *pMessage);
void sgxRegisterOutputTrace(const cbfnOutputTrace pfn);

//
// Cross-platform generic output producers
//
void sgxHaltprocessor();

//
// Windows specific helpers
//
void sgxInt3Break();

//
#ifdef SGX_DEBUG
  #define sgxError                      CGlobalTrace::get()->outputError
  #define sgxTrace                      CGlobalTrace::get()->outputTrace
  #define sgxTraceLimit(limit, trace)   do { static tUINT32 n=limit; if (n && n--){ trace }} while(0)
  #define sgxHalt()                     sgxHaltprocessor()

  #if SGX_PLATFORM_WINTEL32
	#define sgxBreak()	                sgxInt3Break()
  #else
    #define sgxBreak()	                sgxHalt() 
  #endif

  #define sgxAssert(expr)               (((expr) || (sgxTrace(SGX_ERR_ERROR,__FILE__,__LINE__,#expr)) && (sgxHalt(), 0)))
  #define sgxAssertRts(expr, rval)      do { if (!(expr)) { sgxTrace(SGX_ERR_ERROR,__FILE__,__LINE__,#expr); sgxBreak(); return rval; } }while(0)
  #define sgxCompileAssert(expr)        typedef char COMPILE_ASSERT[(expr)?1:-1]


  #define sgxBreakAfter(count)          do { static tUINT32 curr=0; if (++curr > count) sgxBreak(); }while(0)

  #define SGX_SCOPE(fn)                 CScopeTrace scope(fn, __FILE__, __LINE__)
#else
  #define sgxError                      sizeof
  #define sgxTrace                      sizeof
  #define sgxTraceLimit(limit, trace)     
  #define sgxAssert(expr)               sizeof(expr)
  #define sgxAssertRts(expr, rval)      do { if (!(expr)) { return rval; } }while(0)
  #define sgxCompileAssert(expr)
  #define sgxBreak()
  #define sgxBreakAfter(count)
  #define sgxHalt()
  #define SGX_SCOPE(fn)
#endif

//
// Basic handling code
//
class CTraceModule
{
public:
    CTraceModule(tINT32 iDefaultLevel = SGX_ERR_REPORT_ALL);
    void    setTraceLevel(tINT32 iLevel);
    tINT32  getTraceLevel(void);

    tBOOL   outputTrace(const char *pMessage, ...);
    tBOOL   outputTrace(tINT32 idx, const char *pFile, tMEM_SIZE iLine, const char *pMessage, ...);

    tBOOL   outputError(const char *pMessage, ...);
    tBOOL   outputError(const char *pFile, tMEM_SIZE iLine, const char *pMessage, ...);

private:
    tINT32  m_iTraceLevel;
};

class CGlobalTrace : public CTraceModule
{
public:
    static CGlobalTrace   *get();

protected:
    static CGlobalTrace   *ms_pSingleton;
};

class CScopeTrace
{
public:
    CScopeTrace(const char *pFunction) 
    { 
        sgxTrace("FN: Enter %s", pFunction);
        m_FunctionName = sgxString(pFunction);
    }

    CScopeTrace(const char *pFunction, const char *pFilename, tMEM_SIZE iLine) 
    { 
        sgxTrace("FN: Enter %s %s(%d)", pFunction, pFilename, iLine);
        m_FunctionName = sgxString(pFunction);
    }

    ~CScopeTrace()
    {
        sgxTrace("FN: Exit %s", m_FunctionName.c_str());
    }

private:
    sgxString m_FunctionName;
};



#endif /* SGX_CORE_HELPERS_TRACE_HPP */
