clang: clang::CodeCompletionResult Class Reference (original) (raw)

Captures a result of code completion. More...

#include "[clang/Sema/CodeCompleteConsumer.h](CodeCompleteConsumer%5F8h%5Fsource.html)"

Public Member Functions
	CodeCompletionResult (const NamedDecl Declaration, unsigned Priority, NestedNameSpecifier Qualifier=nullptr, bool QualifierIsInformative=false, bool Accessible=true, std::vector< FixItHint > FixIts=std::vector< FixItHint >())
	Build a result that refers to a declaration.

	CodeCompletionResult (const char *Keyword, unsigned Priority=CCP_Keyword)
	Build a result that refers to a keyword or symbol.

	CodeCompletionResult (const IdentifierInfo Macro, const MacroInfo MI=nullptr, unsigned Priority=CCP_Macro)
	Build a result that refers to a macro.

	CodeCompletionResult (CodeCompletionString Pattern, unsigned Priority=CCP_CodePattern, CXCursorKind CursorKind=CXCursor_NotImplemented, CXAvailabilityKind Availability=CXAvailability_Available, const NamedDecl D=nullptr)
	Build a result that refers to a pattern.

	CodeCompletionResult (CodeCompletionString Pattern, const NamedDecl D, unsigned Priority)
	Build a result that refers to a pattern with an associated declaration.

const NamedDecl *	getDeclaration () const
	Retrieve the declaration stored in this result.

const char *	getKeyword () const
	Retrieve the keyword stored in this result.

CodeCompletionString *	CreateCodeCompletionString (Sema &S, const CodeCompletionContext &CCContext, CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo, bool IncludeBriefComments)
	Create a new code-completion string that describes how to insert this result into a program.

CodeCompletionString *	CreateCodeCompletionString (ASTContext &Ctx, Preprocessor &PP, const CodeCompletionContext &CCContext, CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo, bool IncludeBriefComments)
	If possible, create a new code completion string for the given result.

CodeCompletionString *	CreateCodeCompletionStringForMacro (Preprocessor &PP, CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo)
	Creates a new code-completion string for the macro result.

CodeCompletionString *	createCodeCompletionStringForDecl (Preprocessor &PP, ASTContext &Ctx, CodeCompletionBuilder &Result, bool IncludeBriefComments, const CodeCompletionContext &CCContext, PrintingPolicy &Policy)

CodeCompletionString *	createCodeCompletionStringForOverride (Preprocessor &PP, ASTContext &Ctx, CodeCompletionBuilder &Result, bool IncludeBriefComments, const CodeCompletionContext &CCContext, PrintingPolicy &Policy)

StringRef	getOrderedName (std::string &Saved) const
	Retrieve the name that should be used to order a result.

Public Attributes
const NamedDecl *	Declaration = nullptr
	When Kind == RK_Declaration or RK_Pattern, the declaration we are referring to.

union {
const char * Keyword
	When Kind == RK_Keyword, the string representing the keyword or symbol's spelling. More...

CodeCompletionString * Pattern
	When Kind == RK_Pattern, the code-completion string that describes the completion text to insert. More...

const IdentifierInfo * Macro
	When Kind == RK_Macro, the identifier that refers to a macro. More...

};

unsigned	Priority
	The priority of this particular code-completion result.

unsigned	StartParameter = 0
	Specifies which parameter (of a function, Objective-C method, macro, etc.) we should start with when formatting the result.

ResultKind	Kind
	The kind of result stored here.

CXCursorKind	CursorKind
	The cursor kind that describes this result.

CXAvailabilityKind	Availability = CXAvailability_Available
	The availability of this result.

std::vector< FixItHint >	FixIts
	Fix-its that must be applied before inserting the text for the corresponding completion.

bool	Hidden: 1
	Whether this result is hidden by another name.

bool	InBaseClass: 1
	Whether this is a class member from base class.

bool	QualifierIsInformative: 1
	Whether this result was found via lookup into a base class.

bool	StartsNestedNameSpecifier: 1
	Whether this declaration is the beginning of a nested-name-specifier and, therefore, should be followed by '::'.

bool	AllParametersAreInformative: 1
	Whether all parameters (of a function, Objective-C method, etc.) should be considered "informative".

bool	DeclaringEntity: 1
	Whether we're completing a declaration of the given entity, rather than a use of that entity.

