clang  17.0.0git
Public Member Functions | List of all members
clang::ento::StackHintGeneratorForSymbol Class Reference

Constructs a Stack hint for the given symbol. More...

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

Inheritance diagram for clang::ento::StackHintGeneratorForSymbol:
Inheritance graph
Collaboration diagram for clang::ento::StackHintGeneratorForSymbol:
Collaboration graph

Public Member Functions

 StackHintGeneratorForSymbol (SymbolRef S, StringRef M)
 ~StackHintGeneratorForSymbol () override=default
std::string getMessage (const ExplodedNode *N) override
 Search the call expression for the symbol Sym and dispatch the 'getMessageForX()' methods to construct a specific message. More...
virtual std::string getMessageForArg (const Expr *ArgE, unsigned ArgIndex)
 Produces the message of the following form: 'Msg via Nth parameter'. More...
virtual std::string getMessageForReturn (const CallExpr *CallExpr)
virtual std::string getMessageForSymbolNotFound ()
- Public Member Functions inherited from clang::ento::StackHintGenerator
virtual ~StackHintGenerator ()=0

Detailed Description

Constructs a Stack hint for the given symbol.

The class knows how to construct the stack hint message based on traversing the CallExpr associated with the call and checking if the given symbol is returned or is one of the arguments. The hint can be customized by redefining 'getMessageForX()' methods.

Definition at line 91 of file BugReporter.h.

Constructor & Destructor Documentation

◆ StackHintGeneratorForSymbol()

clang::ento::StackHintGeneratorForSymbol::StackHintGeneratorForSymbol ( SymbolRef  S,
StringRef  M 

Definition at line 97 of file BugReporter.h.

◆ ~StackHintGeneratorForSymbol()

clang::ento::StackHintGeneratorForSymbol::~StackHintGeneratorForSymbol ( )

Member Function Documentation

◆ getMessage()

std::string StackHintGeneratorForSymbol::getMessage ( const ExplodedNode N)

◆ getMessageForArg()

std::string StackHintGeneratorForSymbol::getMessageForArg ( const Expr ArgE,
unsigned  ArgIndex 

Produces the message of the following form: 'Msg via Nth parameter'.

Definition at line 333 of file BugReporter.cpp.

◆ getMessageForReturn()

virtual std::string clang::ento::StackHintGeneratorForSymbol::getMessageForReturn ( const CallExpr CallExpr)

Definition at line 108 of file BugReporter.h.

◆ getMessageForSymbolNotFound()

virtual std::string clang::ento::StackHintGeneratorForSymbol::getMessageForSymbolNotFound ( )

Definition at line 112 of file BugReporter.h.

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