debug.h File Reference

#include "types.h"
#include "library.h"
#include "unicode.h"
#include "error.h"

Include dependency graph for debug.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	OPGP_LOG_FILENAME   _T("/tmp/GlobalPlatform.log")
#define	OPGP_LOG_START(msg)
#define	OPGP_LOG_END(msg, rv)
#define	OPGP_LOG_HEX(msg, buffer, bufferLength)
#define	OPGP_LOG_MSG(...)

Functions
OPGP_API void	OPGP_log_Msg (OPGP_STRING msg,...)
	Logs something to a file or the syslog. More...
OPGP_API void	OPGP_log_End (OPGP_STRING func, OPGP_STRING file, int line, OPGP_ERROR_STATUS status)
	Logs the end of a function and its return code. More...
OPGP_API void	OPGP_log_Start (OPGP_STRING func, OPGP_STRING file, int line)
	Logs the start of a function. More...
OPGP_API void	OPGP_log_Hex (OPGP_STRING msg, PBYTE buffer, DWORD bufferLength)
	Logs a buffer as hex string. More...

Detailed Description

This file contains debug functions.

Function Documentation

OPGP_log_End()

OPGP_API void OPGP_log_End	(	OPGP_STRING	func,
		OPGP_STRING	file,
		int	line,
		OPGP_ERROR_STATUS	status
	)

Logs the end of a function and its return code.

The call is redirected to log_Log().

Parameters

func	[in] The function name ‎
file	[in] The source file.
line	[in] The line number in the source file.
status	[in] The return value of the function

OPGP_log_Hex()

OPGP_API void OPGP_log_Hex	(	OPGP_STRING	msg,
		PBYTE	buffer,
		DWORD	bufferLength
	)

Logs a buffer as hex string.

Parameters

msg	[in] The message to print in front of the message. If NULL or empty nothing is printed.
buffer	[in] The buffer to print.
bufferLength	[in] The length of the buffer.

OPGP_log_Msg()

OPGP_API void OPGP_log_Msg	(	OPGP_STRING	msg,
			...
	)

Logs something to a file or the syslog.

In Unix systems which have a syslog facility the msg is stored there. The environment variable GLOBALPLATFORM_DEBUG must be set to enable the logging. With the environment variable GLOBALPLATFORM_LOGFILE an explicit log file name can be set. If a no log file name has been set implicitly /tmp/GlobalPlatform.log or C:\TEMP\GlobalPlatform.log under Windows will be used. If a log file name is given the syslog if available will not be used.

Parameters

msg	The formatted message which will be stored.
...	Variable argument list

OPGP_log_Start()

OPGP_API void OPGP_log_Start	(	OPGP_STRING	func,
		OPGP_STRING	file,
		int	line
	)

Logs the start of a function.

The call is redirected to log_Log().

Parameters

func	[in] The function name. ‎
file	[in] The source file.
line	[in] The line number in the source file.