OverloadCandidate - A single candidate in an overload set (C++ 13.3). More...

#include "clang/Sema/Overload.h"

Public Member Functions
OverloadCandidateRewriteKind	getRewriteKind () const
	Get RewriteKind value in OverloadCandidateRewriteKind type (This function is to workaround the spurious GCC bitfield enum warning)
bool	isReversed () const
bool	hasAmbiguousConversion () const
	hasAmbiguousConversion - Returns whether this overload candidate requires an ambiguous conversion or not.
bool	isPerfectMatch (const ASTContext &Ctx) const
bool	TryToFixBadConversion (unsigned Idx, Sema &S)
unsigned	getNumParams () const
bool	NotValidBecauseConstraintExprHasError () const

Public Attributes
FunctionDecl *	Function
	Function - The actual function that this candidate represents.
DeclAccessPair	FoundDecl
	FoundDecl - The original declaration that was looked up / invented / otherwise found, together with its access.
QualType	BuiltinParamTypes [3]
	BuiltinParamTypes - Provides the parameter types of a built-in overload candidate.
CXXConversionDecl *	Surrogate
	Surrogate - The conversion function for which this candidate is a surrogate, but only if IsSurrogate is true.
ConversionSequenceList	Conversions
	The conversion sequences used to convert the function arguments to the function parameters.
ConversionFixItGenerator	Fix
	The FixIt hints which can be used to fix the Bad candidate.
unsigned	Viable: 1
	Viable - True to indicate that this overload candidate is viable.
unsigned	Best: 1
	Whether this candidate is the best viable function, or tied for being the best viable function.
unsigned	IsSurrogate: 1
	IsSurrogate - True to indicate that this candidate is a surrogate for a conversion to a function pointer or reference (C++ [over.call.object]).
unsigned	IgnoreObjectArgument: 1
	IgnoreObjectArgument - True to indicate that the first argument's conversion, which for this function represents the implicit object argument, should be ignored.
unsigned	TookAddressOfOverload: 1
unsigned	StrictPackMatch: 1
	Have we matched any packs on the parameter side, versus any non-packs on the argument side, in a context where the opposite matching is also allowed?
unsigned	IsADLCandidate: 1
	True if the candidate was found using ADL.
unsigned	HasFinalConversion: 1
	Whether FinalConversion has been set.
unsigned	RewriteKind: 2
	Whether this is a rewritten candidate, and if so, of what kind?
unsigned	FailureKind: 8
	FailureKind - The reason why this candidate is not viable.
unsigned	ExplicitCallArguments
	The number of call arguments that were explicitly provided, to be used while performing partial ordering of function templates.
union {
DeductionFailureInfo DeductionFailure
StandardConversionSequence FinalConversion
	FinalConversion - For a conversion function (where Function is a CXXConversionDecl), the standard conversion that occurs after the call to the overload candidate to convert the result of calling the conversion function to the required type. More...
};

Friends
class	OverloadCandidateSet

Detailed Description

OverloadCandidate - A single candidate in an overload set (C++ 13.3).

Definition at line 926 of file Overload.h.

Member Function Documentation

◆ getNumParams()

unsigned clang::OverloadCandidate::getNumParams ( ) const

inline

Definition at line 1069 of file Overload.h.

References clang::Type::castAs(), ExplicitCallArguments, Function, getNumParams(), clang::Type::getPointeeType(), clang::Type::isPointerOrReferenceType(), IsSurrogate, and Surrogate.

Referenced by getNumParams().

◆ getRewriteKind()

OverloadCandidateRewriteKind clang::OverloadCandidate::getRewriteKind ( ) const

inline

Get RewriteKind value in OverloadCandidateRewriteKind type (This function is to workaround the spurious GCC bitfield enum warning)

Definition at line 1026 of file Overload.h.

References RewriteKind.

Referenced by DiagnoseBadConversion(), DiagnoseBadTarget(), isReversed(), and NoteFunctionCandidate().

◆ hasAmbiguousConversion()

bool clang::OverloadCandidate::hasAmbiguousConversion ( ) const

