/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project . * * This Source Code Form is subject to the terms of the Mozilla Public * License , v . 2 . 0 . If a copy of the MPL was not distributed with this * file , You can obtain one at http : //mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice : * * Licensed to the Apache Software Foundation ( ASF ) under one or more * contributor license agreements . See the NOTICE file distributed * with this work for additional information regarding copyright * ownership . The ASF licenses this file to you under the Apache * License , Version 2 . 0 ( 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.apache.org/licenses/LICENSE-2.0 . #ifndef INCLUDED_COMPHELPER_LOGGING_HXX#define INCLUDED_COMPHELPER_LOGGING_HXX#include <comphelper/comphelperdllapi.h>#include <rtl/ustring.hxx>#include <optional>#include <memory>namespace com::sun::star::uno { template <class interface_type> class Reference; }namespace com::sun::star::uno { class XComponentContext; }namespace com::sun::star::logging { class XLogger; }namespace comphelper//= string conversions, employed by the templatized log* members of //= EventLogger namespace log::convertinline const OUString& convertLogArgToString( const OUString& _rValue )return _rValue;inline OUString convertLogArgToString( const char * _pAsciiValue )return OUString::createFromAscii( _pAsciiValue );inline OUString convertLogArgToString( double _nValue ) { return OUString::number( _nValue ); }inline OUString convertLogArgToString( float _nValue ) { return OUString::number( _nValue ); }inline OUString convertLogArgToString( sal_Int64 _nValue ) { return OUString::number( _nValue ); }inline OUString convertLogArgToString( sal_Int32 _nValue ) { return OUString::number( _nValue ); }inline OUString convertLogArgToString( sal_Int16 _nValue ) { return OUString::number( _nValue ); }inline OUString convertLogArgToString( sal_Unicode _nValue ) { return OUString( _nValue ); }inline OUString convertLogArgToString( bool _bValue ) { return OUString::boolean( _bValue ); }void convertLogArgToString(sal_Bool) = delete ;// namespace log::convert //= EventLogger class EventLogger_Impl;typedef ::std::optional< OUString > OptionalString;/** encapsulates a css::logging::XLogger The class silences several ( unlikely ) errors which could potentially happen when working with a logger . Additionally , it provides some convenience methods for logging events . You can use this class as follows < pre > EventLogger aLogger ( xContext , sLoggerName ) ; . . . aLogger . log ( LogLevel : : SEVERE , sSomeMessage ) ; aLogger . logp ( LogLevel : : CONFIG , " MyClass " , " MyMethod " , sSomeMessage , SomeParameter1 , SomeParameter2 , SomeParameter3 ) ; < / pre > The < code > log < / code > and < code > logp < / code > calls support up to 6 parameters , which can be of arbitrary type . For every parameter , there must exist a function < code > convertLogArgToString < / code > which takes an argument of the respective type , and returns a string . After a parameter has been converted to a string using the above mentioned < code > convertLogArgToString < / code > function , a placeholder $ 1 $ ( resp . $ 2 $ resp . $ 4 $ . . . ) in the message will be replaced with this string , and the resulting message will be logged . class COMPHELPER_DLLPUBLIC EventLoggerpublic :/** creates an <code>EventLogger</code> instance working with a css.logging.XLogger instance given by ASCII name . @ param _ rxContext the component context to create services @ param _ rLoggerName the ASCII name of the logger to create . const css::uno::Reference< css::uno::XComponentContext >& _rxContext,const char * _pAsciiLoggerNamepublic :/// determines whether an event with the given level would be logged bool isLoggable( const sal_Int32 _nLogLevel ) const ;//- XLogger::log equivalents/wrappers //- string messages /// logs a given message, without any arguments, or source class/method names void log( const sal_Int32 _nLogLevel, const OUString& rMessage ) const if ( isLoggable( _nLogLevel ) )const css::uno::Reference<css::logging::XLogger> & getLogger() const ;/** logs a given message, replacing a placeholder in the message with an argument The function takes , additionally to the log level and the message , an arbitrary argument . This argument is converted to a string using an overloaded function named < code > convertLogArgToString < / code > . Then , a placeholder & quot ; $ 1 $ & quot ; is searched in the message string , and replaced with the argument string . template < typename ARGTYPE1 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 2 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 3 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 4 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 5 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 6 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >void log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const if ( isLoggable( _nLogLevel ) )//- XLogger::log equivalents/wrappers //- ASCII messages /** logs a given message, replacing a placeholder in the message with an argument The function takes , additionally to the log level and the message , an arbitrary argument . This argument is converted to a string using an overloaded function named < code > convertLogArgToString < / code > . Then , a placeholder & quot ; $ 1 $ & quot ; is searched in the message string , and replaced with the argument string . template < typename ARGTYPE1 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 2 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 3 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 4 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 5 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 6 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >void log( const sal_Int32 _nLogLevel, const char * _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const if ( isLoggable( _nLogLevel ) )//- XLogger::logp equivalents/wrappers //- string messages /** logs a given message, replacing a placeholder in the message with an argument The function takes , additionally to the logp level and the message , an arbitrary argument . This argument is converted to a string using an overloaded function named < code > convertLogArgToString < / code > . Then , a placeholder & quot ; $ 1 $ & quot ; is searched in the message string , and replaced with the argument string . template < typename ARGTYPE1 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 2 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 3 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 4 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 5 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const if ( isLoggable( _nLogLevel ) )/// logs a given message, replacing 6 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const if ( isLoggable( _nLogLevel ) )//- XLogger::logp equivalents/wrappers //- ASCII messages /** logs a given ASCII message, replacing a placeholder in the message with an argument The function takes , additionally to the logp level and the message , an arbitrary argument . This argument is converted to a string using an overloaded function named < code > convertLogArgToString < / code > . Then , a placeholder & quot ; $ 1 $ & quot ; is searched in the message string , and replaced with the argument string . template < typename ARGTYPE1 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),/// logs a given ASCII message, replacing 2 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),/// logs a given ASCII message, replacing 3 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),/// logs a given ASCII message, replacing 4 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),/// logs a given ASCII message, replacing 5 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),/// logs a given ASCII message, replacing 6 placeholders in the message with respective values template < typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >void logp( const sal_Int32 _nLogLevel, const char * _pSourceClass, const char * _pSourceMethod, const char * _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const if ( isLoggable( _nLogLevel ) )iiMessage ),protected :void impl_log(const sal_Int32 _nLogLevel,const char * _pSourceClass,const char * _pSourceMethod,const OUString& _rMessage,const OptionalString& _rArgument1 = OptionalString(),const OptionalString& _rArgument2 = OptionalString(),const OptionalString& _rArgument3 = OptionalString(),const OptionalString& _rArgument4 = OptionalString(),const OptionalString& _rArgument5 = OptionalString(),const OptionalString& _rArgument6 = OptionalString()const ;// namespace comphelper #endif // INCLUDED_COMPHELPER_LOGGING_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Messung V0.5 in Prozent C=92 H=99 G=95
¤ Dauer der Verarbeitung: 0.9 Sekunden
¤ *© Formatika GbR, Deutschland
