clang 19.0.0git
Public Member Functions | Static Public Member Functions | List of all members
clang::ento::PathDiagnosticEventPiece Class Reference

#include "clang/Analysis/PathDiagnostic.h"

Inheritance diagram for clang::ento::PathDiagnosticEventPiece:
Inheritance graph
[legend]

Public Member Functions

 PathDiagnosticEventPiece (const PathDiagnosticLocation &pos, StringRef s, bool addPosRange=true)
 
 ~PathDiagnosticEventPiece () override
 
void setPrunable (bool isPrunable, bool override=false)
 Mark the diagnostic piece as being potentially prunable.
 
bool isPrunable () const
 Return true if the diagnostic piece is prunable.
 
void dump () const override
 
- Public Member Functions inherited from clang::ento::PathDiagnosticSpotPiece
 PathDiagnosticSpotPiece (const PathDiagnosticLocation &pos, StringRef s, PathDiagnosticPiece::Kind k, bool addPosRange=true)
 
PathDiagnosticLocation getLocation () const override
 
void flattenLocations () override
 
void Profile (llvm::FoldingSetNodeID &ID) const override
 
- Public Member Functions inherited from clang::ento::PathDiagnosticPiece
 PathDiagnosticPiece ()=delete
 
 PathDiagnosticPiece (const PathDiagnosticPiece &)=delete
 
PathDiagnosticPieceoperator= (const PathDiagnosticPiece &)=delete
 
virtual ~PathDiagnosticPiece ()
 
StringRef getString () const
 
void setTag (const char *tag)
 Tag this PathDiagnosticPiece with the given C-string.
 
const void * getTag () const
 Return the opaque tag (if any) on the PathDiagnosticPiece.
 
StringRef getTagStr () const
 Return the string representation of the tag.
 
DisplayHint getDisplayHint () const
 getDisplayHint - Return a hint indicating where the diagnostic should be displayed by the PathDiagnosticConsumer.
 
virtual PathDiagnosticLocation getLocation () const =0
 
virtual void flattenLocations ()=0
 
Kind getKind () const
 
void addRange (SourceRange R)
 
void addRange (SourceLocation B, SourceLocation E)
 
void addFixit (FixItHint F)
 
ArrayRef< SourceRangegetRanges () const
 Return the SourceRanges associated with this PathDiagnosticPiece.
 
ArrayRef< FixItHintgetFixits () const
 Return the fix-it hints associated with this PathDiagnosticPiece.
 
virtual void Profile (llvm::FoldingSetNodeID &ID) const
 
void setAsLastInMainSourceFile ()
 
bool isLastInMainSourceFile () const
 
virtual void dump () const =0
 

Static Public Member Functions

static bool classof (const PathDiagnosticPiece *P)
 
- Static Public Member Functions inherited from clang::ento::PathDiagnosticSpotPiece
static bool classof (const PathDiagnosticPiece *P)
 

Additional Inherited Members

- Public Types inherited from clang::ento::PathDiagnosticPiece
enum  Kind {
  ControlFlow , Event , Macro , Call ,
  Note , PopUp
}
 
enum  DisplayHint { Above , Below }
 
- Protected Member Functions inherited from clang::ento::PathDiagnosticPiece
 PathDiagnosticPiece (StringRef s, Kind k, DisplayHint hint=Below)
 
 PathDiagnosticPiece (Kind k, DisplayHint hint=Below)
 

Detailed Description

Definition at line 534 of file PathDiagnostic.h.

Constructor & Destructor Documentation

◆ PathDiagnosticEventPiece()

clang::ento::PathDiagnosticEventPiece::PathDiagnosticEventPiece ( const PathDiagnosticLocation pos,
StringRef  s,
bool  addPosRange = true 
)
inline

Definition at line 538 of file PathDiagnostic.h.

◆ ~PathDiagnosticEventPiece()

PathDiagnosticEventPiece::~PathDiagnosticEventPiece ( )
overridedefault

Member Function Documentation

◆ classof()

static bool clang::ento::PathDiagnosticEventPiece::classof ( const PathDiagnosticPiece P)
inlinestatic

Definition at line 557 of file PathDiagnostic.h.

References clang::ento::PathDiagnosticPiece::Event, and P.

◆ dump()

LLVM_DUMP_METHOD void PathDiagnosticEventPiece::dump ( ) const
overridevirtual

Implements clang::ento::PathDiagnosticPiece.

Definition at line 1172 of file PathDiagnostic.cpp.

◆ isPrunable()

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

Return true if the diagnostic piece is prunable.

Definition at line 553 of file PathDiagnostic.h.

Referenced by setPrunable().

◆ setPrunable()

void clang::ento::PathDiagnosticEventPiece::setPrunable ( bool  isPrunable,
bool  override = false 
)
inline

Mark the diagnostic piece as being potentially prunable.

This flag may have been previously set, at which point it will not be reset unless one specifies to do so.

Definition at line 546 of file PathDiagnostic.h.

References isPrunable().


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