inline

hasAmbiguousConversion - Returns whether this overload candidate requires an ambiguous conversion or not.

Definition at line 1034 of file Overload.h.

References clang::C, and Conversions.

◆ isPerfectMatch()

bool clang::OverloadCandidate::isPerfectMatch ( const ASTContext & Ctx ) const

inline

Definition at line 1044 of file Overload.h.

References clang::C, Conversions, FinalConversion, HasFinalConversion, and Viable.

◆ isReversed()

bool clang::OverloadCandidate::isReversed ( ) const

inline

Definition at line 1030 of file Overload.h.

References clang::CRK_Reversed, and getRewriteKind().

Referenced by CompleteNonViableCandidate(), clang::Sema::CreateOverloadedBinOp(), and clang::isBetterOverloadCandidate().

◆ NotValidBecauseConstraintExprHasError()

bool OverloadCandidate::NotValidBecauseConstraintExprHasError ( ) const

Definition at line 11160 of file SemaOverload.cpp.

References clang::ConstraintsNotSatisfied, DeductionFailure, FailureKind, and clang::ovl_fail_bad_deduction.

◆ TryToFixBadConversion()

bool clang::OverloadCandidate::TryToFixBadConversion	(	unsigned	Idx,
		Sema &	S )

inline

Definition at line 1056 of file Overload.h.

References Conversions, and Fix.

Referenced by CompleteNonViableCandidate().

◆ OverloadCandidateSet

friend class OverloadCandidateSet

friend

Definition at line 1084 of file Overload.h.

References clang::CRK_None, false, HasFinalConversion, IgnoreObjectArgument, IsADLCandidate, IsSurrogate, OverloadCandidateSet, RewriteKind, StrictPackMatch, and TookAddressOfOverload.

Referenced by OverloadCandidateSet.

Member Data Documentation

◆ [union]

union { ... } clang::OverloadCandidate

◆ Best

unsigned clang::OverloadCandidate::Best

Whether this candidate is the best viable function, or tied for being the best viable function.

For an ambiguous overload resolution, indicates whether this candidate was part of the ambiguity kernel: the minimal non-empty set of viable candidates such that all elements of the ambiguity kernel are better than all viable candidates not in the ambiguity kernel.

Definition at line 966 of file Overload.h.

Referenced by clang::OverloadCandidateSet::CompleteCandidates().

◆ BuiltinParamTypes

QualType clang::OverloadCandidate::BuiltinParamTypes[3]

BuiltinParamTypes - Provides the parameter types of a built-in overload candidate.

Only valid when Function is NULL.

Definition at line 940 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), CompleteNonViableCandidate(), and NoteBuiltinOperatorCandidate().

◆ Conversions

ConversionSequenceList clang::OverloadCandidate::Conversions

The conversion sequences used to convert the function arguments to the function parameters.

Note that these are indexed by argument, so may not match the parameter order of Function.

Definition at line 949 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), CompleteNonViableCandidate(), clang::Sema::CreateOverloadedBinOp(), DiagnoseBadConversion(), hasAmbiguousConversion(), clang::isBetterOverloadCandidate(), isPerfectMatch(), NoteAmbiguousUserConversions(), NoteBuiltinOperatorCandidate(), NoteFunctionCandidate(), clang::Sema::PerformCopyInitialization(), and TryToFixBadConversion().

◆ DeductionFailure

DeductionFailureInfo clang::OverloadCandidate::DeductionFailure

Definition at line 1015 of file Overload.h.

Referenced by clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), CheckArityMismatch(), DiagnoseBadDeduction(), DiagnoseFailedEnableIfAttr(), and NotValidBecauseConstraintExprHasError().

◆ ExplicitCallArguments

unsigned clang::OverloadCandidate::ExplicitCallArguments

The number of call arguments that were explicitly provided, to be used while performing partial ordering of function templates.

Definition at line 1012 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), getNumParams(), and clang::isBetterOverloadCandidate().

◆ FailureKind

unsigned clang::OverloadCandidate::FailureKind

