clang API Documentation

Public Types | Public Member Functions
clang::CodeCompleteConsumer::OverloadCandidate Class Reference

#include <CodeCompleteConsumer.h>

Collaboration diagram for clang::CodeCompleteConsumer::OverloadCandidate:
Collaboration graph
[legend]

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.
FunctionDeclgetFunction () const
 Retrieve the function overload candidate or the templated function declaration for a function template.
FunctionTemplateDeclgetFunctionTemplate () const
 Retrieve the function template overload candidate.
const FunctionTypegetFunctionType () const
 Retrieve the function type of the entity, regardless of how the function is stored.
CodeCompletionStringCreateSignatureString (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 837 of file CodeCompleteConsumer.h.


Member Enumeration Documentation

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 840 of file CodeCompleteConsumer.h.


Constructor & Destructor Documentation

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.


Member Function Documentation

CodeCompletionString * CodeCompleteConsumer::OverloadCandidate::CreateSignatureString ( unsigned  CurrentArg,
Sema S,
CodeCompletionAllocator Allocator,
CodeCompletionTUInfo CCTUInfo 
) const
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().


Member Data Documentation

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.


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