|
clang
5.0.0
|
A "string" used to describe how code completion can be performed for an entity. More...
#include "clang/Sema/CodeCompleteConsumer.h"
Classes | |
| struct | Chunk |
| One piece of the code completion string. More... | |
Public Types | |
| enum | ChunkKind { CK_TypedText, CK_Text, CK_Optional, CK_Placeholder, CK_Informative, CK_ResultType, CK_CurrentParameter, CK_LeftParen, CK_RightParen, CK_LeftBracket, CK_RightBracket, CK_LeftBrace, CK_RightBrace, CK_LeftAngle, CK_RightAngle, CK_Comma, CK_Colon, CK_SemiColon, CK_Equal, CK_HorizontalSpace, CK_VerticalSpace } |
| The different kinds of "chunks" that can occur within a code completion string. More... | |
| typedef const Chunk * | iterator |
Public Member Functions | |
| iterator | begin () const |
| iterator | end () const |
| bool | empty () const |
| unsigned | size () const |
| const Chunk & | operator[] (unsigned I) const |
| const char * | getTypedText () const |
| Returns the text in the TypedText chunk. More... | |
| unsigned | getPriority () const |
| Retrieve the priority of this code completion result. More... | |
| unsigned | getAvailability () const |
| Retrieve the availability of this code completion result. More... | |
| unsigned | getAnnotationCount () const |
| Retrieve the number of annotations for this code completion result. More... | |
| const char * | getAnnotation (unsigned AnnotationNr) const |
Retrieve the annotation string specified by AnnotationNr. More... | |
| StringRef | getParentContextName () const |
| Retrieve the name of the parent context. More... | |
| const char * | getBriefComment () const |
| std::string | getAsString () const |
| Retrieve a string representation of the code completion string, which is mainly useful for debugging. More... | |
Friends | |
| class | CodeCompletionBuilder |
| class | CodeCompletionResult |
A "string" used to describe how code completion can be performed for an entity.
A code completion string typically shows how a particular entity can be used. For example, the code completion string for a function would show the syntax to call it, including the parentheses, placeholders for the arguments, etc.
Definition at line 328 of file CodeCompleteConsumer.h.
| typedef const Chunk* clang::CodeCompletionString::iterator |
Definition at line 464 of file CodeCompleteConsumer.h.
The different kinds of "chunks" that can occur within a code completion string.
Definition at line 332 of file CodeCompleteConsumer.h.
|
inline |
Definition at line 465 of file CodeCompleteConsumer.h.
Referenced by end(), getAsString(), getTypedText(), and operator[]().
|
inline |
Definition at line 467 of file CodeCompleteConsumer.h.
|
inline |
Definition at line 466 of file CodeCompleteConsumer.h.
References begin().
Referenced by getAnnotation(), getAsString(), and getTypedText().
| const char * CodeCompletionString::getAnnotation | ( | unsigned | AnnotationNr | ) | const |
Retrieve the annotation string specified by AnnotationNr.
Definition at line 218 of file CodeCompleteConsumer.cpp.
References end().
| unsigned CodeCompletionString::getAnnotationCount | ( | ) | const |
Retrieve the number of annotations for this code completion result.
Definition at line 214 of file CodeCompleteConsumer.cpp.
| std::string CodeCompletionString::getAsString | ( | ) | const |
Retrieve a string representation of the code completion string, which is mainly useful for debugging.
Definition at line 226 of file CodeCompleteConsumer.cpp.
References begin(), CK_CurrentParameter, CK_Informative, CK_Optional, CK_Placeholder, CK_ResultType, end(), and clang::Result.
Referenced by clang::PrintingCodeCompleteConsumer::isResultFilteredOut(), and clang::PrintingCodeCompleteConsumer::ProcessCodeCompleteResults().
|
inline |
Retrieve the availability of this code completion result.
Definition at line 482 of file CodeCompleteConsumer.h.
Referenced by getDeclAvailability().
|
inline |
Definition at line 495 of file CodeCompleteConsumer.h.
|
inline |
Retrieve the name of the parent context.
Definition at line 491 of file CodeCompleteConsumer.h.
|
inline |
Retrieve the priority of this code completion result.
Definition at line 479 of file CodeCompleteConsumer.h.
| const char * CodeCompletionString::getTypedText | ( | ) | const |
Returns the text in the TypedText chunk.
Definition at line 247 of file CodeCompleteConsumer.cpp.
References begin(), CK_TypedText, and end().
Referenced by getOrderedName().
Definition at line 470 of file CodeCompleteConsumer.h.
|
inline |
Definition at line 468 of file CodeCompleteConsumer.h.
Referenced by operator[]().
|
friend |
Definition at line 460 of file CodeCompleteConsumer.h.
|
friend |
Definition at line 461 of file CodeCompleteConsumer.h.
1.8.6