source/glue/inc/glue_debug.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2011 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _GLUE_DEBUG_H
#define _GLUE_DEBUG_H

#include "stb_debug.h"
#include "techtype.h"
#include "glue_assert.h"
#include "mheg5_debug.h"

#ifdef TRACING
   #ifndef F_IDENT
   #define F_IDENT __FUNCTION__
   #endif
   #ifndef T_NL
   #define T_NL "\n"
   #endif
extern void trace_set_time(void);
extern unsigned long trace_time(void);
extern void trace_dump_chars(unsigned char *data, unsigned int len);
extern void trace_dump_uints(U32BIT *data, unsigned int len, unsigned int pitch);
extern void trace_unicode(U16BIT *data, unsigned int len);

extern U32BIT mheg_trace_debug;

   #define TERROR       0
   #define TALWAYS      0x00ffffff
   #define TWARN        (1 << 30)

   #define TSTATE       MHDBG_TSTATE
   #define TTUNE        MHDBG_TTUNE
   #define TMEMORY      MHDBG_TMEMORY
   #define TKEYS        MHDBG_TKEYS

   #define TMHBOOT      MHDBG_TMHBOOT
   #define TSTRM        MHDBG_TSTRM
   #define TFILE        MHDBG_TFILE
   #define TDSMFG       MHDBG_TDSMFG

   #define TMHAPI       MHDBG_TMHAPI
   #define TSERVICE     MHDBG_TSERVICE
   #define TICS         MHDBG_TICS
   #define TQUEUE       MHDBG_TQUEUE

   #define TEVNTS       MHDBG_TEVNTS
   #define TACTIONS     MHDBG_TACTIONS
   #define TTIME        MHDBG_TTIME
   #define TPERFORM     MHDBG_TPERFORM

   #define TGRAPHICS    MHDBG_TGRAPHICS
   #define TFONT        MHDBG_TFONT
   #define TTEXT        MHDBG_TTEXT
   #define TFONTCACHE   MHDBG_TFONTCACHE

#if TRACE_TIMING == 2
extern unsigned long last_trace_time;
   #define TRACETIME()     if (last_trace_time + 100 < trace_time()) { last_trace_time = trace_time(); \
                                                                       STB_SPDebugWrite("TRACE TIME= %d.%02d secs", last_trace_time / 100, last_trace_time % 100); }
   #define TERPRINT(s, ...) STB_SPDebugWrite("ERROR-%s:%d " s, F_IDENT, __LINE__, ##__VA_ARGS__)
   #define TRCPRINT(s, ...) STB_SPDebugWrite("%s:%d " s, F_IDENT, __LINE__, ##__VA_ARGS__)
   #define TRACE_SET_TIME()
#elif TRACE_TIMING == 1
   #define TRACETIME()
   #define TERPRINT(s, ...) STB_SPDebugWrite("ERROR-%s:%d (%ld) " s, F_IDENT, __LINE__, trace_time(), ##__VA_ARGS__)
   #define TRCPRINT(s, ...) STB_SPDebugWrite("%s:%d (%ld) " s, F_IDENT, __LINE__, trace_time(), ##__VA_ARGS__)
   #define TRACE_SET_TIME()   trace_set_time()
#else
   #define TRACETIME()
   #define TERPRINT(s, ...) STB_SPDebugWrite("ERROR-%s:%d " s, F_IDENT, __LINE__, ##__VA_ARGS__)
   #define TRCPRINT(s, ...) STB_SPDebugWrite("%s:%d " s, F_IDENT, __LINE__, ##__VA_ARGS__)
   #define TRACE_SET_TIME()
