summaryrefslogtreecommitdiff
path: root/Source/Core/Common/DynamicLibrary.h
diff options
context:
space:
mode:
authorConnor McLaughlin <stenzek@gmail.com>2019-03-29 20:40:06 +1000
committerGitHub <noreply@github.com>2019-03-29 20:40:06 +1000
commitf3fadd730218429a5f6472283d16d30d7e276f8d (patch)
treed1d6577cd52b2d3b3d7872aef4fac80dbd0ce563 /Source/Core/Common/DynamicLibrary.h
parentfbe57e8dbef17e583f0ba0208af7bf414a3716bf (diff)
parentd0d010f8549cc902829f567b3b5127d9a0556ca5 (diff)
Merge pull request #7869 from stenzek/d3dcommon
D3D: Move sharable D3D11/D3D12 code to common library
Diffstat (limited to 'Source/Core/Common/DynamicLibrary.h')
-rw-r--r--Source/Core/Common/DynamicLibrary.h67
1 files changed, 67 insertions, 0 deletions
diff --git a/Source/Core/Common/DynamicLibrary.h b/Source/Core/Common/DynamicLibrary.h
new file mode 100644
index 0000000000..2320ace2e7
--- /dev/null
+++ b/Source/Core/Common/DynamicLibrary.h
@@ -0,0 +1,67 @@
+// Copyright 2019 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#pragma once
+#include <atomic>
+#include <string>
+
+namespace Common
+{
+/**
+ * Provides a platform-independent interface for loading a dynamic library and retrieving symbols.
+ * The interface maintains an internal reference count to allow one handle to be shared between
+ * multiple users.
+ */
+class DynamicLibrary final
+{
+public:
+ // Default constructor, does not load a library.
+ DynamicLibrary();
+
+ // Automatically loads the specified library. Call IsOpen() to check validity before use.
+ DynamicLibrary(const char* filename);
+
+ // Closes the library.
+ ~DynamicLibrary();
+
+ // Returns the specified library name with the platform-specific suffix added.
+ static std::string GetUnprefixedFilename(const char* filename);
+
+ // Returns the specified library name in platform-specific format.
+ // Major/minor versions will not be included if set to -1.
+ // If libname already contains the "lib" prefix, it will not be added again.
+ // Windows: LIBNAME-MAJOR-MINOR.dll
+ // Linux: libLIBNAME.so.MAJOR.MINOR
+ // Mac: libLIBNAME.MAJOR.MINOR.dylib
+ static std::string GetVersionedFilename(const char* libname, int major = -1, int minor = -1);
+
+ // Returns true if a module is loaded, otherwise false.
+ bool IsOpen() const { return m_handle != nullptr; }
+
+ // Loads (or replaces) the handle with the specified library file name.
+ // Returns true if the library was loaded and can be used.
+ bool Open(const char* filename);
+
+ // Unloads the library, any function pointers from this library are no longer valid.
+ void Close();
+
+ // Returns the address of the specified symbol (function or variable) as an untyped pointer.
+ // If the specified symbol does not exist in this library, nullptr is returned.
+ void* GetSymbolAddress(const char* name) const;
+
+ // Obtains the address of the specified symbol, automatically casting to the correct type.
+ // Returns true if the symbol was found and assigned, otherwise false.
+ template <typename T>
+ bool GetSymbol(const char* name, T* ptr) const
+ {
+ *ptr = reinterpret_cast<T>(GetSymbolAddress(name));
+ return *ptr != nullptr;
+ }
+
+private:
+ // Platform-dependent data type representing a dynamic library handle.
+ void* m_handle = nullptr;
+};
+
+} // namespace Common