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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "addons/Addon.h"
#include "addons/kodi-dev-kit/include/kodi/c-api/addon_base.h"
#include <map>
#include <memory>
#include <string>
class DllAddon;
namespace ADDON
{
class CBinaryAddonBase;
using BinaryAddonBasePtr = std::shared_ptr<CBinaryAddonBase>;
/*!
* Addon instance handler, used as identify for std::map to find related
* addon instance. This class itself not accessed here.
*
* @todo As long game addon system use CAddonDll itself and not
* IAddonInstanceHandler as parent, is the set of this as "void*" needed.
* After game system is changed should by this also changed to
* "const IAddonInstanceHandler*" or direct in map below.
*/
using ADDON_INSTANCE_HANDLER = void*;
/*!
* @brief Information class for use on addon type managers.
*
* This to query via @ref CAddonDll the manager so that work can be performed.
* If there are multiple instances it be harder to be informed about any changes.
*/
class CAddonDllInformer
{
public:
virtual ~CAddonDllInformer() = default;
virtual bool IsInUse(const std::string& id) = 0;
};
class CAddonDll : public CAddon
{
public:
CAddonDll(const AddonInfoPtr& addonInfo, BinaryAddonBasePtr addonBase);
CAddonDll(const AddonInfoPtr& addonInfo, AddonType addonType);
~CAddonDll() override;
// Implementation of IAddon via CAddon
std::string LibPath() const override;
// addon settings
void SaveSettings(AddonInstanceId id = ADDON_SETTINGS_ID) override;
bool DllLoaded(void) const;
/*!
* @brief Get api version of moduleType type
*
* @return The version of requested type, if dll is loaded and supported by addon.
* If one of both do not match, an empty version is returned.
*
* @note This should only be called if the associated dll is loaded.
* Otherwise use @ref CAddonInfo::DependencyVersion(...)
*/
CAddonVersion GetTypeVersionDll(int type) const;
/*!
* @brief Get api min version of moduleType type
*
* @return The version of requested type, if dll is loaded and supported by addon.
* If one of both do not match, an empty version is returned.
*
* @note This should only be called if the associated dll is loaded.
* Otherwise use @ref CAddonInfo::DependencyMinVersion(...)
*/
CAddonVersion GetTypeMinVersionDll(int type) const;
/*!
* @brief Function to create a addon instance class
*
* @param[in,out] instance The for addon used data structure for active instance
* @return The status of addon after the creation.
*/
ADDON_STATUS CreateInstance(KODI_ADDON_INSTANCE_STRUCT* instance);
/*!
* @brief Function to destroy a on addon created instance class
*
* @param[in] instance The for addon used data structure for active instance
*/
void DestroyInstance(KODI_ADDON_INSTANCE_STRUCT* instance);
bool IsInUse() const override;
void RegisterInformer(CAddonDllInformer* informer);
AddonPtr GetRunningInstance() const override;
void OnPreInstall() override;
void OnPostInstall(bool update, bool modal) override;
void OnPreUnInstall() override;
void OnPostUnInstall() override;
bool Initialized() const { return m_initialized; }
protected:
static std::string GetDllPath(const std::string& strFileName);
std::string m_parentLib;
private:
/*!
* @brief Main addon creation call function
*
* This becomes called only one time before a addon instance becomes created.
* If another instance becomes requested is this Create no more used. To see
* like a "int main()" on exe.
*
* @param[in] firstKodiInstance The first instance who becomes used.
* In case addon supports only one instance
* and not multiple together can addon use
* only one complete class for everything.
* This is used then to interact on interface.
* @return The status of addon after the creation.
*/
ADDON_STATUS Create(KODI_ADDON_INSTANCE_STRUCT* firstKodiInstance);
/*!
* @brief Main addon destroying call function
*
* This becomes called only one time after the last addon instance becomes destroyed.
*/
void Destroy();
bool CheckAPIVersion(int type);
BinaryAddonBasePtr m_binaryAddonBase = nullptr;
DllAddon* m_pDll = nullptr;
bool m_initialized = false;
bool LoadDll();
std::map<ADDON_INSTANCE_HANDLER, KODI_ADDON_INSTANCE_STRUCT*> m_usedInstances;
CAddonDllInformer* m_informer = nullptr;
virtual ADDON_STATUS TransferSettings(AddonInstanceId instanceId);
/*!
* This structure, which is fixed to the addon headers, makes use of the at
* least supposed parts for the interface.
* This structure is defined in:
* /xbmc/addons/kodi-dev-kit/include/kodi/AddonBase.h
*/
AddonGlobalInterface m_interface = {};
};
} /* namespace ADDON */
|
