ReportVisitorBase.hpp

Go to the documentation of this file.

#pragma once
 
#include "common/Utilities.hpp"
#include "common/Wildcard.hpp"
 
#include "slang/ast/ASTVisitor.h"
#include "slang/ast/Compilation.h"
#include "slang/text/FormatBuffer.h"
#include "slang/text/Json.h"
#include "slang/text/SourceLocation.h"
 
#include <string>
#include <string_view>
#include <vector>
 
namespace slang::report {

template <typename Derived, typename Info>
class ReportVisitorBase
    : public ast::ASTVisitor<Derived, ast::VisitFlags::Expressions |
                                          ast::VisitFlags::Canonical> {
protected:
  ast::Compilation &compilation;
  std::vector<Info> items;
  std::vector<std::string> nameFilters;

  auto locationStr(SourceLocation loc) const -> std::string {
    return netlist::Utilities::locationStr(compilation, loc);
  }

  auto nameMatches(std::string_view name) const -> bool {
    if (nameFilters.empty()) {
      return true;
    }
    auto subject = std::string(name);
    for (auto const &pattern : nameFilters) {
      if (netlist::wildcardMatch(subject.c_str(), pattern.c_str())) {
        return true;
      }
    }
    return false;
  }
 
public:
  explicit ReportVisitorBase(ast::Compilation &compilation)
      : compilation(compilation) {}

  void setNameFilters(std::vector<std::string> filters) {
    nameFilters = std::move(filters);
  }

  void report(FormatBuffer &buffer) {
    auto header = static_cast<Derived const *>(this)->tableHeader();
    auto table = netlist::Utilities::Table{};
    for (auto const &item : items) {
      static_cast<Derived const *>(this)->appendItemRows(table, item);
    }
    netlist::Utilities::formatTable(buffer, header, table);
  }

  void report(JsonWriter &writer) {
    writer.startArray();
    for (auto const &item : items) {
      static_cast<Derived const *>(this)->emitJsonItem(writer, item);
    }
    writer.endArray();
  }
};
 
} // namespace slang::report