include/osl/module.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_OSL_MODULE_HXX
  21 #define INCLUDED_OSL_MODULE_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <cstddef>
  26
  27 #include <rtl/ustring.hxx>
  28 #include <osl/module.h>
  29
  30 namespace osl
  31 {
  32
  33 class Module
  34 {
  35     Module( const Module&) SAL_DELETED_FUNCTION;
  36     Module& operator = ( const Module&) SAL_DELETED_FUNCTION;
  37
  38 public:
  39     static bool getUrlFromAddress(void * addr, ::rtl::OUString & libraryUrl) {
  40         return osl_getModuleURLFromAddress(addr, &libraryUrl.pData);
  41     }
  42
  43     /** Get module URL from the specified function address in the module.
  44
  45         Similar to getUrlFromAddress, but use a function address to get URL of the Module.
  46         Use Function pointer as symbol address to conceal type conversion.
  47
  48         @param addr
  49         [in] function address in oslGenericFunction format.
  50
  51         @param libraryUrl
  52         [in|out] receives the URL of the module.
  53
  54         @retval true on success
  55         @retval false can not get the URL from the specified function address or the parameter is invalid.
  56
  57         @see getUrlFromAddress
  58     */
  59     static bool getUrlFromAddress( oslGenericFunction addr, ::rtl::OUString & libraryUrl){
  60         return osl_getModuleURLFromFunctionAddress( addr, &libraryUrl.pData );
  61     }
  62
  63     Module(): m_Module(NULL){}
  64
  65 #ifndef DISABLE_DYNLOADING
  66
  67     Module( const ::rtl::OUString& strModuleName, sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT) : m_Module(NULL)
  68     {
  69         load( strModuleName, nRtldMode);
  70     }
  71
  72 #endif
  73
  74     ~Module()
  75     {
  76 #ifndef DISABLE_DYNLOADING
  77         osl_unloadModule(m_Module);
  78 #endif
  79     }
  80
  81 #ifndef DISABLE_DYNLOADING
  82
  83     bool SAL_CALL load( const ::rtl::OUString& strModuleName,
  84         sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT)
  85     {
  86         unload();
  87         m_Module= osl_loadModule( strModuleName.pData, nRtldMode );
  88         return is();
  89     }
  90
  91     /// @since UDK 3.2.8
  92     bool SAL_CALL loadRelative(
  93         ::oslGenericFunction baseModule, ::rtl::OUString const & relativePath,
  94         ::sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
  95     {
  96         unload();
  97         m_Module = osl_loadModuleRelative(baseModule, relativePath.pData, mode);
  98         return is();
  99     }
 100
 101     /// @since LibreOffice 3.5
 102     bool SAL_CALL loadRelative(
 103         oslGenericFunction baseModule, char const * relativePath,
 104         sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
 105     {
 106         unload();
 107         m_Module = osl_loadModuleRelativeAscii(baseModule, relativePath, mode);
 108         return is();
 109     }
 110
 111     void SAL_CALL unload()
 112     {
 113         if (m_Module)
 114         {
 115             osl_unloadModule(m_Module);
 116             m_Module = NULL;
 117         }
 118     }
 119
 120 #endif
 121
 122     bool SAL_CALL is() const
 123     {
 124            return m_Module != NULL;
 125     }
 126
 127     void* SAL_CALL getSymbol( const ::rtl::OUString& strSymbolName)
 128     {
 129     return ( osl_getSymbol( m_Module, strSymbolName.pData ) );
 130     }
 131
 132     /** Get function address by the function name in the module.
 133
 134         getFunctionSymbol is an alternative function for getSymbol.
 135         Use Function pointer as symbol address to conceal type conversion.
 136
 137         @param ustrFunctionSymbolName
 138         [in] Function name to be looked up.
 139
 140         @retval oslGenericFunction format function address on success
 141         @retval NULL lookup failed or parameter is somewhat invalid
 142
 143         @see getSymbol
 144     */
 145     oslGenericFunction SAL_CALL getFunctionSymbol( const ::rtl::OUString& ustrFunctionSymbolName ) const
 146     {
 147         return ( osl_getFunctionSymbol( m_Module, ustrFunctionSymbolName.pData ) );
 148     }
 149
 150     /// @since LibreOffice 3.5
 151     oslGenericFunction SAL_CALL getFunctionSymbol(char const * name) const {
 152         return osl_getAsciiFunctionSymbol(m_Module, name);
 153     }
 154
 155     operator oslModule() const
 156     {
 157         return m_Module;
 158     }
 159
 160     /** Release the module so that it will not be unloaded from the destructor.
 161
 162         This instance returns to the state of a default-constructed instance
 163         again.
 164
 165         @since LibreOffice 4.3
 166     */
 167     void release() { m_Module = NULL; }
 168
 169 private:
 170     oslModule m_Module;
 171
 172 };
 173
 174 }
 175
 176 #endif
 177
 178 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */