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
|
/*
* Copyright (C) 2013-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/IAddon.h"
#include "interfaces/generic/ILanguageInvoker.h"
#include "threads/CriticalSection.h"
#include <map>
#include <memory>
#include <set>
#include <vector>
class CLanguageInvokerThread;
typedef std::shared_ptr<CLanguageInvokerThread> CLanguageInvokerThreadPtr;
class CScriptInvocationManager
{
public:
static CScriptInvocationManager& GetInstance();
void Process();
void Uninitialize();
void RegisterLanguageInvocationHandler(ILanguageInvocationHandler *invocationHandler, const std::string &extension);
void RegisterLanguageInvocationHandler(ILanguageInvocationHandler *invocationHandler, const std::set<std::string> &extensions);
void UnregisterLanguageInvocationHandler(ILanguageInvocationHandler *invocationHandler);
bool HasLanguageInvoker(const std::string &script) const;
LanguageInvokerPtr GetLanguageInvoker(const std::string& script);
/*!
* \brief Returns addon_handle if last reusable invoker is ready to use.
*/
int GetReusablePluginHandle(const std::string& script);
/*!
* \brief Executes the given script asynchronously in a separate thread.
*
* \param script Path to the script to be executed
* \param addon (Optional) Addon to which the script belongs
* \param arguments (Optional) List of arguments passed to the script
* \return -1 if an error occurred, otherwise the ID of the script
*/
int ExecuteAsync(const std::string& script,
const ADDON::AddonPtr& addon = ADDON::AddonPtr(),
const std::vector<std::string>& arguments = std::vector<std::string>(),
bool reuseable = false,
int pluginHandle = -1);
/*!
* \brief Executes the given script asynchronously in a separate thread.
*
* \param script Path to the script to be executed
* \param languageInvoker Language invoker to be used to execute the script
* \param addon (Optional) Addon to which the script belongs
* \param arguments (Optional) List of arguments passed to the script
* \return -1 if an error occurred, otherwise the ID of the script
*/
int ExecuteAsync(const std::string& script,
const LanguageInvokerPtr& languageInvoker,
const ADDON::AddonPtr& addon = ADDON::AddonPtr(),
const std::vector<std::string>& arguments = std::vector<std::string>(),
bool reuseable = false,
int pluginHandle = -1);
/*!
* \brief Executes the given script synchronously.
*
* \details The script is actually executed asynchronously but the calling
* thread is blocked until either the script has finished or the given timeout
* has expired. If the given timeout has expired the script's execution is
* stopped and depending on the specified wait behaviour we wait for the
* script's execution to finish or not.
*
* \param script Path to the script to be executed
* \param addon (Optional) Addon to which the script belongs
* \param arguments (Optional) List of arguments passed to the script
* \param timeout (Optional) Timeout (in milliseconds) for the script's execution
* \param waitShutdown (Optional) Whether to wait when having to forcefully stop the script's execution or not.
* \return -1 if an error occurred, 0 if the script terminated or ETIMEDOUT if the given timeout expired
*/
int ExecuteSync(const std::string& script,
const ADDON::AddonPtr& addon = ADDON::AddonPtr(),
const std::vector<std::string>& arguments = std::vector<std::string>(),
uint32_t timeoutMs = 0,
bool waitShutdown = false);
/*!
* \brief Executes the given script synchronously.
*
* \details The script is actually executed asynchronously but the calling
* thread is blocked until either the script has finished or the given timeout
* has expired. If the given timeout has expired the script's execution is
* stopped and depending on the specified wait behaviour we wait for the
* script's execution to finish or not.
*
* \param script Path to the script to be executed
* \param languageInvoker Language invoker to be used to execute the script
* \param addon (Optional) Addon to which the script belongs
* \param arguments (Optional) List of arguments passed to the script
* \param timeout (Optional) Timeout (in milliseconds) for the script's execution
* \param waitShutdown (Optional) Whether to wait when having to forcefully stop the script's execution or not.
* \return -1 if an error occurred, 0 if the script terminated or ETIMEDOUT if the given timeout expired
*/
int ExecuteSync(const std::string& script,
const LanguageInvokerPtr& languageInvoker,
const ADDON::AddonPtr& addon = ADDON::AddonPtr(),
const std::vector<std::string>& arguments = std::vector<std::string>(),
uint32_t timeoutMs = 0,
bool waitShutdown = false);
bool Stop(int scriptId, bool wait = false);
bool Stop(const std::string &scriptPath, bool wait = false);
/*!
*\brief Stop all running scripts
*\param wait if kodi should wait for each script to finish (default false)
*/
void StopRunningScripts(bool wait = false);
bool IsRunning(int scriptId) const;
bool IsRunning(const std::string& scriptPath) const;
protected:
friend class CLanguageInvokerThread;
void OnExecutionDone(int scriptId);
private:
CScriptInvocationManager() = default;
CScriptInvocationManager(const CScriptInvocationManager&) = delete;
CScriptInvocationManager const& operator=(CScriptInvocationManager const&) = delete;
virtual ~CScriptInvocationManager();
typedef struct {
CLanguageInvokerThreadPtr thread;
std::string script;
bool done;
} LanguageInvokerThread;
typedef std::map<int, LanguageInvokerThread> LanguageInvokerThreadMap;
typedef std::map<std::string, ILanguageInvocationHandler*> LanguageInvocationHandlerMap;
LanguageInvokerThread getInvokerThread(int scriptId) const;
LanguageInvocationHandlerMap m_invocationHandlers;
LanguageInvokerThreadMap m_scripts;
CLanguageInvokerThreadPtr m_lastInvokerThread;
int m_lastPluginHandle = -1;
std::map<std::string, int> m_scriptPaths;
int m_nextId = 0;
mutable CCriticalSection m_critSection;
};
|
