[#llvm-DOTGraphTraits-08]
= xref:llvm.adoc[llvm]::xref:llvm/DOTGraphTraits-077.adoc[DOTGraphTraits]<xref:llvm/DomTreeNode.adoc[DomTreeNode]*>
:relfileprefix: ../
:mrdocs:

DOTGraphTraits specialization for rendering a dominator‐tree node.

== Synopsis

Declared in `<llvm/Analysis/DomPrinter.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
struct xref:llvm/DOTGraphTraits-077.adoc[DOTGraphTraits]<xref:llvm/DomTreeNode.adoc[DomTreeNode]*>
    : xref:llvm/DefaultDOTGraphTraits.adoc[DefaultDOTGraphTraits]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/DefaultDOTGraphTraits.adoc[DefaultDOTGraphTraits]`
| Default implementations of all DOTGraphTraits customization hooks.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DOTGraphTraits-08/2constructor.adoc[`DOTGraphTraits`]         [.small]#[constructor]#
| Construct DOT traits for a dominator‐tree node, optionally in simple mode.
| xref:llvm/DOTGraphTraits-08/getNodeLabel-0a.adoc[`getNodeLabel`] 
| `getNodeLabel` overloads
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DefaultDOTGraphTraits/addCustomGraphFeatures.adoc[`addCustomGraphFeatures`] 
| Emit graph features beyond ordinary nodes and edges.
| xref:llvm/DefaultDOTGraphTraits/edgeTargetsEdgeSource.adoc[`edgeTargetsEdgeSource`] 
| Return true if this outgoing edge should target another edge source.
| xref:llvm/DefaultDOTGraphTraits/getEdgeAttributes.adoc[`getEdgeAttributes`] 
| Return custom DOT attributes for a particular edge.
| xref:llvm/DefaultDOTGraphTraits/getEdgeDestLabel.adoc[`getEdgeDestLabel`] 
| Return the incoming edge destination label at the given index.
| xref:llvm/DefaultDOTGraphTraits/getEdgeSourceLabel.adoc[`getEdgeSourceLabel`] 
| Return a label for the edge source itself, if any.
| xref:llvm/DefaultDOTGraphTraits/getEdgeTarget.adoc[`getEdgeTarget`] 
| Return the outgoing edge that is the target of this edge.
| xref:llvm/DefaultDOTGraphTraits/getGraphName.adoc[`getGraphName`] 
| Return the label for the graph as a whole.
| xref:llvm/DefaultDOTGraphTraits/getGraphProperties.adoc[`getGraphProperties`] 
| Return custom properties for the top‐level DOT graph structure.
| xref:llvm/DefaultDOTGraphTraits/getNodeAttributes.adoc[`getNodeAttributes`] 
| Return custom DOT attributes for the given node.
| xref:llvm/DefaultDOTGraphTraits/getNodeDescription.adoc[`getNodeDescription`] 
| Return an optional longer description for the given node.
| xref:llvm/DefaultDOTGraphTraits/getNodeIdentifierLabel.adoc[`getNodeIdentifierLabel`] 
| Return a unique identifier string for the given node.
| xref:llvm/DefaultDOTGraphTraits/hasEdgeDestLabels.adoc[`hasEdgeDestLabels`] 
| hasEdgeDestLabels ‐ If this function returns true, the graph is able to provide labels for edge destinations.
| xref:llvm/DefaultDOTGraphTraits/isNodeHidden.adoc[`isNodeHidden`] 
| Return true if the given node should be omitted from the graph.
| xref:llvm/DefaultDOTGraphTraits/numEdgeDestLabels.adoc[`numEdgeDestLabels`] 
| Return how many incoming edge destination labels the node has.
| xref:llvm/DefaultDOTGraphTraits/renderGraphFromBottomUp.adoc[`renderGraphFromBottomUp`] 
| renderGraphFromBottomUp ‐ If this function returns true, the graph is emitted bottom‐up instead of top‐down. This requires graphviz 2.0 to work though.
| xref:llvm/DefaultDOTGraphTraits/renderNodesUsingHTML.adoc[`renderNodesUsingHTML`] 
| Return true if nodes should be rendered with HTML‐like labels.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DefaultDOTGraphTraits/isSimple.adoc[`isSimple`] 
| Return true if this traits instance was constructed for simple names.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DOTGraphTraits-0b7.adoc[`DOTGraphTraits<DominatorTree*>`] 
| DOTGraphTraits specialization for rendering a dominator tree.
| xref:llvm/DOTGraphTraits-0bb.adoc[`DOTGraphTraits<PostDominatorTree*>`] 
| DOTGraphTraits specialization for rendering a post‐dominator tree.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#