DotWriter.hpp

Go to the documentation of this file.

/*
 * Copyright 2025 Nico Reißmann <nico.reissmann@gmail.com>
 * See COPYING for terms of redistribution.
 */
 
#ifndef JLM_RVSDG_DOTWRITER_HPP
#define JLM_RVSDG_DOTWRITER_HPP
 
#include <jlm/rvsdg/region.hpp>
#include <jlm/util/GraphWriter.hpp>
 
namespace jlm::rvsdg
{
 
class DotWriter
{
public:
  virtual ~DotWriter() noexcept;
 
  util::graph::Graph &
  WriteGraph(util::graph::Writer & writer, const Region & region);
 
  util::graph::Graph &
  WriteGraphs(util::graph::Writer & writer, const Region & region, bool emitTypeGraph);
 
protected:
  util::graph::Node &
  GetOrCreateTypeGraphNode(const Type & type, util::graph::Graph & typeGraph);
 
  virtual void
  AnnotateTypeGraphNode(const Type & type, util::graph::Node & node);
 
  virtual void
  AnnotateGraphNode(
      const Node & rvsdgNode,
      util::graph::Node & node,
      util::graph::Graph * typeGraph);
 
  virtual void
  AnnotateEdge(const Input & rvsdgInput, util::graph::Edge & edge);
 
  virtual void
  AnnotateRegionArgument(
      const RegionArgument & regionArgument,
      util::graph::Node & node,
      util::graph::Graph * typeGraph);
 
private:
  void
  CreateGraphNodes(
      util::graph::Graph & graph,
      const Region & region,
      util::graph::Graph * typeGraph,
      bool traverseRecursively);
 
  void
  AttachNodeInput(util::graph::Port & inputPort, const Input & rvsdgInput);
 
  void
  AttachNodeOutput(
      util::graph::Port & outputPort,
      const Output & rvsdgOutput,
      util::graph::Graph * typeGraph);
};
 
}
 
#endif