DOTGraphTraits.h revision 208954
1//===-- llvm/Support/DotGraphTraits.h - Customize .dot output ---*- C++ -*-===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file defines a template class that can be used to customize dot output 11// graphs generated by the GraphWriter.h file. The default implementation of 12// this file will produce a simple, but not very polished graph. By 13// specializing this template, lots of customization opportunities are possible. 14// 15//===----------------------------------------------------------------------===// 16 17#ifndef LLVM_SUPPORT_DOTGRAPHTRAITS_H 18#define LLVM_SUPPORT_DOTGRAPHTRAITS_H 19 20#include <string> 21 22namespace llvm { 23 24/// DefaultDOTGraphTraits - This class provides the default implementations of 25/// all of the DOTGraphTraits methods. If a specialization does not need to 26/// override all methods here it should inherit so that it can get the default 27/// implementations. 28/// 29struct DefaultDOTGraphTraits { 30private: 31 bool IsSimple; 32 33protected: 34 bool isSimple() { 35 return IsSimple; 36 } 37 38public: 39 explicit DefaultDOTGraphTraits(bool simple=false) : IsSimple (simple) {} 40 41 /// getGraphName - Return the label for the graph as a whole. Printed at the 42 /// top of the graph. 43 /// 44 template<typename GraphType> 45 static std::string getGraphName(const GraphType& Graph) { return ""; } 46 47 /// getGraphProperties - Return any custom properties that should be included 48 /// in the top level graph structure for dot. 49 /// 50 template<typename GraphType> 51 static std::string getGraphProperties(const GraphType& Graph) { 52 return ""; 53 } 54 55 /// renderGraphFromBottomUp - If this function returns true, the graph is 56 /// emitted bottom-up instead of top-down. This requires graphviz 2.0 to work 57 /// though. 58 static bool renderGraphFromBottomUp() { 59 return false; 60 } 61 62 /// isNodeHidden - If the function returns true, the given node is not 63 /// displayed in the graph. 64 static bool isNodeHidden(const void *Node) { 65 return false; 66 } 67 68 /// getNodeLabel - Given a node and a pointer to the top level graph, return 69 /// the label to print in the node. 70 template<typename GraphType> 71 std::string getNodeLabel(const void *Node, const GraphType& Graph) { 72 return ""; 73 } 74 75 /// hasNodeAddressLabel - If this method returns true, the address of the node 76 /// is added to the label of the node. 77 template<typename GraphType> 78 static bool hasNodeAddressLabel(const void *Node, const GraphType& Graph) { 79 return false; 80 } 81 82 /// If you want to specify custom node attributes, this is the place to do so 83 /// 84 template<typename GraphType> 85 static std::string getNodeAttributes(const void *Node, 86 const GraphType& Graph) { 87 return ""; 88 } 89 90 /// If you want to override the dot attributes printed for a particular edge, 91 /// override this method. 92 template<typename EdgeIter> 93 static std::string getEdgeAttributes(const void *Node, EdgeIter EI) { 94 return ""; 95 } 96 97 /// getEdgeSourceLabel - If you want to label the edge source itself, 98 /// implement this method. 99 template<typename EdgeIter> 100 static std::string getEdgeSourceLabel(const void *Node, EdgeIter I) { 101 return ""; 102 } 103 104 /// edgeTargetsEdgeSource - This method returns true if this outgoing edge 105 /// should actually target another edge source, not a node. If this method is 106 /// implemented, getEdgeTarget should be implemented. 107 template<typename EdgeIter> 108 static bool edgeTargetsEdgeSource(const void *Node, EdgeIter I) { 109 return false; 110 } 111 112 /// getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is 113 /// called to determine which outgoing edge of Node is the target of this 114 /// edge. 115 template<typename EdgeIter> 116 static EdgeIter getEdgeTarget(const void *Node, EdgeIter I) { 117 return I; 118 } 119 120 /// hasEdgeDestLabels - If this function returns true, the graph is able 121 /// to provide labels for edge destinations. 122 static bool hasEdgeDestLabels() { 123 return false; 124 } 125 126 /// numEdgeDestLabels - If hasEdgeDestLabels, this function returns the 127 /// number of incoming edge labels the given node has. 128 static unsigned numEdgeDestLabels(const void *Node) { 129 return 0; 130 } 131 132 /// getEdgeDestLabel - If hasEdgeDestLabels, this function returns the 133 /// incoming edge label with the given index in the given node. 134 static std::string getEdgeDestLabel(const void *Node, unsigned i) { 135 return ""; 136 } 137 138 /// addCustomGraphFeatures - If a graph is made up of more than just 139 /// straight-forward nodes and edges, this is the place to put all of the 140 /// custom stuff necessary. The GraphWriter object, instantiated with your 141 /// GraphType is passed in as an argument. You may call arbitrary methods on 142 /// it to add things to the output graph. 143 /// 144 template<typename GraphType, typename GraphWriter> 145 static void addCustomGraphFeatures(const GraphType& Graph, GraphWriter &GW) {} 146}; 147 148 149/// DOTGraphTraits - Template class that can be specialized to customize how 150/// graphs are converted to 'dot' graphs. When specializing, you may inherit 151/// from DefaultDOTGraphTraits if you don't need to override everything. 152/// 153template <typename Ty> 154struct DOTGraphTraits : public DefaultDOTGraphTraits { 155 DOTGraphTraits (bool simple=false) : DefaultDOTGraphTraits (simple) {} 156}; 157 158} // End llvm namespace 159 160#endif 161