clang API Documentation
A "string" used to describe how code completion can be performed for an entity. More...
#include <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. | |
| unsigned | getPriority () const |
| Retrieve the priority of this code completion result. | |
| unsigned | getAvailability () const |
| Retrieve the availability of this code completion result. | |
| unsigned | getAnnotationCount () const |
| Retrieve the number of annotations for this code completion result. | |
| const char * | getAnnotation (unsigned AnnotationNr) const |
Retrieve the annotation string specified by AnnotationNr. | |
| CXCursorKind | getParentContextKind () const |
| Retrieve parent context's cursor kind. | |
| StringRef | getParentContextName () const |
| Retrieve the name of the parent context. | |
| std::string | getAsString () const |
| Retrieve a string representation of the code completion string, which is mainly useful for debugging. | |
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 327 of file CodeCompleteConsumer.h.
| typedef const Chunk* clang::CodeCompletionString::iterator |
Definition at line 461 of file CodeCompleteConsumer.h.
The different kinds of "chunks" that can occur within a code completion string.
| CK_TypedText |
The piece of text that the user is expected to type to match the code-completion string, typically a keyword or the name of a declarator or macro. |
| CK_Text |
A piece of text that should be placed in the buffer, e.g., parentheses or a comma in a function call. |
| CK_Optional |
A code completion string that is entirely optional. For example, an optional code completion string that describes the default arguments in a function call. |
| CK_Placeholder |
A string that acts as a placeholder for, e.g., a function call argument. |
| CK_Informative |
A piece of text that describes something about the result but should not be inserted into the buffer. |
| CK_ResultType |
A piece of text that describes the type of an entity or, for functions and methods, the return type. |
| CK_CurrentParameter |
A piece of text that describes the parameter that corresponds to the code-completion location within a function call, message send, macro invocation, etc. |
| CK_LeftParen |
A left parenthesis ('('). |
| CK_RightParen |
A right parenthesis (')'). |
| CK_LeftBracket |
A left bracket ('['). |
| CK_RightBracket |
A right bracket (']'). |
| CK_LeftBrace |
A left brace ('{'). |
| CK_RightBrace |
A right brace ('}'). |
| CK_LeftAngle |
A left angle bracket ('<'). |
| CK_RightAngle |
A right angle bracket ('>'). |
| CK_Comma |
A comma separator (','). |
| CK_Colon |
A colon (':'). |
| CK_SemiColon |
A semicolon (';'). |
| CK_Equal |
An '=' sign. |
| CK_HorizontalSpace |
Horizontal whitespace (' '). |
| CK_VerticalSpace |
Verticle whitespace (' |
Definition at line 331 of file CodeCompleteConsumer.h.
| iterator clang::CodeCompletionString::begin | ( | ) | const [inline] |
Definition at line 462 of file CodeCompleteConsumer.h.
Referenced by end(), getAsString(), getTypedText(), and operator[]().
| bool clang::CodeCompletionString::empty | ( | ) | const [inline] |
Definition at line 464 of file CodeCompleteConsumer.h.
| iterator clang::CodeCompletionString::end | ( | ) | const [inline] |
Definition at line 463 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, and end().
Referenced by clang::PrintingCodeCompleteConsumer::ProcessCodeCompleteResults().
| unsigned clang::CodeCompletionString::getAvailability | ( | ) | const [inline] |
Retrieve the availability of this code completion result.
Definition at line 479 of file CodeCompleteConsumer.h.
Referenced by getDeclAvailability().
| CXCursorKind clang::CodeCompletionString::getParentContextKind | ( | ) | const [inline] |
Retrieve parent context's cursor kind.
Definition at line 488 of file CodeCompleteConsumer.h.
| StringRef clang::CodeCompletionString::getParentContextName | ( | ) | const [inline] |
Retrieve the name of the parent context.
Definition at line 493 of file CodeCompleteConsumer.h.
| unsigned clang::CodeCompletionString::getPriority | ( | ) | const [inline] |
Retrieve the priority of this code completion result.
Definition at line 476 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().
| const Chunk& clang::CodeCompletionString::operator[] | ( | unsigned | I | ) | const [inline] |
Definition at line 467 of file CodeCompleteConsumer.h.
| unsigned clang::CodeCompletionString::size | ( | ) | const [inline] |
Definition at line 465 of file CodeCompleteConsumer.h.
Referenced by operator[]().
friend class CodeCompletionBuilder [friend] |
Definition at line 457 of file CodeCompleteConsumer.h.
friend class CodeCompletionResult [friend] |
Definition at line 458 of file CodeCompleteConsumer.h.