Base class for callback objects used by Sema::CorrectTypo to check the validity of a potential typo correction. More...

#include "clang/Sema/TypoCorrection.h"

Inheritance diagram for clang::CorrectionCandidateCallback:

[legend]

Public Member Functions
	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< CorrectionCandidateCallback >	clone ()=0
	Clone this CorrectionCandidateCallback.

void	setTypoName (const IdentifierInfo *II)

void	setTypoNNS (NestedNameSpecifier *NNS)

Public Attributes
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
static const unsigned	InvalidDistance = TypoCorrection::InvalidDistance

Protected Member Functions
bool	MatchesTypo (const TypoCorrection &candidate)

Protected Attributes
const IdentifierInfo *	Typo

NestedNameSpecifier *	TypoNNS

Detailed Description

Base class for callback objects used by Sema::CorrectTypo to check the validity of a potential typo correction.

Definition at line 281 of file TypoCorrection.h.

Constructor & Destructor Documentation

◆ CorrectionCandidateCallback()

clang::CorrectionCandidateCallback::CorrectionCandidateCallback	(	const IdentifierInfo *	Typo = `nullptr`,
		NestedNameSpecifier *	TypoNNS = `nullptr`
	)

inlineexplicit

Definition at line 285 of file TypoCorrection.h.

◆ ~CorrectionCandidateCallback()

virtual clang::CorrectionCandidateCallback::~CorrectionCandidateCallback ( )

virtualdefault

Member Function Documentation

◆ clone()

virtual std::unique_ptr< CorrectionCandidateCallback > clang::CorrectionCandidateCallback::clone ( )

pure virtual

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.

Implemented in clang::DefaultFilterCCC, clang::DeclFilterCCC< C >, clang::FunctionCallFilterCCC, and clang::NoTypoCorrectionCCC.

◆ MatchesTypo()

bool clang::CorrectionCandidateCallback::MatchesTypo ( const TypoCorrection & candidate )

inlineprotected

Definition at line 340 of file TypoCorrection.h.

References clang::TypoCorrection::getCorrectionAsIdentifierInfo(), clang::TypoCorrection::getCorrectionSpecifier(), clang::TypoCorrection::isResolved(), clang::TypoCorrection::requiresImport(), Typo, and TypoNNS.

Referenced by RankCandidate().

◆ RankCandidate()

virtual unsigned clang::CorrectionCandidateCallback::RankCandidate ( const TypoCorrection & candidate )

inlinevirtual

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.

For validation callbacks that only need to determine if a candidate is viable, the default RankCandidate returns either 0 or InvalidDistance depending whether ValidateCandidate returns true or false.

Definition at line 309 of file TypoCorrection.h.

References InvalidDistance, MatchesTypo(), and ValidateCandidate().

Referenced by isCandidateViable().

◆ setTypoName()

void clang::CorrectionCandidateCallback::setTypoName ( const IdentifierInfo * II )

inline

Definition at line 322 of file TypoCorrection.h.

References Typo.

Referenced by clang::Sema::ActOnIdExpression().

◆ setTypoNNS()

void clang::CorrectionCandidateCallback::setTypoNNS ( NestedNameSpecifier * NNS )

inline

Definition at line 323 of file TypoCorrection.h.

References TypoNNS.

Referenced by clang::Sema::ActOnIdExpression().

◆ ValidateCandidate()

bool CorrectionCandidateCallback::ValidateCandidate ( const TypoCorrection & candidate )

virtual

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 in clang::DeclFilterCCC< C >, clang::FunctionCallFilterCCC, and clang::NoTypoCorrectionCCC.

Definition at line 5416 of file SemaLookup.cpp.

References D, clang::TypoCorrection::getCorrectionSpecifier(), IsAddressOfOperand, clang::TypoCorrection::isKeyword(), clang::TypoCorrection::isResolved(), WantCXXNamedCasts, WantExpressionKeywords, WantObjCSuper, WantRemainingKeywords, and WantTypeSpecifiers.

Referenced by RankCandidate().