clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::CompletionItem Struct Reference

#include <Protocol.h>

Collaboration diagram for clang::clangd::CompletionItem:
Collaboration graph
[legend]

Public Attributes

std::string label
 The label of this completion item. More...
 
CompletionItemKind kind = CompletionItemKind::Missing
 The kind of this completion item. More...
 
std::string detail
 A human-readable string with additional information about this item, like type or symbol information. More...
 
llvm::Optional< MarkupContentdocumentation
 A human-readable string that represents a doc-comment. More...
 
std::string sortText
 A string that should be used when comparing this item with other items. More...
 
std::string filterText
 A string that should be used when filtering a set of completion items. More...
 
std::string insertText
 A string that should be inserted to a document when selecting this completion. More...
 
InsertTextFormat insertTextFormat = InsertTextFormat::Missing
 The format of the insert text. More...
 
llvm::Optional< TextEdittextEdit
 An edit which is applied to a document when selecting this completion. More...
 
std::vector< TextEditadditionalTextEdits
 An optional array of additional text edits that are applied when selecting this completion. More...
 
bool deprecated = false
 Indicates if this item is deprecated. More...
 
float score = 0.f
 The score that clangd calculates to rank the returned completions. More...
 

Detailed Description

Definition at line 1179 of file Protocol.h.

Member Data Documentation

◆ additionalTextEdits

std::vector<TextEdit> clang::clangd::CompletionItem::additionalTextEdits

An optional array of additional text edits that are applied when selecting this completion.

Edits must not overlap with the main edit nor with themselves.

Definition at line 1221 of file Protocol.h.

◆ deprecated

bool clang::clangd::CompletionItem::deprecated = false

Indicates if this item is deprecated.

Definition at line 1224 of file Protocol.h.

◆ detail

std::string clang::clangd::CompletionItem::detail

A human-readable string with additional information about this item, like type or symbol information.

Definition at line 1190 of file Protocol.h.

◆ documentation

llvm::Optional<MarkupContent> clang::clangd::CompletionItem::documentation

A human-readable string that represents a doc-comment.

Definition at line 1193 of file Protocol.h.

◆ filterText

std::string clang::clangd::CompletionItem::filterText

A string that should be used when filtering a set of completion items.

When falsy the label is used.

Definition at line 1201 of file Protocol.h.

◆ insertText

std::string clang::clangd::CompletionItem::insertText

A string that should be inserted to a document when selecting this completion.

When falsy the label is used.

Definition at line 1205 of file Protocol.h.

◆ insertTextFormat

InsertTextFormat clang::clangd::CompletionItem::insertTextFormat = InsertTextFormat::Missing

The format of the insert text.

The format applies to both the insertText property and the newText property of a provided textEdit.

Definition at line 1209 of file Protocol.h.

◆ kind

CompletionItemKind clang::clangd::CompletionItem::kind = CompletionItemKind::Missing

The kind of this completion item.

Based of the kind an icon is chosen by the editor.

Definition at line 1186 of file Protocol.h.

◆ label

std::string clang::clangd::CompletionItem::label

The label of this completion item.

By default also the text that is inserted when selecting this completion.

Definition at line 1182 of file Protocol.h.

Referenced by clang::clangd::operator<<().

◆ score

float clang::clangd::CompletionItem::score = 0.f

The score that clangd calculates to rank the returned completions.

This excludes the fuzzy-match between filterText and the partial word. This can be used to re-rank results as the user types, using client-side fuzzy-matching (that score should be multiplied with this one). This is a clangd extension.

Definition at line 1231 of file Protocol.h.

◆ sortText

std::string clang::clangd::CompletionItem::sortText

A string that should be used when comparing this item with other items.

When falsy the label is used.

Definition at line 1197 of file Protocol.h.

◆ textEdit

llvm::Optional<TextEdit> clang::clangd::CompletionItem::textEdit

An edit which is applied to a document when selecting this completion.

When an edit is provided insertText is ignored.

Note: The range of the edit must be a single line range and it must contain the position at which completion has been requested.

Definition at line 1216 of file Protocol.h.


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