xref: /trunk/main/filter/source/filtertracer/filtertracer.hxx (revision 22e87013)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef _FILTERTRACER_HXX
#define _FILTERTRACER_HXX

#include <rtl/ustring.hxx>
#include <tools/debug.hxx>
#include <tools/stream.hxx>
#include <tools/string.hxx>
#include <tools/urlobj.hxx>
#include <tools/stack.hxx>

#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <com/sun/star/registry/XRegistryKey.hpp>
#include <com/sun/star/lang/XComponent.hpp>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/implbase4.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/util/logging/XLogger.hpp>
#include <com/sun/star/util/logging/LogLevel.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/util/XTextSearch.hpp>
#include <com/sun/star/util/SearchResult.hpp>
#include <com/sun/star/xml/sax/XDocumentHandler.hpp>

// -----------------------------------------------------------------------------

#define NMSP_IO			com::sun::star::io
#define NMSP_UNO		com::sun::star::uno
#define NMSP_BEANS      com::sun::star::beans
#define NMSP_LANG		com::sun::star::lang
#define NMSP_UTIL		com::sun::star::util
#define NMSP_SAX		com::sun::star::xml::sax
#define NMSP_LOGGING	NMSP_UTIL::logging


#define REF( _def_Obj )         NMSP_UNO::Reference< _def_Obj >
#define SEQ( _def_Obj )         NMSP_UNO::Sequence< _def_Obj >
#define B2UCONST( _def_pChar )  (rtl::OUString(RTL_CONSTASCII_USTRINGPARAM(_def_pChar )))

// ----------------
// - FILTERTRACER -
// ----------------
//

/** Some options of the FilterTracer can be initialized
    via XInitialization interface.

	Therefore the first sequence of	PropertyValues that
	is given in the argument list is used.

	Following Properties are supported:

	OutputStream	com.sun.star.io.XOutputStream	Defines the output stream. Optional it is possible to provide
													the URL property, then the corresponding output stream will
													be generated automatically.

	URL				string							Defines the URL, which is used to create an output stream.
													This property is used only, if there is no valid
													OutputStream property available.

	DocumentHandler	com.sun.star.xml.sax.XDocumentHandler	The output can also be written to a DocumentHandler,
															then the "characters" method of the handler is used.

    LogLevel		long							Defines the LogLevel for the FilterTracer.
													Using logp with a LogLevel that is higher as the LogLevel
													for	the FilterTracer component will generate no output.
													LogLevel constants are defined in sun::star::util::logging::LogLevel
													The default LogLevel com::sun::star::logging::LogLevel::ALL

	ClassFilter		string							This property defines a filter for the SourceClass string of logp.
													The ClassFilter string can be separated into multiple tokens using
													a semicolon. If one of the ClassFilter token is part of the
													SourceClass string of the logp method then there will be no output.

	MethodFilter	string							This property defines a filter for the SourceMethod string of logp.
													The MethodFilter string can be separated into multiple tokens using
													a semicolon. If one of the MethodFilter token is part of the
													SourceMethod string of the logp method then there will be no output.

	MessageFilter	string							This property defines a filter for the Message string of logp.
													The MessageFilter string can be separated into multiple tokens using
													a semicolon. If one of the MessageFilter token is part of the
													Message string of the logp method then there will be no output.

*/

class FilterTracer : public cppu::WeakImplHelper4
<
	NMSP_LOGGING::XLogger,
	NMSP_LANG::XInitialization,
	NMSP_LANG::XServiceInfo,
	NMSP_UTIL::XTextSearch
>
{
	REF( NMSP_LANG::XMultiServiceFactory )	xFact;
	SvStream*		mpStream;

	sal_Int32		mnLogLevel;
	rtl::OUString	msClassFilter;
	rtl::OUString	msMethodFilter;
	rtl::OUString	msMessageFilter;
	rtl::OUString	msURL;

	REF( NMSP_IO::XOutputStream )		mxOutputStream;
	REF( NMSP_SAX::XDocumentHandler)	mxDocumentHandler;

	REF( NMSP_UTIL::XTextSearch )		mxTextSearch;
	NMSP_UTIL::SearchOptions			maSearchOptions;

	sal_Bool				ImplFilter( const rtl::OUString& rFilter, const rtl::OUString& rString );

public:
							FilterTracer( const REF( NMSP_LANG::XMultiServiceFactory )& rxMgr );
	virtual 				~FilterTracer();

	// XInterface
    virtual void SAL_CALL	acquire() throw();
    virtual void SAL_CALL	release() throw();

	// XInitialization
    virtual void SAL_CALL initialize( const SEQ( NMSP_UNO::Any )& aArguments )
		throw ( NMSP_UNO::Exception, NMSP_UNO::RuntimeException );

	// XServiceInfo
    virtual rtl::OUString SAL_CALL getImplementationName()
		throw ( NMSP_UNO::RuntimeException );
    virtual sal_Bool SAL_CALL supportsService( const rtl::OUString& rServiceName )
		throw ( NMSP_UNO::RuntimeException );
    virtual SEQ( rtl::OUString ) SAL_CALL getSupportedServiceNames()
		throw ( NMSP_UNO::RuntimeException );

	// XLogger
    virtual REF( NMSP_LOGGING::XLogger ) SAL_CALL getLogger( const rtl::OUString& rName ) throw (::com::sun::star::uno::RuntimeException);
    virtual sal_Int32 SAL_CALL getLevel() throw (::com::sun::star::uno::RuntimeException);
	virtual rtl::OUString SAL_CALL getName() throw (::com::sun::star::uno::RuntimeException);
	virtual sal_Bool SAL_CALL isLoggable( sal_Int32 nLevel ) throw (::com::sun::star::uno::RuntimeException);
	virtual void SAL_CALL logp( sal_Int32 nLevel, const rtl::OUString& rSourceClass,
					const rtl::OUString& rSourceMethod, const rtl::OUString& rMessage ) throw (::com::sun::star::uno::RuntimeException);

	// XTextSearch
	virtual void SAL_CALL setOptions( const NMSP_UTIL::SearchOptions& ) throw (::com::sun::star::uno::RuntimeException);
	virtual NMSP_UTIL::SearchResult SAL_CALL searchForward( const rtl::OUString& rSearchStr,
		sal_Int32 nStartPos, sal_Int32 nEndPos ) throw (::com::sun::star::uno::RuntimeException);
	virtual NMSP_UTIL::SearchResult SAL_CALL searchBackward( const rtl::OUString& rSearchStr,
		sal_Int32 nStartPos, sal_Int32 nEndPos ) throw (::com::sun::star::uno::RuntimeException);
};

rtl::OUString FilterTracer_getImplementationName()
	throw ( NMSP_UNO::RuntimeException );
sal_Bool SAL_CALL FilterTracer_supportsService( const rtl::OUString& rServiceName )
	throw( NMSP_UNO::RuntimeException );
SEQ( rtl::OUString ) SAL_CALL FilterTracer_getSupportedServiceNames()
	throw( NMSP_UNO::RuntimeException );

#endif