These options tweak the behavior of path diangostic consumers. More...

#include "clang/Analysis/PathDiagnostic.h"

Public Attributes
std::string	ToolInvocation
	Run-line of the tool that produced the diagnostic.

bool	ShouldDisplayMacroExpansions = false
	Whether to include additional information about macro expansions with the diagnostics, because otherwise they can be hard to obtain without re-compiling the program under analysis.

bool	ShouldSerializeStats = false
	Whether to include LLVM statistics of the process in the diagnostic.

bool	ShouldWriteVerboseReportFilename = false
	If the consumer intends to produce multiple output files, should it use a pseudo-random file name or a human-readable file name.

bool	ShouldDisplayWarningsAsErrors = false
	Whether the consumer should treat consumed diagnostics as hard errors.

bool	ShouldApplyFixIts = false
	Whether the consumer should attempt to rewrite the source file with fix-it hints attached to the diagnostics it consumes.

bool	ShouldDisplayDiagnosticName = false
	Whether the consumer should present the name of the entity that emitted the diagnostic (eg., a checker) so that the user knew how to disable it.

Detailed Description

These options tweak the behavior of path diangostic consumers.

Most of these options are currently supported by very few consumers.

Definition at line 61 of file PathDiagnostic.h.

Member Data Documentation

◆ ShouldApplyFixIts

bool clang::ento::PathDiagnosticConsumerOptions::ShouldApplyFixIts = false

Whether the consumer should attempt to rewrite the source file with fix-it hints attached to the diagnostics it consumes.

Definition at line 85 of file PathDiagnostic.h.

◆ ShouldDisplayDiagnosticName

bool clang::ento::PathDiagnosticConsumerOptions::ShouldDisplayDiagnosticName = false

Whether the consumer should present the name of the entity that emitted the diagnostic (eg., a checker) so that the user knew how to disable it.

Definition at line 89 of file PathDiagnostic.h.

◆ ShouldDisplayMacroExpansions

bool clang::ento::PathDiagnosticConsumerOptions::ShouldDisplayMacroExpansions = false

Whether to include additional information about macro expansions with the diagnostics, because otherwise they can be hard to obtain without re-compiling the program under analysis.

Definition at line 69 of file PathDiagnostic.h.

◆ ShouldDisplayWarningsAsErrors

bool clang::ento::PathDiagnosticConsumerOptions::ShouldDisplayWarningsAsErrors = false

Whether the consumer should treat consumed diagnostics as hard errors.

Useful for breaking your build when issues are found.

Definition at line 81 of file PathDiagnostic.h.

◆ ShouldSerializeStats

bool clang::ento::PathDiagnosticConsumerOptions::ShouldSerializeStats = false

Whether to include LLVM statistics of the process in the diagnostic.

Useful for profiling the tool on large real-world codebases.

Definition at line 73 of file PathDiagnostic.h.

◆ ShouldWriteVerboseReportFilename

bool clang::ento::PathDiagnosticConsumerOptions::ShouldWriteVerboseReportFilename = false

If the consumer intends to produce multiple output files, should it use a pseudo-random file name or a human-readable file name.

Definition at line 77 of file PathDiagnostic.h.

◆ ToolInvocation

std::string clang::ento::PathDiagnosticConsumerOptions::ToolInvocation

Run-line of the tool that produced the diagnostic.

It can be included with the diagnostic for debugging purposes.

Definition at line 64 of file PathDiagnostic.h.

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

include/clang/Analysis/PathDiagnostic.h

Public Attributes