clang-tools  7.0.0
Classes | Public Member Functions | Public Attributes | List of all members
clang::clangd::CodeCompleteOptions Struct Reference

#include <CodeComplete.h>

Collaboration diagram for clang::clangd::CodeCompleteOptions:
[legend]

Classes

struct  IncludeInsertionIndicator
 A visual indicator to prepend to the completion label to indicate whether completion result would trigger an #include insertion or not. More...
 

Public Member Functions

clang::CodeCompleteOptions getClangCompleteOpts () const
 Returns options that can be passed to clang's completion engine. More...
 

Public Attributes

bool EnableSnippets = false
 When true, completion items will contain expandable code snippets in completion (e.g. More...
 
bool IncludeCodePatterns = true
 Add code patterns to completion results. More...
 
bool IncludeMacros = true
 Add macros to code completion results. More...
 
bool IncludeComments = true
 Add comments to code completion results, if available. More...
 
bool IncludeIneligibleResults = false
 Include results that are not legal completions in the current context. More...
 
bool BundleOverloads = false
 Combine overloads into a single completion item where possible. More...
 
size_t Limit = 0
 Limit the number of results returned (0 means no limit). More...
 
struct clang::clangd::CodeCompleteOptions::IncludeInsertionIndicator IncludeIndicator
 
bool ShowOrigins = false
 Expose origins of completion items in the label (for debugging). More...
 
const SymbolIndexIndex = nullptr
 If Index is set, it is used to augment the code completion results. More...
 

Detailed Description

Definition at line 33 of file CodeComplete.h.

Member Function Documentation

◆ getClangCompleteOpts()

clang::CodeCompleteOptions clang::clangd::CodeCompleteOptions::getClangCompleteOpts ( ) const

Returns options that can be passed to clang's completion engine.

Definition at line 897 of file CodeComplete.cpp.

Member Data Documentation

◆ BundleOverloads

bool clang::clangd::CodeCompleteOptions::BundleOverloads = false

Combine overloads into a single completion item where possible.

Definition at line 58 of file CodeComplete.h.

◆ EnableSnippets

bool clang::clangd::CodeCompleteOptions::EnableSnippets = false

When true, completion items will contain expandable code snippets in completion (e.g.

return ${1:expression} or `foo(${1:int a}, ${2:int b})).

Definition at line 40 of file CodeComplete.h.

◆ IncludeCodePatterns

bool clang::clangd::CodeCompleteOptions::IncludeCodePatterns = true

Add code patterns to completion results.

If EnableSnippets is false, this options is ignored and code patterns will always be omitted.

Definition at line 45 of file CodeComplete.h.

◆ IncludeComments

bool clang::clangd::CodeCompleteOptions::IncludeComments = true

Add comments to code completion results, if available.

Definition at line 51 of file CodeComplete.h.

◆ IncludeIndicator

struct clang::clangd::CodeCompleteOptions::IncludeInsertionIndicator clang::clangd::CodeCompleteOptions::IncludeIndicator

◆ IncludeIneligibleResults

bool clang::clangd::CodeCompleteOptions::IncludeIneligibleResults = false

Include results that are not legal completions in the current context.

For example, private members are usually inaccessible.

Definition at line 55 of file CodeComplete.h.

◆ IncludeMacros

bool clang::clangd::CodeCompleteOptions::IncludeMacros = true

Add macros to code completion results.

Definition at line 48 of file CodeComplete.h.

◆ Index

const SymbolIndex* clang::clangd::CodeCompleteOptions::Index = nullptr

If Index is set, it is used to augment the code completion results.

FIXME(ioeric): we might want a better way to pass the index around inside clangd.

Definition at line 79 of file CodeComplete.h.

◆ Limit

size_t clang::clangd::CodeCompleteOptions::Limit = 0

Limit the number of results returned (0 means no limit).

If more results are available, we set CompletionList.isIncomplete.

Definition at line 62 of file CodeComplete.h.

◆ ShowOrigins

bool clang::clangd::CodeCompleteOptions::ShowOrigins = false

Expose origins of completion items in the label (for debugging).

Definition at line 72 of file CodeComplete.h.


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