Compatibility

Installation

Using a package manager

vcpkg install dylib

conan install --requires=dylib/2.2.1

Using CMake Fetch

include(FetchContent)FetchContent_Declare(dylibGIT_REPOSITORY"https://github.com/martin-olivier/dylib"GIT_TAG"v2.2.1")FetchContent_MakeAvailable(dylib)

Documentation

Constructor

// Load "foo" library from the system library pathdyliblib("foo");

// Load "foo" library from relative path "./libs"dyliblib("./libs","foo");// Load "foo" library from full path "/usr/lib"dyliblib("/usr/lib","foo");

// Windows -> "foo.dll"// MacOS   -> "libfoo.dylib"// Linux   -> "libfoo.so"dyliblib("foo");// Windows -> "foo.lib"// MacOS   -> "foo.lib"// Linux   -> "foo.lib"dyliblib("foo.lib", dylib::no_filename_decorations);

Get a function or a variable

// Load "foo" dynamic librarydyliblib("foo");// Get the function "adder" (get_function<T> will return T*)auto adder = lib.get_function<double(double,double)>("adder");// Get the variable "pi_value" (get_variable<T> will return T&)double pi = lib.get_variable<double>("pi_value");// Use the function "adder" with "pi_value"double result = adder(pi, pi);

Miscellaneous tools

dyliblib("foo");if (lib.has_symbol("GetModule") ==false)    std::cerr <<"symbol 'GetModule' not found in 'foo' lib" << std::endl;dylib::native_handle_type handle = lib.native_handle();dylib::native_symbol_type symbol = lib.get_symbol("GetModule");assert(handle !=nullptr && symbol !=nullptr);assert(symbol == dlsym(handle,"GetModule"));

Exceptions

try {    dyliblib("foo");double pi_value = lib.get_variable<double>("pi_value");    std::cout << pi_value << std::endl;}catch (const dylib::load_error &) {    std::cerr <<"failed to load 'foo' library" << std::endl;}catch (const dylib::symbol_error &) {    std::cerr <<"failed to get 'pi_value' symbol" << std::endl;}

Example

Tests

cmake. -B build -DDYLIB_BUILD_TESTS=ONcmake --build build

ctest

Community

Contributing

cmake. -B build -DDYLIB_BUILD_TESTS=ON

git commit -s -m"feat: ..."