FailureKind - The reason why this candidate is not viable.

Actually an OverloadFailureKind.

Definition at line 1008 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), AddTemplateOverloadCandidateImmediately(), clang::Sema::BuildCallToObjectOfClassType(), CheckArityMismatch(), CompleteNonViableCandidate(), NoteFunctionCandidate(), NoteSurrogateCandidate(), NotValidBecauseConstraintExprHasError(), clang::Sema::PerformCopyInitialization(), and clang::OverloadCandidateSet::shouldDeferDiags().

◆ FinalConversion

StandardConversionSequence clang::OverloadCandidate::FinalConversion

FinalConversion - For a conversion function (where Function is a CXXConversionDecl), the standard conversion that occurs after the call to the overload candidate to convert the result of calling the conversion function to the required type.

Definition at line 1021 of file Overload.h.

Referenced by clang::Sema::AddConversionCandidate(), clang::isBetterOverloadCandidate(), and isPerfectMatch().

◆ Fix

ConversionFixItGenerator clang::OverloadCandidate::Fix

The FixIt hints which can be used to fix the Bad candidate.

Definition at line 952 of file Overload.h.

Referenced by CompleteNonViableCandidate(), DiagnoseBadConversion(), and TryToFixBadConversion().

◆ FoundDecl

DeclAccessPair clang::OverloadCandidate::FoundDecl

FoundDecl - The original declaration that was looked up / invented / otherwise found, together with its access.

Might be a UsingShadowDecl or a FunctionTemplateDecl.

Definition at line 936 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), AddTemplateOverloadCandidateImmediately(), DiagnoseArityMismatch(), DiagnoseBadConversion(), DiagnoseBadDeduction(), DiagnoseBadTarget(), clang::isBetterOverloadCandidate(), and NoteFunctionCandidate().

◆ Function

FunctionDecl* clang::OverloadCandidate::Function

Function - The actual function that this candidate represents.

When NULL, this is a built-in candidate (C++ [over.oper]) or a surrogate for a conversion to a function pointer or reference (C++ [over.call.object]).

Definition at line 931 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), AddTemplateOverloadCandidateImmediately(), CheckArityMismatch(), chooseRecoveryType(), clang::OverloadCandidateSet::CompleteCandidates(), CompleteNonViableCandidate(), clang::Sema::CreateOverloadedBinOp(), DiagnoseArityMismatch(), DiagnoseBadConversion(), DiagnoseBadDeduction(), DiagnoseBadTarget(), DiagnoseFailedEnableIfAttr(), DiagnoseFailedExplicitSpec(), GetLocationForCandidate(), getNumParams(), isBetterMultiversionCandidate(), clang::isBetterOverloadCandidate(), clang::OverloadCandidateSet::NoteCandidates(), NoteFunctionCandidate(), and clang::OverloadCandidateSet::shouldDeferDiags().

◆ HasFinalConversion

unsigned clang::OverloadCandidate::HasFinalConversion

Whether FinalConversion has been set.

Definition at line 999 of file Overload.h.

Referenced by clang::Sema::AddConversionCandidate(), clang::isBetterOverloadCandidate(), isPerfectMatch(), and OverloadCandidateSet.

◆ IgnoreObjectArgument

unsigned clang::OverloadCandidate::IgnoreObjectArgument

IgnoreObjectArgument - True to indicate that the first argument's conversion, which for this function represents the implicit object argument, should be ignored.

This will be true when the candidate is a static member function (where the implicit object argument is just a placeholder) or a non-static member function when the call doesn't have an object argument.

Definition at line 982 of file Overload.h.

Referenced by clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), CompleteNonViableCandidate(), clang::isBetterOverloadCandidate(), NoteFunctionCandidate(), and OverloadCandidateSet.

◆ IsADLCandidate

unsigned clang::OverloadCandidate::IsADLCandidate

True if the candidate was found using ADL.

Definition at line 995 of file Overload.h.

Referenced by clang::Sema::AddOverloadCandidate(), and OverloadCandidateSet.