bool	FunctionCanBeCall: 1
	When completing a function, whether it can be a call.

NestedNameSpecifier *	Qualifier = nullptr
	If the result should have a nested-name-specifier, this is it.

const UsingShadowDecl *	ShadowDecl = nullptr
	If this Decl was unshadowed by using declaration, this can store a pointer to the UsingShadowDecl which was used in the unshadowing process.

const MacroInfo *	MacroDefInfo = nullptr
	If the result is RK_Macro, this can store the information about the macro definition.

Captures a result of code completion.

Definition at line 760 of file CodeCompleteConsumer.h.

◆ ResultKind

Describes the kind of result generated.

Enumerator
RK_Declaration	Refers to a declaration.
RK_Keyword	Refers to a keyword or symbol.
RK_Macro	Refers to a macro.
RK_Pattern	Refers to a precomputed pattern.

Definition at line 763 of file CodeCompleteConsumer.h.

◆ CodeCompletionResult() [2/5]

clang::CodeCompletionResult::CodeCompletionResult ( const char * Keyword, unsigned Priority = CCP_Keyword )	inline

◆ CodeCompletionResult() [3/5]

◆ CodeCompletionResult() [4/5]

◆ CodeCompletionResult() [5/5]

Build a result that refers to a pattern with an associated declaration.

Definition at line 930 of file CodeCompleteConsumer.h.

◆ CreateCodeCompletionString() [1/2]

If possible, create a new code completion string for the given result.

Returns

Either a new, heap-allocated code completion string describing how to use this result, or NULL to indicate that the string or name of the result is all that is needed.

Definition at line 3576 of file SemaCodeComplete.cpp.

References Availability, createCodeCompletionStringForDecl(), CreateCodeCompletionStringForMacro(), Declaration, getCompletionPrintingPolicy(), clang::Decl::getDeclContext(), clang::getPatternCompletionComment(), Keyword, Kind, Pattern, Priority, clang::Result, RK_Declaration, RK_Keyword, RK_Macro, and RK_Pattern.

◆ CreateCodeCompletionString() [2/2]

◆ createCodeCompletionStringForDecl()

Definition at line 3663 of file SemaCodeComplete.cpp.

References AddFunctionParameterChunks(), AddFunctionTypeQualsToCompletionString(), AddQualifierToCompletionString(), AddResultTypeChunk(), AddTemplateParameterChunks(), AddTypedNameChunk(), AllParametersAreInformative, clang::CodeCompletionString::CK_HorizontalSpace, clang::CodeCompletionString::CK_LeftAngle, clang::CodeCompletionString::CK_LeftParen, clang::CodeCompletionString::CK_RightAngle, clang::CodeCompletionString::CK_RightParen, Declaration, DeclaringEntity, extractFunctorCallOperator(), FormatFunctionParameter(), formatObjCParamQualifiers(), clang::Function, FunctionCanBeCall, clang::QualType::getAsString(), clang::CodeCompletionContext::getBaseType(), clang::getCompletionComment(), clang::Decl::getDeclContext(), clang::Selector::getIdentifierInfoForSlot(), clang::NamedDecl::getNameAsString(), clang::Selector::getNameForSlot(), clang::Selector::getNumArgs(), clang::Type::getObjCSubstitutions(), clang::Type::isBlockPointerType(), clang::QualType::isNull(), clang::Selector::isUnarySelector(), clang::FunctionDecl::isVariadic(), Keyword, clang::Sema::MarkDeducedTemplateParameters(), MaybeAddSentinel(), P, clang::FunctionDecl::param_begin(), clang::FunctionDecl::param_end(), clang::FunctionDecl::param_size(), clang::Parameter, Qualifier, QualifierIsInformative, clang::Result, clang::Decl::specific_attrs(), StartParameter, StartsNestedNameSpecifier, and clang::QualType::substObjCTypeArgs().

Referenced by CreateCodeCompletionString(), and createCodeCompletionStringForOverride().

◆ CreateCodeCompletionStringForMacro()

Creates a new code-completion string for the macro result.

Similar to the above overloads, except this only requires preprocessor information. The result kind must be RK_Macro.

Definition at line 3524 of file SemaCodeComplete.cpp.

