include/llvm/Support/GraphWriter.h

   1 //===-- Support/GraphWriter.h - Write a graph to a .dot file ----*- C++ -*-===//
   2 //
   3 // This file defines a simple interface that can be used to print out generic
   4 // LLVM graphs to ".dot" files.  "dot" is a tool that is part of the AT&T
   5 // graphviz package (http://www.research.att.com/sw/tools/graphviz/) which can
   6 // be used to turn the files output by this interface into a variety of
   7 // different graphics formats.
   8 //
   9 // Graphs do not need to implement any interface past what is already required
  10 // by the GraphTraits template, but they can choose to implement specializations
  11 // of the DOTGraphTraits template if they want to customize the graphs output in
  12 // any way.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef SUPPORT_GRAPHWRITER_H
  17 #define SUPPORT_GRAPHWRITER_H
  18
  19 #include "Support/DOTGraphTraits.h"
  20 #include "Support/GraphTraits.h"
  21 #include <vector>
  22 #include <iostream>
  23
  24 namespace DOT {  // Private functions...
  25   inline std::string EscapeString(const std::string &Label) {
  26     std::string Str(Label);
  27     for (unsigned i = 0; i != Str.length(); ++i)
  28       switch (Str[i]) {
  29       case '\n':
  30         Str.insert(Str.begin()+i, '\\');  // Escape character...
  31         ++i;
  32         Str[i] = 'n';
  33         break;
  34       case '\t':
  35         Str.insert(Str.begin()+i, ' ');  // Convert to two spaces
  36         ++i;
  37         Str[i] = ' ';
  38         break;
  39       case '\\':
  40         if (i+1 != Str.length() && Str[i+1] == 'l')
  41           break;  // don't disturb \l
  42       case '{': case '}':
  43       case '<': case '>':
  44         Str.insert(Str.begin()+i, '\\');  // Escape character...
  45         ++i;  // don't infinite loop
  46         break;
  47       }
  48     return Str;
  49   }
  50 }
  51
  52 template<typename GraphType>
  53 class GraphWriter {
  54   std::ostream &O;
  55   const GraphType &G;
  56
  57   typedef DOTGraphTraits<GraphType>           DOTTraits;
  58   typedef GraphTraits<GraphType>              GTraits;
  59   typedef typename GTraits::NodeType          NodeType;
  60   typedef typename GTraits::nodes_iterator    node_iterator;
  61   typedef typename GTraits::ChildIteratorType child_iterator;
  62 public:
  63   GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
  64
  65   void writeHeader(const std::string &Name) {
  66     if (Name.empty())
  67       O << "digraph foo {\n";        // Graph name doesn't matter
  68     else
  69       O << "digraph " << Name << " {\n";
  70
  71     std::string GraphName = DOTTraits::getGraphName(G);
  72     if (!GraphName.empty())
  73       O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
  74     O << DOTTraits::getGraphProperties(G);
  75     O << "\n";
  76   }
  77
  78   void writeFooter() {
  79     // Finish off the graph
  80     O << "}\n";
  81   }
  82
  83   void writeNodes() {
  84     // Loop over the graph, printing it out...
  85     for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
  86          I != E; ++I)
  87       writeNode(&*I);
  88   }
  89
  90   void writeNode(NodeType *Node) {
  91     std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
  92
  93     O << "\tNode" << (void*)Node << " [shape=record,";
  94     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
  95     O << "label=\"{"
  96       << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
  97
  98     // Print out the fields of the current node...
  99     child_iterator EI = GTraits::child_begin(Node);
 100     child_iterator EE = GTraits::child_end(Node);
 101     if (EI != EE) {
 102       O << "|{";
 103
 104       for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
 105         if (i) O << "|";
 106         O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
 107       }
 108
 109       if (EI != EE)
 110         O << "|truncated...";
 111       O << "}";
 112     }
 113     O << "}\"];\n";   // Finish printing the "node" line
 114
 115     // Output all of the edges now
 116     EI = GTraits::child_begin(Node);
 117     for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
 118       writeEdge(Node, i, EI);
 119   }
 120
 121   void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
 122     if (NodeType *TargetNode = *EI) {
 123       int DestPort = -1;
 124       if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
 125         child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
 126
 127         // Figure out which edge this targets...
 128         unsigned Offset = std::distance(GTraits::child_begin(TargetNode),
 129                                         TargetIt);
 130         DestPort = (int)Offset;
 131       }
 132
 133       emitEdge((void *)Node, edgeidx, (void*)TargetNode, DestPort,
 134                DOTTraits::getEdgeAttributes(Node, EI));
 135     }
 136   }
 137
 138   /// emitSimpleNode - Outputs a simple (non-record) node
 139   void emitSimpleNode(const void *ID, const std::string &Attr,
 140                       const std::string &Label, unsigned NumEdgeSources = 0,
 141                       const std::vector<std::string> *EdgeSourceLabels = 0) {
 142     O << "\tNode" << ID << "[ ";
 143     if (!Attr.empty())
 144       O << Attr << ",";
 145     O << " label =\"";
 146     if (NumEdgeSources) O << "{";
 147     O << DOT::EscapeString(Label);
 148     if (NumEdgeSources) {
 149       O << "|{";
 150
 151       for (unsigned i = 0; i != NumEdgeSources; ++i) {
 152         if (i) O << "|";
 153         O << "<g" << i << ">";
 154         if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
 155       }
 156       O << "}}";
 157     }
 158     O << "\"];\n";
 159   }
 160
 161   /// emitEdge - Output an edge from a simple node into the graph...
 162   void emitEdge(const void *SrcNodeID, int SrcNodePort,
 163                 const void *DestNodeID, int DestNodePort,
 164                 const std::string &Attrs) {
 165     if (SrcNodePort  > 64) return;             // Eminating from truncated part?
 166     if (DestNodePort > 64) DestNodePort = 64;  // Targetting the truncated part?
 167
 168     O << "\tNode" << SrcNodeID;
 169     if (SrcNodePort >= 0)
 170       O << ":g" << SrcNodePort;
 171     O << " -> Node" << (void*)DestNodeID;
 172     if (DestNodePort >= 0)
 173       O << ":g" << DestNodePort;
 174
 175     if (!Attrs.empty())
 176       O << "[" << Attrs << "]";
 177     O << ";\n";
 178   }
 179 };
 180
 181 template<typename GraphType>
 182 std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
 183                          const std::string &Name = "") {
 184   // Start the graph emission process...
 185   GraphWriter<GraphType> W(O, G);
 186
 187   // Output the header for the graph...
 188   W.writeHeader(Name);
 189
 190   // Emit all of the nodes in the graph...
 191   W.writeNodes();
 192
 193   // Output any customizations on the graph
 194   DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
 195
 196   // Output the end of the graph
 197   W.writeFooter();
 198   return O;
 199 }
 200
 201 #endif