1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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;
};
|
