clang  14.0.0git
Public Member Functions | List of all members
clang::ento::TagVisitor Class Reference

The visitor detects NoteTags and displays the event notes they contain. More...

#include "clang/StaticAnalyzer/Core/BugReporter/BugReporterVisitors.h"

Inheritance diagram for clang::ento::TagVisitor:
Inheritance graph
[legend]
Collaboration diagram for clang::ento::TagVisitor:
Collaboration graph
[legend]

Public Member Functions

void Profile (llvm::FoldingSetNodeID &ID) const override
 
PathDiagnosticPieceRef VisitNode (const ExplodedNode *N, BugReporterContext &BRC, PathSensitiveBugReport &R) override
 Return a diagnostic piece which should be associated with the given node. More...
 
- Public Member Functions inherited from clang::ento::BugReporterVisitor
 BugReporterVisitor ()=default
 
 BugReporterVisitor (const BugReporterVisitor &)=default
 
 BugReporterVisitor (BugReporterVisitor &&)
 
virtual ~BugReporterVisitor ()
 
virtual void finalizeVisitor (BugReporterContext &BRC, const ExplodedNode *EndPathNode, PathSensitiveBugReport &BR)
 Last function called on the visitor, no further calls to VisitNode would follow. More...
 
virtual PathDiagnosticPieceRef getEndPath (BugReporterContext &BRC, const ExplodedNode *N, PathSensitiveBugReport &BR)
 Provide custom definition for the final diagnostic piece on the path - the piece, which is displayed before the path is expanded. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from clang::ento::BugReporterVisitor
static PathDiagnosticPieceRef getDefaultEndPath (const BugReporterContext &BRC, const ExplodedNode *N, const PathSensitiveBugReport &BR)
 Generates the default final diagnostic piece. More...
 

Detailed Description

The visitor detects NoteTags and displays the event notes they contain.

Definition at line 617 of file BugReporterVisitors.h.

Member Function Documentation

◆ Profile()

void TagVisitor::Profile ( llvm::FoldingSetNodeID &  ID) const
overridevirtual

Implements clang::ento::BugReporterVisitor.

Definition at line 3303 of file BugReporterVisitors.cpp.

◆ VisitNode()

PathDiagnosticPieceRef TagVisitor::VisitNode ( const ExplodedNode Succ,
BugReporterContext BRC,
PathSensitiveBugReport BR 
)
overridevirtual

Return a diagnostic piece which should be associated with the given node.

Note that this function does not get run on the very last node of the report, as the PathDiagnosticPiece associated with the last node should be unique. Use getEndPath to customize the note associated with the report end instead.

The last parameter can be used to register a new visitor with the given BugReport while processing a node.

Implements clang::ento::BugReporterVisitor.

Definition at line 3308 of file BugReporterVisitors.cpp.

References clang::ento::PathDiagnosticLocation::create(), clang::ento::NoteTag::generateMessage(), clang::ento::ExplodedNode::getLocation(), clang::ento::BugReporterContext::getSourceManager(), clang::ProgramPoint::getTag(), and clang::ento::NoteTag::isPrunable().


The documentation for this class was generated from the following files: