OrxDebug

Defines
#define	orxASSERT(TEST,...)
#define	orxBREAK()
#define	orxDEBUG_EXIT()   _orxDebug_Exit()
#define	orxDEBUG_FLAG_BACKUP()
#define	orxDEBUG_FLAG_RESTORE()
#define	orxDEBUG_FLAG_SET(SET, UNSET)
#define	orxDEBUG_INIT()   _orxDebug_Init()
#define	orxDEBUG_KS32_BUFFER_MAX_NUMBER   32
#define	orxDEBUG_KS32_BUFFER_OUTPUT_SIZE   1024
#define	orxDEBUG_KU32_STATIC_FLAG_CONSOLE   0x00000020
#define	orxDEBUG_KU32_STATIC_FLAG_FILE   0x00000010
#define	orxDEBUG_KU32_STATIC_FLAG_GRAPHIC   0x00000040
#define	orxDEBUG_KU32_STATIC_FLAG_NONE   0x00000000
#define	orxDEBUG_KU32_STATIC_FLAG_TAGGED   0x00000004
#define	orxDEBUG_KU32_STATIC_FLAG_TIMESTAMP   0x00000001
#define	orxDEBUG_KU32_STATIC_FLAG_TYPE   0x00000002
#define	orxDEBUG_KU32_STATIC_MASK_DEFAULT   0x00000037
#define	orxDEBUG_KU32_STATIC_MASK_USER_ALL   0x0FFFFFFF
#define	orxDEBUG_KZ_DATE_FORMAT   "[%Y-%m-%d %H:%M:%S]"
#define	orxDEBUG_KZ_DEFAULT_DEBUG_FILE   "orx-debug.log"
#define	orxDEBUG_KZ_DEFAULT_DEBUG_SUFFIX   "-debug.log"
#define	orxDEBUG_KZ_DEFAULT_LOG_FILE   "orx.log"
#define	orxDEBUG_KZ_DEFAULT_LOG_SUFFIX   ".log"
#define	orxDEBUG_PRINT(LEVEL, STRING,...)
#define	orxDEBUG_SETBASEFILENAME(FILE)
#define	orxDEBUG_SETDEBUGFILE(FILE)
#define	orxDEBUG_SETLOGFILE(FILE)   _orxDebug_SetLogFile(FILE)
Enumerations
enum	orxDEBUG_LEVEL {   orxDEBUG_LEVEL_ANIM = 0, orxDEBUG_LEVEL_CLOCK, orxDEBUG_LEVEL_DISPLAY, orxDEBUG_LEVEL_FILE,   orxDEBUG_LEVEL_INPUT, orxDEBUG_LEVEL_JOYSTICK, orxDEBUG_LEVEL_KEYBOARD, orxDEBUG_LEVEL_MEMORY,   orxDEBUG_LEVEL_MOUSE, orxDEBUG_LEVEL_OBJECT, orxDEBUG_LEVEL_PARAM, orxDEBUG_LEVEL_PHYSICS,   orxDEBUG_LEVEL_PLUGIN, orxDEBUG_LEVEL_PROFILER, orxDEBUG_LEVEL_RENDER, orxDEBUG_LEVEL_SCREENSHOT,   orxDEBUG_LEVEL_SOUND, orxDEBUG_LEVEL_SYSTEM, orxDEBUG_LEVEL_TIMER, orxDEBUG_LEVEL_USER,   orxDEBUG_LEVEL_LOG, orxDEBUG_LEVEL_ASSERT, orxDEBUG_LEVEL_CRITICAL_ASSERT, orxDEBUG_LEVEL_NUMBER,   orxDEBUG_LEVEL_MAX_NUMBER = 32, orxDEBUG_LEVEL_ALL = 0xFFFFFFFE, orxDEBUG_LEVEL_NONE = orxENUM_NONE }
Functions
orxDLLAPI void orxFASTCALL	_orxDebug_BackupFlags ()
orxDLLAPI void orxFASTCALL	_orxDebug_Break ()
orxDLLAPI void orxFASTCALL	_orxDebug_Exit ()
orxDLLAPI orxSTATUS orxFASTCALL	_orxDebug_Init ()
orxDLLAPI void orxCDECL	_orxDebug_Log (orxDEBUG_LEVEL _eLevel, const orxSTRING _zFunction, const orxSTRING _zFile, orxU32 _u32Line, const orxSTRING _zFormat,...)
orxDLLAPI void orxFASTCALL	_orxDebug_RestoreFlags ()
orxDLLAPI void orxFASTCALL	_orxDebug_SetDebugFile (const orxSTRING _zFileName)
orxDLLAPI void orxFASTCALL	_orxDebug_SetFlags (orxU32 _u32Add, orxU32 _u32Remove)
orxDLLAPI void orxFASTCALL	_orxDebug_SetLogFile (const orxSTRING _zFileName)

