class CodeCompleteConsumer
Declaration
class CodeCompleteConsumer { /* full declaration omitted */ };
Description
Abstract interface for a consumer of code-completion information.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1003
Member Variables
- protected const clang::CodeCompleteOptions CodeCompleteOpts
Method Overview
- public CodeCompleteConsumer(const clang::CodeCompleteOptions & CodeCompleteOpts)
- public virtual void ProcessCodeCompleteResults(clang::Sema & S, clang::CodeCompletionContext Context, clang::CodeCompletionResult * Results, unsigned int NumResults)
- public virtual void ProcessOverloadCandidates(clang::Sema & S, unsigned int CurrentArg, clang::CodeCompleteConsumer::OverloadCandidate * Candidates, unsigned int NumCandidates, clang::SourceLocation OpenParLoc, bool Braced)
- public virtual clang::CodeCompletionAllocator & getAllocator()
- public virtual clang::CodeCompletionTUInfo & getCodeCompletionTUInfo()
- public bool includeBriefComments() const
- public bool includeCodePatterns() const
- public bool includeFixIts() const
- public bool includeGlobals() const
- public bool includeMacros() const
- public bool includeNamespaceLevelDecls() const
- public virtual bool isResultFilteredOut(llvm::StringRef Filter, clang::CodeCompletionResult Results)
- public bool loadExternal() const
- public virtual ~CodeCompleteConsumer()
Methods
¶CodeCompleteConsumer(
const clang::CodeCompleteOptions&
CodeCompleteOpts)
CodeCompleteConsumer(
const clang::CodeCompleteOptions&
CodeCompleteOpts)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1145
Parameters
- const clang::CodeCompleteOptions& CodeCompleteOpts
¶virtual void ProcessCodeCompleteResults(
clang::Sema& S,
clang::CodeCompletionContext Context,
clang::CodeCompletionResult* Results,
unsigned int NumResults)
virtual void ProcessCodeCompleteResults(
clang::Sema& S,
clang::CodeCompletionContext Context,
clang::CodeCompletionResult* Results,
unsigned int NumResults)
Description
Process the finalized code-completion results.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1197
Parameters
- clang::Sema& S
- clang::CodeCompletionContext Context
- clang::CodeCompletionResult* Results
- unsigned int NumResults
¶virtual void ProcessOverloadCandidates(
clang::Sema& S,
unsigned int CurrentArg,
clang::CodeCompleteConsumer::
OverloadCandidate* Candidates,
unsigned int NumCandidates,
clang::SourceLocation OpenParLoc,
bool Braced)
virtual void ProcessOverloadCandidates(
clang::Sema& S,
unsigned int CurrentArg,
clang::CodeCompleteConsumer::
OverloadCandidate* Candidates,
unsigned int NumCandidates,
clang::SourceLocation OpenParLoc,
bool Braced)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1213
Parameters
- clang::Sema& S
- the semantic-analyzer object for which code-completion is being done.
- unsigned int CurrentArg
- the index of the current argument.
- clang::CodeCompleteConsumer::OverloadCandidate* Candidates
- an array of overload candidates.
- unsigned int NumCandidates
- the number of overload candidates
- clang::SourceLocation OpenParLoc
- location of the opening parenthesis of the argument list.
- bool Braced
¶virtual clang::CodeCompletionAllocator&
getAllocator()
virtual clang::CodeCompletionAllocator&
getAllocator()
Description
Retrieve the allocator that will be used to allocate code completion strings.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1222
¶virtual clang::CodeCompletionTUInfo&
getCodeCompletionTUInfo()
virtual clang::CodeCompletionTUInfo&
getCodeCompletionTUInfo()
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1224
¶bool includeBriefComments() const
bool includeBriefComments() const
Description
Whether to include brief documentation comments within the set of code completions returned.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1170
¶bool includeCodePatterns() const
bool includeCodePatterns() const
Description
Whether the code-completion consumer wants to see code patterns.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1154
¶bool includeFixIts() const
bool includeFixIts() const
Description
Whether to include completion items with small fix-its, e.g. change '.' to '->' on member access, etc.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1176
¶bool includeGlobals() const
bool includeGlobals() const
Description
Whether to include global (top-level) declaration results.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1159
¶bool includeMacros() const
bool includeMacros() const
Description
Whether the code-completion consumer wants to see macros.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1149
¶bool includeNamespaceLevelDecls() const
bool includeNamespaceLevelDecls() const
Description
Whether to include declarations in namespace contexts (including the global namespace). If this is false, `includeGlobals()` will be ignored.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1164
¶virtual bool isResultFilteredOut(
llvm::StringRef Filter,
clang::CodeCompletionResult Results)
virtual bool isResultFilteredOut(
llvm::StringRef Filter,
clang::CodeCompletionResult Results)
Description
Check if the result should be filtered out.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1189
Parameters
- llvm::StringRef Filter
- clang::CodeCompletionResult Results
¶bool loadExternal() const
bool loadExternal() const
Description
Hint whether to load data from the external AST in order to provide full results. If false, declarations from the preamble may be omitted.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1180
¶virtual ~CodeCompleteConsumer()
virtual ~CodeCompleteConsumer()
Description
Deregisters and destroys this code-completion consumer.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:1185