aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/module/Module.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/module/Module.h')
-rw-r--r--src/core/module/Module.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/src/core/module/Module.h b/src/core/module/Module.h
new file mode 100644
index 00000000..2a5b54e7
--- /dev/null
+++ b/src/core/module/Module.h
@@ -0,0 +1,80 @@
+/**
+ * Copyright (C) 2021 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 = std::map<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&);
+
+ ~Module();
+
+ virtual auto Register() -> bool = 0;
+
+ virtual auto Active() -> bool = 0;
+
+ virtual auto Exec(EventRefrernce) -> int = 0;
+
+ virtual auto Deactive() -> bool = 0;
+
+ [[nodiscard]] auto GetModuleIdentifier() const -> ModuleIdentifier;
+
+ 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 \ No newline at end of file