bienutil/_trace.h at master · davidbien/bienutil · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#pragma once

//          Copyright David Lawrence Bien 1997 - 2021.
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          https://www.boost.org/LICENSE_1_0.txt).

// _trace.h
// Implement a "trace" mechanism to alert to code entry points.
// Traces in retail are off by default but can be turned on by setting TRACESENABLED to non-zero before including this file.

#include "bien_assert.h"

__BIENUTIL_BEGIN_NAMESPACE

#ifdef Trace
#error _trace.h: Trace() macro is already defined.
#endif

#ifndef TRACESENABLED
#ifdef	NDEBUG
#define TRACESENABLED 0
#else
#define TRACESENABLED 1
#endif // !NDEBUG
#endif // !TRACESENABLED

#ifndef ACTIONONTRACE
// By default we just ignore a trace.
#define ACTIONONTRACE eabiIgnore
#endif // !ACTIONONTRACE

void
Trace_LogMessage( EAbortBreakIgnore _eabi, const char * _szFile, unsigned int _nLine, const char * _szFunction, const n_SysLog::vtyJsoValueSysLog * _pjvTrace, const char * _szMesg, ... );
void
Trace_LogMessageVArg( EAbortBreakIgnore _eabi, const char * _szFile, unsigned int _nLine, const char * _szFunction, const n_SysLog::vtyJsoValueSysLog * _pjvTrace, const char * _szMesg, va_list _ap );

#if !TRACESENABLED
#define Trace(szMesg, ...)		(static_cast<void>(0))
#define TraceAndIgnore(szMesg, ...) (static_cast<void>(0))
#define TraceAndBreak(szMesg, ...) (static_cast<void>(0))
#define TraceAndAbort(szMesg, ...)		(static_cast<void>(0))
#else // #if !TRACESENABLED
#define Trace(szMesg, ...) Trace_LogMessage( ACTIONONTRACE, __FILE__, __LINE__, FUNCTION_PRETTY_NAME, nullptr, szMesg, ##__VA_ARGS__ )
#define TraceJson(JSONVAL,szMesg, ...) Trace_LogMessage( ACTIONONTRACE, __FILE__, __LINE__, FUNCTION_PRETTY_NAME, &JSONVAL, szMesg, ##__VA_ARGS__ )
#define TraceAndIgnore(szMesg, ...) Trace_LogMessage( eabiIgnore, __FILE__, __LINE__, FUNCTION_PRETTY_NAME, nullptr, szMesg, ##__VA_ARGS__ )
#define TraceAndBreak(szMesg, ...) Trace_LogMessage( eabiBreak, __FILE__, __LINE__, FUNCTION_PRETTY_NAME, nullptr, szMesg, ##__VA_ARGS__ )
#define TraceAndAbort(szMesg, ...) Trace_LogMessage( eabiAbort, __FILE__, __LINE__, FUNCTION_PRETTY_NAME, nullptr, szMesg, ##__VA_ARGS__ )
#endif // #if !TRACESENABLED

__BIENUTIL_END_NAMESPACE