ProcessComponentRegistry.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_ENGINE_PLUGINS_PROCESS_COMPONENT_REGISTRY_HPP
#define OPENSWMM_ENGINE_PLUGINS_PROCESS_COMPONENT_REGISTRY_HPP
 
#include <functional>
#include <map>
#include <string>
#include <vector>
 
namespace openswmm {
struct SimulationContext;
struct ProcessComponentSpec;
}
 
namespace openswmm::components {

struct ComponentConfigSections {
    std::string source_path;  
    std::vector<std::pair<std::string, std::vector<std::string>>> sections;

    const std::vector<std::string>* find(const std::string& upper_tag) const {
        for (const auto& s : sections)
            if (s.first == upper_tag) return &s.second;
        return nullptr;
    }
};

std::string read_component_config(const std::string& path,
                                  const std::string& base_dir,
                                  ComponentConfigSections& out);

std::string parse_component_config_text(const std::string& text,
                                        const std::string& label,
                                        ComponentConfigSections& out);

using ComponentConfigApply =
    std::function<void(SimulationContext& ctx,
                       const ProcessComponentSpec& spec,
                       const ComponentConfigSections& config,
                       std::vector<std::string>& errors)>;

using ComponentConfigSave =
    std::function<std::string(const SimulationContext& ctx,
                              const ProcessComponentSpec& spec)>;
 
struct ProcessComponentEntry {
    std::string description;      
    std::string pending_phase;    
    ComponentConfigApply apply;   
    ComponentConfigSave  save;
};

class ProcessComponentRegistry {
public:
    static ProcessComponentRegistry& instance();

    void register_component(const std::string& id, std::string description,
                            ComponentConfigApply apply,
                            ComponentConfigSave save = nullptr);
 
    const ProcessComponentEntry* find(const std::string& id) const;
    std::vector<std::string> known_ids() const;
 
private:
    ProcessComponentRegistry();
    std::map<std::string, ProcessComponentEntry> entries_;
};

std::vector<std::string> resolve_process_components(SimulationContext& ctx,
                                                    const std::string& base_dir);
 
}  // namespace openswmm::components
 
#endif  // OPENSWMM_ENGINE_PLUGINS_PROCESS_COMPONENT_REGISTRY_HPP