pcsx2/common/DynamicLibrary.h

80 lines
2.7 KiB
C
Raw Permalink Normal View History

// SPDX-FileCopyrightText: 2002-2024 PCSX2 Dev Team
// SPDX-License-Identifier: GPL-3.0+
2022-12-18 13:04:48 +00:00
#pragma once
2022-12-18 13:04:48 +00:00
#include <string>
class Error;
2022-12-18 13:04:48 +00:00
/**
* 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();
2022-12-18 13:04:48 +00:00
/// Automatically loads the specified library. Call IsOpen() to check validity before use.
DynamicLibrary(const char* filename);
2022-12-18 13:04:48 +00:00
/// Move constructor, transfers ownership.
DynamicLibrary(DynamicLibrary&& move);
2022-12-18 13:04:48 +00:00
/// Closes the library.
~DynamicLibrary();
2022-12-18 13:04:48 +00:00
/// Returns the specified library name with the platform-specific suffix added.
static std::string GetUnprefixedFilename(const char* filename);
2022-12-18 13:04:48 +00:00
/// 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);
2022-12-18 13:04:48 +00:00
/// Returns true if a module is loaded, otherwise false.
bool IsOpen() const { return m_handle != nullptr; }
2022-12-18 13:04:48 +00:00
/// 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, Error* error);
2022-12-18 13:04:48 +00:00
/// Adopts, or takes ownership of an existing opened library.
void Adopt(void* handle);
/// Unloads the library, any function pointers from this library are no longer valid.
void Close();
2022-12-18 13:04:48 +00:00
/// 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;
2022-12-18 13:04:48 +00:00
/// 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;
}
2022-12-18 13:04:48 +00:00
/// Returns the opaque OS-specific handle.
void* GetHandle() const { return m_handle; }
/// Move assignment, transfer ownership.
DynamicLibrary& operator=(DynamicLibrary&& move);
2022-12-18 13:04:48 +00:00
private:
DynamicLibrary(const DynamicLibrary&) = delete;
DynamicLibrary& operator=(const DynamicLibrary&) = delete;
2022-12-18 13:04:48 +00:00
/// Platform-dependent data type representing a dynamic library handle.
void* m_handle = nullptr;
};