clang  15.0.0git
Classes | Public Member Functions | Protected Attributes | List of all members
clang::CodeCompleteConsumer Class Referenceabstract

Abstract interface for a consumer of code-completion information. More...

#include "clang/Sema/CodeCompleteConsumer.h"

Inheritance diagram for clang::CodeCompleteConsumer:
Inheritance graph
[legend]
Collaboration diagram for clang::CodeCompleteConsumer:
Collaboration graph
[legend]

Classes

class  OverloadCandidate
 

Public Member Functions

 CodeCompleteConsumer (const CodeCompleteOptions &CodeCompleteOpts)
 
bool includeMacros () const
 Whether the code-completion consumer wants to see macros. More...
 
bool includeCodePatterns () const
 Whether the code-completion consumer wants to see code patterns. More...
 
bool includeGlobals () const
 Whether to include global (top-level) declaration results. More...
 
bool includeNamespaceLevelDecls () const
 Whether to include declarations in namespace contexts (including the global namespace). More...
 
bool includeBriefComments () const
 Whether to include brief documentation comments within the set of code completions returned. More...
 
bool includeFixIts () const
 Whether to include completion items with small fix-its, e.g. More...
 
bool loadExternal () const
 Hint whether to load data from the external AST in order to provide full results. More...
 
virtual ~CodeCompleteConsumer ()
 Deregisters and destroys this code-completion consumer. More...
 
Code-completion filtering

Check if the result should be filtered out.

virtual bool isResultFilteredOut (StringRef Filter, CodeCompletionResult Results)
 
Code-completion callbacks
virtual void ProcessCodeCompleteResults (Sema &S, CodeCompletionContext Context, CodeCompletionResult *Results, unsigned NumResults)
 Process the finalized code-completion results. More...
 
virtual void ProcessOverloadCandidates (Sema &S, unsigned CurrentArg, OverloadCandidate *Candidates, unsigned NumCandidates, SourceLocation OpenParLoc, bool Braced)
 
virtual CodeCompletionAllocatorgetAllocator ()=0
 Retrieve the allocator that will be used to allocate code completion strings. More...
 
virtual CodeCompletionTUInfogetCodeCompletionTUInfo ()=0
 

Protected Attributes

const CodeCompleteOptions CodeCompleteOpts
 

Detailed Description

Abstract interface for a consumer of code-completion information.

Definition at line 1000 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

◆ CodeCompleteConsumer()

clang::CodeCompleteConsumer::CodeCompleteConsumer ( const CodeCompleteOptions CodeCompleteOpts)
inline

Definition at line 1124 of file CodeCompleteConsumer.h.

◆ ~CodeCompleteConsumer()

CodeCompleteConsumer::~CodeCompleteConsumer ( )
virtualdefault

Deregisters and destroys this code-completion consumer.

Member Function Documentation

◆ getAllocator()

virtual CodeCompletionAllocator& clang::CodeCompleteConsumer::getAllocator ( )
pure virtual

Retrieve the allocator that will be used to allocate code completion strings.

Implemented in clang::PrintingCodeCompleteConsumer.

◆ getCodeCompletionTUInfo()

virtual CodeCompletionTUInfo& clang::CodeCompleteConsumer::getCodeCompletionTUInfo ( )
pure virtual

◆ includeBriefComments()

bool clang::CodeCompleteConsumer::includeBriefComments ( ) const
inline

Whether to include brief documentation comments within the set of code completions returned.

Definition at line 1149 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeBriefComments.

◆ includeCodePatterns()

bool clang::CodeCompleteConsumer::includeCodePatterns ( ) const
inline

Whether the code-completion consumer wants to see code patterns.

Definition at line 1133 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeCodePatterns.

◆ includeFixIts()

bool clang::CodeCompleteConsumer::includeFixIts ( ) const
inline

Whether to include completion items with small fix-its, e.g.

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

Definition at line 1155 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeFixIts.

◆ includeGlobals()

bool clang::CodeCompleteConsumer::includeGlobals ( ) const
inline

Whether to include global (top-level) declaration results.

Definition at line 1138 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeGlobals.

◆ includeMacros()

bool clang::CodeCompleteConsumer::includeMacros ( ) const
inline

Whether the code-completion consumer wants to see macros.

Definition at line 1128 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeMacros.

◆ includeNamespaceLevelDecls()

bool clang::CodeCompleteConsumer::includeNamespaceLevelDecls ( ) const
inline

Whether to include declarations in namespace contexts (including the global namespace).

If this is false, includeGlobals() will be ignored.

Definition at line 1143 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::IncludeNamespaceLevelDecls.

◆ isResultFilteredOut()

virtual bool clang::CodeCompleteConsumer::isResultFilteredOut ( StringRef  Filter,
CodeCompletionResult  Results 
)
inlinevirtual

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 1168 of file CodeCompleteConsumer.h.

◆ loadExternal()

bool clang::CodeCompleteConsumer::loadExternal ( ) const
inline

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

If false, declarations from the preamble may be omitted.

Definition at line 1159 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and clang::CodeCompleteOptions::LoadExternal.

◆ ProcessCodeCompleteResults()

virtual void clang::CodeCompleteConsumer::ProcessCodeCompleteResults ( Sema S,
CodeCompletionContext  Context,
CodeCompletionResult Results,
unsigned  NumResults 
)
inlinevirtual

Process the finalized code-completion results.

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 1176 of file CodeCompleteConsumer.h.

◆ ProcessOverloadCandidates()

virtual void clang::CodeCompleteConsumer::ProcessOverloadCandidates ( Sema S,
unsigned  CurrentArg,
OverloadCandidate Candidates,
unsigned  NumCandidates,
SourceLocation  OpenParLoc,
bool  Braced 
)
inlinevirtual
Parameters
Sthe semantic-analyzer object for which code-completion is being done.
CurrentArgthe index of the current argument.
Candidatesan array of overload candidates.
NumCandidatesthe number of overload candidates
OpenParLoclocation of the opening parenthesis of the argument list.

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 1192 of file CodeCompleteConsumer.h.

Referenced by ProduceSignatureHelp().

Member Data Documentation

◆ CodeCompleteOpts

const CodeCompleteOptions clang::CodeCompleteConsumer::CodeCompleteOpts
protected

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