From 4c3251ec645c8b71820dab7e51e612e5919d4e75 Mon Sep 17 00:00:00 2001
From: manuel <manuel@mausz.at>
Date: Sun, 23 Jul 2017 16:59:43 +0200
Subject: sync with upstream

---
 .../include/kodi/tools/DllHelper.h                 | 129 +++++++++++++++++++++
 1 file changed, 129 insertions(+)
 create mode 100644 xbmc/addons/kodi-addon-dev-kit/include/kodi/tools/DllHelper.h

(limited to 'xbmc/addons/kodi-addon-dev-kit/include/kodi/tools/DllHelper.h')

diff --git a/xbmc/addons/kodi-addon-dev-kit/include/kodi/tools/DllHelper.h b/xbmc/addons/kodi-addon-dev-kit/include/kodi/tools/DllHelper.h
new file mode 100644
index 0000000..232f67d
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/include/kodi/tools/DllHelper.h
@@ -0,0 +1,129 @@
+#pragma once
+/*
+ *      Copyright (C) 2005-2017 Team Kodi
+ *      http://kodi.tv
+ *
+ *  This Program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2, or (at your option)
+ *  any later version.
+ *
+ *  This Program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Kodi; see the file COPYING.  If not, see
+ *  <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#include <string>
+#include <kodi/AddonBase.h>
+
+#ifdef _WIN32                   // windows
+#include <p8-platform/windows/dlfcn-win32.h>
+#else
+#include <dlfcn.h>              // linux+osx
+#endif
+
+#define REGISTER_DLL_SYMBOL(functionPtr) \
+  CDllHelper::RegisterSymbol(functionPtr, #functionPtr)
+
+/// @brief Class to help with load of shared library functions
+///
+/// You can add them as parent to your class and to help with load of shared
+/// library functions.
+///
+/// @note To use on Windows must you also include p8-platform on your addon!
+///
+///
+/// ----------------------------------------------------------------------------
+///
+/// **Example:**
+/// ~~~~~~~~~~~~~{.cpp}
+///
+/// #include <kodi/tools/DllHelper.h>
+///
+/// ...
+/// class CMyInstance : public kodi::addon::CInstanceAudioDecoder,
+///                     private CDllHelper
+/// {
+/// public:
+///   CMyInstance(KODI_HANDLE instance);
+///   bool Start();
+///
+///   ...
+///
+///   /* The pointers for on shared library exported functions */
+///   int (*Init)();
+///   void (*Cleanup)();
+///   int (*GetLength)();
+/// };
+///
+/// CMyInstance::CMyInstance(KODI_HANDLE instance)
+///   : CInstanceAudioDecoder(instance)
+/// {
+/// }
+///
+/// bool CMyInstance::Start()
+/// {
+///   std::string lib = kodi::GetAddonPath("myLib.so");
+///   if (!LoadDll(lib)) return false;
+///   if (!REGISTER_DLL_SYMBOL(Init)) return false;
+///   if (!REGISTER_DLL_SYMBOL(Cleanup)) return false;
+///   if (!REGISTER_DLL_SYMBOL(GetLength)) return false;
+///
+///   Init();
+///   return true;
+/// }
+/// ...
+/// ~~~~~~~~~~~~~
+///
+class CDllHelper
+{
+public:
+  CDllHelper() : m_dll(nullptr) { }
+  virtual ~CDllHelper()
+  {
+    if (m_dll)
+      dlclose(m_dll);
+  }
+
+  /// @brief Function to load requested library
+  ///
+  /// @param[in] path         The path with filename of shared library to load
+  /// @return                 true if load was successful done
+  ///
+  bool LoadDll(const std::string& path)
+  {
+    m_dll = dlopen(path.c_str(), RTLD_LAZY);
+    if (m_dll == nullptr)
+    {
+      kodi::Log(ADDON_LOG_ERROR, "Unable to load %s", dlerror());
+      return false;
+    }
+    return true;
+  }
+
+  /// @brief Function to register requested library symbol
+  ///
+  /// @note This function should not be used, use instead the macro
+  /// REGISTER_DLL_SYMBOL to register the symbol pointer.
+  ///
+  template <typename T>
+  bool RegisterSymbol(T& functionPtr, const char* strFunctionPtr)
+  {
+    functionPtr = reinterpret_cast<T>(dlsym(m_dll, strFunctionPtr));
+    if (functionPtr == nullptr)
+    {
+      kodi::Log(ADDON_LOG_ERROR, "Unable to assign function %s", dlerror());
+      return false;
+    }
+    return true;
+  }
+
+private:
+  void* m_dll;
+};
-- 
cgit v1.2.3