clang API Documentation
#include <CodeCompleteConsumer.h>

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. | |
Definition at line 837 of file CodeCompleteConsumer.h.
Describes the type of overload candidate.
| 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 840 of file CodeCompleteConsumer.h.
| clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate | ( | FunctionDecl * | Function | ) | [inline] |
Definition at line 869 of file CodeCompleteConsumer.h.
| clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate | ( | FunctionTemplateDecl * | FunctionTemplateDecl | ) | [inline] |
Definition at line 872 of file CodeCompleteConsumer.h.
| clang::CodeCompleteConsumer::OverloadCandidate::OverloadCandidate | ( | const FunctionType * | Type | ) | [inline] |
Definition at line 875 of file CodeCompleteConsumer.h.
| 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 2710 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::FunctionProtoType::getArgType(), clang::QualType::getAsString(), clang::QualType::getAsStringInternal(), getCompletionPrintingPolicy(), GetCompletionTypeString(), getFunctionType(), clang::NamedDecl::getNameAsString(), clang::FunctionProtoType::getNumArgs(), clang::FunctionDecl::getNumParams(), clang::ParmVarDecl::getOriginalType(), clang::FunctionDecl::getParamDecl(), clang::FunctionType::getResultType(), 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 428 of file CodeCompleteConsumer.cpp.
| FunctionTemplateDecl* clang::CodeCompleteConsumer::OverloadCandidate::getFunctionTemplate | ( | ) | const [inline] |
Retrieve the function template overload candidate.
Definition at line 886 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 438 of file CodeCompleteConsumer.cpp.
References clang::Type::getAs().
| CandidateKind clang::CodeCompleteConsumer::OverloadCandidate::getKind | ( | ) | const [inline] |
Determine the kind of overload candidate.
Definition at line 879 of file CodeCompleteConsumer.h.
Referenced by getFunctionTemplate().
The function overload candidate, available when Kind == CK_Function.
Definition at line 857 of file CodeCompleteConsumer.h.
The function template overload candidate, available when Kind == CK_FunctionTemplate.
Definition at line 861 of file CodeCompleteConsumer.h.
Referenced by getFunctionTemplate().
The function type that describes the entity being called, when Kind == CK_FunctionType.
Definition at line 865 of file CodeCompleteConsumer.h.