clang 20.0.0git
Public Member Functions | List of all members
clang::DeclFilterCCC< C > Class Template Referencefinal

Simple template class for restricting typo correction candidates to ones having a single Decl* of the given type. More...

#include "clang/Sema/TypoCorrection.h"

Inheritance diagram for clang::DeclFilterCCC< C >:
Inheritance graph
[legend]

Public Member Functions

 DeclFilterCCC (const IdentifierInfo *Typo=nullptr, NestedNameSpecifier *TypoNNS=nullptr)
 
bool ValidateCandidate (const TypoCorrection &candidate) override
 Simple predicate used by the default RankCandidate to determine whether to return an edit distance of 0 or InvalidDistance.
 
std::unique_ptr< CorrectionCandidateCallbackclone () override
 Clone this CorrectionCandidateCallback.
 
- Public Member Functions inherited from clang::CorrectionCandidateCallback
 CorrectionCandidateCallback (const IdentifierInfo *Typo=nullptr, NestedNameSpecifier *TypoNNS=nullptr)
 
virtual ~CorrectionCandidateCallback ()=default
 
virtual bool ValidateCandidate (const TypoCorrection &candidate)
 Simple predicate used by the default RankCandidate to determine whether to return an edit distance of 0 or InvalidDistance.
 
virtual unsigned RankCandidate (const TypoCorrection &candidate)
 Method used by Sema::CorrectTypo to assign an "edit distance" rank to a candidate (where a lower value represents a better candidate), or returning InvalidDistance if the candidate is not at all viable.
 
virtual std::unique_ptr< CorrectionCandidateCallbackclone ()=0
 Clone this CorrectionCandidateCallback.
 
void setTypoName (const IdentifierInfo *II)
 
void setTypoNNS (NestedNameSpecifier *NNS)
 

Additional Inherited Members

- Public Attributes inherited from clang::CorrectionCandidateCallback
bool WantTypeSpecifiers = true
 
bool WantExpressionKeywords = true
 
bool WantCXXNamedCasts = true
 
bool WantFunctionLikeCasts = true
 
bool WantRemainingKeywords = true
 
bool WantObjCSuper = false
 
bool IsObjCIvarLookup = false
 
bool IsAddressOfOperand = false
 
- Static Public Attributes inherited from clang::CorrectionCandidateCallback
static const unsigned InvalidDistance = TypoCorrection::InvalidDistance
 
- Protected Member Functions inherited from clang::CorrectionCandidateCallback
bool MatchesTypo (const TypoCorrection &candidate)
 
- Protected Attributes inherited from clang::CorrectionCandidateCallback
const IdentifierInfoTypo
 
NestedNameSpecifierTypoNNS
 

Detailed Description

template<class C>
class clang::DeclFilterCCC< C >

Simple template class for restricting typo correction candidates to ones having a single Decl* of the given type.

Definition at line 366 of file TypoCorrection.h.

Constructor & Destructor Documentation

◆ DeclFilterCCC()

template<class C >
clang::DeclFilterCCC< C >::DeclFilterCCC ( const IdentifierInfo Typo = nullptr,
NestedNameSpecifier TypoNNS = nullptr 
)
inlineexplicit

Definition at line 368 of file TypoCorrection.h.

Member Function Documentation

◆ clone()

template<class C >
std::unique_ptr< CorrectionCandidateCallback > clang::DeclFilterCCC< C >::clone ( )
inlineoverridevirtual

Clone this CorrectionCandidateCallback.

CorrectionCandidateCallbacks are initially stack-allocated. However in case where delayed typo-correction is done we need to move the callback to storage with a longer lifetime. Every class deriving from CorrectionCandidateCallback must implement this method.

Implements clang::CorrectionCandidateCallback.

Definition at line 375 of file TypoCorrection.h.

◆ ValidateCandidate()

template<class C >
bool clang::DeclFilterCCC< C >::ValidateCandidate ( const TypoCorrection candidate)
inlineoverridevirtual

Simple predicate used by the default RankCandidate to determine whether to return an edit distance of 0 or InvalidDistance.

This can be overridden by validators that only need to determine if a candidate is viable, without ranking potentially viable candidates. Only ValidateCandidate or RankCandidate need to be overridden by a callback wishing to check the viability of correction candidates. The default predicate always returns true if the candidate is not a type name or keyword, true for types if WantTypeSpecifiers is true, and true for keywords if WantTypeSpecifiers, WantExpressionKeywords, WantCXXNamedCasts, WantRemainingKeywords, or WantObjCSuper is true.

Reimplemented from clang::CorrectionCandidateCallback.

Definition at line 372 of file TypoCorrection.h.

References clang::C, and clang::TypoCorrection::getCorrectionDeclAs().


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