PluginDiscovery.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_PLUGIN_DISCOVERY_HPP
#define OPENSWMM_PLUGIN_DISCOVERY_HPP
 
#include <string>
#include <vector>
 
#include "IPluginComponentInfo.hpp"
 
/* =========================================================================
 * Export macro
 *
 * The engine target sets WINDOWS_EXPORT_ALL_SYMBOLS OFF and relies on explicit
 * export macros (see src/engine/CMakeLists.txt). On ELF/Mach-O the target's
 * CXX_VISIBILITY_PRESET is `default`, so omitting the macro still exports the
 * symbol — which is why the unannotated declarations below linked fine on
 * Linux/macOS while failing on Windows with:
 *     error LNK2001: unresolved external symbol openswmm::discover_all_filters
 * Block is byte-identical to the one in openswmm_engine.h / openswmm_2d.h;
 * identical macro redefinition is well-defined, so including those alongside
 * this header is safe.
 * ========================================================================= */
 
#ifdef OPENSWMM_ENGINE_STATIC
#  define SWMM_ENGINE_API
#else
#  ifdef _WIN32
#    ifdef openswmm_engine_EXPORTS
#      define SWMM_ENGINE_API __declspec(dllexport)
#    else
#      define SWMM_ENGINE_API __declspec(dllimport)
#    endif
#  else
#    define SWMM_ENGINE_API __attribute__((visibility("default")))
#  endif
#endif
 
namespace openswmm {

struct DiscoveredFilter {
    std::string  plugin_id;       
    std::string  plugin_version;  
    std::string  plugin_caption;  
    FileFilter   filter;          

    bool         is_builtin = false;
};

SWMM_ENGINE_API std::vector<DiscoveredFilter> discover_all_filters();

struct DiscoveredPlugin {
    std::string                plugin_id;       
    std::string                plugin_version;  
    std::string                plugin_caption;  
    std::vector<PluginRole>    roles;           
    std::vector<FileFilter>    filters;         

    bool                       is_builtin = false;
};

SWMM_ENGINE_API std::vector<DiscoveredPlugin> discover_plugins_by_id();
 
} /* namespace openswmm */
 
#endif /* OPENSWMM_PLUGIN_DISCOVERY_HPP */