Module.h

// Copyright 2026 Matteo Fusi and Contributors
//
// 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 SIMO_MODULE_HH
#define SIMO_MODULE_HH
 
#include <Simo/core/Log.h>
#include <Simo/core/Time.h>
 
#include <string>
 
#include "Simo/core/InitializationStatus.h"
#include "Simo/parameter/ParameterTrie.h"
#include "Simo/port/Port.h"
#include "Simo/statistics/StatMapper.h"
 
namespace Simo {
 
class Context;

class SIMO_PUBLIC Parameters {
 public:
  virtual ~Parameters() = default;
 
  [[nodiscard]] std::string_view name() const;
 
  template <typename Self>
  Self& name(this Self& self, const std::string_view name) {
    self.name_ = name;
    return self;
  }
 
  // TODO make it to return a list of errors

  [[nodiscard]] virtual bool check() const;

  template <typename T>
  [[maybe_unused]]
  Parameter::ParameterTyped<T>& set(const std::string& name, const T& value) {
    return trie.add<T>(name, value);
  }

  template <typename T>
  [[nodiscard]] Parameter::ParameterTyped<T>* get(
      const std::string& name) const {
    return trie.find<T>(name);
  }
 
  [[nodiscard]] Parameter::Parameter* get(const std::string& name) const {
    return trie.find(name);
  }

  [[nodiscard]] std::optional<Parameters> get_subtree(
      const std::string& name) const;
 
  template <typename Function>
  void visit(Function f) {
    trie.visit(f);
  }
 
 protected:
  Parameter::ParameterTrie trie;
  std::string name_;
};

class SIMO_PUBLIC Module {
 public:
  [[nodiscard]]
  virtual InitializationStatus initialize(Context& sim_ctx_v,
                                          const Parameters& parameters);
 
  [[nodiscard]] std::string_view name() const;
 
  [[nodiscard]] constexpr std::string name_of_child(
      const std::string_view child) const {
    return name_ + "/" + std::string(child);
  }
 
  [[nodiscard]] Context& sim_ctx() const;
 
  virtual ~Module() {}

  void record_statistics(Statistics::StatMapper& mapper);

  [[nodiscard]] Port* get_port(std::string_view);

  template <typename T>
  [[nodiscard]]
  T get_port(std::string_view name)
    requires std::is_pointer_v<T>
  {
    Port* port = get_port(name);
    if (port == nullptr) {
      return nullptr;
    }
    return boost::typeindex::runtime_cast<T>(port);
  }

  template <typename T>
    requires(!std::is_pointer_v<T>)
  [[nodiscard]]
  T* get_port(std::string_view name) {
    return get_port<T*>(name);
  }
 
  struct PortWithFullName {
    std::string full_name;
    Port* port;
  };

  std::vector<PortWithFullName> get_unconnected_ports(
      bool include_nested_components) const;
 
  Time current_time() const;
 
  template <typename Stat>
  Stat* get_statistic(const std::string_view name) {
    return statistics.get<Stat>(name);
  }
 
  template <typename Function>
  void visit_statistics(Function f) {
    statistics.visit(f);
  }

  virtual InitializationStatus log_setup(const std::filesystem::path& out_file);
  InitializationStatus log_setup();

  void log_enable(bool new_value);
 
  void log_level(size_t level);
  void log_level(std::string_view level_name);

  template <typename Callable>
  void log(size_t level, Callable&& callable) {
    auto f = [this, callable]() {
      return std::format("[{}] [{}] {}\n", current_time(), name(), callable());
    };
    log_raw_callable(level, true, f);
  }

  template <typename Callable>
  void log_raw_callable(size_t level, bool print_level, Callable&& callable) {
    logger.log_callable(level, print_level, std::forward<Callable>(callable));
  }
 
  void populate_default_log_levels();
 
  Log::Logger& get_logger() { return logger; }

  template <typename T, typename... Args>
  T& create_statistic(Args... args) {
    T& s = statistics.emplace<T>(std::forward<Args>(args)...);
    return s;
  }

  template <typename T, typename... Args>
  T& create_port(const std::string_view name, Args... args) {
    auto ptr = std::make_unique<T>(std::forward<Args>(args)...);
    T& out_ref = *ptr;
    ports[std::string(name)] = std::move(ptr);
    return out_ref;
  }

  template <typename T, typename... Args>
  T& create_child(Args... args) {
    auto ptr = std::make_unique<T>(std::forward<Args>(args)...);
    T& out_ref = *ptr;
    children.emplace_back(std::move(ptr));
    return out_ref;
  }
 
 protected:
  Statistics::StatStorage statistics;
  std::unordered_map<std::string, std::unique_ptr<Port>> ports;
  std::vector<std::unique_ptr<Module>> children;
  Log::Logger logger;
 
 private:
  std::string name_;
  Context* sim_ctx_ = nullptr;
};
}  // namespace Simo
 
#endif  // SIMO_MODULE_HH