clang 23.0.0git
clang::ssaf::WPASuite Class Reference

Bundles the EntityIdTable (moved from the LUSummary) and the analysis results produced by one AnalysisDriver::run() call, keyed by AnalysisName. More...

#include "clang/ScalableStaticAnalysisFramework/Core/WholeProgramAnalysis/WPASuite.h"

Public Member Functions

const EntityIdTableidTable () const
 Returns the EntityIdTable that maps EntityId values to their symbolic names.
template<typename ResultT>
bool contains () const
 Returns true if a result for ResultT is present.
bool contains (AnalysisName Name) const
 Returns true if a result for Name is present.
template<typename ResultT>
llvm::Expected< const ResultT & > get () const
 Returns a const reference to the result for ResultT, or an error if absent.
llvm::Expected< const AnalysisResult & > get (AnalysisName Name) const
 Returns a const reference to the result for Name, or an error if absent.

Friends

class AnalysisDriver

Detailed Description

Bundles the EntityIdTable (moved from the LUSummary) and the analysis results produced by one AnalysisDriver::run() call, keyed by AnalysisName.

This is the natural unit of persistence: entity names and analysis results are self-contained in one object.

Definition at line 35 of file WPASuite.h.

Member Function Documentation

◆ contains() [1/2]

template<typename ResultT>
bool clang::ssaf::WPASuite::contains ( ) const
inlinenodiscard

Returns true if a result for ResultT is present.

Definition at line 49 of file WPASuite.h.

References contains(), and clang::ssaf::HasAnalysisName_v.

Referenced by contains().

◆ contains() [2/2]

bool clang::ssaf::WPASuite::contains ( AnalysisName Name) const
inlinenodiscard

Returns true if a result for Name is present.

Definition at line 59 of file WPASuite.h.

◆ get() [1/2]

template<typename ResultT>
llvm::Expected< const ResultT & > clang::ssaf::WPASuite::get ( ) const
inlinenodiscard

Returns a const reference to the result for ResultT, or an error if absent.

Definition at line 66 of file WPASuite.h.

References get(), clang::ssaf::HasAnalysisName_v, and clang::Result.

Referenced by get().

◆ get() [2/2]

llvm::Expected< const AnalysisResult & > clang::ssaf::WPASuite::get ( AnalysisName Name) const
inlinenodiscard

Returns a const reference to the result for Name, or an error if absent.

Definition at line 82 of file WPASuite.h.

References clang::ssaf::ErrorBuilder::build(), and clang::ssaf::ErrorBuilder::create().

◆ idTable()

const EntityIdTable & clang::ssaf::WPASuite::idTable ( ) const
inline

Returns the EntityIdTable that maps EntityId values to their symbolic names.

Definition at line 46 of file WPASuite.h.

◆ AnalysisDriver

friend class AnalysisDriver
friend

Definition at line 36 of file WPASuite.h.

References AnalysisDriver.

Referenced by AnalysisDriver.


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