aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/module/Module.h
blob: d618268837a1b5d65006dfcfbc4cf1c7d40e39c3 (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
/**
 * 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 "core/module/Event.h"
#include "core/thread/TaskRunner.h"

namespace GpgFrontend::Module {

class Module;
class GlobalModuleContext;
class ModuleManager;

using ModuleIdentifier = QString;
using ModuleVersion = QString;
using ModuleMetaData = QMap<QString, QString>;
using ModulePtr = std::shared_ptr<Module>;

using TaskRunnerPtr = std::shared_ptr<Thread::TaskRunner>;

class GPGFRONTEND_CORE_EXPORT Module : public QObject {
  Q_OBJECT
 public:
  Module(ModuleIdentifier, ModuleVersion, const ModuleMetaData &);

  explicit Module(QLibrary &module_library);

  ~Module();

  auto IsGood() -> bool;

  virtual auto Register() -> int;

  virtual auto Active() -> int;

  virtual auto Exec(EventReference) -> int;

  virtual auto Deactivate() -> int;

  virtual auto UnRegister() -> int;

  [[nodiscard]] auto GetModuleIdentifier() const -> ModuleIdentifier;

  [[nodiscard]] auto GetModuleVersion() const -> ModuleVersion;

  [[nodiscard]] auto GetModuleMetaData() const -> ModuleMetaData;

  [[nodiscard]] auto GetModulePath() const -> QString;

  [[nodiscard]] auto GetModuleHash() const -> QString;

  [[nodiscard]] auto GetModuleSDKVersion() const -> QString;

  [[nodiscard]] auto GetModuleQtEnvVersion() const -> QString;

  void SetGPC(GlobalModuleContext *);

 protected:
  auto getChannel() -> int;

  auto getDefaultChannel() -> int;

  auto getTaskRunner() -> TaskRunnerPtr;

  auto listenEvent(EventIdentifier) -> bool;

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

}  // namespace GpgFrontend::Module