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
|
#import "OFObject.h"
@class OFString;
#ifndef OF_WINDOWS
# include <dlfcn.h>
typedef void *OFPluginHandle;
typedef enum {
OFDLOpenFlagLazy = RTLD_LAZY,
OFDLOpenFlagNow = RTLD_NOW
} OFDLOpenFlags;
typedef enum {
OFDLOpenFlagLazy = 0,
OFDLOpenFlagNow = 0
} OFDLOpenFlags;
* @brief Provides a system for loading plugins at runtime.
*
* A plugin must subclass @ref OFPlugin and have a global function called
* `OFPluginInit`, which returns an instance of the @ref OFPlugin subclass and
* takes no parameters.
OFPluginHandle _pluginHandle;
OF_RESERVE_IVARS(OFPlugin, 4)
}
/**
* @brief Loads a plugin from a file.
*
* @param path Path to the plugin file. The suffix is appended automatically.
* @return The loaded plugin
*/
+ (OF_KINDOF(OFPlugin *))pluginWithPath: (OFString *)path;
@end
#ifdef __cplusplus
extern "C" {
#endif
extern OFPluginHandle OFDLOpen(OFString *path, OFDLOpenFlags flags);
extern void *OFDLSym(OFPluginHandle handle, const char *symbol);
extern OFString *_Nullable OFDLError(void);
extern void OFDLClose(OFPluginHandle handle);
#ifdef __cplusplus
}
#endif
|
<
<
<
<
<
<
<
<
<
<
|
<
<
<
>
|
<
|
>
>
>
|
|
|
|
>
>
|
<
>
>
|
>
>
|
>
|
>
>
>
>
|
>
|
<
<
|
>
>
>
>
>
>
>
|
|
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
|
#import "OFObject.h"
@class OFString;
#ifndef OF_WINDOWS
# include <dlfcn.h>
typedef void *OFPluginHandle;
#else
# include <windows.h>
typedef HMODULE OFPluginHandle;
#endif
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFPlugin OFPlugin.h ObjFW/OFPlugin.h
*
* @brief A class representing a loaded plugin (shared library).
*
*/
OF_SUBCLASSING_RESTRICTED
@interface OFPlugin: OFObject
{
OFPluginHandle _handle;
}
/**
* @brief Returns the plugin path for a plugin with the specified name.
*
* E.g. on ELF systems, it appends .so, while on macOS and iOS, it creates the
* appropriate plugin path. This can also be prefixed by a directory.
*
* @param name The name to return the plugin path for
* @return The plugin path
*/
+ (OFString *)pathForName: (OFString *)name;
/**
* @brief Creates a new OFPlugin by loading the plugin with the specified path.
*
* @param path The path to the plugin file. The suffix is appended
* automatically.
* @return An new, autoreleased OFPlugin
*/
+ (instancetype)pluginWithPath: (OFString *)path;
/**
* @brief Initializes an already allocated OFPlugin by loading the plugin with
* the specified path.
*
* @param path The path to the plugin file. The suffix is appended
* automatically.
* @return An initialized OFPlugin
*/
- (instancetype)initWithPath: (OFString *)path;
/**
* @brief Returns the address for the specified symbol, or `nil` if not found.
*
* @param symbol The symbol to return the address for
* @return The address for the speccified symbol, or `nil` if not found
*/
- (nullable void *)addressForSymbol: (OFString *)symbol;
@end
OF_ASSUME_NONNULL_END
|