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

#include "clang/Sema/CodeCompleteConsumer.h"

Inheritance diagram for clang::CodeCompleteConsumer:

Collaboration diagram for clang::CodeCompleteConsumer:

Classes
class	OverloadCandidate

Public Member Functions
	CodeCompleteConsumer (const CodeCompleteOptions &CodeCompleteOpts)

bool	includeMacros () const
	Whether the code-completion consumer wants to see macros.

bool	includeCodePatterns () const
	Whether the code-completion consumer wants to see code patterns.

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

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

bool	includeBriefComments () const
	Whether to include brief documentation comments within the set of code completions returned.

bool	includeFixIts () const
	Whether to include completion items with small fix-its, e.g.

bool	loadExternal () const
	Hint whether to load data from the external AST in order to provide full results.

virtual	~CodeCompleteConsumer ()
	Deregisters and destroys this code-completion consumer.

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.

virtual void	ProcessOverloadCandidates (Sema &S, unsigned CurrentArg, OverloadCandidate *Candidates, unsigned NumCandidates, SourceLocation OpenParLoc, bool Braced)

virtual CodeCompletionAllocator &	getAllocator ()=0
	Retrieve the allocator that will be used to allocate code completion strings.

virtual CodeCompletionTUInfo &	getCodeCompletionTUInfo ()=0

Protected Attributes
const CodeCompleteOptions	CodeCompleteOpts

Detailed Description

Abstract interface for a consumer of code-completion information.

Definition at line 1009 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

◆ CodeCompleteConsumer()

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

inline

Definition at line 1151 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

Implemented in clang::PrintingCodeCompleteConsumer.

◆ includeBriefComments()

bool clang::CodeCompleteConsumer::includeBriefComments ( ) const

inline

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

Definition at line 1176 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 1160 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 1182 of file CodeCompleteConsumer.h.

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

Referenced by clang::ASTUnit::CodeComplete().

◆ includeGlobals()

bool clang::CodeCompleteConsumer::includeGlobals ( ) const

inline

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

Definition at line 1165 of file CodeCompleteConsumer.h.

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

Referenced by AddRecordMembersCompletionResults().

◆ includeMacros()

bool clang::CodeCompleteConsumer::includeMacros ( ) const

inline

Whether the code-completion consumer wants to see macros.

Definition at line 1155 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 1170 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 1195 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 1186 of file CodeCompleteConsumer.h.

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

Referenced by AddRecordMembersCompletionResults(), and clang::ASTUnit::CodeComplete().

◆ 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 1203 of file CodeCompleteConsumer.h.

Referenced by HandleCodeCompleteResults().

◆ ProcessOverloadCandidates()

virtual void clang::CodeCompleteConsumer::ProcessOverloadCandidates	(	Sema &	S,
		unsigned	CurrentArg,
		OverloadCandidate *	Candidates,
		unsigned	NumCandidates,
		SourceLocation	OpenParLoc,
		bool	Braced
	)

inlinevirtual

Parameters

S	the semantic-analyzer object for which code-completion is being done.
CurrentArg	the index of the current argument.
Candidates	an array of overload candidates.
NumCandidates	the number of overload candidates
OpenParLoc	location of the opening parenthesis of the argument list.

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 1219 of file CodeCompleteConsumer.h.

Referenced by ProduceSignatureHelp().

Member Data Documentation

◆ CodeCompleteOpts

const CodeCompleteOptions clang::CodeCompleteConsumer::CodeCompleteOpts

protected

Definition at line 1011 of file CodeCompleteConsumer.h.

Referenced by includeBriefComments(), includeCodePatterns(), includeFixIts(), includeGlobals(), includeMacros(), includeNamespaceLevelDecls(), and loadExternal().

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

include/clang/Sema/CodeCompleteConsumer.h
lib/Sema/CodeCompleteConsumer.cpp

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CodeCompleteConsumer()

◆ ~CodeCompleteConsumer()

Member Function Documentation

◆ getAllocator()

◆ getCodeCompletionTUInfo()

◆ includeBriefComments()

◆ includeCodePatterns()

◆ includeFixIts()

◆ includeGlobals()

◆ includeMacros()

◆ includeNamespaceLevelDecls()

◆ isResultFilteredOut()

◆ loadExternal()

◆ ProcessCodeCompleteResults()

◆ ProcessOverloadCandidates()

Member Data Documentation

◆ CodeCompleteOpts