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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: logfile.h,v $
* $Revision: 1.6 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _RTL_LOGFILE_H_
#define _RTL_LOGFILE_H_
#include <sal/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/** This function allows to log arbitrary messages even in a product-environment.
The logfile is created on first access and closed, when the sal-library gets unloaded.
The file is line buffered. A log file is not created if no log messages are
written.
The first time, rtl_logfile_trace is called, it checks for the bootstrap variable
RTL_LOGFILE. If the variable is not empty, it creates a file with the name
$(RTL_LOGFILE)_$(PID).log, where $(PID) is the process id of the running process.
@param pszformat A format string with fprintf-syntax
@param ... An arbitrary number of arguments for fprintf, matching the
format string.
*/
void SAL_CALL rtl_logfile_trace( const sal_Char* pszFormat, ... );
/** Like rtl_logfile_trace, but prefixing every log entry with the current time
and thread ID.
@param format
a format string with fprintf-like syntax
@param ...
an arbitrary number of arguments for fprintf, matching the given format
string
@since UDK 3.2.0
*/
void SAL_CALL rtl_logfile_longTrace(char const * format, ...);
#ifdef __cplusplus
}
#endif
#ifdef TIMELOG
#define RTL_LOGFILE_TRACE( string ) \
rtl_logfile_longTrace( "| : %s\n", string )
#define RTL_LOGFILE_TRACE1( frmt, arg1 ) \
rtl_logfile_longTrace( "| : " ); \
rtl_logfile_trace( frmt, arg1 ); \
rtl_logfile_trace( "\n" )
#define RTL_LOGFILE_TRACE2( frmt, arg1 , arg2 ) \
rtl_logfile_longTrace( "| : " ); \
rtl_logfile_trace( frmt, arg1 , arg2 ); \
rtl_logfile_trace( "\n" )
#define RTL_LOGFILE_TRACE3( frmt, arg1 , arg2 , arg3 ) \
rtl_logfile_longTrace( "| : " ); \
rtl_logfile_trace( frmt, arg1 , arg2 , arg3 ); \
rtl_logfile_trace( "\n" )
// Now the macros with project and author arguments. The strings
// are formatted in a way, so that the log file can be parsed by
// post processing scripts.
#define RTL_LOGFILE_TRACE_AUTHOR( project, author, string ) \
rtl_logfile_longTrace( "| %s (%s) : %s\n", \
project,\
author,\
string )
#define RTL_LOGFILE_TRACE_AUTHOR1( project, author, frmt, arg1 ) \
rtl_logfile_longTrace( "| %s (%s) : ", \
project,\
author );\
rtl_logfile_trace( frmt, arg1 ); \
rtl_logfile_trace( "\n" )
#define RTL_LOGFILE_TRACE_AUTHOR2( project, author, frmt, arg1 , arg2 ) \
rtl_logfile_longTrace( "| %s (%s) : ", \
project,\
author ); \
rtl_logfile_trace( frmt, arg1 , arg2 ); \
rtl_logfile_trace( "\n" )
#define RTL_LOGFILE_TRACE_AUTHOR3( project, author, frmt, arg1 , arg2 , arg3 ) \
rtl_logfile_longTrace( "| %s (%s) : ", \
project,\
author ); \
rtl_logfile_trace( frmt, arg1 , arg2 , arg3 ); \
rtl_logfile_trace( "\n" )
#else
#define RTL_LOGFILE_TRACE( string ) ((void)0)
#define RTL_LOGFILE_TRACE1( frmt, arg1 ) ((void)0)
#define RTL_LOGFILE_TRACE2( frmt, arg1 , arg2 ) ((void)0)
#define RTL_LOGFILE_TRACE3( frmt, arg1 , arg2 , arg3 ) ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR( project, author, string ) ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR1( project, author, frmt, arg1 ) ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR2( project, author, frmt, arg1 , arg2 ) ((void)0)
#define RTL_LOGFILE_TRACE_AUTHOR3( project, author, frmt, arg1 , arg2 , arg3 ) ((void)0)
#endif // TIMELOG
#endif
|
