class CodeCompletionBuilder
Declaration
class CodeCompletionBuilder { /* full declaration omitted */ };
Description
A builder class used to construct new code-completion strings.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:677
Member Variables
- private clang::CodeCompletionAllocator& Allocator
- private clang::CodeCompletionTUInfo& CCTUInfo
- private unsigned int Priority = 0
- private CXAvailabilityKind Availability = CXAvailability_Available
- private llvm::StringRef ParentName
- private const char* BriefComment = nullptr
- private SmallVector<clang::CodeCompletionBuilder::Chunk, 4> Chunks
- The chunks stored in this string.
- private SmallVector<const char*, 2> Annotations
Method Overview
- public void AddAnnotation(const char * A)
- public void AddChunk(CodeCompletionString::ChunkKind CK, const char * Text = "")
- public void AddCurrentParameterChunk(const char * CurrentParameter)
- public void AddInformativeChunk(const char * Text)
- public void AddOptionalChunk(clang::CodeCompletionString * Optional)
- public void AddPlaceholderChunk(const char * Placeholder)
- public void AddResultTypeChunk(const char * ResultType)
- public void AddTextChunk(const char * Text)
- public void AddTypedTextChunk(const char * Text)
- public CodeCompletionBuilder(clang::CodeCompletionAllocator & Allocator, clang::CodeCompletionTUInfo & CCTUInfo, unsigned int Priority, CXAvailabilityKind Availability)
- public CodeCompletionBuilder(clang::CodeCompletionAllocator & Allocator, clang::CodeCompletionTUInfo & CCTUInfo)
- public clang::CodeCompletionString * TakeString()
- public void addBriefComment(llvm::StringRef Comment)
- public void addParentContext(const clang::DeclContext * DC)
- public clang::CodeCompletionAllocator & getAllocator() const
- public const char * getBriefComment() const
- public clang::CodeCompletionTUInfo & getCodeCompletionTUInfo() const
- public llvm::StringRef getParentName() const
Methods
¶void AddAnnotation(const char* A)
void AddAnnotation(const char* A)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:740
Parameters
- const char* A
¶void AddChunk(CodeCompletionString::ChunkKind CK,
const char* Text = "")
void AddChunk(CodeCompletionString::ChunkKind CK,
const char* Text = "")
Description
Add a new chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:738
Parameters
- CodeCompletionString::ChunkKind CK
- const char* Text = ""
¶void AddCurrentParameterChunk(
const char* CurrentParameter)
void AddCurrentParameterChunk(
const char* CurrentParameter)
Description
Add a new current-parameter chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:735
Parameters
- const char* CurrentParameter
¶void AddInformativeChunk(const char* Text)
void AddInformativeChunk(const char* Text)
Description
Add a new informative chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:729
Parameters
- const char* Text
¶void AddOptionalChunk(
clang::CodeCompletionString* Optional)
void AddOptionalChunk(
clang::CodeCompletionString* Optional)
Description
Add a new optional chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:723
Parameters
- clang::CodeCompletionString* Optional
¶void AddPlaceholderChunk(const char* Placeholder)
void AddPlaceholderChunk(const char* Placeholder)
Description
Add a new placeholder chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:726
Parameters
- const char* Placeholder
¶void AddResultTypeChunk(const char* ResultType)
void AddResultTypeChunk(const char* ResultType)
Description
Add a new result-type chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:732
Parameters
- const char* ResultType
¶void AddTextChunk(const char* Text)
void AddTextChunk(const char* Text)
Description
Add a new text chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:720
Parameters
- const char* Text
¶void AddTypedTextChunk(const char* Text)
void AddTypedTextChunk(const char* Text)
Description
Add a new typed-text chunk.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:717
Parameters
- const char* Text
¶CodeCompletionBuilder(
clang::CodeCompletionAllocator& Allocator,
clang::CodeCompletionTUInfo& CCTUInfo,
unsigned int Priority,
CXAvailabilityKind Availability)
CodeCompletionBuilder(
clang::CodeCompletionAllocator& Allocator,
clang::CodeCompletionTUInfo& CCTUInfo,
unsigned int Priority,
CXAvailabilityKind Availability)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:699
Parameters
- clang::CodeCompletionAllocator& Allocator
- clang::CodeCompletionTUInfo& CCTUInfo
- unsigned int Priority
- CXAvailabilityKind Availability
¶CodeCompletionBuilder(
clang::CodeCompletionAllocator& Allocator,
clang::CodeCompletionTUInfo& CCTUInfo)
CodeCompletionBuilder(
clang::CodeCompletionAllocator& Allocator,
clang::CodeCompletionTUInfo& CCTUInfo)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:695
Parameters
- clang::CodeCompletionAllocator& Allocator
- clang::CodeCompletionTUInfo& CCTUInfo
¶clang::CodeCompletionString* TakeString()
clang::CodeCompletionString* TakeString()
Description
Take the resulting completion string. This operation can only be performed once.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:714
¶void addBriefComment(llvm::StringRef Comment)
void addBriefComment(llvm::StringRef Comment)
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:746
Parameters
- llvm::StringRef Comment
¶void addParentContext(
const clang::DeclContext* DC)
void addParentContext(
const clang::DeclContext* DC)
Description
Add the parent context information to this code completion.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:743
Parameters
- const clang::DeclContext* DC
¶clang::CodeCompletionAllocator& getAllocator()
const
clang::CodeCompletionAllocator& getAllocator()
const
Description
Retrieve the allocator into which the code completion strings should be allocated.
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:707
¶const char* getBriefComment() const
const char* getBriefComment() const
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:745
¶clang::CodeCompletionTUInfo&
getCodeCompletionTUInfo() const
clang::CodeCompletionTUInfo&
getCodeCompletionTUInfo() const
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:709
¶llvm::StringRef getParentName() const
llvm::StringRef getParentName() const
Declared at: clang/include/clang/Sema/CodeCompleteConsumer.h:748