ReportPorts.hpp

Go to the documentation of this file.

#pragma once
 
#include "common/Utilities.hpp"
 
#include "slang/ast/ASTVisitor.h"
#include "slang/text/FormatBuffer.h"
 
namespace slang::report {

class ReportPorts
    : public ast::ASTVisitor<ReportPorts, ast::VisitFlags::Expressions |
                                              ast::VisitFlags::Canonical> {
  struct PortInfo {
    std::string name;
    ast::ArgumentDirection direction;
    SourceLocation location;
  };
 
  ast::Compilation &compilation;
  std::vector<PortInfo> ports;
 
public:
  explicit ReportPorts(ast::Compilation &compilation)
      : compilation(compilation) {}

  void report(FormatBuffer &buffer) {
    auto header = netlist::Utilities::Row{"Direction", "Name", "Location"};
    auto table = netlist::Utilities::Table{};
    for (auto port : ports) {
      auto loc = netlist::Utilities::locationStr(compilation, port.location);
      table.push_back(netlist::Utilities::Row{
          std::string(toString(port.direction)), port.name, loc});
    }
    netlist::Utilities::formatTable(buffer, header, table);
  }
 
  void handle(const ast::PortSymbol &symbol) {
    auto port = PortInfo{
        .name = symbol.getHierarchicalPath(),
        .direction = symbol.direction,
        .location = symbol.location,
    };
    ports.push_back(port);
  }
};
 
} // namespace slang::report