---

Detailed Description

Debug module Module used to output debug info and assert code

---

Define Documentation

#define orxASSERT	(		TEST,
			...
	)

Definition at line 222 of file orxDebug.h.

#define orxBREAK

(

)

Definition at line 209 of file orxDebug.h.

#define orxDEBUG_EXIT

(

)

_orxDebug_Exit()

Definition at line 149 of file orxDebug.h.

#define orxDEBUG_FLAG_BACKUP

(

)

Definition at line 225 of file orxDebug.h.

#define orxDEBUG_FLAG_RESTORE

(

)

Definition at line 226 of file orxDebug.h.

#define orxDEBUG_FLAG_SET	(		SET,
			UNSET
	)

Definition at line 224 of file orxDebug.h.

#define orxDEBUG_INIT

(

)

_orxDebug_Init()

Definition at line 148 of file orxDebug.h.

#define orxDEBUG_KS32_BUFFER_MAX_NUMBER   32

Definition at line 236 of file orxDebug.h.

#define orxDEBUG_KS32_BUFFER_OUTPUT_SIZE   1024

Definition at line 237 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_CONSOLE   0x00000020

Definition at line 61 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_FILE   0x00000010

Definition at line 60 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_GRAPHIC   0x00000040

Definition at line 62 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_NONE   0x00000000

Definition at line 54 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_TAGGED   0x00000004

Definition at line 58 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_TIMESTAMP   0x00000001

Definition at line 56 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_FLAG_TYPE   0x00000002

Definition at line 57 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_MASK_DEFAULT   0x00000037

Definition at line 64 of file orxDebug.h.

#define orxDEBUG_KU32_STATIC_MASK_USER_ALL   0x0FFFFFFF

Definition at line 66 of file orxDebug.h.

#define orxDEBUG_KZ_DATE_FORMAT   "[%Y-%m-%d %H:%M:%S]"

Definition at line 239 of file orxDebug.h.

#define orxDEBUG_KZ_DEFAULT_DEBUG_FILE   "orx-debug.log"

Definition at line 71 of file orxDebug.h.

#define orxDEBUG_KZ_DEFAULT_DEBUG_SUFFIX   "-debug.log"

Definition at line 74 of file orxDebug.h.

#define orxDEBUG_KZ_DEFAULT_LOG_FILE   "orx.log"

Definition at line 72 of file orxDebug.h.

#define orxDEBUG_KZ_DEFAULT_LOG_SUFFIX   ".log"

Definition at line 73 of file orxDebug.h.

#define orxDEBUG_PRINT	(		LEVEL,
			STRING,
			...
	)

Definition at line 207 of file orxDebug.h.

#define orxDEBUG_SETBASEFILENAME

(

FILE )

Value:

do                                                        \
    {                                                         \
      orxCHAR   zBuffer[256];                                 \
      strncpy(zBuffer, FILE, 256);                            \
      strncat(zBuffer, orxDEBUG_KZ_DEFAULT_LOG_SUFFIX, 256);  \
      _orxDebug_SetLogFile(zBuffer);                          \
    } while(orxFALSE)

