llvm::DOTGraphTraits< const Function * > Struct Template Reference

#include "llvm/Analysis/CFGPrinter.h"

Inheritance diagram for llvm::DOTGraphTraits< const Function * >:

Collaboration diagram for llvm::DOTGraphTraits< const Function * >:

Public Member Functions
	DOTGraphTraits (bool isSimple=false)
std::string	getNodeLabel (const BasicBlock *Node, const Function *Graph)
std::string	getEdgeAttributes (const BasicBlock *Node, succ_const_iterator I, const Function *F)
	Display the raw branch weights from PGO. More...
Public Member Functions inherited from llvm::DefaultDOTGraphTraits
	DefaultDOTGraphTraits (bool simple=false)
template<typename GraphType >
std::string	getNodeLabel (const void *, const GraphType &)
	getNodeLabel - Given a node and a pointer to the top level graph, return the label to print in the node. More...

Static Public Member Functions
static std::string	getGraphName (const Function *F)
static std::string	getSimpleNodeLabel (const BasicBlock *Node, const Function *)
static std::string	getCompleteNodeLabel (const BasicBlock *Node, const Function *)
static std::string	getEdgeSourceLabel (const BasicBlock *Node, succ_const_iterator I)
Static Public Member Functions inherited from llvm::DefaultDOTGraphTraits
template<typename GraphType >
static std::string	getGraphName (const GraphType &)
	getGraphName - Return the label for the graph as a whole. More...
template<typename GraphType >
static std::string	getGraphProperties (const GraphType &)
	getGraphProperties - Return any custom properties that should be included in the top level graph structure for dot. More...
static bool	renderGraphFromBottomUp ()
	renderGraphFromBottomUp - If this function returns true, the graph is emitted bottom-up instead of top-down. More...
static bool	isNodeHidden (const void *)
	isNodeHidden - If the function returns true, the given node is not displayed in the graph. More...
template<typename GraphType >
static std::string	getNodeIdentifierLabel (const void *, const GraphType &)
template<typename GraphType >
static std::string	getNodeDescription (const void *, const GraphType &)
template<typename GraphType >
static std::string	getNodeAttributes (const void *, const GraphType &)
	If you want to specify custom node attributes, this is the place to do so. More...
template<typename EdgeIter , typename GraphType >
static std::string	getEdgeAttributes (const void *, EdgeIter, const GraphType &)
	If you want to override the dot attributes printed for a particular edge, override this method. More...
template<typename EdgeIter >
static std::string	getEdgeSourceLabel (const void *, EdgeIter)
	getEdgeSourceLabel - If you want to label the edge source itself, implement this method. More...
template<typename EdgeIter >
static bool	edgeTargetsEdgeSource (const void *, EdgeIter)
	edgeTargetsEdgeSource - This method returns true if this outgoing edge should actually target another edge source, not a node. More...
template<typename EdgeIter >
static EdgeIter	getEdgeTarget (const void *, EdgeIter I)
	getEdgeTarget - If edgeTargetsEdgeSource returns true, this method is called to determine which outgoing edge of Node is the target of this edge. More...
static bool	hasEdgeDestLabels ()
	hasEdgeDestLabels - If this function returns true, the graph is able to provide labels for edge destinations. More...
static unsigned	numEdgeDestLabels (const void *)
	numEdgeDestLabels - If hasEdgeDestLabels, this function returns the number of incoming edge labels the given node has. More...
static std::string	getEdgeDestLabel (const void *, unsigned)
	getEdgeDestLabel - If hasEdgeDestLabels, this function returns the incoming edge label with the given index in the given node. More...
template<typename GraphType , typename GraphWriter >
static void	addCustomGraphFeatures (const GraphType &, GraphWriter &)
	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. More...

Additional Inherited Members
Protected Member Functions inherited from llvm::DefaultDOTGraphTraits
bool	isSimple ()

Detailed Description

template<>
struct llvm::DOTGraphTraits< const Function * >

Definition at line 55 of file CFGPrinter.h.

Constructor & Destructor Documentation

DOTGraphTraits()

llvm::DOTGraphTraits< const Function * >::DOTGraphTraits ( bool  isSimple = false )

inline

Definition at line 57 of file CFGPrinter.h.

Member Function Documentation

getCompleteNodeLabel()

static std::string llvm::DOTGraphTraits< const Function * >::getCompleteNodeLabel ( const BasicBlock *  Node, const Function *    )

inlinestatic

Definition at line 75 of file CFGPrinter.h.

getEdgeAttributes()

std::string llvm::DOTGraphTraits< const Function * >::getEdgeAttributes ( const BasicBlock *  Node, succ_const_iterator  I, const Function *  F  )

inline

Display the raw branch weights from PGO.

Definition at line 151 of file CFGPrinter.h.

getEdgeSourceLabel()

static std::string llvm::DOTGraphTraits< const Function * >::getEdgeSourceLabel ( const BasicBlock *  Node, succ_const_iterator  I  )

inlinestatic

Definition at line 128 of file CFGPrinter.h.

getGraphName()

static std::string llvm::DOTGraphTraits< const Function * >::getGraphName ( const Function *  F )

inlinestatic

Definition at line 59 of file CFGPrinter.h.

References llvm::Value::getName(), and llvm::StringRef::str().

getNodeLabel()

std::string llvm::DOTGraphTraits< const Function * >::getNodeLabel ( const BasicBlock *  Node, const Function *  Graph  )

inline

Definition at line 120 of file CFGPrinter.h.

getSimpleNodeLabel()

static std::string llvm::DOTGraphTraits< const Function * >::getSimpleNodeLabel ( const BasicBlock *  Node, const Function *    )

inlinestatic

Definition at line 63 of file CFGPrinter.h.

---

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

• include/llvm/Analysis/CFGPrinter.h