clang 10.0.0git

Public Types | Public Member Functions | Public Attributes | List of all members
clang::ento::PathDiagnostic Class Reference

PathDiagnostic - PathDiagnostic objects represent a single path-sensitive diagnostic. More...

`#include "clang/Analysis/PathDiagnostic.h"`

Inheritance diagram for clang::ento::PathDiagnostic:
[legend]
Collaboration diagram for clang::ento::PathDiagnostic:
[legend]

## Public Types
using | meta_iterator = std::deque< std::string >::const_iterator

## Public Member Functions
| PathDiagnostic ()=delete
| PathDiagnostic (StringRef CheckerName, const Decl *DeclWithIssue, StringRef bugtype, StringRef verboseDesc, StringRef shortDesc, StringRef category, PathDiagnosticLocation LocationToUnique, const Decl *DeclToUnique, std::unique_ptr< FilesToLineNumsMap > ExecutedLines)
| ~PathDiagnostic ()
PathPieces & | getActivePath ()
| Return the path currently used by builders for constructing the PathDiagnostic. More...
PathPieces & | getMutablePieces ()
| Return a mutable version of 'path'. More...
unsigned | full_size ()
| Return the unrolled size of the path. More...
void | pushActivePath (PathPieces *p)
void | popActivePath ()
bool | isWithinCall () const
void | setEndOfPath (PathDiagnosticPieceRef EndPiece)
void | appendToDesc (StringRef S)
StringRef | getVerboseDescription () const
StringRef | getShortDescription () const
StringRef | getCheckerName () const
StringRef | getBugType () const
StringRef | getCategory () const
meta_iterator | meta_begin () const
meta_iterator | meta_end () const
void | addMeta (StringRef s)
const FilesToLineNumsMap & | getExecutedLines () const
FilesToLineNumsMap & | getExecutedLines ()
const Decl * | getDeclWithIssue () const
| Return the semantic context where an issue occurred. More...
void | setDeclWithIssue (const Decl *D)
PathDiagnosticLocation | getLocation () const
void | setLocation (PathDiagnosticLocation NewLoc)
PathDiagnosticLocation | getUniqueingLoc () const
| Get the location on which the report should be uniqued. More...
const Decl * | getUniqueingDecl () const
| Get the declaration containing the uniqueing location. More...
void | flattenLocations ()
void | Profile (llvm::FoldingSetNodeID &ID) const
| Profiles the diagnostic, independent of the path it references. More...
void | FullProfile (llvm::FoldingSetNodeID &ID) const
| Profiles the diagnostic, including its path. More...

## Public Attributes
const PathPieces & | path

## Detailed Description

PathDiagnostic - PathDiagnostic objects represent a single path-sensitive diagnostic.

It represents an ordered-collection of PathDiagnosticPieces, each which represent the pieces of the path.

Definition at line 727 of file PathDiagnostic.h.

## Member Typedef Documentation

## ◆ meta_iterator

using clang::ento::PathDiagnostic::meta_iterator = std::deque<std::string>::const_iterator

Definition at line 805 of file PathDiagnostic.h.

## Constructor & Destructor Documentation

## ◆ PathDiagnostic() [1/2]

clang::ento::PathDiagnostic::PathDiagnostic | ( |  | ) |
| delete

## ◆ PathDiagnostic() [2/2]

PathDiagnostic::PathDiagnostic | ( | StringRef | CheckerName,
|  | const Decl * | DeclWithIssue,
|  | StringRef | bugtype,
|  | StringRef | verboseDesc,
|  | StringRef | shortDesc,
|  | StringRef | category,
|  | PathDiagnosticLocation | LocationToUnique,
|  | const Decl * | DeclToUnique,
|  | std::unique_ptr< FilesToLineNumsMap > | ExecutedLines
| ) |  |

Definition at line 119 of file PathDiagnostic.cpp.

## ◆ ~PathDiagnostic()

PathDiagnostic::~PathDiagnostic | ( |  | ) |
| default

## Member Function Documentation

## ◆ addMeta()

void clang::ento::PathDiagnostic::addMeta | ( | StringRef | s | ) |
| inline

Definition at line 809 of file PathDiagnostic.h.

## ◆ appendToDesc()

void clang::ento::PathDiagnostic::appendToDesc | ( | StringRef | S | ) |
| inline

Definition at line 789 of file PathDiagnostic.h.

## ◆ flattenLocations()

void clang::ento::PathDiagnostic::flattenLocations | ( |  | ) |
| inline

Definition at line 846 of file PathDiagnostic.h.

References clang::ento::PathDiagnosticLocation::flatten(), and clang::ento::PathDiagnosticConsumer::PDFileEntry::Profile().

## ◆ full_size()

unsigned PathDiagnostic::full_size | ( |  | ) |

Return the unrolled size of the path.

Definition at line 1059 of file PathDiagnostic.cpp.

References compute_path_size(), and path.

## ◆ FullProfile()

void PathDiagnostic::FullProfile | ( | llvm::FoldingSetNodeID & | ID | ) | const

Profiles the diagnostic, including its path.

Two diagnostics with the same issue along different paths will generate different profiles.

Definition at line 1125 of file PathDiagnostic.cpp.

References meta_begin(), meta_end(), path, and Profile().

## ◆ getActivePath()

PathPieces& clang::ento::PathDiagnostic::getActivePath | ( |  | ) |
| inline

Return the path currently used by builders for constructing the PathDiagnostic.

Definition at line 763 of file PathDiagnostic.h.

## ◆ getBugType()

