Files
libreoffice/scripting/source/storage/ScriptStorageManager.hxx

212 lines
8.1 KiB
C++

/*************************************************************************
*
* $RCSfile: ScriptStorageManager.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: jmrice $ $Date: 2002-09-27 12:16:30 $
*
* 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: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _DRAFTS_COM_SUN_STAR_SCRIPT_FRAMEWORK_STORAGE_SCRIPTSTORAGEMANAGER_HXX_
#define _DRAFTS_COM_SUN_STAR_SCRIPT_FRAMEWORK_STORAGE_SCRIPTSTORAGEMANAGER_HXX_
#include <hash_map>
#include <osl/mutex.hxx>
#include <cppuhelper/implbase3.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XEventListener.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <drafts/com/sun/star/script/framework/scripturi/XScriptURI.hpp>
#include <drafts/com/sun/star/script/framework/storage/XScriptStorageManager.hpp>
namespace scripting_impl
{
// Define a hash_map used to store the ScriptingStorages key;d by ID
typedef ::std::hash_map <
sal_Int16,
::com::sun::star::uno::Reference < ::com::sun::star::uno::XInterface > >
ScriptStorage_hash;
class ScriptStorageManager :
public ::cppu::WeakImplHelper3<
::drafts::com::sun::star::script::framework::storage::XScriptStorageManager,
::com::sun::star::lang::XServiceInfo, ::com::sun::star::lang::XEventListener >
{
public:
explicit ScriptStorageManager(
const ::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > & xContext )
SAL_THROW ( (RuntimeException) );
;
~ScriptStorageManager() SAL_THROW ( () );
// XServiceInfo implementation
//======================================================================
virtual ::rtl::OUString SAL_CALL
getImplementationName()
throw(::com::sun::star::uno::RuntimeException);
//----------------------------------------------------------------------
virtual sal_Bool SAL_CALL
supportsService(
const ::rtl::OUString& ServiceName )
throw(::com::sun::star::uno::RuntimeException);
//----------------------------------------------------------------------
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
getSupportedServiceNames()
throw(::com::sun::star::uno::RuntimeException);
//======================================================================
//XScriptStorageManager
//======================================================================
/**
create a ScriptStorage using the XSimpleFileAccess passed as an
argument, and return a ID for getting the associated ScriptStorage
@params xSFA
an implementation of XSimpleFileAccess that knows its own base URL
and can thus take URLs relative to that base.
@returns an unsigned short ScriptStorage ID, which can be used in the
getScriptStorage method
*/
virtual sal_uInt16 SAL_CALL
createScriptStorage(
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XSimpleFileAccess > & xSFA )
throw (::com::sun::star::uno::RuntimeException);
//----------------------------------------------------------------------
/**
create a ScriptStorage using the XSimpleFileAccess, and a string URL
and return a ID for getting the associated ScriptStorage
@params xSFA
a standard implementation of XSimpleFileAccess
@params stringURI
a string URI to the head of the script storage
@returns an unsigned short ScriptStorage ID, which can be used in the
getScriptStorage method
*/
virtual sal_uInt16 SAL_CALL
createScriptStorageWithURI(
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XSimpleFileAccess >& xSFA,
const ::rtl::OUString& stringURI )
throw (::com::sun::star::uno::RuntimeException);
//----------------------------------------------------------------------
/**
get a ScriptStorage component using its scriptStorageID
@params scriptStorageID
the usigned short returned by one of the methods above. ID=0 is
reserved for the application/share scripts, and ID=1 is reserved
for the application/user scripts
@returns an XInterface to a component that implements the ScriptStorage
service
*/
virtual ::com::sun::star::uno::Reference<
::com::sun::star::uno::XInterface > SAL_CALL
getScriptStorage( sal_uInt16 scriptStorageID )
throw (::com::sun::star::uno::RuntimeException);
//======================================================================
//XEventListener
//======================================================================
virtual void SAL_CALL
disposing( const ::com::sun::star::lang::EventObject& Source )
throw (::com::sun::star::uno::RuntimeException);
static const sal_uInt16 APP_SHARE_STORAGE_ID = 0;
static const sal_uInt16 APP_USER_STORAGE_ID = 1;
private:
ScriptStorageManager(const ScriptStorageManager & );
ScriptStorageManager& operator= (const ScriptStorageManager &);
// to obtain other services if needed
::com::sun::star::uno::Reference<
::com::sun::star::uno::XComponentContext > m_xContext;
::com::sun::star::uno::Reference<
::com::sun::star::lang::XMultiComponentFactory > m_xMgr;
::osl::Mutex m_mutex;
ScriptStorage_hash m_ScriptStorageHash;
sal_Int16 m_count;
void setupAppStorage(
const ::com::sun::star::uno::Reference<
::com::sun::star::util::XMacroExpander > & xME,
const ::rtl::OUString & storageStr )
SAL_THROW ( ( ::com::sun::star::uno::RuntimeException ) );
sal_uInt16 setupAnyStorage(
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XSimpleFileAccess> & xSFA,
const ::rtl::OUString & storageStr )
SAL_THROW ( ( ::com::sun::star::uno::RuntimeException ) );
};
} // scripting_impl
#endif //_COM_SUN_STAR_SCRIPTING_STORAGE_SCRIPTSTORAGEMANAGER_HXX_