◆ IsSurrogate

unsigned clang::OverloadCandidate::IsSurrogate

IsSurrogate - True to indicate that this candidate is a surrogate for a conversion to a function pointer or reference (C++ [over.call.object]).

Definition at line 972 of file Overload.h.

Referenced by AddMethodTemplateCandidateImmediately(), clang::Sema::AddSurrogateCandidate(), clang::OverloadCandidateSet::CompleteCandidates(), CompleteNonViableCandidate(), GetLocationForCandidate(), getNumParams(), clang::OverloadCandidateSet::NoteCandidates(), and OverloadCandidateSet.

◆ RewriteKind

unsigned clang::OverloadCandidate::RewriteKind

Whether this is a rewritten candidate, and if so, of what kind?

Definition at line 1003 of file Overload.h.

Referenced by clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), getRewriteKind(), clang::isBetterOverloadCandidate(), and OverloadCandidateSet.

◆ StrictPackMatch

unsigned clang::OverloadCandidate::StrictPackMatch

Have we matched any packs on the parameter side, versus any non-packs on the argument side, in a context where the opposite matching is also allowed?

Definition at line 991 of file Overload.h.

Referenced by clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), clang::Sema::AddOverloadCandidate(), clang::isBetterOverloadCandidate(), and OverloadCandidateSet.

◆ Surrogate

CXXConversionDecl* clang::OverloadCandidate::Surrogate

Surrogate - The conversion function for which this candidate is a surrogate, but only if IsSurrogate is true.

Definition at line 944 of file Overload.h.

Referenced by clang::Sema::AddSurrogateCandidate(), CompleteNonViableCandidate(), GetLocationForCandidate(), getNumParams(), and NoteSurrogateCandidate().

◆ TookAddressOfOverload

unsigned clang::OverloadCandidate::TookAddressOfOverload

Definition at line 985 of file Overload.h.

Referenced by clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), CompleteNonViableCandidate(), DiagnoseArityMismatch(), clang::isBetterOverloadCandidate(), NoteFunctionCandidate(), and OverloadCandidateSet.

◆ Viable

unsigned clang::OverloadCandidate::Viable

Viable - True to indicate that this overload candidate is viable.

Definition at line 956 of file Overload.h.

Referenced by clang::Sema::AddBuiltinCandidate(), clang::Sema::AddConversionCandidate(), clang::Sema::AddMethodCandidate(), AddMethodTemplateCandidateImmediately(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddSurrogateCandidate(), AddTemplateConversionCandidateImmediately(), AddTemplateOverloadCandidateImmediately(), clang::Sema::BuildCallToObjectOfClassType(), clang::OverloadCandidateSet::CompleteCandidates(), CompleteNonViableCandidate(), clang::Sema::CreateOverloadedBinOp(), clang::isBetterOverloadCandidate(), isPerfectMatch(), clang::OverloadCandidateSet::NoteCandidates(), NoteFunctionCandidate(), NoteSurrogateCandidate(), clang::Sema::PerformCopyInitialization(), and clang::OverloadCandidateSet::shouldDeferDiags().

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

include/clang/Sema/Overload.h
lib/Sema/SemaOverload.cpp

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Function Documentation

◆ getNumParams()

◆ getRewriteKind()

◆ hasAmbiguousConversion()

◆ isPerfectMatch()

◆ isReversed()

◆ NotValidBecauseConstraintExprHasError()

◆ TryToFixBadConversion()

Friends And Related Symbol Documentation

◆ OverloadCandidateSet

Member Data Documentation

◆ [union]

◆ Best

◆ BuiltinParamTypes

◆ Conversions

◆ DeductionFailure

◆ ExplicitCallArguments

◆ FailureKind

◆ FinalConversion

◆ Fix

◆ FoundDecl

◆ Function

◆ HasFinalConversion

◆ IgnoreObjectArgument

◆ IsADLCandidate

◆ IsSurrogate

◆ RewriteKind

◆ StrictPackMatch

◆ Surrogate

◆ TookAddressOfOverload

◆ Viable