[#llvm-DOTGraphTraitsViewer-03]
= xref:llvm.adoc[llvm]::DOTGraphTraitsViewer
:relfileprefix: ../
:mrdocs:

Pass mixin that displays an analysis graph for a function in a viewer.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    typename AnalysisT,
    bool IsSimple,
    typename GraphT = AnalysisT::Result*,
    typename AnalysisGraphTraitsT = xref:llvm/DefaultAnalysisGraphTraits.adoc[DefaultAnalysisGraphTraits<AnalysisT::Result&, GraphT>]>
struct DOTGraphTraitsViewer
    : xref:llvm/RequiredPassInfoMixin-047.adoc[RequiredPassInfoMixin<DOTGraphTraitsViewer<AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT>>]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:llvm/RequiredPassInfoMixin-047.adoc[RequiredPassInfoMixin<DOTGraphTraitsViewer<AnalysisT, IsSimple, GraphT, AnalysisGraphTraitsT>>]`
| A CRTP mix‐in for passes that should not be skipped.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DOTGraphTraitsViewer-03/2constructor.adoc[`DOTGraphTraitsViewer`]         [.small]#[constructor]#
| Construct a viewer pass with the given graph name.
| xref:llvm/RequiredPassInfoMixin-047/printPipeline.adoc[`printPipeline`] 
| Print this pass as a single name in a textual pipeline.
| xref:llvm/DOTGraphTraitsViewer-03/processFunction.adoc[`processFunction`]  [.small]#[virtual]#
| Return true if this function should be processed.
| xref:llvm/DOTGraphTraitsViewer-03/run.adoc[`run`] 
| Display the analysis graph for `F` in a Graphviz viewer.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/RequiredPassInfoMixin-047/isRequired.adoc[`isRequired`] 
| Return true; required passes cannot be skipped.
|===


== Protected Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DOTGraphTraitsViewer-03/2destructor.adoc[`~DOTGraphTraitsViewer`] [.small]#[destructor]#
| Avoid compiler warning "has virtual functions but non‐virtual destructor [‐Wnon‐virtual‐dtor]" in derived classes.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:llvm/DomOnlyViewer.adoc[`DomOnlyViewer`] 
| Pass that displays a function dominator tree without block bodies.
| xref:llvm/DomViewer.adoc[`DomViewer`] 
| Pass that displays a function dominator tree in a Graphviz viewer.
| xref:llvm/PostDomOnlyViewer.adoc[`PostDomOnlyViewer`] 
| Pass that displays a function post‐dominator tree without block bodies.
| xref:llvm/PostDomViewer.adoc[`PostDomViewer`] 
| Pass that displays a function post‐dominator tree in a Graphviz viewer.
|===


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