clang::CodeCompleteConsumer::OverloadCandidate Class Reference

#include <CodeCompleteConsumer.h>

Collaboration diagram for clang::CodeCompleteConsumer::OverloadCandidate:

List of all members.

Public Types
enum	CandidateKind { CK_Function, CK_FunctionTemplate, CK_FunctionType }
	Describes the type of overload candidate. More...
Public Member Functions
	OverloadCandidate (FunctionDecl *Function)
	OverloadCandidate (FunctionTemplateDecl *FunctionTemplateDecl)
	OverloadCandidate (const FunctionType *Type)
CandidateKind	getKind () const
	Determine the kind of overload candidate.
FunctionDecl *	getFunction () const
	Retrieve the function overload candidate or the templated function declaration for a function template.
FunctionTemplateDecl *	getFunctionTemplate () const
	Retrieve the function template overload candidate.
const FunctionType *	getFunctionType () const
	Retrieve the function type of the entity, regardless of how the function is stored.
CodeCompletionString *	CreateSignatureString (unsigned CurrentArg, Sema &S, CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo) const
	Create a new code-completion string that describes the function signature of this overload candidate.

---

Detailed Description

Definition at line 825 of file CodeCompleteConsumer.h.

---

Member Enumeration Documentation

enum clang::CodeCompleteConsumer::OverloadCandidate::CandidateKind

Describes the type of overload candidate.

Enumerator:

CK_Function	The candidate is a function declaration.
CK_FunctionTemplate	The candidate is a function template.
CK_FunctionType	The "candidate" is actually a variable, expression, or block for which we only have a function prototype.

Definition at line 828 of file CodeCompleteConsumer.h.

---

Constructor & Destructor Documentation

clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate

(

FunctionDecl *

Function

)

[inline]

Definition at line 857 of file CodeCompleteConsumer.h.

clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate

(

FunctionTemplateDecl *

FunctionTemplateDecl

)

[inline]

Definition at line 860 of file CodeCompleteConsumer.h.

clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate

(

const FunctionType *

Type

)

[inline]

Definition at line 863 of file CodeCompleteConsumer.h.

---

Member Function Documentation

CodeCompletionString * CodeCompleteConsumer::OverloadCandidate::CreateSignatureString	(	unsigned	CurrentArg,
		Sema &	S,
		CodeCompletionAllocator &	Allocator,
		CodeCompletionTUInfo &	CCTUInfo
	)		const

Create a new code-completion string that describes the function signature of this overload candidate.

Definition at line 2816 of file SemaCodeComplete.cpp.

References clang::CodeCompletionBuilder::AddChunk(), AddResultTypeChunk(), clang::CodeCompletionBuilder::AddTextChunk(), clang::CodeCompletionString::CK_Comma, clang::CodeCompletionString::CK_CurrentParameter, clang::CodeCompletionString::CK_LeftParen, clang::CodeCompletionString::CK_RightParen, clang::Sema::Context, clang::CodeCompletionAllocator::CopyString(), CXAvailability_Available, clang::CodeCompletionBuilder::getAllocator(), clang::QualType::getAsString(), clang::QualType::getAsStringInternal(), getCompletionPrintingPolicy(), GetCompletionTypeString(), clang::NamedDecl::getNameAsString(), clang::FunctionDecl::getNumParams(), clang::FunctionProtoType::getNumParams(), clang::ParmVarDecl::getOriginalType(), clang::FunctionDecl::getParamDecl(), clang::FunctionProtoType::getParamType(), clang::FunctionType::getReturnType(), clang::FunctionProtoType::isVariadic(), and clang::CodeCompletionBuilder::TakeString().

FunctionDecl * CodeCompleteConsumer::OverloadCandidate::getFunction

(

)

const

Retrieve the function overload candidate or the templated function declaration for a function template.

Definition at line 402 of file CodeCompleteConsumer.cpp.

References getKind().

FunctionTemplateDecl* clang::CodeCompleteConsumer::OverloadCandidate::getFunctionTemplate

(

)

const [inline]

Retrieve the function template overload candidate.

Definition at line 874 of file CodeCompleteConsumer.h.

References CK_FunctionTemplate, FunctionTemplate, and getKind().

const FunctionType * CodeCompleteConsumer::OverloadCandidate::getFunctionType

(

)

const

Retrieve the function type of the entity, regardless of how the function is stored.

Definition at line 412 of file CodeCompleteConsumer.cpp.

References clang::Type::getAs().

CandidateKind clang::CodeCompleteConsumer::OverloadCandidate::getKind

(

)

const [inline]

Determine the kind of overload candidate.

Definition at line 867 of file CodeCompleteConsumer.h.

Referenced by getFunctionTemplate().

---

Member Data Documentation

FunctionDecl* clang::CodeCompleteConsumer::OverloadCandidate::Function

The function overload candidate, available when Kind == CK_Function.

Definition at line 845 of file CodeCompleteConsumer.h.

FunctionTemplateDecl* clang::CodeCompleteConsumer::OverloadCandidate::FunctionTemplate

The function template overload candidate, available when Kind == CK_FunctionTemplate.

Definition at line 849 of file CodeCompleteConsumer.h.

Referenced by getFunctionTemplate().

const FunctionType* clang::CodeCompleteConsumer::OverloadCandidate::Type

The function type that describes the entity being called, when Kind == CK_FunctionType.

Definition at line 853 of file CodeCompleteConsumer.h.

---

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

• CodeCompleteConsumer.h
• CodeCompleteConsumer.cpp
• SemaCodeComplete.cpp