clang 19.0.0git
Public Member Functions | Public Attributes | List of all members
clang::CodeCompleteOptions Class Reference

Options controlling the behavior of code completion. More...

#include "clang/Sema/CodeCompleteOptions.h"

Public Member Functions

 CodeCompleteOptions ()
 

Public Attributes

unsigned IncludeMacros: 1
 Show macros in code completion results.
 
unsigned IncludeCodePatterns: 1
 Show code patterns in code completion results.
 
unsigned IncludeGlobals: 1
 Show top-level decls in code completion results.
 
unsigned IncludeNamespaceLevelDecls: 1
 Show decls in namespace (including the global namespace) in code completion results.
 
unsigned IncludeBriefComments: 1
 Show brief documentation comments in code completion results.
 
unsigned LoadExternal: 1
 Hint whether to load data from the external AST to provide full results.
 
unsigned IncludeFixIts: 1
 Include results after corrections (small fix-its), e.g.
 

Detailed Description

Options controlling the behavior of code completion.

Definition at line 17 of file CodeCompleteOptions.h.

Constructor & Destructor Documentation

◆ CodeCompleteOptions()

clang::CodeCompleteOptions::CodeCompleteOptions ( )
inline

Definition at line 55 of file CodeCompleteOptions.h.

Member Data Documentation

◆ IncludeBriefComments

unsigned clang::CodeCompleteOptions::IncludeBriefComments

Show brief documentation comments in code completion results.

Definition at line 42 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), clang::getClangCompleteOpts(), and clang::CodeCompleteConsumer::includeBriefComments().

◆ IncludeCodePatterns

unsigned clang::CodeCompleteOptions::IncludeCodePatterns

Show code patterns in code completion results.

Definition at line 25 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), clang::getClangCompleteOpts(), and clang::CodeCompleteConsumer::includeCodePatterns().

◆ IncludeFixIts

unsigned clang::CodeCompleteOptions::IncludeFixIts

Include results after corrections (small fix-its), e.g.

change '.' to '->' on member access, etc.

Definition at line 53 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), and clang::CodeCompleteConsumer::includeFixIts().

◆ IncludeGlobals

unsigned clang::CodeCompleteOptions::IncludeGlobals

Show top-level decls in code completion results.

Definition at line 29 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), clang::getClangCompleteOpts(), and clang::CodeCompleteConsumer::includeGlobals().

◆ IncludeMacros

unsigned clang::CodeCompleteOptions::IncludeMacros

Show macros in code completion results.

Definition at line 21 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), clang::getClangCompleteOpts(), and clang::CodeCompleteConsumer::includeMacros().

◆ IncludeNamespaceLevelDecls

unsigned clang::CodeCompleteOptions::IncludeNamespaceLevelDecls

Show decls in namespace (including the global namespace) in code completion results.

If this is 0, IncludeGlobals will be ignored.

Currently, this only works when completing qualified IDs (i.e. Sema::CodeCompleteQualifiedId). FIXME: consider supporting more completion cases with this option.

Definition at line 38 of file CodeCompleteOptions.h.

Referenced by clang::CodeCompleteConsumer::includeNamespaceLevelDecls().

◆ LoadExternal

unsigned clang::CodeCompleteOptions::LoadExternal

Hint whether to load data from the external AST to provide full results.

If false, namespace-level declarations and macros from the preamble may be omitted.

Definition at line 48 of file CodeCompleteOptions.h.

Referenced by clang::ASTUnit::CodeComplete(), and clang::CodeCompleteConsumer::loadExternal().


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