Abstract interface for a consumer of code-completion information. More...
#include <CodeCompleteConsumer.h>
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 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 | |
| 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.
| CodeCompleteConsumer::~CodeCompleteConsumer | ( | ) | [virtual] |
Deregisters and destroys this code-completion consumer.
Definition at line 432 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::includeBriefComments | ( | ) | const [inline] |
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.
| bool clang::CodeCompleteConsumer::includeCodePatterns | ( | ) | const [inline] |
Whether the code-completion consumer wants to see code patterns.
Definition at line 902 of file CodeCompleteConsumer.h.
References CodeCompleteOpts, and CodeCompleteOptions::IncludeCodePatterns.
| bool clang::CodeCompleteConsumer::includeGlobals | ( | ) | const [inline] |
Whether to include global (top-level) declaration results.
Definition at line 907 of file CodeCompleteConsumer.h.
References CodeCompleteOpts, and CodeCompleteOptions::IncludeGlobals.
| bool clang::CodeCompleteConsumer::includeMacros | ( | ) | const [inline] |
Whether the code-completion consumer wants to see macros.
Definition at line 897 of file CodeCompleteConsumer.h.
References CodeCompleteOpts, and CodeCompleteOptions::IncludeMacros.
| bool clang::CodeCompleteConsumer::isOutputBinary | ( | ) | const [inline] |
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:
-
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 939 of file CodeCompleteConsumer.h.
Member Data Documentation
const CodeCompleteOptions clang::CodeCompleteConsumer::CodeCompleteOpts [protected] |
Definition at line 818 of file CodeCompleteConsumer.h.
Referenced by includeBriefComments(), includeCodePatterns(), includeGlobals(), and includeMacros().
bool clang::CodeCompleteConsumer::OutputIsBinary [protected] |
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: