Files
libreoffice/scripting/source/runtimemgr/ScriptRuntimeManager.hxx
2011-03-29 21:40:28 +01:00

153 lines
6.0 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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_SCRIPT_SCRIPTRUNTIMEMANAGER_HXX_
#define _FRAMEWORK_SCRIPT_SCRIPTRUNTIMEMANAGER_HXX_
#include <osl/mutex.hxx>
#include <cppuhelper/implbase3.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/uno/RuntimeException.hpp>
#include <com/sun/star/lang/XMultiComponentFactory.hpp>
#include <com/sun/star/script/CannotConvertException.hpp>
#include <com/sun/star/reflection/InvocationTargetException.hpp>
#include <drafts/com/sun/star/script/framework/runtime/XScriptInvocation.hpp>
#include <drafts/com/sun/star/script/framework/runtime/XScriptNameResolver.hpp>
namespace scripting_runtimemgr
{
// for simplification
#define css ::com::sun::star
#define dcsssf ::drafts::com::sun::star::script::framework
/**
* Class responsible for managing the various ScriptRuntime implementations.
*/
class ScriptRuntimeManager : public
::cppu::WeakImplHelper3< dcsssf::runtime::XScriptInvocation, css::lang::XServiceInfo,
dcsssf::runtime::XScriptNameResolver >
{
public:
explicit ScriptRuntimeManager(
const css::uno::Reference< css::uno::XComponentContext > & xContext );
~ScriptRuntimeManager();
// XServiceInfo implementation
virtual ::rtl::OUString SAL_CALL getImplementationName()
throw( css::uno::RuntimeException );
virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
throw( css::uno::RuntimeException );
virtual css::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames()
throw( css::uno::RuntimeException );
/**
* implements XScriptInvocation, invokes the script named in scriptURI
* (resolving it first, if necessary), with the args passed.
*
* @param scriptURI the URI, which may not be fully qualified, for the
* script to be invoked
*
*************************************************************
Invoke
@param scriptUri script uri describing the script
@param invocationCtx
the invocation context contains the documentStorageID and document reference
for use in script name resolving
@param aParams all parameters; pure, out params are undefined in sequence,
i.e., the value has to be ignored by the callee
@param aOutParamIndex out indices
@param aOutParam out parameters
@returns
the value returned from the function being invoked
@throws IllegalArgumentException
if there is no matching script name
@throws CannotConvertException
if args do not match or cannot be converted the those
of the invokee
@throws InvocationTargetException
if the running script throws an exception this information is captured and
rethrown as this exception type.
*/
virtual css::uno::Any SAL_CALL invoke(
const ::rtl::OUString & scriptUri,
const css::uno::Any& invocationCtx,
const css::uno::Sequence< css::uno::Any >& aParams,
css::uno::Sequence< sal_Int16 >& aOutParamIndex,
css::uno::Sequence< css::uno::Any >& aOutParam )
throw ( css::lang::IllegalArgumentException,
css::script::CannotConvertException,
css::reflection::InvocationTargetException,
css::uno::RuntimeException );
/**
* implements XScriptNameResolver, attempts to resolve the script URI
* passed in
*
* @param scriptURI the URI to be resolved
* @param invocationCtx the invocation context contains the
* documentStorageID and document reference for use in script name
* resolving. On full name resolution it sets the resolvedScriptStorageID to
* the actual storage location of the fully resolved script. May or may not * be the
same as the documentStorageID.
* @return the resolved URI
*/
virtual css::uno::Reference< dcsssf::storage::XScriptInfo > SAL_CALL resolve(
const ::rtl::OUString& scriptUri,
css::uno::Any& invocationCtx )
throw( css::lang::IllegalArgumentException, css::script::CannotConvertException,
css::uno::RuntimeException );
private:
css::uno::Reference< dcsssf::runtime::XScriptInvocation > SAL_CALL getScriptRuntime(
const css::uno::Reference< css::uno::XInterface > & scriptInfo )
throw( css::uno::RuntimeException );
css::uno::Reference< dcsssf::runtime::XScriptNameResolver > SAL_CALL getScriptNameResolver()
throw( css::uno::RuntimeException );
css::uno::Reference< css::uno::XComponentContext > m_xContext;
css::uno::Reference< css::lang::XMultiComponentFactory > m_xMgr;
::osl::Mutex m_mutex;
};
} // scripting_runtimemgr
#endif //_FRAMEWORK_SCRIPT_SCRIPTRUNTIMEMANAGER_HXX_
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */