73197297d6
2008/04/01 15:18:23 thb 1.6.458.3: #i85898# Stripping all external header guards 2008/04/01 10:57:52 thb 1.6.458.2: #i85898# Stripping all external header guards 2008/03/28 15:34:48 rt 1.6.458.1: #i87441# Change license header to LPGL v3.
397 lines
21 KiB
C++
397 lines
21 KiB
C++
/*************************************************************************
|
|
*
|
|
* 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: frameloaderfactory.hxx,v $
|
|
* $Revision: 1.7 $
|
|
*
|
|
* 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 __FRAMEWORK_SERVICES_FRAMELOADERFACTORY_HXX_
|
|
#define __FRAMEWORK_SERVICES_FRAMELOADERFACTORY_HXX_
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// my own includes
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
#include <classes/filtercache.hxx>
|
|
#include <threadhelp/threadhelpbase.hxx>
|
|
#include <macros/generic.hxx>
|
|
#include <macros/debug.hxx>
|
|
#include <macros/xinterface.hxx>
|
|
#include <macros/xtypeprovider.hxx>
|
|
#include <macros/xserviceinfo.hxx>
|
|
#include <general.h>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// interface includes
|
|
//_________________________________________________________________________________________________________________
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
#include <com/sun/star/lang/XInitialization.hpp>
|
|
#include <com/sun/star/lang/WrappedTargetException.hpp>
|
|
#include <com/sun/star/container/XNameAccess.hpp>
|
|
#include <com/sun/star/container/NoSuchElementException.hpp>
|
|
#include <com/sun/star/io/XInputStream.hpp>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// other includes
|
|
//_________________________________________________________________________________________________________________
|
|
#include <cppuhelper/weak.hxx>
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// namespace
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
namespace framework{
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// exported const
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
//_________________________________________________________________________________________________________________
|
|
// exported definitions
|
|
//_________________________________________________________________________________________________________________
|
|
|
|
struct tIMPLExtractedArguments
|
|
{
|
|
::rtl::OUString sMimeType ;
|
|
sal_Int32 nFlags ;
|
|
::rtl::OUString sFilterName ;
|
|
sal_Int32 nClipboardFormat ;
|
|
::rtl::OUString sDetectService ;
|
|
css::uno::Reference< css::io::XInputStream > xInputStream ;
|
|
|
|
sal_Int32 nValidMask ;
|
|
};
|
|
|
|
/*-************************************************************************************************************//**
|
|
@short factory to create frameloader-objects
|
|
@descr These class can be used to create new loader for specified contents.
|
|
We use cached values of the registry to lay down, wich frameloader match
|
|
a given URL or filtername. To do this, we use the XMultiServiceFactory-interface.
|
|
|
|
@ATTENTION In a specialmode of these implementation we support a simple filterdetection.
|
|
But there is no special interface. You must call some existing methods in another context!
|
|
see createInstanceWithArguments() fo rfurther informations!
|
|
|
|
@implements XInterface
|
|
XTypeProvider
|
|
XServiceInfo
|
|
XMultiServiceFactory
|
|
XNameAccess
|
|
XElementAccess
|
|
@base ThreadHelpBase
|
|
OWeakObject
|
|
|
|
@devstatus deprecated
|
|
*//*-*************************************************************************************************************/
|
|
|
|
class FrameLoaderFactory : public css::lang::XTypeProvider ,
|
|
public css::lang::XServiceInfo ,
|
|
public css::lang::XMultiServiceFactory ,
|
|
public css::container::XNameAccess , // => XElementAccess
|
|
public ThreadHelpBase , // Struct for right initalization of mutex member! Mst first of baseclasses
|
|
public ::cppu::OWeakObject
|
|
{
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// public methods
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// constructor / destructor
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short standard constructor
|
|
@descr Initialize a new instance and fill the registrycache with values.
|
|
To do this - xFactory must be valid!
|
|
|
|
@seealso class RegistryCache
|
|
@seealso member m_aRegistryCache
|
|
|
|
@param "xFactory", factory which has created us.
|
|
@return -
|
|
|
|
@onerror An ASSERTION is thrown in debug version, if xFactory is invalid or cache can't filled.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
FrameLoaderFactory( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short standard destructor to delete instance
|
|
@descr We use it to clear ouer cache.
|
|
|
|
@seealso class RegistryCache
|
|
|
|
@param -
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual ~FrameLoaderFactory();
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// XInterface, XTypeProvider, XServiceInfo
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
DECLARE_XINTERFACE
|
|
DECLARE_XTYPEPROVIDER
|
|
DECLARE_XSERVICEINFO
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// XMultiServiceFactory
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short create a new frameloder (without arguments!)
|
|
@descr We search for an agreement between given type name and our cache-content.
|
|
If we found some information, we create the registered frameloader for these type.
|
|
Otherwise - we return NULL.
|
|
We search from begin to end of internal loader list!
|
|
|
|
@seealso method impl_createFrameLoader()
|
|
@seealso method createInstanceWithArguments()
|
|
|
|
@param "sTypeName", type name of a document to filter, open or save.
|
|
@return A reference to a new created frameloader.
|
|
|
|
@onerror A null reference is returned.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstance( const ::rtl::OUString& sTypeName ) throw( css::uno::Exception ,
|
|
css::uno::RuntimeException );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short create a new frameloder
|
|
@descr We search for an agreement between given type name and our cache-content.
|
|
If we found some information, we create the registered frameloader for these type.
|
|
Otherwise - we return NULL.
|
|
You can give us some optional arguments to influence our search!
|
|
|
|
@seealso method impl_createFrameLoader()
|
|
@seealso method createInstance()
|
|
|
|
@param "sTypeName", type name of a document to filter, open or save.
|
|
@param "seqArguments", list of optional arguments for initializing of new frameloader.
|
|
@return A reference to a new created frameloader.
|
|
|
|
@onerror A null reference is returned.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Reference< css::uno::XInterface > SAL_CALL createInstanceWithArguments( const ::rtl::OUString& sTypeName ,
|
|
const css::uno::Sequence< css::uno::Any >& seqArguments) throw( css::uno::Exception ,
|
|
css::uno::RuntimeException);
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short not supported
|
|
@descr Please use XNameAcces instead of these!
|
|
|
|
@seealso -
|
|
|
|
@param -
|
|
@return -
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getAvailableServiceNames() throw( css::uno::RuntimeException );
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// XNameAccess
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short return properties of registered frame loader specified by his implementation name
|
|
@descr Use these method to get all informations about our internal loader cache
|
|
and a special frame loader.
|
|
We return a Sequence< PropertyValue > in an Any packed as result.
|
|
|
|
structure of return value:
|
|
[0].Name = "Types"
|
|
[0].Value = list of supported types of these loader as [sequence< oustring >]
|
|
|
|
[1].Name = "UIName"
|
|
[1].Value = localized name of loader as [string]
|
|
|
|
@seealso method getElementNames()
|
|
@seealso method hasByName()
|
|
|
|
@param "sName", the name of searched frame loader (use getElementNames() to get it!)
|
|
@return A Sequence< PropertyValue > packed in an Any.
|
|
|
|
@onerror If given name not exist a NoSuchElementException is thrown.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Any SAL_CALL getByName( const ::rtl::OUString& sName ) throw( css::container::NoSuchElementException ,
|
|
css::lang::WrappedTargetException ,
|
|
css::uno::RuntimeException );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short return list of all well known loader names from configuration
|
|
@descr Use these method to get all names of well known loader.
|
|
You can use it to get the properties of a loader by calling getByName()!
|
|
|
|
@seealso method getByName()
|
|
@seealso method hasByName()
|
|
|
|
@param -
|
|
@return A list of well known loader. Is static at runtime!
|
|
|
|
@onerror No error should occure.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames() throw( css::uno::RuntimeException );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short check if searched frame loader exist in configuration
|
|
@descr Normaly nobody need these method realy (use getElementNames() in combination with getByName()).
|
|
We guarantee correctness of these mechanism. There is no reason to check for existing elements then ...
|
|
but if you have an unknwon name and has no fun to search it in returned sequence ...
|
|
you can call these ...
|
|
|
|
@seealso method getByName()
|
|
@seealso method getElementNames()
|
|
|
|
@param "sName", implementation name of searched frame loader
|
|
@return sal_True if loader exist, sal_False otherwise.
|
|
|
|
@onerror No error should occure.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& sName ) throw( css::uno::RuntimeException );
|
|
|
|
//---------------------------------------------------------------------------------------------------------
|
|
// XElementAccess
|
|
//---------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short return the type of retrun value of method XNameAccess::getByName()
|
|
@descr In these implementation its a Sequence< PropertyValue > everytime!
|
|
|
|
@seealso description of interface XNameAccess
|
|
|
|
@param -
|
|
@return Type of Sequence< PropertyValue >.
|
|
|
|
@onerror No error should occure.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual css::uno::Type SAL_CALL getElementType() throw( css::uno::RuntimeException );
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short return state if informations about frame loader available
|
|
@descr If these method return false - no information could'nt read from configuration ...
|
|
I think nothing will work then. Normaly we return TRUE!
|
|
|
|
@seealso class FilterCache!
|
|
|
|
@param -
|
|
@return sal_True if information available, sal_False otherwise.
|
|
|
|
@onerror No error should occure.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
virtual sal_Bool SAL_CALL hasElements() throw( css::uno::RuntimeException );
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// protected methods
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
protected:
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// private methods
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short try to set configuration properties at created loader
|
|
@descr We support the old async. loader interface ( XFrameLoader ) and the new one XSynchronousFrameLoader.
|
|
The new one should implement a property set on which we can set his configuration values!
|
|
We try to cast given loader to these interface - if it's exist we set the values - otherwise not!
|
|
|
|
@seealso service FrameLoader
|
|
@seealso service SynchronousFrameLoader
|
|
|
|
@param "xLoader" loader with generic XInterface! (We don't know before which service type is used!)
|
|
@param "pLoaderInfo" configuration structure of these loader.
|
|
@return -
|
|
|
|
@onerror No error should occure.
|
|
*//*-*****************************************************************************************************/
|
|
|
|
void impl_initializeLoader( css::uno::Reference< css::uno::XInterface >& xLoader, const Loader& pLoaderInfo );
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// debug methods
|
|
// (should be private everyway!)
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
/*-****************************************************************************************************//**
|
|
@short debug-method to check incoming parameter of some other mehods of this class
|
|
@descr The following methods are used to check parameters for other methods
|
|
of this class. The return value is used directly for an ASSERT(...).
|
|
|
|
@seealso ASSERTs in implementation!
|
|
|
|
@param references to checking variables
|
|
@return sal_False ,on invalid parameter
|
|
@return sal_True ,otherwise
|
|
|
|
@onerror -
|
|
*//*-*****************************************************************************************************/
|
|
|
|
|
|
#ifdef ENABLE_ASSERTIONS
|
|
|
|
private:
|
|
|
|
static sal_Bool impldbg_checkParameter_FrameLoaderFactory ( const css::uno::Reference< css::lang::XMultiServiceFactory >& xFactory );
|
|
static sal_Bool impldbg_checkParameter_createInstance ( const ::rtl::OUString& sTypeName );
|
|
static sal_Bool impldbg_checkParameter_createInstanceWithArguments ( const ::rtl::OUString& sTypeName ,
|
|
const css::uno::Sequence< css::uno::Any >& seqArguments);
|
|
static sal_Bool impldbg_checkParameter_getByName ( const ::rtl::OUString& sName );
|
|
static sal_Bool impldbg_checkParameter_hasByName ( const ::rtl::OUString& sName );
|
|
|
|
#endif // #ifdef ENABLE_ASSERTIONS
|
|
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
// private variables
|
|
// (should be private everyway!)
|
|
//-------------------------------------------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
css::uno::Reference< css::lang::XMultiServiceFactory > m_xFactory ;
|
|
FilterCache m_aCache ;
|
|
|
|
}; // class FrameLoaderFactory
|
|
|
|
} // namespace framework
|
|
|
|
#endif // #ifndef __FRAMEWORK_SERVICES_FRAMELOADERFACTORY_HXX_
|