1 //===-- Support/GraphWriter.h - Write a graph to a .dot file ---*- C++ -*--===//
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.
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
14 //===----------------------------------------------------------------------===//
16 #ifndef SUPPORT_GRAPHWRITER_H
17 #define SUPPORT_GRAPHWRITER_H
19 #include "Support/DOTGraphTraits.h"
20 #include "Support/GraphTraits.h"
23 namespace DOT { // Private functions...
24 inline std::string EscapeString(const std::string &Label) {
25 std::string Str(Label);
26 for (unsigned i = 0; i != Str.length(); ++i)
29 Str.insert(Str.begin()+i, '\\'); // Escape character...
34 Str.insert(Str.begin()+i, ' '); // Convert to two spaces
39 if (i+1 != Str.length() && Str[i+1] == 'l')
40 break; // don't disturb \l
43 Str.insert(Str.begin()+i, '\\'); // Escape character...
44 ++i; // don't infinite loop
51 template<typename GraphType>
56 typedef DOTGraphTraits<GraphType> DOTTraits;
57 typedef GraphTraits<GraphType> GTraits;
58 typedef typename GTraits::NodeType NodeType;
59 typedef typename GTraits::nodes_iterator node_iterator;
60 typedef typename GTraits::ChildIteratorType child_iterator;
62 GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
64 void writeHeader(const std::string &Name) {
66 O << "digraph foo {\n"; // Graph name doesn't matter
68 O << "digraph " << Name << " {\n";
70 std::string GraphName = DOTTraits::getGraphName(G);
71 if (!GraphName.empty())
72 O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
73 O << DOTTraits::getGraphProperties(G);
78 // Finish off the graph
83 // Loop over the graph, printing it out...
84 for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
89 void writeNode(NodeType *Node) {
90 std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
92 O << "\tNode" << (void*)Node << " [shape=record,";
93 if (!NodeAttributes.empty()) O << NodeAttributes << ",";
95 << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
97 // Print out the fields of the current node...
98 child_iterator EI = GTraits::child_begin(Node);
99 child_iterator EE = GTraits::child_end(Node);
103 for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
105 O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
109 O << "|truncated...";
112 O << "}\"];\n"; // Finish printing the "node" line
114 // Output all of the edges now
115 EI = GTraits::child_begin(Node);
116 for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
117 writeEdge(Node, i, EI);
120 void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
121 if (NodeType *TargetNode = *EI) {
123 if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
124 child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
126 // Figure out which edge this targets...
127 unsigned Offset = std::distance(GTraits::child_begin(TargetNode),
129 DestPort = (int)Offset;
132 emitEdge((void *)Node, edgeidx, (void*)TargetNode, DestPort,
133 DOTTraits::getEdgeAttributes(Node, EI));
137 /// emitSimpleNode - Outputs a simple (non-record) node
138 void emitSimpleNode(const void *ID, const std::string &Attr,
139 const std::string &Label, unsigned NumEdgeSources = 0) {
140 O << "\tNode" << ID << "[ ";
144 if (NumEdgeSources) O << "{";
145 O << DOT::EscapeString(Label);
146 if (NumEdgeSources) {
149 for (unsigned i = 0; i != NumEdgeSources; ++i) {
151 O << "<g" << i << ">";
158 /// emitEdge - Output an edge from a simple node into the graph...
159 void emitEdge(const void *SrcNodeID, int SrcNodePort,
160 const void *DestNodeID, int DestNodePort,
161 const std::string &Attrs) {
162 if (SrcNodePort > 64) return; // Eminating from truncated part?
163 if (DestNodePort > 64) DestNodePort = 64; // Targetting the truncated part?
165 O << "\tNode" << SrcNodeID;
166 if (SrcNodePort >= 0)
167 O << ":g" << SrcNodePort;
168 O << " -> Node" << (void*)DestNodeID;
169 if (DestNodePort >= 0)
170 O << ":g" << DestNodePort;
173 O << "[" << Attrs << "]";
178 template<typename GraphType>
179 std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
180 const std::string &Name = "") {
181 // Start the graph emission process...
182 GraphWriter<GraphType> W(O, G);
184 // Output the header for the graph...
187 // Emit all of the nodes in the graph...
190 // Output any customizations on the graph
191 DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
193 // Output the end of the graph