StringRef clang::ento::PathDiagnostic::getBugType | ( |  | ) | const
| inline

Definition at line 802 of file PathDiagnostic.h.

Referenced by compare().

## ◆ getCategory()

StringRef clang::ento::PathDiagnostic::getCategory | ( |  | ) | const
| inline

Definition at line 803 of file PathDiagnostic.h.

References Category.

Referenced by compare().

## ◆ getCheckerName()

StringRef clang::ento::PathDiagnostic::getCheckerName | ( |  | ) | const
| inline

Definition at line 801 of file PathDiagnostic.h.

## ◆ getDeclWithIssue()

const Decl* clang::ento::PathDiagnostic::getDeclWithIssue | ( |  | ) | const
| inline

Return the semantic context where an issue occurred.

If the issue occurs along a path, this represents the "central" area where the bug manifests.

Definition at line 822 of file PathDiagnostic.h.

Referenced by compare().

## ◆ getExecutedLines() [1/2]

const FilesToLineNumsMap& clang::ento::PathDiagnostic::getExecutedLines | ( |  | ) | const
| inline

Definition at line 811 of file PathDiagnostic.h.

## ◆ getExecutedLines() [2/2]

FilesToLineNumsMap& clang::ento::PathDiagnostic::getExecutedLines | ( |  | ) |
| inline

Definition at line 815 of file PathDiagnostic.h.

## ◆ getLocation()

PathDiagnosticLocation clang::ento::PathDiagnostic::getLocation | ( |  | ) | const
| inline

Definition at line 828 of file PathDiagnostic.h.

Referenced by compare(), clang::ento::PathDiagnosticEventPiece::dump(), clang::ento::PathDiagnosticCallPiece::dump(), clang::ento::PathDiagnosticNotePiece::dump(), clang::ento::PathDiagnosticPopUpPiece::dump(), and Profile().

## ◆ getMutablePieces()

PathPieces& clang::ento::PathDiagnostic::getMutablePieces | ( |  | ) |
| inline

Return a mutable version of 'path'.

Definition at line 770 of file PathDiagnostic.h.

## ◆ getShortDescription()

StringRef clang::ento::PathDiagnostic::getShortDescription | ( |  | ) | const
| inline

Definition at line 797 of file PathDiagnostic.h.

Referenced by compare().

## ◆ getUniqueingDecl()

const Decl* clang::ento::PathDiagnostic::getUniqueingDecl | ( |  | ) | const
| inline

Get the declaration containing the uniqueing location.

Definition at line 842 of file PathDiagnostic.h.

## ◆ getUniqueingLoc()

PathDiagnosticLocation clang::ento::PathDiagnostic::getUniqueingLoc | ( |  | ) | const
| inline

Get the location on which the report should be uniqued.

Definition at line 837 of file PathDiagnostic.h.

## ◆ getVerboseDescription()

StringRef clang::ento::PathDiagnostic::getVerboseDescription | ( |  | ) | const
| inline

Definition at line 795 of file PathDiagnostic.h.

Referenced by compare().

## ◆ isWithinCall()

bool clang::ento::PathDiagnostic::isWithinCall | ( |  | ) | const
| inline

Definition at line 780 of file PathDiagnostic.h.

## ◆ meta_begin()

meta_iterator clang::ento::PathDiagnostic::meta_begin | ( |  | ) | const
| inline

Definition at line 807 of file PathDiagnostic.h.

Referenced by compare(), and FullProfile().

## ◆ meta_end()

meta_iterator clang::ento::PathDiagnostic::meta_end | ( |  | ) | const
| inline

Definition at line 808 of file PathDiagnostic.h.

Referenced by compare(), and FullProfile().

## ◆ popActivePath()

void clang::ento::PathDiagnostic::popActivePath | ( |  | ) |
| inline

Definition at line 778 of file PathDiagnostic.h.

## ◆ Profile()

void PathDiagnostic::Profile | ( | llvm::FoldingSetNodeID & | ID | ) | const

Profiles the diagnostic, independent of the path it references.

This can be used to merge diagnostics that refer to the same issue along different paths.

Definition at line 1118 of file PathDiagnostic.cpp.

References getLocation().

Referenced by FullProfile().

## ◆ pushActivePath()

void clang::ento::PathDiagnostic::pushActivePath | ( | PathPieces * | p | ) |
| inline

Definition at line 777 of file PathDiagnostic.h.

## ◆ setDeclWithIssue()

void clang::ento::PathDiagnostic::setDeclWithIssue | ( | const Decl * | D | ) |
| inline

Definition at line 824 of file PathDiagnostic.h.

## ◆ setEndOfPath()

void clang::ento::PathDiagnostic::setEndOfPath | ( | PathDiagnosticPieceRef | EndPiece | ) |
| inline

Definition at line 782 of file PathDiagnostic.h.

References clang::ento::PathDiagnosticLocation::isValid().

## ◆ setLocation()

void clang::ento::PathDiagnostic::setLocation | ( | PathDiagnosticLocation | NewLoc | ) |
| inline

Definition at line 832 of file PathDiagnostic.h.

## Member Data Documentation

## ◆ path

const PathPieces& clang::ento::PathDiagnostic::path

Definition at line 759 of file PathDiagnostic.h.

Referenced by compare(), full_size(), FullProfile(), clang::ento::PathDiagnosticConsumer::HandlePathDiagnostic(), and clang::ento::PathDiagnosticCallPiece::Profile().

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

- include/clang/Analysis/PathDiagnostic.h
- lib/Analysis/PathDiagnostic.cpp