NodeVisitor.h

/*
** Copyright 2007-2024, RTE (https://www.rte-france.com)
** See AUTHORS.txt
** SPDX-License-Identifier: MPL-2.0
** This file is part of Antares-Simulator,
** Adequacy and Performance assessment for interconnected energy networks.
**
** Antares_Simulator is free software: you can redistribute it and/or modify
** it under the terms of the Mozilla Public Licence 2.0 as published by
** the Mozilla Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** Antares_Simulator is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** Mozilla Public Licence 2.0 for more details.
**
** You should have received a copy of the Mozilla Public Licence 2.0
** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
*/
#pragma once
#include <functional>
#include <optional>
#include <typeindex>
#include <vector>
 
#include <antares/expressions/IName.h>
#include <antares/expressions/nodes/Node.h>
#include <antares/expressions/nodes/NodesForwardDeclaration.h>
#include <antares/expressions/visitors/InvalidNode.h>
 
namespace Antares::Expressions::Visitors
{
// we use LogSink because the inclusion of <antares/logs/logs.h> somehow results in the
// inclusion of <windows.h> (very bad idea in a header!) which conflict with antlr4 headers (defines
// in the former become enums in the latter etc...)
struct LogSink
{
    using LogFunction = std::function<void(const std::string&)>;
 
    LogFunction info;
    LogFunction warning;
    LogFunction error;
};
 
LogSink RedirectToAntaresLogs();
 
template<class RetT, class VisitorT, class NodeT, class... Args>
RetT tryVisit(const Nodes::Node* node, VisitorT& visitor, Args... args)
{
    auto* x = dynamic_cast<const NodeT*>(node);
    return visitor.visit(x, args...);
}
 
template<class R, class... Args>
class NodeVisitor;
 
template<class R, class... Args>
struct NodeVisitsProvider
{
    using FunctionT = R (*)(const Nodes::Node*, NodeVisitor<R, Args...>&, Args... args);
 
    template<class... NodeTypes>
    static auto NodesVisitList()
    {
        std::unordered_map<std::type_index, FunctionT> nodeDispatchFunctions;
        (
          [&nodeDispatchFunctions] {
              nodeDispatchFunctions[typeid(NodeTypes)] = &tryVisit<R,
                                                                   NodeVisitor<R, Args...>,
                                                                   NodeTypes>;
          }(),
          ...);
        return nodeDispatchFunctions;
    }
};
 
template<class R, class... Args>
class NodeVisitor: public IName
{
public:
    virtual ~NodeVisitor() = default;
 
    R dispatch(const Nodes::Node* node, Args... args)
    {
        if (!node)
        {
            throw InvalidNode("null");
        }
 
        const static auto nodeVisitList = NodeVisitsProvider<R, Args...>::template NodesVisitList<
          Nodes::SumNode,
          Nodes::SubtractionNode,
          Nodes::MultiplicationNode,
          Nodes::DivisionNode,
          Nodes::EqualNode,
          Nodes::LessThanOrEqualNode,
          Nodes::GreaterThanOrEqualNode,
          Nodes::NegationNode,
          Nodes::ParameterNode,
          Nodes::VariableNode,
          Nodes::LiteralNode,
          Nodes::PortFieldNode,
          Nodes::PortFieldSumNode,
          Nodes::ComponentVariableNode,
          Nodes::ComponentParameterNode>();
 
        try
        {
            return nodeVisitList.at(typeid(*node))(node, *this, args...);
        }
        catch (std::exception&)
        {
            log_.error("Antares::Expressions::Visitor: could not visit the node!");
            throw;
        }
    }
 
    virtual R visit(const Nodes::SumNode*, Args... args) = 0;
    virtual R visit(const Nodes::SubtractionNode*, Args... args) = 0;
    virtual R visit(const Nodes::MultiplicationNode*, Args... args) = 0;
    virtual R visit(const Nodes::DivisionNode*, Args... args) = 0;
    virtual R visit(const Nodes::EqualNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::LessThanOrEqualNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::GreaterThanOrEqualNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::NegationNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::LiteralNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::VariableNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::ParameterNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::PortFieldNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::PortFieldSumNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::ComponentVariableNode*, Args... args) = 0;
 
    virtual R visit(const Nodes::ComponentParameterNode*, Args... args) = 0;
 
private:
    // we use LogSink because the inclusion of <antares/logs/logs.h> somehow results in the
    // inclusion of <windows.h> (very bad idea in a header!) which conflict with antlr4 headers
    // (defines in the former become enums in the latter etc...)
    LogSink log_ = RedirectToAntaresLogs();
};
} // namespace Antares::Expressions::Visitors