#88409# added logging functionality
This commit is contained in:
Jörg Budischewski
parent
df3c3f4e3b
commit
be920e3528
3 changed files with 283 additions and 3 deletions
124
sal/inc/rtl/logfile.h
Normal file
124
sal/inc/rtl/logfile.h
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* $RCSfile: logfile.h,v $
|
||||
*
|
||||
* $Revision: 1.1 $
|
||||
*
|
||||
* last change: $Author: jbu $ $Date: 2001-07-06 09:36:09 $
|
||||
*
|
||||
* The Contents of this file are made available subject to the terms of
|
||||
* either of the following licenses
|
||||
*
|
||||
* - GNU Lesser General Public License Version 2.1
|
||||
* - Sun Industry Standards Source License Version 1.1
|
||||
*
|
||||
* Sun Microsystems Inc., October, 2000
|
||||
*
|
||||
* GNU Lesser General Public License Version 2.1
|
||||
* =============================================
|
||||
* Copyright 2000 by Sun Microsystems, Inc.
|
||||
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License version 2.1, as published by the Free Software Foundation.
|
||||
*
|
||||
* This library 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 for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
* MA 02111-1307 USA
|
||||
*
|
||||
*
|
||||
* Sun Industry Standards Source License Version 1.1
|
||||
* =================================================
|
||||
* The contents of this file are subject to the Sun Industry Standards
|
||||
* Source License Version 1.1 (the "License"); You may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of the
|
||||
* License at http://www.openoffice.org/license.html.
|
||||
*
|
||||
* Software provided under this License is provided on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
||||
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
||||
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
||||
* See the License for the specific provisions governing your rights and
|
||||
* obligations concerning the Software.
|
||||
*
|
||||
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
||||
*
|
||||
* Copyright: 2001 by Sun Microsystems, Inc.
|
||||
*
|
||||
* All Rights Reserved.
|
||||
*
|
||||
* Contributor(s): _______________________________________
|
||||
*
|
||||
*
|
||||
************************************************************************/
|
||||
#ifndef _RTL_LOGFILE_H_
|
||||
#define _RTL_LOGFILE_H_
|
||||
|
||||
#ifndef _SAL_TYPES_H_
|
||||
#include <sal/types.h>
|
||||
#endif
|
||||
|
||||
#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, ... );
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef PROFILE
|
||||
#define RTL_LOGFILE_TRACE( string ) \
|
||||
rtl_logfile_trace( "%06lu %lu | : %s\n", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ), \
|
||||
string )
|
||||
#define RTL_LOGFILE_TRACE1( frmt, arg1 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ) ); \
|
||||
rtl_logfile_trace( frmt, arg1 ); \
|
||||
rtl_logfile_trace( "\n" )
|
||||
|
||||
#define RTL_LOGFILE_TRACE2( frmt, arg1 , arg2 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ) ); \
|
||||
rtl_logfile_trace( frmt, arg1 , arg2 ); \
|
||||
rtl_logfile_trace( "\n" )
|
||||
#define RTL_LOGFILE_TRACE3( frmt, arg1 , arg2 , arg3 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ) ); \
|
||||
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)
|
||||
#endif // PROFILE
|
||||
#endif
|
||||
155
sal/inc/rtl/logfile.hxx
Normal file
155
sal/inc/rtl/logfile.hxx
Normal file
|
|
@ -0,0 +1,155 @@
|
|||
/*************************************************************************
|
||||
*
|
||||
* $RCSfile: logfile.hxx,v $
|
||||
*
|
||||
* $Revision: 1.1 $
|
||||
*
|
||||
* last change: $Author: jbu $ $Date: 2001-07-06 09:36:09 $
|
||||
*
|
||||
* The Contents of this file are made available subject to the terms of
|
||||
* either of the following licenses
|
||||
*
|
||||
* - GNU Lesser General Public License Version 2.1
|
||||
* - Sun Industry Standards Source License Version 1.1
|
||||
*
|
||||
* Sun Microsystems Inc., October, 2000
|
||||
*
|
||||
* GNU Lesser General Public License Version 2.1
|
||||
* =============================================
|
||||
* Copyright 2000 by Sun Microsystems, Inc.
|
||||
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
||||
*
|
||||
* This library is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU Lesser General Public
|
||||
* License version 2.1, as published by the Free Software Foundation.
|
||||
*
|
||||
* This library 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 for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Lesser General Public
|
||||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
* MA 02111-1307 USA
|
||||
*
|
||||
*
|
||||
* Sun Industry Standards Source License Version 1.1
|
||||
* =================================================
|
||||
* The contents of this file are subject to the Sun Industry Standards
|
||||
* Source License Version 1.1 (the "License"); You may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of the
|
||||
* License at http://www.openoffice.org/license.html.
|
||||
*
|
||||
* Software provided under this License is provided on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
||||
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
||||
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
||||
* See the License for the specific provisions governing your rights and
|
||||
* obligations concerning the Software.
|
||||
*
|
||||
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
||||
*
|
||||
* Copyright: 2001 by Sun Microsystems, Inc.
|
||||
*
|
||||
* All Rights Reserved.
|
||||
*
|
||||
* Contributor(s): _______________________________________
|
||||
*
|
||||
*
|
||||
************************************************************************/
|
||||
#ifndef _RTL_LOGFILE_HXX_
|
||||
#define _RTL_LOGFILE_HXX_
|
||||
|
||||
#ifndef _OSL_TIME_H_
|
||||
#include <osl/time.h>
|
||||
#endif
|
||||
#ifndef _OSL_THREAD_H_
|
||||
#include <osl/thread.h>
|
||||
#endif
|
||||
|
||||
#ifndef _RTL_LOGFILE_H_
|
||||
#include <rtl/logfile.h>
|
||||
#endif
|
||||
#ifndef _RTL_STRING_HXX_
|
||||
#include <rtl/string.hxx>
|
||||
#endif
|
||||
|
||||
namespace rtl
|
||||
{
|
||||
/** wrapper class to keep a logging context.
|
||||
|
||||
Should not be used directly, instead use the RTL_LOGFILE_CONTEXT -macros.
|
||||
*/
|
||||
class Logfile
|
||||
{
|
||||
public:
|
||||
inline Logfile( const sal_Char *name );
|
||||
inline ~Logfile();
|
||||
inline const sal_Char *getName();
|
||||
private:
|
||||
::rtl::OString m_sName;
|
||||
};
|
||||
|
||||
inline Logfile::Logfile( const sal_Char *name )
|
||||
: m_sName( name )
|
||||
{
|
||||
rtl_logfile_trace( "%06lu %lu { %s\n",
|
||||
osl_getGlobalTimer(),
|
||||
osl_getThreadIdentifier( 0 ),
|
||||
name );
|
||||
}
|
||||
|
||||
inline Logfile::~Logfile()
|
||||
{
|
||||
rtl_logfile_trace( "%06lu %lu } %s\n",
|
||||
osl_getGlobalTimer(),
|
||||
osl_getThreadIdentifier(0),
|
||||
m_sName.pData->buffer );
|
||||
}
|
||||
|
||||
inline const sal_Char * Logfile::getName()
|
||||
{
|
||||
return m_sName.getStr();
|
||||
}
|
||||
}
|
||||
|
||||
#ifdef PROFILE
|
||||
#define RTL_LOGFILE_CONTEXT( instance, name ) ::rtl::Logfile instance( name )
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE( instance, message ) \
|
||||
rtl_logfile_trace( "%06lu %lu | %s : %s\n", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ), \
|
||||
instance.getName(), \
|
||||
message )
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE1( instance , frmt, arg1 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | %s : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ), \
|
||||
instance.getName() ); \
|
||||
rtl_logfile_trace( frmt , arg1 ); \
|
||||
rtl_logfile_trace( "\n" )
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE2( instance , frmt, arg1 , arg2 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | %s : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ), \
|
||||
instance.getName() ); \
|
||||
rtl_logfile_trace( frmt , arg1 , arg2 ); \
|
||||
rtl_logfile_trace( "\n" )
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE3( instance , frmt, arg1 , arg2 , arg3 ) \
|
||||
rtl_logfile_trace( "%06lu %lu | %s : ", \
|
||||
osl_getGlobalTimer(), \
|
||||
osl_getThreadIdentifier( 0 ), \
|
||||
instance.getName() ); \
|
||||
rtl_logfile_trace( frmt , arg1 , arg2 , arg3 ); \
|
||||
rtl_logfile_trace( "\n" )
|
||||
|
||||
#else
|
||||
#define RTL_LOGFILE_CONTEXT( instance,name ) ((void)0)
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE( instance, message ) ((void)0)
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE1( instance, frmt, arg1 ) ((void)0)
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE2( instance, frmt, arg1, arg2 ) ((void)0)
|
||||
#define RTL_LOGFILE_CONTEXT_TRACE3( instance, frmt, arg1, arg2 , arg3 ) ((void)0)
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
|
@ -2,9 +2,9 @@
|
|||
#
|
||||
# $RCSfile: makefile.mk,v $
|
||||
#
|
||||
# $Revision: 1.5 $
|
||||
# $Revision: 1.6 $
|
||||
#
|
||||
# last change: $Author: kr $ $Date: 2001-06-15 13:53:54 $
|
||||
# last change: $Author: jbu $ $Date: 2001-07-06 09:39:53 $
|
||||
#
|
||||
# The Contents of this file are made available subject to the terms of
|
||||
# either of the following licenses
|
||||
|
|
@ -93,7 +93,8 @@ APP1OBJS= \
|
|||
$(OBJ)$/teststrbuf.obj \
|
||||
$(OBJ)$/testbyteseq.obj \
|
||||
$(OBJ)$/testuri.obj \
|
||||
$(OBJ)$/test.obj
|
||||
$(OBJ)$/test.obj \
|
||||
$(OBJ)$/testlogfile.obj
|
||||
OBJFILES= \
|
||||
$(APP1OBJS) \
|
||||
$(APP2OBJS)
|
||||
|
|
|
|||
Loading…
Reference in a new issue