LibreOffice
LibreOffice 4.3 SDK C/C++ API Reference
module.hxx
Go to the documentation of this file.
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  static bool getUrlFromAddress(void * addr, ::rtl::OUString & libraryUrl) {
36  return osl_getModuleURLFromAddress(addr, &libraryUrl.pData);
37  }
38 
60  static bool getUrlFromAddress( oslGenericFunction addr, ::rtl::OUString & libraryUrl){
61  return osl_getModuleURLFromFunctionAddress( addr, &libraryUrl.pData );
62  }
63 
64  Module(): m_Module(0){}
65 
66 #ifndef DISABLE_DYNLOADING
67 
68  Module( const ::rtl::OUString& strModuleName, sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT) : m_Module(0)
69  {
70  load( strModuleName, nRtldMode);
71  }
72 
73 #endif
74 
76  {
77 #ifndef DISABLE_DYNLOADING
78  osl_unloadModule(m_Module);
79 #endif
80  }
81 
82 #ifndef DISABLE_DYNLOADING
83 
84  bool SAL_CALL load( const ::rtl::OUString& strModuleName,
85  sal_Int32 nRtldMode = SAL_LOADMODULE_DEFAULT)
86  {
87  unload();
88  m_Module= osl_loadModule( strModuleName.pData, nRtldMode );
89  return is();
90  }
91 
93  bool SAL_CALL loadRelative(
94  ::oslGenericFunction baseModule, ::rtl::OUString const & relativePath,
95  ::sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
96  {
97  unload();
98  m_Module = osl_loadModuleRelative(baseModule, relativePath.pData, mode);
99  return is();
100  }
101 
103  bool SAL_CALL loadRelative(
104  oslGenericFunction baseModule, char const * relativePath,
105  sal_Int32 mode = SAL_LOADMODULE_DEFAULT)
106  {
107  unload();
108  m_Module = osl_loadModuleRelativeAscii(baseModule, relativePath, mode);
109  return is();
110  }
111 
112  void SAL_CALL unload()
113  {
114  if (m_Module)
115  {
116  osl_unloadModule(m_Module);
117  m_Module = 0;
118  }
119  }
120 
121 #endif
122 
123  bool SAL_CALL is() const
124  {
125  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 
151  oslGenericFunction SAL_CALL getFunctionSymbol( const ::rtl::OUString& ustrFunctionSymbolName ) const
152  {
153  return ( osl_getFunctionSymbol( m_Module, ustrFunctionSymbolName.pData ) );
154  }
155 
157  oslGenericFunction SAL_CALL getFunctionSymbol(char const * name) const {
158  return osl_getAsciiFunctionSymbol(m_Module, name);
159  }
160 
161  operator oslModule() const
162  {
163  return m_Module;
164  }
165 
173  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: */
oslGenericFunction getFunctionSymbol(const ::rtl::OUString &ustrFunctionSymbolName) const
Get function address by the function name in the module.
Definition: module.hxx:151
void * getSymbol(const ::rtl::OUString &strSymbolName)
Definition: module.hxx:128
Definition: module.hxx:29
SAL_DLLPUBLIC oslModule osl_loadModuleRelative(oslGenericFunction baseModule, rtl_uString *relativePath, sal_Int32 mode)
Load a module located relative to some other module.
#define SAL_LOADMODULE_DEFAULT
Definition: module.h:51
SAL_DLLPUBLIC void osl_unloadModule(oslModule Module)
Release the module.
bool loadRelative(oslGenericFunction baseModule, char const *relativePath, sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
Definition: module.hxx:103
void * oslModule
Definition: module.h:56
SAL_DLLPUBLIC sal_Bool osl_getModuleURLFromFunctionAddress(oslGenericFunction pf, rtl_uString **pustrFunctionURL)
Lookup URL of module which is mapped at the specified function address.
bool loadRelative(::oslGenericFunction baseModule,::rtl::OUString const &relativePath,::sal_Int32 mode=SAL_LOADMODULE_DEFAULT)
Definition: module.hxx:93
~Module()
Definition: module.hxx:75
Definition: conditn.hxx:30
SAL_DLLPUBLIC oslModule osl_loadModuleRelativeAscii(oslGenericFunction baseModule, char const *relativePath, sal_Int32 mode)
Load a module located relative to some other module.
SAL_DLLPUBLIC oslGenericFunction osl_getAsciiFunctionSymbol(oslModule Module, const sal_Char *pSymbol)
Lookup the specified function symbol name.
SAL_DLLPUBLIC void * osl_getSymbol(oslModule Module, rtl_uString *strSymbolName)
lookup the specified symbol name.
void release()
Release the module so that it will not be unloaded from the destructor.
Definition: module.hxx:173
oslGenericFunction getFunctionSymbol(char const *name) const
Definition: module.hxx:157
void(* oslGenericFunction)(void)
Generic Function pointer type that will be used as symbol address.
Definition: module.h:62
static bool getUrlFromAddress(void *addr,::rtl::OUString &libraryUrl)
Definition: module.hxx:35
SAL_DLLPUBLIC oslGenericFunction osl_getFunctionSymbol(oslModule Module, rtl_uString *ustrFunctionSymbolName)
Lookup the specified function symbol name.
static bool getUrlFromAddress(oslGenericFunction addr,::rtl::OUString &libraryUrl)
Get module URL from the specified function address in the module.
Definition: module.hxx:60
SAL_DLLPUBLIC oslModule osl_loadModule(rtl_uString *strModuleName, sal_Int32 nRtldMode)
Load a shared library or module.
SAL_DLLPUBLIC sal_Bool osl_getModuleURLFromAddress(void *pv, rtl_uString **pustrURL)
Lookup URL of module which is mapped at the specified address.
void unload()
Definition: module.hxx:112
This String class provides base functionality for C++ like Unicode character array handling...
Definition: ustring.hxx:82
Module()
Definition: module.hxx:64
bool load(const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
Definition: module.hxx:84
bool is() const
Definition: module.hxx:123
Module(const ::rtl::OUString &strModuleName, sal_Int32 nRtldMode=SAL_LOADMODULE_DEFAULT)
Definition: module.hxx:68