plugin_manager.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/defines.h"
#include "hal_core/plugin_system/fac_extension_interface.h"
#include "hal_core/plugin_system/plugin_interface_base.h"
#include "hal_core/utilities/callback_hook.h"
#include "hal_core/utilities/program_options.h"
 
#include <functional>
#include <map>
#include <memory>
#include <string>
#include <tuple>
 
namespace hal
{
    class UIPluginInterface;
 
    namespace plugin_manager
    {
        void add_existing_options_description(const ProgramOptions& existing_options);
 
        std::set<std::string> get_plugin_names();
 
        std::filesystem::path get_plugin_path(std::string plugin_name);
 
        std::unordered_map<std::string, std::string> get_cli_plugin_flags();
 
        std::unordered_map<std::string, std::string> get_ui_plugin_flags();
 
        ProgramOptions get_cli_plugin_options();
 
        bool load_all_plugins(const std::vector<std::filesystem::path>& directory_names = {});
 
        bool load(const std::string& plugin_name, const std::filesystem::path& file_path = std::filesystem::path());
 
        bool unload_all_plugins();
 
        bool unload(const std::string& plugin_name);
 
        BasePluginInterface* get_plugin_instance(const std::string& plugin_name, bool initialize = true, bool silent = false);
 
        template<typename T>
        T* get_plugin_instance(const std::string& plugin_name, bool initialize = true)
        {
            return dynamic_cast<T*>(get_plugin_instance(plugin_name, initialize));
        }
 
        UIPluginInterface* get_ui_plugin();
 
        template<typename T>
        T* get_first_extension(const std::string& plugin_name, bool initialize = true)
        {
            BasePluginInterface* bpif = get_plugin_instance(plugin_name, initialize);
            if (!bpif)
                return nullptr;
            return bpif->get_first_extension<T>();
        }
 
        u64 add_model_changed_callback(std::function<void(bool, std::string const&, std::string const&)> callback);
 
        void remove_model_changed_callback(u64 id);
 
        struct PluginFeature
        {
            FacExtensionInterface::Feature feature;
            std::vector<std::string> args;
            std::string description;
        };
 
        bool has_valid_file_extension(std::filesystem::path file_name);
 
        std::vector<PluginFeature> get_plugin_features(std::string name);
 
    }    // namespace plugin_manager
}    // namespace hal