Definition at line 213 of file orxDebug.h.

#define orxDEBUG_SETDEBUGFILE

(

FILE )

Definition at line 211 of file orxDebug.h.

#define orxDEBUG_SETLOGFILE

(

FILE )

_orxDebug_SetLogFile(FILE)

Definition at line 212 of file orxDebug.h.

---

Enumeration Type Documentation

enum orxDEBUG_LEVEL

Enumerator:

orxDEBUG_LEVEL_ANIM	Anim Debug
orxDEBUG_LEVEL_CLOCK	Clock Debug
orxDEBUG_LEVEL_DISPLAY	Display Debug
orxDEBUG_LEVEL_FILE	File Debug
orxDEBUG_LEVEL_INPUT	Input Debug
orxDEBUG_LEVEL_JOYSTICK	Joystick Debug
orxDEBUG_LEVEL_KEYBOARD	Keyboard Debug
orxDEBUG_LEVEL_MEMORY	Memory Debug
orxDEBUG_LEVEL_MOUSE	Mouse Debug
orxDEBUG_LEVEL_OBJECT	Object Debug
orxDEBUG_LEVEL_PARAM	Param Debug
orxDEBUG_LEVEL_PHYSICS	Physics Debug
orxDEBUG_LEVEL_PLUGIN	Plug-in Debug
orxDEBUG_LEVEL_PROFILER	Profiler Debug
orxDEBUG_LEVEL_RENDER	Render Debug
orxDEBUG_LEVEL_SCREENSHOT	Screenshot Debug
orxDEBUG_LEVEL_SOUND	Sound Debug
orxDEBUG_LEVEL_SYSTEM	System Debug
orxDEBUG_LEVEL_TIMER	Timer Debug
orxDEBUG_LEVEL_USER	User Debug
orxDEBUG_LEVEL_LOG	Log Debug
orxDEBUG_LEVEL_ASSERT	Assert Debug
orxDEBUG_LEVEL_CRITICAL_ASSERT	Critical Assert Debug
orxDEBUG_LEVEL_NUMBER
orxDEBUG_LEVEL_MAX_NUMBER
orxDEBUG_LEVEL_ALL	All Debugs
orxDEBUG_LEVEL_NONE

Definition at line 245 of file orxDebug.h.

---

Function Documentation

orxDLLAPI void orxFASTCALL _orxDebug_BackupFlags

(

)

Backups current debug flags

orxDLLAPI void orxFASTCALL _orxDebug_Break

(

)

Software break function

orxDLLAPI void orxFASTCALL _orxDebug_Exit

(

)

Exits from the debug module

orxDLLAPI orxSTATUS orxFASTCALL _orxDebug_Init

(

)

Inits the debug module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxCDECL _orxDebug_Log	(	orxDEBUG_LEVEL	_eLevel,
		const orxSTRING	_zFunction,
		const orxSTRING	_zFile,
		orxU32	_u32Line,
		const orxSTRING	_zFormat,
			...
	)

Logs given debug text

Parameters:

[in]	_eLevel	Debug level associated with this output
[in]	_zFunction	Calling function name
[in]	_zFile	Calling file name
[in]	_u32Line	Calling file line
[in]	_zFormat	Printf formatted text

orxDLLAPI void orxFASTCALL _orxDebug_RestoreFlags

(

)

Restores last backuped flags

orxDLLAPI void orxFASTCALL _orxDebug_SetDebugFile

(

const orxSTRING

_zFileName )

Sets debug file name

Parameters:

[in]

_zFileName

Debug file name

orxDLLAPI void orxFASTCALL _orxDebug_SetFlags	(	orxU32	_u32Add,
		orxU32	_u32Remove
	)

Sets current debug flags

Parameters:

[in]	_u32Add	Flags to add
[in]	_u32Remove	Flags to remove

orxDLLAPI void orxFASTCALL _orxDebug_SetLogFile

(

const orxSTRING

_zFileName )

Sets log file name

Parameters:

[in]

_zFileName

Log file name