clang::clangd::CodeCompletion Struct Reference

#include <CodeComplete.h>

Classes
struct	IncludeCandidate
struct	Scores

Public Member Functions
CompletionItem	render (const CodeCompleteOptions &) const

Public Attributes
std::string	Name
std::string	FilterText
std::string	Scope
std::string	RequiredQualifier
std::string	Signature
std::string	SnippetSuffix
std::string	ReturnType
std::optional< markup::Document >	Documentation
CompletionItemKind	Kind = CompletionItemKind::Missing
unsigned	BundleSize = 1
SymbolOrigin	Origin = SymbolOrigin::Unknown
llvm::SmallVector< IncludeCandidate, 1 >	Includes
std::vector< TextEdit >	FixIts
	Holds information about small corrections that needs to be done.
Range	CompletionTokenRange
	Holds the range of the token we are going to replace with this completion.
Scores	Score
bool	Deprecated = false
	Indicates if this item is deprecated.

Detailed Description

Definition at line 162 of file CodeComplete.h.

Member Function Documentation

render()

CompletionItem clang::clangd::CodeCompletion::render

(

const CodeCompleteOptions &

Opts

)

const

Definition at line 2316 of file CodeComplete.cpp.

References clang::clangd::CompletionItem::additionalTextEdits, clang::clangd::markup::Document::addParagraph(), clang::clangd::markup::Document::append(), clang::clangd::markup::Paragraph::appendCode(), clang::clangd::markup::Paragraph::appendText(), clang::clangd::Deprecated, clang::clangd::CompletionItem::deprecated, clang::clangd::CompletionItem::detail, clang::clangd::CompletionItem::documentation, clang::clangd::CompletionItem::filterText, FixIt, clang::clangd::CompletionItem::insertText, clang::clangd::CompletionItem::insertTextFormat, Kind, clang::clangd::CompletionItem::kind, clang::clangd::CompletionItem::label, clang::clangd::CompletionItem::labelDetails, Name, ReturnType, clang::clangd::CompletionItem::score, Score, Signature, SnippetSuffix, clang::clangd::CompletionItem::sortText, clang::clangd::sortText(), and clang::clangd::CompletionItem::textEdit.

Member Data Documentation

BundleSize

unsigned clang::clangd::CodeCompletion::BundleSize = 1

Definition at line 191 of file CodeComplete.h.

CompletionTokenRange

Range clang::clangd::CodeCompletion::CompletionTokenRange

Holds the range of the token we are going to replace with this completion.

Definition at line 213 of file CodeComplete.h.

Referenced by clang::clangd::codeCompleteComment().

Deprecated

bool clang::clangd::CodeCompletion::Deprecated = false

Indicates if this item is deprecated.

Definition at line 239 of file CodeComplete.h.

Documentation

std::optional<markup::Document> clang::clangd::CodeCompletion::Documentation

Definition at line 181 of file CodeComplete.h.

FilterText

std::string clang::clangd::CodeCompletion::FilterText

Definition at line 168 of file CodeComplete.h.

Referenced by clang::clangd::codeCompleteComment().

FixIts

std::vector<TextEdit> clang::clangd::CodeCompletion::FixIts

Holds information about small corrections that needs to be done.

Like converting '->' to '.' on member access.

Definition at line 210 of file CodeComplete.h.

Includes

llvm::SmallVector<IncludeCandidate, 1> clang::clangd::CodeCompletion::Includes

Definition at line 206 of file CodeComplete.h.

Kind

CompletionItemKind clang::clangd::CodeCompletion::Kind = CompletionItemKind::Missing

Definition at line 182 of file CodeComplete.h.

Referenced by clang::clangd::codeCompleteComment().

Name

std::string clang::clangd::CodeCompletion::Name

Definition at line 164 of file CodeComplete.h.

Referenced by clang::clangd::codeCompleteComment().

Origin

SymbolOrigin clang::clangd::CodeCompletion::Origin = SymbolOrigin::Unknown

Definition at line 192 of file CodeComplete.h.

Referenced by clang::clangd::codeCompleteComment().

RequiredQualifier

std::string clang::clangd::CodeCompletion::RequiredQualifier

Definition at line 173 of file CodeComplete.h.

ReturnType

std::string clang::clangd::CodeCompletion::ReturnType

Definition at line 179 of file CodeComplete.h.

Scope

std::string clang::clangd::CodeCompletion::Scope

Definition at line 171 of file CodeComplete.h.

Score

Scores clang::clangd::CodeCompletion::Score

Definition at line 236 of file CodeComplete.h.

Signature

std::string clang::clangd::CodeCompletion::Signature

Definition at line 175 of file CodeComplete.h.

SnippetSuffix

std::string clang::clangd::CodeCompletion::SnippetSuffix

Definition at line 177 of file CodeComplete.h.

---

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

• CodeComplete.h
• CodeComplete.cpp