diff options
Diffstat (limited to 'sal/inc/osl/module.hxx')
-rw-r--r-- | sal/inc/osl/module.hxx | 158 |
1 files changed, 158 insertions, 0 deletions
diff --git a/sal/inc/osl/module.hxx b/sal/inc/osl/module.hxx new file mode 100644 index 000000000000..fd787569b454 --- /dev/null +++ b/sal/inc/osl/module.hxx @@ -0,0 +1,158 @@ +/************************************************************************* + * + * 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. + * + ************************************************************************/ + +/** @HTML */ + +#ifndef _OSL_MODULE_HXX_ +#define _OSL_MODULE_HXX_ + +#include <rtl/ustring.hxx> +#include <osl/module.h> + +namespace osl +{ + +class Module +{ + Module( const Module&); + Module& operator = ( const Module&); + +public: + static sal_Bool getUrlFromAddress(void * addr, ::rtl::OUString & libraryUrl) { + return osl_getModuleURLFromAddress(addr, &libraryUrl.pData); + } + + /** Get module URL from the specified function address in the module. + + Similar to getUrlFromAddress, but use a function address to get URL of the Module. + Use Function pointer as symbol address to conceal type conversion. + + @param addr + [in] function address in oslGenericFunction format. + + @param libraryUrl + [in|out] receives the URL of the module. + + @return + <dl> + <dt>sal_True</dt> + <dd>on success</dd> + <dt>sal_False</dt> + <dd>can not get the URL from the specified function address or the parameter is invalid.</dd> + </dl> + + @see getUrlFromAddress + */ + static sal_Bool getUrlFromAddress( oslGenericFunction addr, ::rtl::OUString & libraryUrl){ + return osl_getModuleURLFromFunctionAddress( addr, &libraryUrl.pData ); + } + + Module(): m_Module(0){} + + Module( const ::rtl::OUString& strModuleName, sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT) : m_Module(0) + { + load( strModuleName, nRtldMode); + } + + ~Module() + { + osl_unloadModule(m_Module); + } + + sal_Bool SAL_CALL load( const ::rtl::OUString& strModuleName, + sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT) + { + unload(); + m_Module= osl_loadModule( strModuleName.pData, nRtldMode ); + return is(); + } + + /// @since UDK 3.2.8 + sal_Bool SAL_CALL loadRelative( + ::oslGenericFunction baseModule, ::rtl::OUString const & relativePath, + ::sal_Int32 mode = SAL_LOADMODULE_DEFAULT) + { + unload(); + m_Module = osl_loadModuleRelative(baseModule, relativePath.pData, mode); + return is(); + } + + void SAL_CALL unload() + { + if (m_Module) + { + osl_unloadModule(m_Module); + m_Module = 0; + } + } + + sal_Bool SAL_CALL is() const + { + return m_Module != NULL; + } + + void* SAL_CALL getSymbol( const ::rtl::OUString& strSymbolName) + { + return ( osl_getSymbol( m_Module, strSymbolName.pData ) ); + } + + /** Get function address by the function name in the module. + + getFunctionSymbol is an alternative function for getSymbol. + Use Function pointer as symbol address to conceal type conversion. + + @param ustrFunctionSymbolName + [in] Function name to be looked up. + + @return + <dl> + <dt>oslGenericFunction format function address</dt> + <dd>on success</dd> + <dt>NULL</dt> + <dd>lookup failed or parameter is somewhat invalid</dd> + </dl> + + @see getSymbol + */ + oslGenericFunction SAL_CALL getFunctionSymbol( const ::rtl::OUString& ustrFunctionSymbolName ) + { + return ( osl_getFunctionSymbol( m_Module, ustrFunctionSymbolName.pData ) ); + } + + operator oslModule() const + { + return m_Module; + } + +private: + oslModule m_Module; + +}; + +} + +#endif |