LCOV - code coverage report
Current view: top level - include/osl - module.hxx (source / functions) Hit Total Coverage
Test: commit e02a6cb2c3e2b23b203b422e4e0680877f232636 Lines: 25 37 67.6 %
Date: 2014-04-14 Functions: 11 14 78.6 %
Legend: Lines: hit not hit

          Line data    Source code
       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 <rtl/ustring.hxx>
      24             : #include <osl/module.h>
      25             : 
      26             : namespace osl
      27             : {
      28             : 
      29             : class Module
      30             : {
      31             :     Module( const Module&);
      32             :     Module& operator = ( const Module&);
      33             : 
      34             : public:
      35           1 :     static bool getUrlFromAddress(void * addr, ::rtl::OUString & libraryUrl) {
      36           1 :         return osl_getModuleURLFromAddress(addr, &libraryUrl.pData);
      37             :     }
      38             : 
      39             :     /** Get module URL from the specified function address in the module.
      40             : 
      41             :         Similar to getUrlFromAddress, but use a function address to get URL of the Module.
      42             :         Use Function pointer as symbol address to conceal type conversion.
      43             : 
      44             :         @param addr
      45             :         [in] function address in oslGenericFunction format.
      46             : 
      47             :         @param libraryUrl
      48             :         [in|out] receives the URL of the module.
      49             : 
      50             :         @return
      51             :         <dl>
      52             :         <dt>true</dt>
      53             :         <dd>on success</dd>
      54             :         <dt>false</dt>
      55             :         <dd>can not get the URL from the specified function address or the parameter is invalid.</dd>
      56             :         </dl>
      57             : 
      58             :         @see getUrlFromAddress
      59             :     */
      60       85015 :     static bool getUrlFromAddress( oslGenericFunction addr, ::rtl::OUString & libraryUrl){
      61       85015 :         return osl_getModuleURLFromFunctionAddress( addr, &libraryUrl.pData );
      62             :     }
      63             : 
      64           6 :     Module(): m_Module(0){}
      65             : 
      66             : #ifndef DISABLE_DYNLOADING
      67             : 
      68       42508 :     Module( const ::rtl::OUString& strModuleName, sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT) : m_Module(0)
      69             :     {
      70       42508 :         load( strModuleName, nRtldMode);
      71       42508 :     }
      72             : 
      73             : #endif
      74             : 
      75       42514 :     ~Module()
      76             :     {
      77             : #ifndef DISABLE_DYNLOADING
      78       42514 :         osl_unloadModule(m_Module);
      79             : #endif
      80       42514 :     }
      81             : 
      82             : #ifndef DISABLE_DYNLOADING
      83             : 
      84       42510 :     bool SAL_CALL load( const ::rtl::OUString& strModuleName,
      85             :         sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT)
      86             :     {
      87       42510 :         unload();
      88       42510 :         m_Module= osl_loadModule( strModuleName.pData, nRtldMode );
      89       42510 :         return is();
      90             :     }
      91             : 
      92             :     /// @since UDK 3.2.8
      93           0 :     bool SAL_CALL loadRelative(
      94             :         ::oslGenericFunction baseModule, ::rtl::OUString const & relativePath,
      95             :         ::sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
      96             :     {
      97           0 :         unload();
      98           0 :         m_Module = osl_loadModuleRelative(baseModule, relativePath.pData, mode);
      99           0 :         return is();
     100             :     }
     101             : 
     102             :     /// @since LibreOffice 3.5
     103           0 :     bool SAL_CALL loadRelative(
     104             :         oslGenericFunction baseModule, char const * relativePath,
     105             :         sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
     106             :     {
     107           0 :         unload();
     108           0 :         m_Module = osl_loadModuleRelativeAscii(baseModule, relativePath, mode);
     109           0 :         return is();
     110             :     }
     111             : 
     112       42510 :     void SAL_CALL unload()
     113             :     {
     114       42510 :         if (m_Module)
     115             :         {
     116           0 :             osl_unloadModule(m_Module);
     117           0 :             m_Module = 0;
     118             :         }
     119       42510 :     }
     120             : 
     121             : #endif
     122             : 
     123       42516 :     bool SAL_CALL is() const
     124             :     {
     125       42516 :            return m_Module != NULL;
     126             :     }
     127             : 
     128             :     void* SAL_CALL getSymbol( const ::rtl::OUString& strSymbolName)
     129             :     {
     130             :     return ( osl_getSymbol( m_Module, strSymbolName.pData ) );
     131             :     }
     132             : 
     133             :     /** Get function address by the function name in the module.
     134             : 
     135             :         getFunctionSymbol is an alternative function for getSymbol.
     136             :         Use Function pointer as symbol address to conceal type conversion.
     137             : 
     138             :         @param ustrFunctionSymbolName
     139             :         [in] Function name to be looked up.
     140             : 
     141             :         @return
     142             :         <dl>
     143             :         <dt>oslGenericFunction format function address</dt>
     144             :         <dd>on success</dd>
     145             :         <dt>NULL</dt>
     146             :         <dd>lookup failed or parameter is somewhat invalid</dd>
     147             :         </dl>
     148             : 
     149             :         @see getSymbol
     150             :     */
     151          14 :     oslGenericFunction SAL_CALL getFunctionSymbol( const ::rtl::OUString& ustrFunctionSymbolName ) const
     152             :     {
     153          14 :         return ( osl_getFunctionSymbol( m_Module, ustrFunctionSymbolName.pData ) );
     154             :     }
     155             : 
     156             :     /// @since LibreOffice 3.5
     157           0 :     oslGenericFunction SAL_CALL getFunctionSymbol(char const * name) const {
     158           0 :         return osl_getAsciiFunctionSymbol(m_Module, name);
     159             :     }
     160             : 
     161       85008 :     operator oslModule() const
     162             :     {
     163       85008 :         return m_Module;
     164             :     }
     165             : 
     166             :     /** Release the module so that it will not be unloaded from the destructor.
     167             : 
     168             :         This instance returns to the state of a default-constructed instance
     169             :         again.
     170             : 
     171             :         @since LibreOffice 4.3
     172             :     */
     173           4 :     void release() { m_Module = 0; }
     174             : 
     175             : private:
     176             :     oslModule m_Module;
     177             : 
     178             : };
     179             : 
     180             : }
     181             : 
     182             : #endif
     183             : 
     184             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.10