clang  6.0.0svn
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 "clang/Sema/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 545 of file CodeCompleteConsumer.h.

Member Typedef Documentation

◆ Chunk

Definition at line 547 of file CodeCompleteConsumer.h.

Constructor & Destructor Documentation

◆ CodeCompletionBuilder() [1/2]

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

Definition at line 563 of file CodeCompleteConsumer.h.

◆ CodeCompletionBuilder() [2/2]

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

Definition at line 569 of file CodeCompleteConsumer.h.

Member Function Documentation

◆ AddAnnotation()

void clang::CodeCompletionBuilder::AddAnnotation ( const char *  A)

Definition at line 611 of file CodeCompleteConsumer.h.

◆ addBriefComment()

void CodeCompletionBuilder::addBriefComment ( StringRef  Comment)

◆ AddChunk()

void CodeCompletionBuilder::AddChunk ( CodeCompletionString::ChunkKind  CK,
const char *  Text = "" 

◆ AddCurrentParameterChunk()

void CodeCompletionBuilder::AddCurrentParameterChunk ( const char *  CurrentParameter)

Add a new current-parameter chunk.

Definition at line 368 of file CodeCompleteConsumer.cpp.

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

◆ AddInformativeChunk()

void CodeCompletionBuilder::AddInformativeChunk ( const char *  Text)

Add a new informative chunk.

Definition at line 359 of file CodeCompleteConsumer.cpp.

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

Referenced by AddFunctionTypeQualsToCompletionString().

◆ AddOptionalChunk()

void CodeCompletionBuilder::AddOptionalChunk ( CodeCompletionString Optional)

Add a new optional chunk.

Definition at line 351 of file CodeCompleteConsumer.cpp.

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

Referenced by AddFunctionParameterChunks().

◆ addParentContext()

void CodeCompletionBuilder::addParentContext ( const DeclContext DC)

Add the parent context information to this code completion.

Definition at line 377 of file CodeCompleteConsumer.cpp.

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

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

◆ AddPlaceholderChunk()

void CodeCompletionBuilder::AddPlaceholderChunk ( const char *  Placeholder)

◆ AddResultTypeChunk()

void CodeCompletionBuilder::AddResultTypeChunk ( const char *  ResultType)

Add a new result-type chunk.

Definition at line 363 of file CodeCompleteConsumer.cpp.

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

◆ AddTextChunk()

void CodeCompletionBuilder::AddTextChunk ( const char *  Text)

◆ AddTypedTextChunk()

void CodeCompletionBuilder::AddTypedTextChunk ( const char *  Text)

◆ getAllocator()

CodeCompletionAllocator& clang::CodeCompletionBuilder::getAllocator ( ) const

Retrieve the allocator into which the code completion strings should be allocated.

Definition at line 578 of file CodeCompleteConsumer.h.

Referenced by AddFunctionParameterChunks(), AddFunctionTypeQualsToCompletionString(), and clang::CodeCompletionResult::CreateCodeCompletionString().

◆ getBriefComment()

const char* clang::CodeCompletionBuilder::getBriefComment ( ) const

◆ getCodeCompletionTUInfo()

CodeCompletionTUInfo& clang::CodeCompletionBuilder::getCodeCompletionTUInfo ( ) const

Definition at line 580 of file CodeCompleteConsumer.h.

References AddResultTypeChunk(), and Text.

Referenced by AddFunctionParameterChunks().

◆ getParentName()

StringRef clang::CodeCompletionBuilder::getParentName ( ) const

◆ TakeString()

CodeCompletionString * CodeCompletionBuilder::TakeString ( )

Take the resulting completion string.

This operation can only be performed once.

Definition at line 329 of file CodeCompleteConsumer.cpp.

References clang::Result.

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

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