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

#include <CodeCompleteConsumer.h>

Inheritance diagram for clang::CodeCompleteConsumer:

Collaboration diagram for clang::CodeCompleteConsumer:

Classes
class	OverloadCandidate
Public Member Functions
	CodeCompleteConsumer ()
	CodeCompleteConsumer (bool IncludeMacros, bool IncludeCodePatterns, bool IncludeGlobals, bool OutputIsBinary)
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	isOutputBinary () const
	Determine whether the output of this consumer is binary.
virtual	~CodeCompleteConsumer ()
	Deregisters and destroys this code-completion consumer.
virtual CodeCompletionAllocator &	getAllocator ()=0
	Retrieve the allocator that will be used to allocate code completion strings.
virtual CodeCompletionTUInfo &	getCodeCompletionTUInfo ()=0
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)
Protected Attributes
bool	IncludeMacros
	Whether to include macros in the code-completion results.
bool	IncludeCodePatterns
	Whether to include code patterns (such as for loops) within the completion results.
bool	IncludeGlobals
	Whether to include global (top-level) declarations and names in the completion results.
bool	OutputIsBinary
	Whether the output format for the code-completion consumer is binary.

Detailed Description

Abstract interface for a consumer of code-completion information.

Definition at line 819 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

clang::CodeCompleteConsumer::CodeCompleteConsumer ( ) [inline]

Definition at line 903 of file CodeCompleteConsumer.h.

clang::CodeCompleteConsumer::CodeCompleteConsumer	(	bool	IncludeMacros,
		bool	IncludeCodePatterns,
		bool	IncludeGlobals,
		bool	OutputIsBinary
	)		`[inline]`

Definition at line 906 of file CodeCompleteConsumer.h.

CodeCompleteConsumer::~CodeCompleteConsumer ( ) [virtual]

Deregisters and destroys this code-completion consumer.

Definition at line 458 of file CodeCompleteConsumer.cpp.

Member Function Documentation

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

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

Implemented in clang::PrintingCodeCompleteConsumer.

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

Implemented in clang::PrintingCodeCompleteConsumer.

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

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

Definition at line 915 of file CodeCompleteConsumer.h.

References IncludeCodePatterns.

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

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

Definition at line 918 of file CodeCompleteConsumer.h.

References IncludeGlobals.

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

Whether the code-completion consumer wants to see macros.

Definition at line 912 of file CodeCompleteConsumer.h.

References IncludeMacros.

bool clang::CodeCompleteConsumer::isOutputBinary ( ) const [inline]

Determine whether the output of this consumer is binary.

Definition at line 921 of file CodeCompleteConsumer.h.

References OutputIsBinary.

virtual void clang::CodeCompleteConsumer::ProcessCodeCompleteResults	(	Sema &	S,
		CodeCompletionContext	Context,
		CodeCompletionResult *	Results,
		unsigned	NumResults
	)		`[inline, virtual]`

Process the finalized code-completion results.

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 929 of file CodeCompleteConsumer.h.

Referenced by HandleCodeCompleteResults().

virtual void clang::CodeCompleteConsumer::ProcessOverloadCandidates	(	Sema &	S,
		unsigned	CurrentArg,
		OverloadCandidate *	Candidates,
		unsigned	NumCandidates
	)		`[inline, virtual]`

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

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 942 of file CodeCompleteConsumer.h.