File: SharedLib.h

package info (click to toggle)
spring 104.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 47,512 kB
  • sloc: cpp: 391,093; ansic: 79,943; python: 12,356; java: 12,201; awk: 5,889; sh: 1,826; xml: 655; makefile: 486; perl: 405; php: 211; objc: 194; sed: 2
file content (65 lines) | stat: -rw-r--r-- 1,518 bytes parent folder | download | duplicates (7)
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
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef SHAREDLIB_H
#define SHAREDLIB_H

#include <string>

/**
 * @brief shared library loader base
 *
 * Base shared library loading class definitiion.
 * This is the abstract shared library class used for
 * polymorphic loading. Platform-specifics should
 * derive from this.
 */
class SharedLib
{
public:
	/**
	 * @brief instantiate
	 * @param fileName file name as a C string
	 * @return platform-specific shared library class
	 */
	static SharedLib* Instantiate(const char* fileName);

	/**
	 * @brief instantiate
	 * @param fileName file name as a C++ string
	 * @return platform-specific shared library class
	 */
	static SharedLib* Instantiate(const std::string& fileName);

	/**
	 * Explicitly unload this shared library
	 * @brief unload
	 */
	virtual void Unload() = 0;

	/**
	 * Returns true if loading of the native library failed.
	 * @brief loadFailed
	 */
	virtual bool LoadFailed() = 0;

	/**
	 * @brief GetLibExtension
	 * @return "dll", "dylib" or "so" depending on OS
	 */
	static const char* GetLibExtension();

	/**
	 * @brief Find Address
	 * @param symbol function name (symbol) to locate
	 *
	 * Abstract so it must be implemented specifically by all platforms.
	 */
	virtual void* FindAddress(const char* symbol) = 0;

	virtual ~SharedLib();

protected:
	static void reportError(const char* errorMsg, const char* fileName = "???", int lineNumber = -1, const char* function = "???");
};

#endif // SHAREDLIB_H