1 files changed, 134 insertions, 0 deletions
diff --git a/sal/inc/rtl/logfile.h b/sal/inc/rtl/logfile.h
new file mode 100644
index 000000000000..dbb9e9c258cf
--- /dev/null
+++ b/sal/inc/rtl/logfile.h
@@ -0,0 +1,134 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * 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, ...);
+
+/** Return if a log file is written.
+
+    @return true if a log file is written
+
+    @since UDK 3.2.11
+*/
+sal_Bool SAL_CALL rtl_logfile_hasLogFile( void );
+
+#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