C++ cross-platform wrapper around dynamic loading of shared libraries (dll, so, dylib)
CPack
installationMinGW
support, requested by @lonnietcCPack
support, requested by @KOLANICHWIN32_LEAN_AND_MEAN
macro redefinition, thanks to @Aleksoid1978CMake
improvements, thanks to @rmaxi-meworkflows
improvementsstd::filesystem::path
support in dylib contructordylib::add_filename_decorations
and dylib::no_filename_decorations
constantsdylib::get_symbol
public member functiondylib::native_symbol_type
public member type definitionopen()
, close()
and default constructor
are not available anymore
// old API
dylib lib("./libs/libfoo", dylib::extension);
// new API
dylib lib("./libs", "foo");
The dylib class can now load a dynamic library from the system library path
// Load "foo" library from the system library path
dylib lib("foo");
The dylib class will now automatically add os decorations (os prefix and suffix) to the library name, but you can disable that by setting decorations parameter to false
// Windows -> "foo.dll"
// MacOS -> "libfoo.dylib"
// Linux -> "libfoo.so"
dylib lib("foo");
// Windows -> "foo.lib"
// MacOS -> "foo.lib"
// Linux -> "foo.lib"
dylib lib("foo.lib", false);
The return type of get_function
is now a function pointer instead of an std::function
// old API
std::function<double(double, double)> adder = lib.get_function<double(double, double)>("adder");
// new API
double (*adder)(double, double) = lib.get_function<double(double, double)>("adder");
handle_error
exception is now called load_error
try {
dylib lib("foo");
lib.get_function<double(double, double)>("adder");
}
// old API
catch (const dylib::handle_error &e) {
std::cout << e.what() << std::endl;
}
// new API
catch (const dylib::load_error &e) {
std::cout << e.what() << std::endl;
}
To ensure the functions and variable of your future dynamic library will be exported on windows, you can use the following macro
#if defined(_WIN32) || defined(_WIN64)
#define LIB_EXPORT __declspec(dllexport)
#else
#define LIB_EXPORT
#endif
Or, you can add the following cmake rule that will export all symbols on windows
if(MSVC)
set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS TRUE)
endif()
Make sure to mark the functions and variables you want to export as
extern "C"
to avoid name mangling
Since dylib
now handles libs prefix, you will need to remove the following cmake rule when building your dynamic libs
# remove the following rule from your cmakelists if you was using it with dylib 1.X.X
set_target_properties(target PROPERTIES PREFIX "")
Huge thanks to @eyalroz for his help and contributions that made this update possible !
CMake
build system, thanks to @plevoldcpplint
native_handle
functionfetchContent
examplestd::string
overload for ctor
and open
nullptr
is passed as argument in get_function
or get_variable
when no dynamic lib is currently loadedhas_symbol
functionoperator bool()
void dylib_symbol_example(const dylib &lib)
{
if (lib.has_symbol("GetModule"))
std::cout << "GetModule has been found" << std::endl;
else
std::cout << "Could not found GetModule symbol" << std::endl;
}
void dylib_status_example(const dylib &lib)
{
if (lib)
std::cout << "something is curently loaded in the dylib object" << std::endl;
if (!lib)
std::cout << "nothing is curently loaded in the dylib object" << std::endl;
}