1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/* Copyright (C) 2002 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
_DEFS(glibmm,glib)
#include <glibmmconfig.h>
#include <string>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
extern "C" { typedef struct _GModule GModule; }
#endif
namespace Glib
{
//TODO: Replace get_last_error() with exceptions?
//Provide operator()?
/** Dynamic loading of modules.
*
* These functions provide a portable way to dynamically load object
* files (commonly known as 'plug-ins'). The current implementation
* supports all systems that provide an implementation of dlopen()
* (e.g. Linux/Sun), as well as HP-UX via its shl_load() mechanism,
* and Windows platforms via DLLs.
*/
class GLIBMM_API Module
{
_CLASS_GENERIC(Module, GModule)
_IGNORE(g_module_open, g_module_close)
public:
_WRAP_ENUM(Flags, GModuleFlags, NO_GTYPE, decl_prefix GLIBMM_API)
/** Opens a module.
*
* If the module has already been opened, its reference count
* is incremented. If not, the module is searched in the following order:
*
* 1. If @a file_name exists as a regular file, it is used as-is; else
* 2. If @a file_name doesn't have the correct suffix and/or prefix for the
* platform, then possible suffixes and prefixes will be added to the
* basename till a file is found and whatever is found will be used; else
* 3. If @a file_name doesn't have the ".la"-suffix, ".la" is appended. Either
* way, if a matching .la file exists (and is a libtool archive) the
* libtool archive is parsed to find the actual file name, and that is
* used.
*
* At the end of all this, we would have a file path that we can access on
* disk, and it is opened as a module. If not, @a file_name is opened as
* a module verbatim in the hopes that the system implementation will somehow
* be able to access it.
*
* Use operator bool() to see whether the operation succeeded. For instance,
* @code
* Glib::Module module("plugins/helloworld");
* if(module)
* {
* void* func = nullptr;
* bool found = get_symbol("some_function", func);
* }
* @endcode
*
* @param file_name The name or path to the file containing the module,
* or an empty string to obtain a module representing
* the main program itself.
* @param flags The flags used for opening the module.
*/
explicit Module(const std::string& file_name, Flags flags = Flags(0));
Module(const Module&) = delete;
Module& operator=(const Module&) = delete;
Module(Module&& other) noexcept;
Module& operator=(Module&& other) noexcept;
/** Close a module. The module will be removed from memory, unless
* <tt>make_resident</tt> has been called.
*/
virtual ~Module();
/** Check whether the module was found.
*/
explicit operator bool() const;
/** Checks if modules are supported on the current platform.
* @returns true if available, false otherwise
*/
_WRAP_METHOD(static bool get_supported(), g_module_supported)
/** Ensures that a module will never be unloaded. Any calls to the
* Glib::Module destructor will not unload the module.
*/
_WRAP_METHOD(void make_resident(), g_module_make_resident)
/** Gets a string describing the last module error.
* @returns The error string
*/
_WRAP_METHOD(static std::string get_last_error(), g_module_error)
/** Gets a symbol pointer from the module.
* @param symbol_name The name of the symbol to lookup
* @param symbol A pointer to set to the symbol
* @returns True if the symbol was found, false otherwise.
*/
_WRAP_METHOD(bool get_symbol(const std::string& symbol_name, void*& symbol) const, g_module_symbol)
/** Get the name of the module.
* @returns The name of the module
*/
_WRAP_METHOD(std::string get_name() const, g_module_name)
/** A portable way to build the filename of a module. The
* platform-specific prefix and suffix are added to the filename, if
* needed, and the result is added to the directory, using the
* correct separator character.
*
* The directory should specify the directory where the module can
* be found. It can be an empty string to indicate that the
* module is in a standard platform-specific directory, though this
* is not recommended since the wrong module may be found.
*
* For example, calling <tt>build_path()</tt> on a Linux
* system with a directory of <tt>/lib</tt> and a module_name of
* "mylibrary" will return <tt>/lib/libmylibrary.so</tt>. On a
* Windows system, using <tt>\\Windows</tt> as the directory it will
* return <tt>\\Windows\\mylibrary.dll</tt>.
*
* @param directory The directory the module is in
* @param module_name The name of the module
* @returns The system-specific filename of the module
*
* @deprecated 2.76: You will get the wrong results most of the time.
* Use the constructor instead with @a module_name as the
* basename of the file_name argument.
*/
_WRAP_METHOD(static std::string build_path(const std::string& directory, const std::string& module_name),
g_module_build_path, deprecated)
GModule* gobj() { return gobject_; }
const GModule* gobj() const { return gobject_; }
protected:
GModule* gobject_;
};
} // namespace Glib
|