#endif

   #define TRACE(t, x)   TRACETIME() if ((t) == TERROR) { TERPRINT x; } \
   else if ((t) & mheg_trace_debug) { TRCPRINT x; }

   #define TPRINT(t, x)  if ((t) & mheg_trace_debug) STB_SPDebugNoCnWrite x;
   #define TRACE_BUFF(t, d, l)  if ((t) & mheg_trace_debug) trace_dump_chars(d, l);
   #define TRACE_UINT(t, d, l, p)  if ((t) & mheg_trace_debug) trace_dump_uints(d, l, p);
   #define TRACE_UNIC(t, d, l)  if ((t) & mheg_trace_debug) trace_unicode(d, l);

   #undef ERROR_PRINT
   #undef WARNING_PRINT
   #define ERROR_PRINT(x)     STB_SPDebugNoCnWrite x
   #define WARNING_PRINT(x)   if (mheg_trace_debug) STB_SPDebugNoCnWrite x
   #define TRACER(x)          x
   #define TRACE_MEM()        if (TMEMORY & mheg_trace_debug) MHG_DebugMemStats(__LINE__)

   #define DBGTRACE(t, x, ...)  if ((t) == TERROR || ((t) & mheg_trace_debug)) { \
      STB_SPDebugWrite( "T%05x-%s:%d " x, t, F_IDENT, __LINE__, ##__VA_ARGS__); }

   #define DBG_PRINTF STB_SPDebugNoCnWrite

#else 
   #define TRACE(t, x)
   #define TPRINT(t, x)
   #define TRACE_BUFF(t, d, l)
   #define TRACE_UINT(t, d, l, p)
   #define TRACE_UNIC(t, d, l)
   #define TRACER(x)
   #define TRACE_MEM()
   #define TRACE_SET_TIME()
   #define DBGTRACE(...)
   #define DBG_PRINTF(...)

#endif /*TRACING*/

#if !defined(NDEBUG) && defined(STACK_DEBUGGING)
void STB_OSTaskAddFunc(const char *func);
void STB_OSTaskRemFunc(const char *func);
   #ifndef DBG_ID_FUNC
      #define DECLARE_NAME(x)   const char *func_name = F_IDENT;
   #else
      #define DECLARE_NAME(x)   const char func_name[] = #x;
   #endif
   #define FUNCTION_START(x)    DECLARE_NAME(x) STB_OSTaskAddFunc(func_name);
   #define FUNCTION_FINISH(x)   STB_OSTaskRemFunc(func_name);
#else
   #define FUNCTION_START(name)
   #define FUNCTION_FINISH(name)
#endif

#if defined(NDEBUG) && !defined(OVERRIDE_DEBUG_PRINTS)

/* Disable debug prints for retail build */
    #define DPLEVEL 0

    #define DPL1(x)
    #define DPL2(x)
    #define DPL3(x)
    #define DPL4(x)
    #define DPL5(x)

#else   /* #if defined( NDEBUG ) && ! defined( OVERRIDE_DEBUG_PRINTS ) */

    #ifndef DPLEVEL
/* Default to show warnings and error messages */
        #define DPLEVEL DBG_LEVEL
    #endif

    #if (DPLEVEL >= 5)
        #define DPL5(x)     STB_SPDebugNoCnWrite x
    #else
        #define DPL5(x)
    #endif

    #if (DPLEVEL >= 4)
        #define DPL4(x)     STB_SPDebugNoCnWrite x
    #else
        #define DPL4(x)
    #endif

    #if (DPLEVEL >= 3)
        #define DPL3(x)     STB_SPDebugNoCnWrite x
    #else
        #define DPL3(x)
    #endif

    #if (DPLEVEL >= 2)
        #define DPL2(x)     STB_SPDebugNoCnWrite x
    #else
        #define DPL2(x)
    #endif

    #if (DPLEVEL >= 1)
        #define DPL1(x)     STB_SPDebugNoCnWrite x
    #else
        #define DPL1(x)
    #endif
#endif  /* #if defined( NDEBUG ) && ! defined( OVERRIDE_DEBUG_PRINTS ) #else */

void MHG_DebugMemStats(int line);

#endif /*_GLUE_DEBUG_H*/