clang::PrintingCodeCompleteConsumer Class Reference

A simple code-completion consumer that prints the results it receives in a simple format. More...

#include "clang/Sema/CodeCompleteConsumer.h"

Inheritance diagram for clang::PrintingCodeCompleteConsumer:

Public Member Functions
	PrintingCodeCompleteConsumer (const CodeCompleteOptions &CodeCompleteOpts, raw_ostream &OS)
	Create a new printing code-completion consumer that prints its results to the given raw output stream.
void	ProcessCodeCompleteResults (Sema &S, CodeCompletionContext Context, CodeCompletionResult *Results, unsigned NumResults) override
	Prints the finalized code-completion results.
void	ProcessOverloadCandidates (Sema &S, unsigned CurrentArg, OverloadCandidate *Candidates, unsigned NumCandidates, SourceLocation OpenParLoc, bool Braced) override
bool	isResultFilteredOut (StringRef Filter, CodeCompletionResult Results) override
CodeCompletionAllocator &	getAllocator () override
	Retrieve the allocator that will be used to allocate code completion strings.
CodeCompletionTUInfo &	getCodeCompletionTUInfo () override
Public Member Functions inherited from clang::CodeCompleteConsumer
	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.

Additional Inherited Members
Protected Attributes inherited from clang::CodeCompleteConsumer
const CodeCompleteOptions	CodeCompleteOpts

Detailed Description

A simple code-completion consumer that prints the results it receives in a simple format.

Definition at line 1262 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

PrintingCodeCompleteConsumer()

clang::PrintingCodeCompleteConsumer::PrintingCodeCompleteConsumer ( const CodeCompleteOptions & CodeCompleteOpts, raw_ostream & OS )

inline

Create a new printing code-completion consumer that prints its results to the given raw output stream.

Definition at line 1271 of file CodeCompleteConsumer.h.

References clang::CodeCompleteConsumer::CodeCompleteConsumer(), and clang::CodeCompleteConsumer::CodeCompleteOpts.

Member Function Documentation

getAllocator()

CodeCompletionAllocator & clang::PrintingCodeCompleteConsumer::getAllocator ( )

inlineoverridevirtual

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

Implements clang::CodeCompleteConsumer.

Definition at line 1289 of file CodeCompleteConsumer.h.

Referenced by ProcessCodeCompleteResults(), and ProcessOverloadCandidates().

getCodeCompletionTUInfo()

CodeCompletionTUInfo & clang::PrintingCodeCompleteConsumer::getCodeCompletionTUInfo ( )

inlineoverridevirtual

Implements clang::CodeCompleteConsumer.

Definition at line 1293 of file CodeCompleteConsumer.h.

isResultFilteredOut()

bool PrintingCodeCompleteConsumer::isResultFilteredOut ( StringRef Filter, CodeCompletionResult Results )

overridevirtual

Reimplemented from clang::CodeCompleteConsumer.

Definition at line 625 of file CodeCompleteConsumer.cpp.

References clang::Result, clang::CodeCompletionResult::RK_Declaration, clang::CodeCompletionResult::RK_Keyword, clang::CodeCompletionResult::RK_Macro, and clang::CodeCompletionResult::RK_Pattern.

Referenced by ProcessCodeCompleteResults().

ProcessCodeCompleteResults()

void PrintingCodeCompleteConsumer::ProcessCodeCompleteResults ( Sema & S, CodeCompletionContext Context, CodeCompletionResult * Results, unsigned NumResults )

overridevirtual

Prints the finalized code-completion results.

Reimplemented from clang::CodeCompleteConsumer.

Definition at line 643 of file CodeCompleteConsumer.cpp.

References CXAvailability_NotAccessible, clang::CodeCompletionResult::Declaration, getAllocator(), clang::CodeCompletionString::getAsString(), clang::Preprocessor::getCodeCompletionFilter(), clang::IdentifierInfo::getName(), clang::Sema::getPreprocessor(), clang::CodeCompleteConsumer::includeBriefComments(), isResultFilteredOut(), clang::CodeCompletionResult::Keyword, clang::Sema::LangOpts, clang::CodeCompletionResult::Macro, clang::Lexer::MeasureTokenLength(), clang::CodeCompletionResult::Pattern, clang::CodeCompletionResult::RK_Declaration, clang::CodeCompletionResult::RK_Keyword, clang::CodeCompletionResult::RK_Macro, clang::CodeCompletionResult::RK_Pattern, SM, and clang::Sema::SourceMgr.

ProcessOverloadCandidates()

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

overridevirtual

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 from clang::CodeCompleteConsumer.

Definition at line 751 of file CodeCompleteConsumer.cpp.

References getAllocator(), getOverloadAsString(), clang::Sema::getSourceManager(), clang::CodeCompleteConsumer::includeBriefComments(), and clang::SourceLocation::print().

---

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

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