References Availability, clang::CodeCompletionString::CK_Comma, clang::CodeCompletionString::CK_LeftParen, clang::CodeCompletionString::CK_RightParen, clang::Preprocessor::getMacroInfo(), clang::IdentifierInfo::getName(), clang::MacroInfo::isC99Varargs(), clang::MacroInfo::isFunctionLike(), clang::MacroInfo::isVariadic(), Kind, Macro, clang::MacroInfo::param_begin(), clang::MacroInfo::param_end(), Priority, clang::Result, and RK_Macro.

Referenced by CreateCodeCompletionString().

◆ createCodeCompletionStringForOverride()

◆ getDeclaration()

const NamedDecl * clang::CodeCompletionResult::getDeclaration ( ) const	inline

◆ getKeyword()

const char * clang::CodeCompletionResult::getKeyword ( ) const	inline

◆ getOrderedName()

StringRef CodeCompletionResult::getOrderedName	(	std::string &	Saved	)	const

◆

union { ... } clang::CodeCompletionResult::@218

◆ AllParametersAreInformative

bool clang::CodeCompletionResult::AllParametersAreInformative

◆ Availability

◆ CursorKind

◆ Declaration

const NamedDecl* clang::CodeCompletionResult::Declaration = nullptr

◆ DeclaringEntity

bool clang::CodeCompletionResult::DeclaringEntity

◆ FixIts

std::vector<FixItHint> clang::CodeCompletionResult::FixIts

Fix-its that must be applied before inserting the text for the corresponding completion.

By default, CodeCompletionBuilder only returns completions with empty fix-its. Extra completions with non-empty fix-its should be explicitly requested by setting CompletionOptions::IncludeFixIts.

For the clients to be able to compute position of the cursor after applying fix-its, the following conditions are guaranteed to hold for RemoveRange of the stored fix-its:

Ranges in the fix-its are guaranteed to never contain the completion point (or identifier under completion point, if any) inside them, except at the start or at the end of the range.
If a fix-it range starts or ends with completion point (or starts or ends after the identifier under completion point), it will contain at least one character. It allows to unambiguously recompute completion point after applying the fix-it.

The intuition is that provided fix-its change code around the identifier we complete, but are not allowed to touch the identifier itself or the completion point. One example of completions with corrections are the ones replacing '.' with '->' and vice versa:

std::unique_ptr<std::vector> vec_ptr; In 'vec_ptr.^', one of the completions is 'push_back', it requires replacing '.' with '->'. In 'vec_ptr->^', one of the completions is 'release', it requires replacing '->' with '.'.

Definition at line 838 of file CodeCompleteConsumer.h.

◆ FunctionCanBeCall

bool clang::CodeCompletionResult::FunctionCanBeCall

When completing a function, whether it can be a call.

This will usually be true, but we have some heuristics, e.g. when a pointer to a non-static member function is completed outside of that class' scope, it can never be a call.

Definition at line 865 of file CodeCompleteConsumer.h.

Referenced by createCodeCompletionStringForDecl().

◆ Hidden

bool clang::CodeCompletionResult::Hidden

◆ InBaseClass

bool clang::CodeCompletionResult::InBaseClass

◆ Keyword

const char* clang::CodeCompletionResult::Keyword

◆ Kind

◆ Macro

◆ MacroDefInfo

const MacroInfo* clang::CodeCompletionResult::MacroDefInfo = nullptr

If the result is RK_Macro, this can store the information about the macro definition.

This should be set in most cases but can be missing when the macro has been undefined.

Definition at line 881 of file CodeCompleteConsumer.h.

◆ Pattern

◆ Priority

unsigned clang::CodeCompletionResult::Priority

◆ Qualifier

◆ QualifierIsInformative

bool clang::CodeCompletionResult::QualifierIsInformative

◆ ShadowDecl

If this Decl was unshadowed by using declaration, this can store a pointer to the UsingShadowDecl which was used in the unshadowing process.

This information can be used to uprank CodeCompletionResults / which have corresponding using decl::qualified::name; nearby.

Definition at line 876 of file CodeCompleteConsumer.h.

◆ StartParameter

unsigned clang::CodeCompletionResult::StartParameter = 0

◆ StartsNestedNameSpecifier

bool clang::CodeCompletionResult::StartsNestedNameSpecifier

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

include/clang/Sema/CodeCompleteConsumer.h
lib/Sema/CodeCompleteConsumer.cpp
lib/Sema/SemaCodeComplete.cpp