Added the ExecWait() function.
[oota-llvm.git] / include / llvm / Support / GraphWriter.h
index 01851d512f37983c6ff043cb3d21c158b8e2cc36..3b7b3575544bca483c41e43b8b9763db4ea4016a 100644 (file)
@@ -17,8 +17,9 @@
 #define SUPPORT_GRAPHWRITER_H
 
 #include "Support/DOTGraphTraits.h"
-#include "Support/DepthFirstIterator.h"
-#include <ostream>
+#include "Support/GraphTraits.h"
+#include <vector>
+#include <iostream>
 
 namespace DOT {  // Private functions...
   inline std::string EscapeString(const std::string &Label) {
@@ -49,74 +50,151 @@ namespace DOT {  // Private functions...
 }
 
 template<typename GraphType>
-std::ostream &WriteGraph(std::ostream &O, const GraphType &G) {
-  typedef DOTGraphTraits<GraphType>  DOTTraits;
-  typedef GraphTraits<GraphType>     GTraits;
-  typedef typename GTraits::NodeType NodeType;
+class GraphWriter {
+  std::ostream &O;
+  const GraphType &G;
 
-  O << "digraph foo {\n"         // Graph name doesn't matter
-    << "\tsize=\"10,7.5\";\n"    // Size to fit on a page
-    << "\trotate=\"90\";\n";     // Orient correctly
+  typedef DOTGraphTraits<GraphType>           DOTTraits;
+  typedef GraphTraits<GraphType>              GTraits;
+  typedef typename GTraits::NodeType          NodeType;
+  typedef typename GTraits::nodes_iterator    node_iterator;
+  typedef typename GTraits::ChildIteratorType child_iterator;
+public:
+  GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
 
-  std::string GraphName = DOTTraits::getGraphName(G);
-  if (!GraphName.empty())
-    O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
-  O << "\n";
+  void writeHeader(const std::string &Name) {
+    if (Name.empty())
+      O << "digraph foo {\n";        // Graph name doesn't matter
+    else
+      O << "digraph " << Name << " {\n";
 
-  // Loop over the graph in DFO, printing it out...
-  NodeType *Root = GTraits::getEntryNode(G);
-  for (df_iterator<GraphType> I = df_begin(G), E = df_end(G); I != E; ++I) {
-    NodeType *Node = *I;
+    std::string GraphName = DOTTraits::getGraphName(G);
+    if (!GraphName.empty())
+      O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
+    O << DOTTraits::getGraphProperties(G);
+    O << "\n";
+  }
 
-    std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
+  void writeFooter() {
+    // Finish off the graph
+    O << "}\n";
+  }
 
-    O << "\tNode" << (void*)Node << " [";
+  void writeNodes() {
+    // Loop over the graph, printing it out...
+    for (node_iterator I = GTraits::nodes_begin(G), E = GTraits::nodes_end(G);
+         I != E; ++I)
+      writeNode(&*I);
+  }
+
+  void writeNode(NodeType *Node) {
+    std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
+      
+    O << "\tNode" << (void*)Node << " [shape=record,";
     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
-    O << "shape=record,label=\"{"
+    O << "label=\"{"
       << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
     
     // Print out the fields of the current node...
-    typename GTraits::ChildIteratorType EI = GTraits::child_begin(Node);
-    typename GTraits::ChildIteratorType EE = GTraits::child_end(Node);
+    child_iterator EI = GTraits::child_begin(Node);
+    child_iterator EE = GTraits::child_end(Node);
     if (EI != EE) {
       O << "|{";
-
+      
       for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
         if (i) O << "|";
         O << "<g" << i << ">" << DOTTraits::getEdgeSourceLabel(Node, EI);
       }
-
+      
       if (EI != EE)
         O << "|truncated...";
       O << "}";
     }
     O << "}\"];\n";   // Finish printing the "node" line
-
+    
     // Output all of the edges now
     EI = GTraits::child_begin(Node);
-    for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i) {
-      NodeType *TargetNode = *EI;
-      O << "\tNode" << (void*)Node << ":g" << i << " -> Node"
-        << (void*)TargetNode;
+    for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
+      writeEdge(Node, i, EI);
+  }
+
+  void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
+    if (NodeType *TargetNode = *EI) {
+      int DestPort = -1;
       if (DOTTraits::edgeTargetsEdgeSource(Node, EI)) {
-        typename GTraits::ChildIteratorType TargetIt =
-          DOTTraits::getEdgeTarget(Node, EI);
+        child_iterator TargetIt = DOTTraits::getEdgeTarget(Node, EI);
+
         // Figure out which edge this targets...
         unsigned Offset = std::distance(GTraits::child_begin(TargetNode),
                                         TargetIt);
-        if (Offset > 64) Offset = 64;  // Targetting the trancated part?
-        O << ":g" << Offset;        
+        DestPort = (int)Offset;
       }
 
-      std::string EdgeAttributes = DOTTraits::getEdgeAttributes(Node, EI);
-      if (!EdgeAttributes.empty())
-        O << "[" << EdgeAttributes << "]";
-      O << ";\n";
+      emitEdge((void *)Node, edgeidx, (void*)TargetNode, DestPort,
+               DOTTraits::getEdgeAttributes(Node, EI));
+    }
+  }
+
+  /// emitSimpleNode - Outputs a simple (non-record) node
+  void emitSimpleNode(const void *ID, const std::string &Attr,
+                      const std::string &Label, unsigned NumEdgeSources = 0,
+                      const std::vector<std::string> *EdgeSourceLabels = 0) {
+    O << "\tNode" << ID << "[ ";
+    if (!Attr.empty())
+      O << Attr << ",";
+    O << " label =\"";
+    if (NumEdgeSources) O << "{";
+    O << DOT::EscapeString(Label);
+    if (NumEdgeSources) {
+      O << "|{";
+      
+      for (unsigned i = 0; i != NumEdgeSources; ++i) {
+        if (i) O << "|";
+        O << "<g" << i << ">";
+        if (EdgeSourceLabels) O << (*EdgeSourceLabels)[i];
+      }
+      O << "}}";
     }
+    O << "\"];\n";
+  }
+
+  /// emitEdge - Output an edge from a simple node into the graph...
+  void emitEdge(const void *SrcNodeID, int SrcNodePort,
+                const void *DestNodeID, int DestNodePort,
+                const std::string &Attrs) {
+    if (SrcNodePort  > 64) return;             // Eminating from truncated part?
+    if (DestNodePort > 64) DestNodePort = 64;  // Targetting the truncated part?
+
+    O << "\tNode" << SrcNodeID;
+    if (SrcNodePort >= 0)
+      O << ":g" << SrcNodePort;
+    O << " -> Node" << (void*)DestNodeID;
+    if (DestNodePort >= 0)
+      O << ":g" << DestNodePort;    
+
+    if (!Attrs.empty())
+      O << "[" << Attrs << "]";
+    O << ";\n";
   }
+};
+
+template<typename GraphType>
+std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
+                         const std::string &Name = "") {
+  // Start the graph emission process...
+  GraphWriter<GraphType> W(O, G);
+
+  // Output the header for the graph...
+  W.writeHeader(Name);
+
+  // Emit all of the nodes in the graph...
+  W.writeNodes();
+
+  // Output any customizations on the graph
+  DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
 
-  // Finish off the graph
-  O << "}\n";
+  // Output the end of the graph
+  W.writeFooter();
   return O;
 }