aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/module/ModuleManager.h
blob: 2c7d3bee3eb844f3324fbe4438f52fa02ac35902 (plain)
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/**
 * Copyright (C) 2021-2024 Saturneric <[email protected]>
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend 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 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend 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 GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric <[email protected]> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#pragma once

#include <vector>

#include "core/function/SecureMemoryAllocator.h"
#include "core/function/basic/GpgFunctionObject.h"
#include "core/module/Event.h"
#include "core/utils/MemoryUtils.h"

namespace GpgFrontend::Thread {
class TaskRunner;
}

namespace GpgFrontend::Module {

using TaskRunnerPtr = QSharedPointer<Thread::TaskRunner>;

class Event;
class Module;
class GlobalModuleContext;
class ModuleManager;
class GlobalRegisterTable;

using EventReference = QSharedPointer<Event>;
using ModuleIdentifier = QString;
using ModulePtr = QSharedPointer<Module>;
using ModuleMangerPtr = QSharedPointer<ModuleManager>;
using GMCPtr = QSharedPointer<GlobalModuleContext>;
using Namespace = QString;
using Key = QString;
using LPCallback = std::function<void(Namespace, Key, int, std::any)>;

class GPGFRONTEND_CORE_EXPORT ModuleManager
    : public SingletonFunctionObject<ModuleManager> {
 public:
  explicit ModuleManager(int channel);

  virtual ~ModuleManager() override;

  auto LoadModule(QString, bool) -> bool;

  auto SearchModule(ModuleIdentifier) -> ModulePtr;

  void SetNeedRegisterModulesNum(int);

  auto ListAllRegisteredModuleID() -> QStringList;

  void RegisterModule(ModulePtr);

  auto IsAllModulesRegistered() -> bool;

  auto IsModuleActivated(ModuleIdentifier) -> bool;

  auto IsIntegratedModule(ModuleIdentifier) -> bool;

  void ListenEvent(ModuleIdentifier, EventIdentifier);

  void TriggerEvent(EventReference);

  auto SearchEvent(EventTriggerIdentifier) -> std::optional<EventReference>;

  auto GetModuleListening(ModuleIdentifier) -> QStringList;

  void ActiveModule(ModuleIdentifier);

  void DeactivateModule(ModuleIdentifier);

  auto GetTaskRunner(ModuleIdentifier) -> std::optional<TaskRunnerPtr>;

  auto UpsertRTValue(Namespace, Key, std::any) -> bool;

  auto RetrieveRTValue(Namespace, Key) -> std::optional<std::any>;

  auto ListenRTPublish(QObject*, Namespace, Key, LPCallback) -> bool;

  auto ListRTChildKeys(const QString&, const QString&) -> QContainer<Key>;

  auto GRT() -> GlobalRegisterTable*;

 private:
  class Impl;
  SecureUniquePtr<Impl> p_;
};

template <typename T, typename... Args>
void RegisterModule(Args&&... args) {
  ModuleManager::GetInstance().RegisterModule(
      GpgFrontend::SecureCreateSharedObject<T>(std::forward<Args>(args)...));
}

template <typename T, typename... Args>
void RegisterAndActivateModule(Args&&... args) {
  auto& manager = ModuleManager::GetInstance();
  auto module =
      GpgFrontend::SecureCreateSharedObject<T>(std::forward<Args>(args)...);
  manager.RegisterModule(module);
  manager.ActiveModule(module->GetModuleIdentifier());
}

template <typename... Args>
void TriggerEvent(const EventIdentifier& event_id,
                  const Event::Params& params = {},
                  Event::EventCallback e_cb = nullptr) {
  ModuleManager::GetInstance().TriggerEvent(MakeEvent(event_id, params, e_cb));
}

/**
 * @brief
 *
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT IsModuleActivate(ModuleIdentifier) -> bool;

/**
 * @brief
 *
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT IsModuleExists(ModuleIdentifier) -> bool;

/**
 * @brief
 *
 * @param namespace_
 * @param key
 * @param value
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT UpsertRTValue(const QString& namespace_,
                                           const QString& key,
                                           const std::any& value) -> bool;

/**
 * @brief
 *
 * @return true
 * @return false
 */
auto GPGFRONTEND_CORE_EXPORT ListenRTPublishEvent(QObject*, Namespace, Key,
                                                  LPCallback) -> bool;

/**
 * @brief
 *
 * @param namespace_
 * @param key
 * @return QContainer<Key>
 */
auto GPGFRONTEND_CORE_EXPORT ListRTChildKeys(
    const QString& namespace_, const QString& key) -> QContainer<Key>;

template <typename T>
auto RetrieveRTValueTyped(const QString& namespace_,
                          const QString& key) -> std::optional<T> {
  auto any_value =
      ModuleManager::GetInstance().RetrieveRTValue(namespace_, key);
  if (any_value && any_value->type() == typeid(T)) {
    return std::any_cast<T>(*any_value);
  }
  return std::nullopt;
}

template <typename T>
auto RetrieveRTValueTypedOrDefault(const QString& namespace_,
                                   const QString& key,
                                   const T& defaultValue) -> T {
  auto any_value =
      ModuleManager::GetInstance().RetrieveRTValue(namespace_, key);
  if (any_value && any_value->type() == typeid(T)) {
    return std::any_cast<T>(*any_value);
  }
  return defaultValue;
}

}  // namespace GpgFrontend::Module