multi platform shared library

Author: JohanMabille

CMakeLists.txt

@@ -35,10 +35,33 @@ message(STATUS "Building xplugin v${${PROJECT_NAME}_VERSION}")
 
 set(XPLUGIN_HEADERS
     ${XPLUGIN_INCLUDE_DIR}/xplugin/xplugin_config.hpp
+    ${XPLUGIN_INCLUDE_DIR}/xplugin/xshared_library.hpp
     )
 
 set(XPLUGIN_SOURCES
+    ${XPLUGIN_SOURCE_DIR}/xunix_shared_library.cpp
+    ${XPLUGIN_SOURCE_DIR}/xwindows_shared_library.cpp
     )
 
 # Output
 # ======
+
+add_library(xplugin SHARED ${XPLUGIN_SOURCES} ${XPLUGIN_HEADERS})
+
+if (APPLE)
+    set_target_properties(xplugin PROPERTIES
+        MACOSX_RPATH ON
+    )
+    set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib; ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
+else()
+    set_target_properties(xplugin PROPERTIES
+        BUILD_WITH_INSTALL_RPATH 1
+    )
+    set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib; ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}")
+    set(CMAKE_SKIP_BUILD_RPATH FALSE)
+    set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
+endif()
+
+target_include_directories(xplugin PUBLIC $<BUILD_INTERFACE:${XPLUGIN_INCLUDE_DIR}>
+                                       $<INSTALL_INTERFACE:include>)
+

include/xplugin/xplugin_config.hpp

@@ -20,7 +20,6 @@
     #define XPLUGIN_API
 #endif
 
-// Project version
 #define XPLUGIN_VERSION_MAJOR 0
 #define XPLUGIN_VERSION_MINOR 0
 #define XPLUGIN_VERSION_PATCH 0

include/xplugin/xshared_library.hpp

@@ -0,0 +1,55 @@
+/***************************************************************************
+* Copyright (c) 2018, Johan Mabille, Sylvain Corlay, Wolf Vollprecht and   *
+* Martin Renou                                                             *
+*                                                                          *
+* Distributed under the terms of the BSD 3-Clause License.                 *
+*                                                                          *
+* The full license is in the file LICENSE, distributed with this software. *
+****************************************************************************/
+
+#include <string>
+
+#include "xplugin_config.hpp"
+
+namespace xp
+{
+    class XPLUGIN_API xshared_library
+    {
+    public:
+
+        virtual ~xshared_library() {}
+
+        xshared_library(const xshared_library&) = delete;
+        xshared_library& operator=(const xshared_library&) = delete;
+
+        xshared_library(xshared_library&&) = delete;
+        xshared_library& operator=(xshared_library&&) = delete;
+
+        static xshared_library* open(const std::string& name);
+        static void close(xshared_library* library);
+        static const char* get_error();
+
+        template <class T>
+        T find_symbol(const std::string& name);
+
+    protected:
+
+        xshared_library() {}
+
+    private:
+
+        virtual void* find_symbol(const std::string& name) = 0;
+    };
+
+    template <class T>
+    inline T xshared_library::find_symbol(const std::string& name)
+    {
+        return reinterpret_cast<T>(name);
+    }
+
+    inline void xshared_library::close(xshared_library* library)
+    {
+        delete library;
+    }
+}
+

src/xunix_shared_library.cpp

@@ -0,0 +1,60 @@
+/***************************************************************************
+* Copyright (c) 2018, Johan Mabille, Sylvain Corlay, Wolf Vollprecht and   *
+* Martin Renou                                                             *
+*                                                                          *
+* Distributed under the terms of the BSD 3-Clause License.                 *
+*                                                                          *
+* The full license is in the file LICENSE, distributed with this software. *
+****************************************************************************/
+
+#if (defined(__linux__) || defined(__unix__) || defined(__APPLE__))
+
+#include <dlfcn.h>
+#include "xplugin/xshared_library.hpp"
+
+namespace xp
+{
+    class xunix_shared_library : public xshared_library
+    {
+    public:
+
+        xunix_shared_library(void* handle);
+        virtual ~xunix_shared_library();
+
+    private:
+
+        void* find_symbol(const std::string& name);
+
+        void* m_handle;
+    };
+
+    xunix_shared_library::xunix_shared_library(void* handle)
+        : m_handle(handle)
+    {
+    }
+
+    xunix_shared_library::~xunix_shared_library()
+    {
+        dlclose(m_handle);
+        m_handle = nullptr;
+    }
+
+    void* xunix_shared_library::find_symbol(const std::string& name)
+    {
+        void* sym = dlsym(m_handle, name.c_str());
+        return sym;
+    }
+
+    const char* xshared_library::get_error()
+    {
+        return dlerror();
+    }
+
+    xshared_library* xshared_library::open(const std::string& name)
+    {
+        void* handle = dlopen(name.c_str(), RTLD_NOW | RTLD_GLOBAL);
+        return handle ? new xunix_shared_library(handle) : nullptr;
+    }
+}
+
+#endif

src/xwindows_shared_library.cpp

@@ -0,0 +1,66 @@
+/***************************************************************************
+* Copyright (c) 2018, Johan Mabille, Sylvain Corlay, Wolf Vollprecht and   *
+* Martin Renou                                                             *
+*                                                                          *
+* Distributed under the terms of the BSD 3-Clause License.                 *
+*                                                                          *
+* The full license is in the file LICENSE, distributed with this software. *
+****************************************************************************/
+
+#ifdef _WIN32
+
+#include <windows.h>
+#include "xplugin/xshared_library.hpp"
+
+namespace xp
+{
+    class xwindows_shared_library : public xshared_library
+    {
+    public:
+
+    private:
+        
+        xwindows_shared_library(HINSTANCE handle);
+        virtual ~xwindows_shared_library();
+
+    private:
+
+        void* find_symbol(const std::string& name);
+
+        HINSTANCE m_handle;
+    };
+
+    xwindows_shared_library::xwindows_shared_library(HINSTANCE handle)
+        : m_handle(handle)
+    {
+    }
+
+    xwindows_shared_library::~xwindows_shared_library()
+    {
+        FreeLibrary(m_handle);
+    }
+
+    void* xindows_shared_library::find_symbol(const std::string& name)
+    {
+        void* sym = GetProcAddress(name.c_str());
+        return sym;
+    }
+
+    const char* xwindows_shared_library::get_error()
+    {
+        char buffer[255];
+        FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM,0,GetLastError(),
+                      0, buffer,sizeof(buffer),0);
+        return buffer;
+    }
+
+    xshared_library* xshared_library::open(const std::string& name)
+    {
+        HINSTANCE handle = LoadLibrary(name.c_str());
+        return handle ? new xwindows_shared_library(handle) : nullptr;
+    }
+
+}
+
+#endif
+