clang  3.9.0
Public Types | Public Member Functions | List of all members
clang::CodeCompletionBuilder Class Reference

A builder class used to construct new code-completion strings. More...

#include <CodeCompleteConsumer.h>

Public Types

typedef CodeCompletionString::Chunk Chunk
 

Public Member Functions

 CodeCompletionBuilder (CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo)
 
 CodeCompletionBuilder (CodeCompletionAllocator &Allocator, CodeCompletionTUInfo &CCTUInfo, unsigned Priority, CXAvailabilityKind Availability)
 
CodeCompletionAllocatorgetAllocator () const
 Retrieve the allocator into which the code completion strings should be allocated. More...
 
CodeCompletionTUInfogetCodeCompletionTUInfo () const
 
CodeCompletionStringTakeString ()
 Take the resulting completion string. More...
 
void AddTypedTextChunk (const char *Text)
 Add a new typed-text chunk. More...
 
void AddTextChunk (const char *Text)
 Add a new text chunk. More...
 
void AddOptionalChunk (CodeCompletionString *Optional)
 Add a new optional chunk. More...
 
void AddPlaceholderChunk (const char *Placeholder)
 Add a new placeholder chunk. More...
 
void AddInformativeChunk (const char *Text)
 Add a new informative chunk. More...
 
void AddResultTypeChunk (const char *ResultType)
 Add a new result-type chunk. More...
 
void AddCurrentParameterChunk (const char *CurrentParameter)
 Add a new current-parameter chunk. More...
 
void AddChunk (CodeCompletionString::ChunkKind CK, const char *Text="")
 Add a new chunk. More...
 
void AddAnnotation (const char *A)
 
void addParentContext (const DeclContext *DC)
 Add the parent context information to this code completion. More...
 
const char * getBriefComment () const
 
void addBriefComment (StringRef Comment)
 
StringRef getParentName () const
 

Detailed Description

A builder class used to construct new code-completion strings.

Definition at line 546 of file CodeCompleteConsumer.h.

Member Typedef Documentation

Definition at line 548 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

clang::CodeCompletionBuilder::CodeCompletionBuilder ( CodeCompletionAllocator Allocator,
CodeCompletionTUInfo CCTUInfo 
)
inline

Definition at line 564 of file CodeCompleteConsumer.h.

clang::CodeCompletionBuilder::CodeCompletionBuilder ( CodeCompletionAllocator Allocator,
CodeCompletionTUInfo CCTUInfo,
unsigned  Priority,
CXAvailabilityKind  Availability 
)
inline

Definition at line 570 of file CodeCompleteConsumer.h.

Member Function Documentation

void clang::CodeCompletionBuilder::AddAnnotation ( const char *  A)
inline
void CodeCompletionBuilder::addBriefComment ( StringRef  Comment)
void CodeCompletionBuilder::AddChunk ( CodeCompletionString::ChunkKind  CK,
const char *  Text = "" 
)
void CodeCompletionBuilder::AddCurrentParameterChunk ( const char *  CurrentParameter)

Add a new current-parameter chunk.

Definition at line 367 of file CodeCompleteConsumer.cpp.

References clang::CodeCompletionString::Chunk::CreateCurrentParameter().

Referenced by AddOverloadParameterChunks().

void CodeCompletionBuilder::AddInformativeChunk ( const char *  Text)
void CodeCompletionBuilder::AddOptionalChunk ( CodeCompletionString Optional)
void CodeCompletionBuilder::addParentContext ( const DeclContext DC)

Add the parent context information to this code completion.

Definition at line 376 of file CodeCompleteConsumer.cpp.

References clang::DeclContext::isFunctionOrMethod(), and clang::DeclContext::isTranslationUnit().

Referenced by clang::CodeCompletionResult::CreateCodeCompletionString().

void CodeCompletionBuilder::AddPlaceholderChunk ( const char *  Placeholder)
void CodeCompletionBuilder::AddResultTypeChunk ( const char *  ResultType)
void CodeCompletionBuilder::AddTextChunk ( const char *  Text)
void CodeCompletionBuilder::AddTypedTextChunk ( const char *  Text)
CodeCompletionAllocator& clang::CodeCompletionBuilder::getAllocator ( ) const
inline
const char* clang::CodeCompletionBuilder::getBriefComment ( ) const
inline
CodeCompletionTUInfo& clang::CodeCompletionBuilder::getCodeCompletionTUInfo ( ) const
inline
StringRef clang::CodeCompletionBuilder::getParentName ( ) const
inline
CodeCompletionString * CodeCompletionBuilder::TakeString ( )

Take the resulting completion string.

This operation can only be performed once.

Definition at line 328 of file CodeCompleteConsumer.cpp.

References clang::Result.

Referenced by clang::CodeCompletionResult::CreateCodeCompletionString(), and clang::CodeCompleteConsumer::OverloadCandidate::CreateSignatureString().


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