struct IndexerCallbacks

Declaration

struct IndexerCallbacks { /* full declaration omitted */ };

Description

A group of callbacks used by #clang_indexSourceFile and #clang_indexTranslationUnit.

Declared at: clang/include/clang-c/Index.h:6581

Member Variables

public int (*)(CXClientData, void*) abortQuery
Called periodically to check whether indexing should be aborted. Should return 0 to continue, and non-zero to abort.
public void (*)(CXClientData, CXDiagnosticSet, void*) diagnostic
Called at the end of indexing; passes the complete diagnostic set.
public CXIdxClientFile (*)(CXClientData, CXFile, void*) enteredMainFile
public CXIdxClientFile (*)(CXClientData, const CXIdxIncludedFileInfo*) ppIncludedFile
Called when a file gets # included/ # imported.
public CXIdxClientASTFile (*)( CXClientData, const CXIdxImportedASTFileInfo*) importedASTFile
AST files will not get indexed (there will not be callbacks to index all the entities in an AST file). The recommended action is that, if the AST file is not already indexed, to initiate a new indexing job specific to the AST file.
public CXIdxClientContainer (*)(CXClientData, void*) startedTranslationUnit
Called at the beginning of indexing a translation unit.
public void (*)(CXClientData, const CXIdxDeclInfo*) indexDeclaration
public void (*)(CXClientData, const CXIdxEntityRefInfo*) indexEntityReference
Called to index a reference of an entity.