4
* Log file redirector function
5
* Copyright (c) 1999-2006 Ross Bencina, Phil Burk
7
* Permission is hereby granted, free of charge, to any person obtaining
8
* a copy of this software and associated documentation files
9
* (the "Software"), to deal in the Software without restriction,
10
* including without limitation the rights to use, copy, modify, merge,
11
* publish, distribute, sublicense, and/or sell copies of the Software,
12
* and to permit persons to whom the Software is furnished to do so,
13
* subject to the following conditions:
15
* The above copyright notice and this permission notice shall be
16
* included in all copies or substantial portions of the Software.
18
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
22
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
23
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28
* The text above constitutes the entire PortAudio license; however,
29
* the PortAudio community also makes the following non-binding requests:
31
* Any person wishing to distribute modifications to the Software is
32
* requested to send the modifications to the original developer so that
33
* they can be incorporated into the canonical version. It is also
34
* requested that these non-binding requests be included along with the
46
#endif /* __cplusplus */
50
void PaUtil_DebugPrint( const char *format, ... );
54
The basic format for log messages is described below. If you need to
55
add any log messages, please follow this format.
57
Function entry (void function):
59
"FunctionName called.\n"
61
Function entry (non void function):
63
"FunctionName called:\n"
64
"\tParam1Type param1: param1Value\n"
65
"\tParam2Type param2: param2Value\n" (etc...)
68
Function exit (no return value):
70
"FunctionName returned.\n"
72
Function exit (simple return value):
74
"FunctionName returned:\n"
75
"\tReturnType: returnValue\n\n"
77
If the return type is an error code, the error text is displayed in ()
79
If the return type is not an error code, but has taken a special value
80
because an error occurred, then the reason for the error is shown in []
82
If the return type is a struct ptr, the struct is dumped.
84
See the code below for examples
87
/** PA_DEBUG() provides a simple debug message printing facility. The macro
88
passes it's argument to a printf-like function called PaUtil_DebugPrint()
89
which prints to stderr and always flushes the stream after printing.
90
Because preprocessor macros cannot directly accept variable length argument
91
lists, calls to the macro must include an additional set of parenthesis, eg:
92
PA_DEBUG(("errorno: %d", 1001 ));
96
#ifdef PA_ENABLE_DEBUG_OUTPUT
97
#define PA_DEBUG(x) PaUtil_DebugPrint x ;
103
#ifdef PA_LOG_API_CALLS
104
#define PA_LOGAPI(x) PaUtil_DebugPrint x ;
110
typedef void (*PaUtilLogCallback ) (const char *log);
113
Install user provided log function
115
void PaUtil_SetDebugPrintFunction(PaUtilLogCallback cb);
121
#endif /* __cplusplus */
122
#endif /* PA_LOG_H */
7
* Log file redirector function
9
* Copyright (c) 1999-2006 Ross Bencina, Phil Burk
13
* Permission is hereby granted, free of charge, to any person obtaining
15
* a copy of this software and associated documentation files
17
* (the "Software"), to deal in the Software without restriction,
19
* including without limitation the rights to use, copy, modify, merge,
21
* publish, distribute, sublicense, and/or sell copies of the Software,
23
* and to permit persons to whom the Software is furnished to do so,
25
* subject to the following conditions:
29
* The above copyright notice and this permission notice shall be
31
* included in all copies or substantial portions of the Software.
35
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
37
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
39
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
41
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
43
* ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
45
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
47
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
55
* The text above constitutes the entire PortAudio license; however,
57
* the PortAudio community also makes the following non-binding requests:
61
* Any person wishing to distribute modifications to the Software is
63
* requested to send the modifications to the original developer so that
65
* they can be incorporated into the canonical version. It is also
67
* requested that these non-binding requests be included along with the
91
#endif /* __cplusplus */
99
void PaUtil_DebugPrint( const char *format, ... );
107
The basic format for log messages is described below. If you need to
109
add any log messages, please follow this format.
113
Function entry (void function):
117
"FunctionName called.\n"
121
Function entry (non void function):
125
"FunctionName called:\n"
127
"\tParam1Type param1: param1Value\n"
129
"\tParam2Type param2: param2Value\n" (etc...)
135
Function exit (no return value):
139
"FunctionName returned.\n"
143
Function exit (simple return value):
147
"FunctionName returned:\n"
149
"\tReturnType: returnValue\n"
153
If the return type is an error code, the error text is displayed in ()
157
If the return type is not an error code, but has taken a special value
159
because an error occurred, then the reason for the error is shown in []
163
If the return type is a struct ptr, the struct is dumped.
167
See the code below for examples
173
/** PA_DEBUG() provides a simple debug message printing facility. The macro
175
passes it's argument to a printf-like function called PaUtil_DebugPrint()
177
which prints to stderr and always flushes the stream after printing.
179
Because preprocessor macros cannot directly accept variable length argument
181
lists, calls to the macro must include an additional set of parenthesis, eg:
183
PA_DEBUG(("errorno: %d", 1001 ));
191
#ifdef PA_ENABLE_DEBUG_OUTPUT
193
#define PA_DEBUG(x) PaUtil_DebugPrint x ;
205
#ifdef PA_LOG_API_CALLS
207
#define PA_LOGAPI(x) PaUtil_DebugPrint x
211
#define PA_LOGAPI_ENTER(functionName) PaUtil_DebugPrint( functionName " called.\n" )
215
#define PA_LOGAPI_ENTER_PARAMS(functionName) PaUtil_DebugPrint( functionName " called:\n" )
219
#define PA_LOGAPI_EXIT(functionName) PaUtil_DebugPrint( functionName " returned.\n" )
223
#define PA_LOGAPI_EXIT_PAERROR( functionName, result ) \
225
PaUtil_DebugPrint( functionName " returned:\n" ); \
227
PaUtil_DebugPrint("\tPaError: %d ( %s )\n", result, Pa_GetErrorText( result ) )
231
#define PA_LOGAPI_EXIT_T( functionName, resultFormatString, result ) \
233
PaUtil_DebugPrint( functionName " returned:\n" ); \
235
PaUtil_DebugPrint("\t" resultFormatString "\n", result )
239
#define PA_LOGAPI_EXIT_PAERROR_OR_T_RESULT( functionName, positiveResultFormatString, result ) \
241
PaUtil_DebugPrint( functionName " returned:\n" ); \
245
PaUtil_DebugPrint("\t" positiveResultFormatString "\n", result ); \
249
PaUtil_DebugPrint("\tPaError: %d ( %s )\n", result, Pa_GetErrorText( result ) )
255
#define PA_LOGAPI_ENTER(functionName)
257
#define PA_LOGAPI_ENTER_PARAMS(functionName)
259
#define PA_LOGAPI_EXIT(functionName)
261
#define PA_LOGAPI_EXIT_PAERROR( functionName, result )
263
#define PA_LOGAPI_EXIT_T( functionName, resultFormatString, result )
265
#define PA_LOGAPI_EXIT_PAERROR_OR_T_RESULT( functionName, positiveResultFormatString, result )
273
typedef void (*PaUtilLogCallback ) (const char *log);
279
Install user provided log function
283
void PaUtil_SetDebugPrintFunction(PaUtilLogCallback cb);
295
#endif /* __cplusplus */
297
#endif /* PA_LOG_H */
added
removed
lib-src/portaudio-v19/src/common/pa_debugprint.h
