IPluginComponentInfo.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP
#define OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP
 
#include <string>
#include <vector>
#include "PluginState.hpp"
 
namespace openswmm {
 
/* Forward declarations */
class IInputPlugin;
class IOutputPlugin;
class IReportPlugin;
class IStateIOPlugin;

enum class PluginType {
    INPUT,    
    OUTPUT,   
    REPORT,   
    STATE_IO  
};

enum class PluginRole : int {
    INPUT_READ,    
    OUTPUT_WRITE,  
    REPORT_WRITE,  
    STATE_READ,    
    STATE_WRITE    
};

inline const char* plugin_role_to_string(PluginRole role) noexcept {
    switch (role) {
        case PluginRole::INPUT_READ:    return "INPUT_READ";
        case PluginRole::OUTPUT_WRITE:  return "OUTPUT_WRITE";
        case PluginRole::REPORT_WRITE:  return "REPORT_WRITE";
        case PluginRole::STATE_READ:    return "STATE_READ";
        case PluginRole::STATE_WRITE:   return "STATE_WRITE";
        default:                        return "UNKNOWN";
    }
}

struct FileFilter {
    std::string description;

    std::vector<std::string> patterns;

    PluginRole role = PluginRole::INPUT_READ;

    std::vector<std::string> mime_types;
};

struct RegistrationInfo {
    std::string license_key;   
    std::string organization;  
    std::string contact_email; 
    std::string deployment_id; 
};

class IPluginComponentInfo {
public:
    virtual ~IPluginComponentInfo() = default;
 
    // -----------------------------------------------------------------------
    // Identity & metadata
    // -----------------------------------------------------------------------

    virtual std::string id() const = 0;

    virtual std::string caption() const = 0;

    virtual std::string description() const = 0;

    virtual std::string version() const = 0;

    virtual std::string vendor() const = 0;

    virtual std::string url() const = 0;

    virtual std::vector<std::string> tags() const { return {}; }
 
    // -----------------------------------------------------------------------
    // Licensing
    // -----------------------------------------------------------------------

    virtual std::string license_type() const = 0;

    virtual std::string license_text() const = 0;
 
    // -----------------------------------------------------------------------
    // Capability queries
    // -----------------------------------------------------------------------

    virtual bool has_input() const noexcept { return false; }

    virtual bool has_output() const noexcept { return false; }

    virtual bool has_report() const noexcept { return false; }

    virtual bool has_state_io() const noexcept { return false; }
 
    // -----------------------------------------------------------------------
    // File-filter advertisement (every plugin)
    // -----------------------------------------------------------------------

    virtual std::vector<FileFilter> file_filters() const { return {}; }
 
    // -----------------------------------------------------------------------
    // Registration
    // -----------------------------------------------------------------------

    virtual bool register_plugin(const RegistrationInfo& info) {
        (void)info;
        return true;
    }

    virtual bool registered() const noexcept { return true; }

    virtual RegistrationInfo registration_info() const { return {}; }
 
    // -----------------------------------------------------------------------
    // Factory methods
    // -----------------------------------------------------------------------

    virtual IInputPlugin* create_input_plugin() const { return nullptr; }

    virtual IOutputPlugin* create_output_plugin() const { return nullptr; }

    virtual IReportPlugin* create_report_plugin() const { return nullptr; }

    virtual IStateIOPlugin* create_state_io_plugin() const { return nullptr; }
};
 
// ---------------------------------------------------------------------------
// C factory function signature that plugin .so/.dylib/.dll must export
// ---------------------------------------------------------------------------

using PluginInfoFactory = IPluginComponentInfo*(*)();
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_IPLUGIN_COMPONENT_INFO_HPP */