clang API Documentation

Classes | Public Member Functions | Protected Attributes
clang::CodeCompleteConsumer Class Reference

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

#include <CodeCompleteConsumer.h>

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

List of all members.

Classes

class  OverloadCandidate

Public Member Functions

 CodeCompleteConsumer (const CodeCompleteOptions &CodeCompleteOpts, 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 includeBriefComments () const
 Whether to include brief documentation comments within the set of code completions returned.
bool isOutputBinary () const
 Determine whether the output of this consumer is binary.
virtual ~CodeCompleteConsumer ()
 Deregisters and destroys this code-completion consumer.
virtual CodeCompletionAllocatorgetAllocator ()=0
 Retrieve the allocator that will be used to allocate code completion strings.
virtual CodeCompletionTUInfogetCodeCompletionTUInfo ()=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

const CodeCompleteOptions CodeCompleteOpts
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 816 of file CodeCompleteConsumer.h.


Constructor & Destructor Documentation

clang::CodeCompleteConsumer::CodeCompleteConsumer ( const CodeCompleteOptions CodeCompleteOpts,
bool  OutputIsBinary 
) [inline]

Definition at line 891 of file CodeCompleteConsumer.h.

Deregisters and destroys this code-completion consumer.

Definition at line 432 of file CodeCompleteConsumer.cpp.


Member Function Documentation

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

Implemented in clang::PrintingCodeCompleteConsumer.

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

Definition at line 913 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and CodeCompleteOptions::IncludeBriefComments.

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

Definition at line 902 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and CodeCompleteOptions::IncludeCodePatterns.

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

Definition at line 907 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and CodeCompleteOptions::IncludeGlobals.

Whether the code-completion consumer wants to see macros.

Definition at line 897 of file CodeCompleteConsumer.h.

References CodeCompleteOpts, and CodeCompleteOptions::IncludeMacros.

Determine whether the output of this consumer is binary.

Definition at line 918 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 926 of file CodeCompleteConsumer.h.

Referenced by HandleCodeCompleteResults().

virtual void clang::CodeCompleteConsumer::ProcessOverloadCandidates ( Sema S,
unsigned  CurrentArg,
OverloadCandidate Candidates,
unsigned  NumCandidates 
) [inline, virtual]
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

Reimplemented in clang::PrintingCodeCompleteConsumer.

Definition at line 939 of file CodeCompleteConsumer.h.


Member Data Documentation

Whether the output format for the code-completion consumer is binary.

Definition at line 822 of file CodeCompleteConsumer.h.

Referenced by isOutputBinary().


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