llvm::DefaultDOTGraphTraits Struct Reference

#include <DOTGraphTraits.h>

Inheritance diagram for llvm::DefaultDOTGraphTraits:

[legend]

List of all members.

Static Public Member Functions
template<typename GraphType>
static std::string	getGraphName (const GraphType &Graph)
template<typename GraphType>
static std::string	getGraphProperties (const GraphType &Graph)
static bool	renderGraphFromBottomUp ()
template<typename GraphType>
static std::string	getNodeLabel (const void *Node, const GraphType &Graph)
template<typename GraphType>
static bool	hasNodeAddressLabel (const void *Node, const GraphType &Graph)
template<typename GraphType>
static std::string	getNodeAttributes (const void *Node, const GraphType &Graph)
template<typename EdgeIter>
static std::string	getEdgeAttributes (const void *Node, EdgeIter EI)
template<typename EdgeIter>
static std::string	getEdgeSourceLabel (const void *Node, EdgeIter I)
template<typename EdgeIter>
static bool	edgeTargetsEdgeSource (const void *Node, EdgeIter I)
template<typename EdgeIter>
static EdgeIter	getEdgeTarget (const void *Node, EdgeIter I)
static bool	hasEdgeDestLabels ()
static unsigned	numEdgeDestLabels (const void *Node)
static std::string	getEdgeDestLabel (const void *Node, unsigned i)
template<typename GraphType, typename GraphWriter>
static void	addCustomGraphFeatures (const GraphType &Graph, GraphWriter &GW)

---

Detailed Description

DefaultDOTGraphTraits - This class provides the default implementations of all of the DOTGraphTraits methods. If a specialization does not need to override all methods here it should inherit so that it can get the default implementations.

Definition at line 29 of file DOTGraphTraits.h.

---

Member Function Documentation

template<typename GraphType>

static std::string llvm::DefaultDOTGraphTraits::getGraphName

(

const GraphType &

Graph

)

[inline, static]

getGraphName - Return the label for the graph as a whole. Printed at the top of the graph.

Definition at line 34 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeHeader().

template<typename GraphType>

static std::string llvm::DefaultDOTGraphTraits::getGraphProperties

(

const GraphType &

Graph

)

[inline, static]

getGraphProperties - Return any custom properties that should be included in the top level graph structure for dot.

Definition at line 40 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeHeader().

static bool llvm::DefaultDOTGraphTraits::renderGraphFromBottomUp

(

)

[inline, static]

renderGraphFromBottomUp - If this function returns true, the graph is emitted bottom-up instead of top-down. This requires graphviz 2.0 to work though.

Reimplemented in llvm::DOTGraphTraits< ScheduleDAG * >, and llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 47 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeHeader(), and llvm::GraphWriter< GraphType >::writeNode().

template<typename GraphType>

static std::string llvm::DefaultDOTGraphTraits::getNodeLabel	(	const void *	Node,
		const GraphType &	Graph
	)			[inline, static]

getNodeLabel - Given a node and a pointer to the top level graph, return the label to print in the node.

Definition at line 54 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

template<typename GraphType>

static bool llvm::DefaultDOTGraphTraits::hasNodeAddressLabel	(	const void *	Node,
		const GraphType &	Graph
	)			[inline, static]

hasNodeAddressLabel - If this method returns true, the address of the node is added to the label of the node.

Definition at line 61 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

template<typename GraphType>

static std::string llvm::DefaultDOTGraphTraits::getNodeAttributes	(	const void *	Node,
		const GraphType &	Graph
	)			[inline, static]

If you want to specify custom node attributes, this is the place to do so

Definition at line 68 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

template<typename EdgeIter>

static std::string llvm::DefaultDOTGraphTraits::getEdgeAttributes	(	const void *	Node,
		EdgeIter	EI
	)			[inline, static]

If you want to override the dot attributes printed for a particular edge, override this method.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 76 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeEdge().

template<typename EdgeIter>

static std::string llvm::DefaultDOTGraphTraits::getEdgeSourceLabel	(	const void *	Node,
		EdgeIter	I
	)			[inline, static]

getEdgeSourceLabel - If you want to label the edge source itself, implement this method.

Definition at line 83 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

template<typename EdgeIter>

static bool llvm::DefaultDOTGraphTraits::edgeTargetsEdgeSource	(	const void *	Node,
		EdgeIter	I
	)			[inline, static]

edgeTargetsEdgeSource - This method returns true if this outgoing edge should actually target another edge source, not a node. If this method is implemented, getEdgeTarget should be implemented.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 91 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeEdge().

template<typename EdgeIter>

static EdgeIter llvm::DefaultDOTGraphTraits::getEdgeTarget	(	const void *	Node,
		EdgeIter	I
	)			[inline, static]

getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is called to determine which outgoing edge of Node is the target of this edge.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 99 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeEdge().

static bool llvm::DefaultDOTGraphTraits::hasEdgeDestLabels

(

)

[inline, static]

hasEdgeDestLabels - If this function returns true, the graph is able to provide labels for edge destinations.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 105 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

static unsigned llvm::DefaultDOTGraphTraits::numEdgeDestLabels

(

const void *

Node

)

[inline, static]

numEdgeDestLabels - If hasEdgeDestLabels, this function returns the number of incoming edge labels the given node has.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 111 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

static std::string llvm::DefaultDOTGraphTraits::getEdgeDestLabel	(	const void *	Node,
		unsigned	i
	)			[inline, static]

getEdgeDestLabel - If hasEdgeDestLabels, this function returns the incoming edge label with the given index in the given node.

Reimplemented in llvm::DOTGraphTraits< SelectionDAG * >.

Definition at line 117 of file DOTGraphTraits.h.

Referenced by llvm::GraphWriter< GraphType >::writeNode().

template<typename GraphType, typename GraphWriter>

static void llvm::DefaultDOTGraphTraits::addCustomGraphFeatures	(	const GraphType &	Graph,
		GraphWriter &	GW
	)			[inline, static]

addCustomGraphFeatures - If a graph is made up of more than just straight-forward nodes and edges, this is the place to put all of the custom stuff necessary. The GraphWriter object, instantiated with your GraphType is passed in as an argument. You may call arbitrary methods on it to add things to the output graph.

Definition at line 128 of file DOTGraphTraits.h.

---

The documentation for this struct was generated from the following file:

• DOTGraphTraits.h