clang  8.0.0svn
Public Types | Public Member Functions | Public Attributes | List of all members
clang::CodeCompletionResult Class Reference

Captures a result of code completion. More...

#include "clang/Sema/CodeCompleteConsumer.h"

Collaboration diagram for clang::CodeCompletionResult:
Collaboration graph
[legend]

Public Types

enum  ResultKind { RK_Declaration = 0, RK_Keyword, RK_Macro, RK_Pattern }
 Describes the kind of result generated. More...
 

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. More...
 
 CodeCompletionResult (const char *Keyword, unsigned Priority=CCP_Keyword)
 Build a result that refers to a keyword or symbol. More...
 
 CodeCompletionResult (const IdentifierInfo *Macro, const MacroInfo *MI=nullptr, unsigned Priority=CCP_Macro)
 Build a result that refers to a macro. More...
 
 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. More...
 
 CodeCompletionResult (CodeCompletionString *Pattern, const NamedDecl *D, unsigned Priority)
 Build a result that refers to a pattern with an associated declaration. More...
 
const NamedDeclgetDeclaration () const
 Retrieve the declaration stored in this result. More...
 
const char * getKeyword () const
 Retrieve the keyword stored in this result. More...
 
CodeCompletionStringCreateCodeCompletionString (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. More...
 
CodeCompletionStringCreateCodeCompletionString (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. More...
 
CodeCompletionStringCreateCodeCompletionStringForMacro (Preprocessor &PP, CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo)
 Creates a new code-completion string for the macro result. More...
 
StringRef getOrderedName (std::string &Saved) const
 Retrieve the name that should be used to order a result. More...
 

Public Attributes

const NamedDeclDeclaration = nullptr
 When Kind == RK_Declaration or RK_Pattern, the declaration we are referring to. More...
 
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. More...
 
unsigned StartParameter = 0
 Specifies which parameter (of a function, Objective-C method, macro, etc.) we should start with when formatting the result. More...
 
ResultKind Kind
 The kind of result stored here. More...
 
CXCursorKind CursorKind
 The cursor kind that describes this result. More...
 
CXAvailabilityKind Availability = CXAvailability_Available
 The availability of this result. More...
 
std::vector< FixItHintFixIts
 Fix-its that must be applied before inserting the text for the corresponding completion. More...
 
bool Hidden: 1
 Whether this result is hidden by another name. More...
 
bool QualifierIsInformative: 1
 Whether this result was found via lookup into a base class. More...
 
bool StartsNestedNameSpecifier: 1
 Whether this declaration is the beginning of a nested-name-specifier and, therefore, should be followed by '::'. More...
 
bool AllParametersAreInformative: 1
 Whether all parameters (of a function, Objective-C method, etc.) should be considered "informative". More...
 
bool DeclaringEntity: 1
 Whether we're completing a declaration of the given entity, rather than a use of that entity. More...
 
NestedNameSpecifierQualifier = nullptr
 If the result should have a nested-name-specifier, this is it. More...
 
const UsingShadowDeclShadowDecl = nullptr
 If this Decl was unshadowed by using declaration, this can store a pointer to the UsingShadowDecl which was used in the unshadowing process. More...
 
const MacroInfoMacroDefInfo = nullptr
 If the result is RK_Macro, this can store the information about the macro definition. More...
 

Detailed Description

Captures a result of code completion.

Definition at line 741 of file CodeCompleteConsumer.h.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

◆ CodeCompletionResult() [1/5]

clang::CodeCompletionResult::CodeCompletionResult ( const NamedDecl Declaration,
unsigned  Priority,
NestedNameSpecifier Qualifier = nullptr,
bool  QualifierIsInformative = false,
bool  Accessible = true,
std::vector< FixItHint FixIts = std::vector<FixItHint>() 
)
inline

Build a result that refers to a declaration.

Definition at line 856 of file CodeCompleteConsumer.h.

◆ CodeCompletionResult() [2/5]

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

Build a result that refers to a keyword or symbol.

Definition at line 871 of file CodeCompleteConsumer.h.

◆ CodeCompletionResult() [3/5]

clang::CodeCompletionResult::CodeCompletionResult ( const IdentifierInfo Macro,
const MacroInfo MI = nullptr,
unsigned  Priority = CCP_Macro 
)
inline

Build a result that refers to a macro.

Definition at line 878 of file CodeCompleteConsumer.h.

◆ CodeCompletionResult() [4/5]

clang::CodeCompletionResult::CodeCompletionResult ( CodeCompletionString Pattern,
unsigned  Priority = CCP_CodePattern,
CXCursorKind  CursorKind = CXCursor_NotImplemented,
CXAvailabilityKind  Availability = CXAvailability_Available,
const NamedDecl D = nullptr 
)
inline

Build a result that refers to a pattern.

Definition at line 888 of file CodeCompleteConsumer.h.

◆ CodeCompletionResult() [5/5]

clang::CodeCompletionResult::CodeCompletionResult ( CodeCompletionString Pattern,
const NamedDecl D,
unsigned  Priority 
)
inline

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

Definition at line 900 of file CodeCompleteConsumer.h.

Member Function Documentation

◆ CreateCodeCompletionString() [1/2]

CodeCompletionString * CodeCompletionResult::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.

Parameters
SThe semantic analysis that created the result.
AllocatorThe allocator that will be used to allocate the string itself.

Definition at line 2741 of file SemaCodeComplete.cpp.

◆ CreateCodeCompletionString() [2/2]

CodeCompletionString * CodeCompletionResult::CreateCodeCompletionString ( ASTContext Ctx,
Preprocessor PP,
const CodeCompletionContext CCContext,
CodeCompletionAllocator Allocator,
CodeCompletionTUInfo CCTUInfo,
bool  IncludeBriefComments 
)

◆ CreateCodeCompletionStringForMacro()

CodeCompletionString * CodeCompletionResult::CreateCodeCompletionStringForMacro ( Preprocessor PP,
CodeCompletionAllocator Allocator,
CodeCompletionTUInfo CCTUInfo 
)

◆ getDeclaration()

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

Retrieve the declaration stored in this result.

This might be nullptr if Kind is RK_Pattern.

Definition at line 911 of file CodeCompleteConsumer.h.

◆ getKeyword()

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

Retrieve the keyword stored in this result.

Definition at line 918 of file CodeCompleteConsumer.h.

◆ getOrderedName()

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

Retrieve the name that should be used to order a result.

If the name needs to be constructed as a string, that string will be saved into Saved and the returned StringRef will refer to it.

Definition at line 718 of file CodeCompleteConsumer.cpp.

Referenced by clang::operator<().

Member Data Documentation

◆ @202

union { ... }

◆ AllParametersAreInformative

bool clang::CodeCompletionResult::AllParametersAreInformative

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

Definition at line 833 of file CodeCompleteConsumer.h.

◆ Availability

CXAvailabilityKind clang::CodeCompletionResult::Availability = CXAvailability_Available

The availability of this result.

Definition at line 789 of file CodeCompleteConsumer.h.

◆ CursorKind

CXCursorKind clang::CodeCompletionResult::CursorKind

The cursor kind that describes this result.

Definition at line 786 of file CodeCompleteConsumer.h.

◆ Declaration

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

When Kind == RK_Declaration or RK_Pattern, the declaration we are referring to.

In the latter case, the declaration might be NULL.

Definition at line 760 of file CodeCompleteConsumer.h.

Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut().

◆ DeclaringEntity

bool clang::CodeCompletionResult::DeclaringEntity

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

Definition at line 837 of file CodeCompleteConsumer.h.

◆ 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<int>> 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 819 of file CodeCompleteConsumer.h.

◆ Hidden

bool clang::CodeCompletionResult::Hidden

Whether this result is hidden by another name.

Definition at line 822 of file CodeCompleteConsumer.h.

◆ Keyword

const char* clang::CodeCompletionResult::Keyword

When Kind == RK_Keyword, the string representing the keyword or symbol's spelling.

Definition at line 765 of file CodeCompleteConsumer.h.

Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut().

◆ Kind

ResultKind clang::CodeCompletionResult::Kind

The kind of result stored here.

Definition at line 783 of file CodeCompleteConsumer.h.

Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut().

◆ Macro

const IdentifierInfo* clang::CodeCompletionResult::Macro

When Kind == RK_Macro, the identifier that refers to a macro.

Definition at line 772 of file CodeCompleteConsumer.h.

Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut().

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

◆ Pattern

CodeCompletionString* clang::CodeCompletionResult::Pattern

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

Definition at line 769 of file CodeCompleteConsumer.h.

Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut().

◆ Priority

unsigned clang::CodeCompletionResult::Priority

The priority of this particular code-completion result.

Definition at line 776 of file CodeCompleteConsumer.h.

◆ Qualifier

NestedNameSpecifier* clang::CodeCompletionResult::Qualifier = nullptr

If the result should have a nested-name-specifier, this is it.

When QualifierIsInformative, the nested-name-specifier is informative rather than required.

Definition at line 842 of file CodeCompleteConsumer.h.

◆ QualifierIsInformative

bool clang::CodeCompletionResult::QualifierIsInformative

Whether this result was found via lookup into a base class.

Definition at line 825 of file CodeCompleteConsumer.h.

◆ ShadowDecl

const UsingShadowDecl* clang::CodeCompletionResult::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.

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

Definition at line 848 of file CodeCompleteConsumer.h.

Referenced by isConstructor().

◆ StartParameter

unsigned clang::CodeCompletionResult::StartParameter = 0

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

Definition at line 780 of file CodeCompleteConsumer.h.

◆ StartsNestedNameSpecifier

bool clang::CodeCompletionResult::StartsNestedNameSpecifier

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

Definition at line 829 of file CodeCompleteConsumer.h.


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