Add support for -march=c
[oota-llvm.git] / include / Support / GraphWriter.h
index 0a7576cd7c516bd19e368df0642c38ffe33822cd..c6a5c3cdc94b2f871dff95a5a837c744a4998c2c 100644 (file)
@@ -1,4 +1,11 @@
-//===-- Support/GraphWriter.h - Write a graph to a .dot file ---*- C++ -*--===//
+//===-- Support/GraphWriter.h - Write a 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
 // LLVM graphs to ".dot" files.  "dot" is a tool that is part of the AT&T
 
 #include "Support/DOTGraphTraits.h"
 #include "Support/GraphTraits.h"
-#include <ostream>
+#include <vector>
+#include <iostream>
+
+namespace llvm {
 
 namespace DOT {  // Private functions...
   inline std::string EscapeString(const std::string &Label) {
@@ -40,6 +50,7 @@ namespace DOT {  // Private functions...
           break;  // don't disturb \l
       case '{': case '}':
       case '<': case '>':
+      case '"':
         Str.insert(Str.begin()+i, '\\');  // Escape character...
         ++i;  // don't infinite loop
         break;
@@ -59,8 +70,9 @@ class GraphWriter {
   typedef typename GTraits::nodes_iterator    node_iterator;
   typedef typename GTraits::ChildIteratorType child_iterator;
 public:
-  GraphWriter(std::ostream &o, const GraphType &g,
-              const std::string &Name) : O(o), G(g) {
+  GraphWriter(std::ostream &o, const GraphType &g) : O(o), G(g) {}
+
+  void writeHeader(const std::string &Name) {
     if (Name.empty())
       O << "digraph foo {\n";        // Graph name doesn't matter
     else
@@ -71,11 +83,9 @@ public:
       O << "\tlabel=\"" << DOT::EscapeString(GraphName) << "\";\n";
     O << DOTTraits::getGraphProperties(G);
     O << "\n";
-
-    writeNodes();
   }
 
-  ~GraphWriter() {
+  void writeFooter() {
     // Finish off the graph
     O << "}\n";
   }
@@ -90,7 +100,7 @@ public:
   void writeNode(NodeType *Node) {
     std::string NodeAttributes = DOTTraits::getNodeAttributes(Node);
       
-    O << "\tNode" << (void*)Node << " [shape=record,";
+    O << "\tNode" << reinterpret_cast<const void*>(Node) << " [shape=record,";
     if (!NodeAttributes.empty()) O << NodeAttributes << ",";
     O << "label=\"{"
       << DOT::EscapeString(DOTTraits::getNodeLabel(Node, G));
@@ -107,7 +117,7 @@ public:
       }
       
       if (EI != EE)
-        O << "|truncated...";
+        O << "|<g64>truncated...";
       O << "}";
     }
     O << "}\"];\n";   // Finish printing the "node" line
@@ -116,27 +126,68 @@ public:
     EI = GTraits::child_begin(Node);
     for (unsigned i = 0; EI != EE && i != 64; ++EI, ++i)
       writeEdge(Node, i, EI);
+    for (; EI != EE; ++EI)
+      writeEdge(Node, 64, EI);
   }
 
   void writeEdge(NodeType *Node, unsigned edgeidx, child_iterator EI) {
     if (NodeType *TargetNode = *EI) {
-      O << "\tNode" << (void*)Node << ":g" << edgeidx << " -> Node"
-        << (void*)TargetNode;
+      int DestPort = -1;
       if (DOTTraits::edgeTargetsEdgeSource(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 truncated part?
-        O << ":g" << Offset;        
+        DestPort = static_cast<int>(Offset);
       }
+
+      emitEdge(reinterpret_cast<const void*>(Node), edgeidx,
+               reinterpret_cast<const 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 << "|{";
       
-      std::string EdgeAttributes = DOTTraits::getEdgeAttributes(Node, EI);
-      if (!EdgeAttributes.empty())
-        O << "[" << EdgeAttributes << "]";
-      O << ";\n";
+      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" << reinterpret_cast<const void*>(DestNodeID);
+    if (DestNodePort >= 0)
+      O << ":g" << DestNodePort;    
+
+    if (!Attrs.empty())
+      O << "[" << Attrs << "]";
+    O << ";\n";
   }
 };
 
@@ -144,8 +195,22 @@ 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, Name);
+  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);
+
+  // Output the end of the graph
+  W.writeFooter();
   return O;
 }
 
+} // End llvm namespace
+
 #endif