class CodeCompletionHandler

Declaration

class CodeCompletionHandler { /* full declaration omitted */ };

Description

Callback handler that receives notifications when performing code completion within the preprocessor.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:25

Method Overview

• public virtual void CodeCompleteDirective(bool InConditional)
• public virtual void CodeCompleteInConditionalExclusion()
• public virtual void CodeCompleteIncludedFile(llvm::StringRef Dir, bool IsAngled)
• public virtual void CodeCompleteMacroArgument(clang::IdentifierInfo * Macro, clang::MacroInfo * MacroInfo, unsigned int ArgumentIndex)
• public virtual void CodeCompleteMacroName(bool IsDefinition)
• public virtual void CodeCompleteNaturalLanguage()
• public virtual void CodeCompletePreprocessorExpression()
• public virtual ~CodeCompletionHandler()

Methods

¶virtual void CodeCompleteDirective(
    bool InConditional)

Description

Callback invoked when performing code completion for a preprocessor directive. This callback will be invoked when the preprocessor processes a '#' at the start of a line, followed by the code-completion token.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:37

Parameters

bool InConditional

Whether we're inside a preprocessor conditional already.

¶virtual void CodeCompleteInConditionalExclusion()

Description

Callback invoked when performing code completion within a block of code that was excluded due to preprocessor conditionals.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:41

¶virtual void CodeCompleteIncludedFile(
    llvm::StringRef Dir,
    bool IsAngled)

Description

Callback invoked when performing code completion inside the filename part of an #include directive. (Also #import, #include_next, etc).\p Dir is the directory relative to the include path.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:67

Parameters

llvm::StringRef Dir

bool IsAngled

¶virtual void CodeCompleteMacroArgument(
    clang::IdentifierInfo* Macro,
    clang::MacroInfo* MacroInfo,
    unsigned int ArgumentIndex)

Description

Callback invoked when performing code completion inside a function-like macro argument. There will be another callback invocation after the macro arguments are parsed, so this callback should generally be used to note that the next callback is invoked inside a macro argument.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:60

Parameters

clang::IdentifierInfo* Macro

clang::MacroInfo* MacroInfo

unsigned int ArgumentIndex

¶virtual void CodeCompleteMacroName(
    bool IsDefinition)

Description

Callback invoked when performing code completion in a context where the name of a macro is expected.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:48

Parameters

bool IsDefinition

Whether this is the definition of a macro, e.g., in a # define.

¶virtual void CodeCompleteNaturalLanguage()

Description

Callback invoked when performing code completion in a part of the file where we expect natural language, e.g., a comment, string, or # error directive.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:72

¶virtual void CodeCompletePreprocessorExpression()

Description

Callback invoked when performing code completion in a preprocessor expression, such as the condition of an # if or # elif directive.

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:52

¶virtual ~CodeCompletionHandler()

Declared at: clang/include/clang/Lex/CodeCompletionHandler.h:27