clang  14.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for clang::ento::NoteTag:
Collaboration graph
[legend]

Public Types

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

Public Member Functions

Optional< std::stringgenerateMessage (BugReporterContext &BRC, PathSensitiveBugReport &R) const
 
StringRef getTagDescription () const override
 
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. More...
 

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 765 of file BugReporter.h.

Member Typedef Documentation

◆ Callback

Definition at line 768 of file BugReporter.h.

Member Function Documentation

◆ classof()

static bool clang::ento::NoteTag::classof ( const ProgramPointTag T)
inlinestatic

Definition at line 780 of file BugReporter.h.

References clang::ProgramPointTag::getTagKind().

◆ generateMessage()

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

Definition at line 784 of file BugReporter.h.

References string().

Referenced by clang::ento::TagVisitor::VisitNode().

◆ getTagDescription()

StringRef clang::ento::NoteTag::getTagDescription ( ) const
inlineoverridevirtual

Reimplemented from clang::ento::DataTag.

Definition at line 793 of file BugReporter.h.

◆ isPrunable()

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

Definition at line 800 of file BugReporter.h.

Referenced by clang::ento::TagVisitor::VisitNode().

Friends And Related Function Documentation

◆ Factory

friend class Factory
friend

Definition at line 802 of file BugReporter.h.

◆ TagVisitor

friend class TagVisitor
friend

Definition at line 803 of file BugReporter.h.


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