summaryrefslogtreecommitdiff
path: root/support/dktools/dk3trace.h
blob: 4dd6bd2909e4756c5bdfc69789bd225d13cfd535 (plain)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
	WARNING: This file was generated by dkct.
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk3trace.ctr
*/

/*
Copyright (C) 2011-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

/**	@file dk3trace.h Header file for the dk3trace module.
*/

#ifndef DK3TRACE_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3TRACE_H_INCLUDED 1


#line 10 "dk3trace.ctr"


#ifndef STDIO_H_INCLUDED
#include <stdio.h>
#define	STDIO_H_INCLUDED 1
#endif

#if defined(__cplusplus)
extern "C" {
#endif



/**	Close trace output file.
*/
void
dktrace_end(void);



/**	Start tracing.
	@param	filename	File name to write trace output
	or NULL to use standard output.
*/
void
dktrace_init(
  char const *filename
);



/**	Get trace file.
	@return	Pointer to open file used for tracing.
*/
FILE *
dktrace_file(void);



/**	Close trace output file.
*/
void
dk_trace_end(void);



/**	Start tracing.
	@param	filename	File name to write trace output
	  or NULL to use standard output.
*/
void
dk_trace_init(
  char const *filename
);



/**	Get trace file.
	  @return	Pointer to open file used for tracing.
*/
FILE *
dk_trace_file(void);



/**	Write time to trace output.
*/
void
dktrace_time(void);



/**	Write time to trace output.
*/
void
dk_trace_time(void);



/**	Write time to standard output.
*/
void
dktrace_stdout_time(void);


#if DK4_ON_WINDOWS
/**	Write time to trace output.
*/
void
dk_trace_wtime(void);

/**	Write time to standard output.
*/
void
dktrace_stdout_wtime(void);

#endif

#if defined(__cplusplus)
}
#endif
/* ifdef __cplusplus */


#if TRACE_WIDE

/** Show string. */
#define TR_STR(x)	((NULL != x) ? (x) : L"(NULL)")

/** Show pointer. */
#define TR_PTR(x)	((NULL != x) ? L"PTR" : L"(NULL)")

#else
/* if TRACE_WIDE */

/** Show string. */
#define TR_STR(x)	((NULL != x) ? (x) : "(NULL)")

/** Show pointer. */
#define TR_PTR(x)	((NULL != x) ? "PTR" : "(NULL)")

#endif
/* if TRACE_WIDE */


/** Show 8 bit string. */
#define	TR_8STR(x)	((NULL != x) ? (x) : "(NULL)")

/** Show pointer as 8 bit string. */
#define	TR_8PTR(x)	((NULL != x) ? "PTR" : "(NULL)")

/** Show long string. */
#define	TR_LSTR(x)	((NULL != x) ? (x) : L"(NULL)")

/** Show pointer as long string. */
#define	TR_LPTR(x)	((NULL != x) ? L"PTR" : L"(NULL)")

/** Show string as dkChar. */
#define	TR_DKSTR(x)	((NULL != x) ? (x) : dkT("NULL"))

/** Show pointer as dkChar. */
#define	TR_DKPTR(x)	((NULL != x) ? dkT("PTR") : dkT("(NULL)"))

/** Show string as wxChar. */
#define	TR_WXSTR(x)	((NULL != x) ? (x) : wxT("(NULL)"))

/** Show pointer as wxChar. */
#define	TR_WXPTR(x)	((NULL != x) ? wxT("PTR") : wxT("(NULL)"))

/** Show pointer as integer. */
#define	TR_IPTR(x)	((NULL != x) ? 1 : 0)



#endif