AstDOTStyleVisitor.h

/*
** Copyright 2007-2025, 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 <map>
#include <ostream>
 
#include "antares/expressions/visitors/NodeVisitor.h"
 
namespace Antares::Expressions::Visitors
{
struct BoxStyle
{
    std::string_view color;
 
    std::string_view shape;
 
    std::string_view style;
};
 
class AstDOTStyleVisitor: public NodeVisitor<void, std::ostream&>
{
public:
    AstDOTStyleVisitor() = default;
 
    static void NewTreeGraph(std::ostream& os, const std::string& tree_name = "ExpressionTree");
 
    void EndTreeGraph(std::ostream& os);
 
    std::string name() const override;
 
    void operator()(std::ostream& os, const Nodes::Node* root);
 
private:
    void visit(const Nodes::SumNode* node, std::ostream& os) override;
    void visit(const Nodes::SubtractionNode* node, std::ostream& os) override;
    void visit(const Nodes::MultiplicationNode* node, std::ostream& os) override;
    void visit(const Nodes::DivisionNode* node, std::ostream& os) override;
    void visit(const Nodes::EqualNode* node, std::ostream& os) override;
    void visit(const Nodes::LessThanOrEqualNode* node, std::ostream& os) override;
    void visit(const Nodes::GreaterThanOrEqualNode* node, std::ostream& os) override;
    void visit(const Nodes::NegationNode* node, std::ostream& os) override;
    void visit(const Nodes::VariableNode* node, std::ostream& os) override;
    void visit(const Nodes::ParameterNode* node, std::ostream& os) override;
    void visit(const Nodes::LiteralNode* node, std::ostream& os) override;
    void visit(const Nodes::PortFieldNode* node, std::ostream& os) override;
    void visit(const Nodes::PortFieldSumNode* node, std::ostream& os) override;
    void visit(const Nodes::TimeShiftNode* node, std::ostream& os) override;
    void visit(const Nodes::TimeIndexNode* node, std::ostream& os) override;
    void visit(const Nodes::TimeSumNode* node, std::ostream& os) override;
    void visit(const Nodes::AllTimeSumNode* node, std::ostream& os) override;
    void visit(const Nodes::FunctionNode* node, std::ostream& os) override;
 
    void computeNumberNodesPerType();
    void makeLegend(std::ostream& os);
 
    unsigned int getNodeID(const Nodes::Node* node);
 
    static void emitNode(unsigned int id,
                         const std::string& label,
                         const BoxStyle& box_style,
                         std::ostream& os);
 
    void processParentNode(const Nodes::ParentNode* node,
                           const std::string& label,
                           const BoxStyle& box_style,
                           std::ostream& os);
 
    std::map<const Nodes::Node*, unsigned int> nodeIds_;
 
    std::map<std::string, unsigned int> nbNodesPerType_;
 
    unsigned int nodeCount_ = 0;
};
} // namespace Antares::Expressions::Visitors