For PR801:

[oota-llvm.git] / include / llvm / Support / GraphWriter.h

diff --git a/include/llvm/Support/GraphWriter.h b/include/llvm/Support/GraphWriter.h
index 02f3952422c88d42ec0317cba5d645d01c7a7be0..9f96a7723806548c3c4ebbeef11cfd87e572d645 100644 (file)
--- a/include/llvm/Support/GraphWriter.h
+++ b/include/llvm/Support/GraphWriter.h
@@ -1,10 +1,10 @@
 //===-- llvm/Support/GraphWriter.h - Write graph to a .dot file -*- C++ -*-===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // This file defines a simple interface that can be used to print out generic
@@ -25,8 +25,10 @@
 
 #include "llvm/Support/DOTGraphTraits.h"
 #include "llvm/ADT/GraphTraits.h"
+#include "llvm/System/Path.h"
 #include <vector>
 #include <iostream>
+#include <fstream>
 
 namespace llvm {
 
@@ -59,6 +61,8 @@ namespace DOT {  // Private functions...
   }
 }
 
+void DisplayGraph(const sys::Path& Filename);
+  
 template<typename GraphType>
 class GraphWriter {
   std::ostream &O;
@@ -78,6 +82,9 @@ public:
     else
       O << "digraph " << Name << " {\n";
 
+    if (DOTTraits::renderGraphFromBottomUp())
+      O << "\trankdir=\"BT\";\n";
+
     std::string GraphName = DOTTraits::getGraphName(G);
     if (!GraphName.empty())
       O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
@@ -96,36 +103,54 @@ public:
          I != E; ++I)
       writeNode(&*I);
   }
- 
+
   void writeNode(NodeType *const *Node) {
     writeNode(*Node);
   }
- 
+
   void writeNode(NodeType *Node) {
     std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
-      
+
     O << "\tNode" << reinterpret_cast<const void*>(Node) << " [shape=record,";
     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
-    O << "label=\"{"
-      << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
-    
+    O << "label=\"{";
+
+    if (!DOTTraits::renderGraphFromBottomUp()) {
+      O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
+
+      // If we should include the address of the node in the label, do so now.
+      if (DOTTraits::hasNodeAddressLabel(Node, G))
+        O << "|" << (void*)Node;
+    }
+
     // Print out the fields of the current node...
     child_iterator EI = GTraits::child_begin(Node);
     child_iterator EE = GTraits::child_end(Node);
     if (EI != EE) {
-      O << "|{";
-      
+      if (!DOTTraits::renderGraphFromBottomUp()) O << "|";
+      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 << "|<g64>truncated...";
       O << "}";
+      if (DOTTraits::renderGraphFromBottomUp()) O << "|";
     }
+
+    if (DOTTraits::renderGraphFromBottomUp()) {
+      O << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
+
+      // If we should include the address of the node in the label, do so now.
+      if (DOTTraits::hasNodeAddressLabel(Node, G))
+        O << "|" << (void*)Node;
+    }
+
     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)
@@ -164,7 +189,7 @@ public:
     O << DOT::EscapeString(Label);
     if (NumEdgeSources) {
       O << "|{";
-      
+
       for (unsigned i = 0; i != NumEdgeSources; ++i) {
         if (i) O << "|";
         O << "<g" << i << ">";
@@ -187,7 +212,7 @@ public:
       O << ":g" << SrcNodePort;
     O << " -> Node" << reinterpret_cast<const void*>(DestNodeID);
     if (DestNodePort >= 0)
-      O << ":g" << DestNodePort;    
+      O << ":g" << DestNodePort;
 
     if (!Attrs.empty())
       O << "[" << Attrs << "]";
@@ -215,6 +240,60 @@ std::ostream &WriteGraph(std::ostream &O, const GraphType &G,
   return O;
 }
 
+template<typename GraphType>
+sys::Path WriteGraph(const GraphType &G,
+                     const std::string& Name, 
+                     const std::string& Title = "") {
+  sys::Path Filename = sys::Path::GetTemporaryDirectory();;  
+  Filename.appendComponent(Name + ".dot");
+  Filename.makeUnique();
+  std::cerr << "Writing '" << Filename << "'... ";
+  
+  std::ofstream O(Filename.c_str());
+
+  if (O.good()) {
+    // Start the graph emission process...
+    GraphWriter<GraphType> W(O, G);
+
+    // Output the header for the graph...
+    W.writeHeader(Title);
+
+    // Emit all of the nodes in the graph...
+    W.writeNodes();
+
+    // Output any customizations on the graph
+    DOTGraphTraits<GraphType>::addCustomGraphFeatures(G, W);
+
+    // Output the end of the graph
+    W.writeFooter();
+    std::cerr << " done. \n";
+
+    O.close();
+    
+  } else {
+    std::cerr << "error opening file for writing!\n";
+    Filename.clear();
+  }
+  
+  return Filename;
+}
+  
+/// ViewGraph - Emit a dot graph, run 'dot', run gv on the postscript file,
+/// then cleanup.  For use from the debugger.
+///
+template<typename GraphType>
+void ViewGraph(const GraphType& G, 
+               const std::string& Name, 
+               const std::string& Title = "") {
+  sys::Path Filename =  WriteGraph(G, Name, Title);
+
+  if (Filename.isEmpty()) {
+    return;
+  }
+  
+  DisplayGraph(Filename);
+}
+
 } // End llvm namespace
 
 #endif