clang::ento::NoteTag Class Reference

The tag upon which the TagVisitor reacts. More...

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

Inheritance diagram for clang::ento::NoteTag:

Public Types
using	Callback

Public Member Functions
std::optional< std::string >	generateMessage (BugReporterContext &BRC, PathSensitiveBugReport &R) const
StringRef	getDebugTag () const override
	The description of this program point which will be dumped for debugging purposes.
bool	isPrunable () const
Public Member Functions inherited from clang::ProgramPointTag
	ProgramPointTag (void *tagKind=nullptr)
virtual	~ProgramPointTag ()
const void *	getTagKind () const
	Used to implement 'isKind' in subclasses.

Static Public Member Functions
static bool	classof (const ProgramPointTag *T)

Friends
class	Factory
class	TagVisitor

Additional Inherited Members
Protected Member Functions inherited from clang::ento::DataTag
	DataTag (void *TagKind)

Detailed Description

The tag upon which the TagVisitor reacts.

Add these in order to display additional PathDiagnosticEventPieces along the path.

Definition at line 790 of file BugReporter.h.

Member Typedef Documentation

Callback

using clang::ento::NoteTag::Callback

Initial value:

 std::function<std::string(BugReporterContext &,
                                             PathSensitiveBugReport &)>

Definition at line 792 of file BugReporter.h.

Member Function Documentation

classof()

bool clang::ento::NoteTag::classof ( const ProgramPointTag * T )

inlinestatic

Definition at line 805 of file BugReporter.h.

References clang::ProgramPointTag::ProgramPointTag().

generateMessage()

std::optional< std::string > clang::ento::NoteTag::generateMessage ( BugReporterContext & BRC, PathSensitiveBugReport & R ) const

inline

Definition at line 809 of file BugReporter.h.

getDebugTag()

StringRef clang::ento::NoteTag::getDebugTag ( ) const

inlineoverridevirtual

The description of this program point which will be dumped for debugging purposes.

Do not use in user-facing output!

Reimplemented from clang::ento::DataTag.

Definition at line 818 of file BugReporter.h.

isPrunable()

bool clang::ento::NoteTag::isPrunable ( ) const

inline

Definition at line 825 of file BugReporter.h.

Friends And Related Symbol Documentation

Factory

friend class Factory

friend

Definition at line 827 of file BugReporter.h.

References Factory.

Referenced by Factory.

TagVisitor

friend class TagVisitor

friend

Definition at line 828 of file BugReporter.h.

References TagVisitor.

Referenced by TagVisitor.

---

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

• include/clang/StaticAnalyzer/Core/BugReporter/BugReporter.h
• lib/StaticAnalyzer/Core/BugReporterVisitors.cpp