Merge pull request #2 from fasiondog/feature/plugin

fasiondog · web-flow · commit fa1f4f52a3da · 2025-04-06T16:15:05.000+08:00
Feature/plugin
diff --git a/cppcheck.cppcheck b/cppcheck.cppcheck
@@ -13,5 +13,8 @@
         <library>boost</library>
         <library>sqlite3</library>
     </libraries>
+    <suppressions>
+        <suppression>unusedFunction</suppression>
+    </suppressions>
     <project-name>cppcheck</project-name>
 </project>
diff --git a/hikyuu/utilities/plugin/PluginBase.h b/hikyuu/utilities/plugin/PluginBase.h
@@ -0,0 +1,47 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-18
+ *      Author: fasiondog
+ */
+
+#pragma once
+#ifndef HKU_UTILS_PLUGIN_BASE_H_
+#define HKU_UTILS_PLUGIN_BASE_H_
+
+#include <string>
+#include "hikyuu/utilities/config.h"
+#include "hikyuu/utilities/osdef.h"
+
+namespace hku {
+
+class PluginBase {
+public:
+    PluginBase() = default;
+    virtual ~PluginBase() = default;
+
+    /**
+     * @brief 返回插件信息
+     * @details
+     * 插件信息为json格式，包含name(string)、version(int)、description(string)、author(string)字段
+     * 如：{"name":"unknown","version": 1.0,"description":"","author":"unknown"}
+     * @return std::string
+     */
+    virtual std::string info() const noexcept = 0;
+};
+
+}  // namespace hku
+
+#if HKU_OS_WINDOWS
+#define HKU_PLUGIN_DEFINE(plugin)                                      \
+    extern "C" __declspec(dllexport) hku::PluginBase* createPlugin() { \
+        return new plugin();                                           \
+    }
+#else
+#define HKU_PLUGIN_DEFINE(plugin)                \
+    extern "C" hku::PluginBase* createPlugin() { \
+        return new plugin();                     \
+    }
+#endif
+
+#endif /* HKU_UTILS_PLUGIN_BASE_H_ */
diff --git a/hikyuu/utilities/plugin/PluginClient.h b/hikyuu/utilities/plugin/PluginClient.h
@@ -0,0 +1,55 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-04-06
+ *      Author: fasiondog
+ */
+
+#pragma once
+
+#include "PluginLoader.h"
+
+namespace hku {
+
+template <typename InterfaceT>
+class PluginClient : public InterfaceT {
+public:
+    PluginClient() = delete;
+    PluginClient(const std::string &path, const std::string &filename) {
+        m_loader = std::make_unique<PluginLoader>(path);
+        m_loader->load(filename);
+        m_impl = m_loader->instance<InterfaceT>();
+    }
+    virtual ~PluginClient() = default;
+
+    PluginClient(const PluginClient &) = delete;
+    PluginClient &operator=(const PluginClient &) = delete;
+
+    PluginClient(PluginClient &&rhs) : m_impl(rhs.m_impl), m_loader(std::move(rhs.m_loader)) {
+        rhs.m_impl = nullptr;
+    }
+
+    PluginClient &operator=(PluginClient &&rhs) {
+        if (this != &rhs) {
+            m_loader = std::move(rhs.m_loader);
+            m_impl = rhs.m_impl;
+            rhs.m_impl = nullptr;
+        }
+    }
+
+    std::string info() const noexcept override {
+        return m_impl->info();
+    }
+
+    InterfaceT *getPlugin() const {
+        return m_impl;
+    }
+
+protected:
+    InterfaceT *m_impl;
+
+protected:
+    std::unique_ptr<PluginLoader> m_loader;
+};
+
+}  // namespace hku
diff --git a/hikyuu/utilities/plugin/PluginLoader.cpp b/hikyuu/utilities/plugin/PluginLoader.cpp
@@ -0,0 +1,84 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-18
+ *      Author: fasiondog
+ */
+
+#include "hikyuu/utilities/osdef.h"
+#include "hikyuu/utilities/os.h"
+#include "PluginLoader.h"
+
+#if HKU_OS_WINDOWS
+#include <windows.h>
+#else
+#include <dlfcn.h>
+#endif
+
+namespace hku {
+
+PluginLoader::PluginLoader() : PluginLoader(".") {}
+
+PluginLoader::PluginLoader(const std::string& path) : m_path(path) {}
+
+PluginLoader::~PluginLoader() {
+    unload();
+}
+
+std::string PluginLoader::getFileName(const std::string& pluginname) const noexcept {
+#if HKU_OS_WINDOWS
+    return fmt::format("{}/{}.dll", m_path, pluginname);
+#elif HKU_OS_LINUX
+    return fmt::format("{}/lib{}.so", m_path, pluginname);
+#elif HKU_OS_OSX
+    return fmt::format("{}/lib{}.dylib", m_path, pluginname);
+#endif
+}
+
+void* PluginLoader::getFunciton(const char* symbol) noexcept {
+#if HKU_OS_WINDOWS
+    void* func = GetProcAddress(m_handle, symbol);
+#else
+    void* func = dlsym(m_handle, symbol);
+#endif
+    return func;
+}
+
+bool PluginLoader::load(const std::string& pluginname) noexcept {
+    std::string filename = getFileName(pluginname);
+    HKU_WARN_IF_RETURN(!existFile(filename), false, "file({}) not exist!", filename);
+
+#if HKU_OS_WINDOWS
+    m_handle = LoadLibrary(HKU_PATH(filename).c_str());
+#else
+    m_handle = dlopen(filename.c_str(), RTLD_LAZY);
+#endif
+    HKU_WARN_IF_RETURN(!m_handle, false, "load plugin({}) failed!", filename);
+
+    typedef PluginBase* (*CreateFunction)();
+    CreateFunction createFunction = reinterpret_cast<CreateFunction>(getFunciton("createPlugin"));
+    HKU_WARN_IF_RETURN(!createFunction, false, "Failed to get plugin({}) handle!", filename);
+
+    m_plugin.reset(createFunction());
+    if (!m_plugin) {
+        HKU_ERROR("Failed to create plugin ({})!", filename);
+        unload();
+        m_plugin.reset();
+        return false;
+    }
+
+    return true;
+}
+
+void PluginLoader::unload() noexcept {
+    m_plugin.reset();
+    if (m_handle) {
+#if HKU_OS_WINDOWS
+        FreeLibrary(m_handle);
+#else
+        dlclose(m_handle);
+#endif
+    }
+}
+
+}  // namespace hku
diff --git a/hikyuu/utilities/plugin/PluginLoader.h b/hikyuu/utilities/plugin/PluginLoader.h
@@ -0,0 +1,64 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-18
+ *      Author: fasiondog
+ */
+
+#pragma once
+#ifndef HKU_UTILS_PLUGIN_LOADER_H_
+#define HKU_UTILS_PLUGIN_LOADER_H_
+
+#include <mutex>
+#include <string>
+#include <memory>
+#include "hikyuu/utilities/config.h"
+#include "hikyuu/utilities/osdef.h"
+#include "hikyuu/utilities/Log.h"
+#include "PluginBase.h"
+
+#if HKU_OS_WINDOWS
+#include <windows.h>
+#endif
+
+#ifndef HKU_UTILS_API
+#define HKU_UTILS_API
+#endif
+
+namespace hku {
+
+class HKU_UTILS_API PluginLoader final {
+public:
+    PluginLoader();
+    explicit PluginLoader(const std::string& path);
+    PluginLoader(const PluginLoader&) = delete;
+    PluginLoader(PluginLoader&&) = delete;
+
+    ~PluginLoader();
+
+    bool load(const std::string& pluginname) noexcept;
+
+    template <typename T>
+    T* instance() const noexcept {
+        HKU_IF_RETURN(!m_plugin, nullptr);
+        return dynamic_cast<T*>(m_plugin.get());
+    }
+
+private:
+    void unload() noexcept;
+    void* getFunciton(const char* symbol) noexcept;
+    std::string getFileName(const std::string& pluginname) const noexcept;
+
+private:
+#if HKU_OS_WINDOWS
+    HMODULE m_handle{nullptr};
+#else
+    void* m_handle{nullptr};
+#endif
+    std::string m_path;
+    std::unique_ptr<PluginBase> m_plugin{nullptr};
+};
+
+}  // namespace hku
+
+#endif /* HKU_UTILS_PLUGIN_LOADER_H_ */
diff --git a/test/plugin/TestPlugin.cpp b/test/plugin/TestPlugin.cpp
@@ -0,0 +1,22 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-19
+ *      Author: fasiondog
+ */
+
+#include "TestPlugin.h"
+
+namespace hku {
+
+std::string TestPlugin::name() const {
+    return "testplugin";
+}
+
+std::string TestPlugin::info() const noexcept {
+    return R"({"name":"unknown","version": 1.0,"description":"","author":"unknown"})";
+}
+
+}  // namespace hku
+
+HKU_PLUGIN_DEFINE(hku::TestPlugin)
diff --git a/test/plugin/TestPlugin.h b/test/plugin/TestPlugin.h
@@ -0,0 +1,25 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-19
+ *      Author: fasiondog
+ */
+
+#pragma once
+
+#include <string>
+#include "hikyuu/utilities/plugin/PluginBase.h"
+#include "TestPluginInterface.h"
+
+namespace hku {
+
+class TestPlugin : public TestPluginInterface {
+public:
+    TestPlugin() = default;
+    virtual ~TestPlugin() = default;
+
+    virtual std::string name() const override;
+    virtual std::string info() const noexcept override;
+};
+
+}  // namespace hku
diff --git a/test/plugin/TestPluginInterface.h b/test/plugin/TestPluginInterface.h
@@ -0,0 +1,21 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-04-06
+ *      Author: fasiondog
+ */
+
+#pragma once
+#include <hikyuu/utilities/plugin/PluginLoader.h>
+
+namespace hku {
+
+class TestPluginInterface : public PluginBase {
+public:
+    TestPluginInterface() = default;
+    virtual ~TestPluginInterface() = default;
+
+    virtual std::string name() const = 0;
+};
+
+}  // namespace hku
diff --git a/test/utilities/plugin/test_Plugin.cpp b/test/utilities/plugin/test_Plugin.cpp
@@ -0,0 +1,34 @@
+/*
+ *  Copyright (c) 2025 hikyuu.org
+ *
+ *  Created on: 2025-03-19
+ *      Author: fasiondog
+ */
+
+#include "test_config.h"
+#include "hikyuu/utilities/os.h"
+#include "hikyuu/utilities/plugin/PluginClient.h"
+#include "../../plugin/TestPluginInterface.h"
+#include <cstdlib>
+
+using namespace hku;
+
+class TestPluginClient : public PluginClient<TestPluginInterface> {
+public:
+    TestPluginClient(const std::string &path, const std::string &filename)
+    : PluginClient<TestPluginInterface>(path, filename) {}
+
+    virtual std::string name() const override {
+        HKU_CHECK(m_impl, "Plugin not loaded!");
+        return m_impl->name();
+    }
+};
+
+TEST_CASE("test_plugin") {
+    TestPluginClient plugin1(".", "testplugin");
+    TestPluginClient plugin = std::move(plugin1);
+    CHECK_EQ(plugin.name(), "testplugin");
+    CHECK_THROWS(plugin1.name());
+    HKU_INFO("{}", plugin.name());
+    HKU_INFO("{}", plugin.info());
+}
diff --git a/test/xmake.lua b/test/xmake.lua
diff --git a/xmake.lua b/xmake.lua
