IndexerCallbacks Struct Reference

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

#include <Index.h>

Collaboration diagram for IndexerCallbacks:

List of all members.

Public Attributes
int(*	abortQuery )(CXClientData client_data, void *reserved)
	Called periodically to check whether indexing should be aborted. Should return 0 to continue, and non-zero to abort.
void(*	diagnostic )(CXClientData client_data, CXDiagnosticSet, void *reserved)
	Called at the end of indexing; passes the complete diagnostic set.
CXIdxClientFile(*	enteredMainFile )(CXClientData client_data, CXFile mainFile, void *reserved)
CXIdxClientFile(*	ppIncludedFile )(CXClientData client_data, const CXIdxIncludedFileInfo *)
	Called when a file gets #included/#imported.
CXIdxClientASTFile(*	importedASTFile )(CXClientData client_data, const CXIdxImportedASTFileInfo *)
	Called when a AST file (PCH or module) gets imported.
CXIdxClientContainer(*	startedTranslationUnit )(CXClientData client_data, void *reserved)
	Called at the beginning of indexing a translation unit.
void(*	indexDeclaration )(CXClientData client_data, const CXIdxDeclInfo *)
void(*	indexEntityReference )(CXClientData client_data, const CXIdxEntityRefInfo *)
	Called to index a reference of an entity.

---

Detailed Description

A group of callbacks used by clang_indexSourceFile and clang_indexTranslationUnit.

Definition at line 5424 of file Index.h.

---

Member Data Documentation

int(* IndexerCallbacks::abortQuery)(CXClientData client_data, void *reserved)

Called periodically to check whether indexing should be aborted. Should return 0 to continue, and non-zero to abort.

Definition at line 5429 of file Index.h.

void(* IndexerCallbacks::diagnostic)(CXClientData client_data, CXDiagnosticSet, void *reserved)

Called at the end of indexing; passes the complete diagnostic set.

Definition at line 5434 of file Index.h.

CXIdxClientFile(* IndexerCallbacks::enteredMainFile)(CXClientData client_data, CXFile mainFile, void *reserved)

Definition at line 5437 of file Index.h.

CXIdxClientASTFile(* IndexerCallbacks::importedASTFile)(CXClientData client_data, const CXIdxImportedASTFileInfo *)

Called when a AST file (PCH or module) gets imported.

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.

Definition at line 5454 of file Index.h.

void(* IndexerCallbacks::indexDeclaration)(CXClientData client_data, const CXIdxDeclInfo *)

Definition at line 5463 of file Index.h.

void(* IndexerCallbacks::indexEntityReference)(CXClientData client_data, const CXIdxEntityRefInfo *)

Called to index a reference of an entity.

Definition at line 5469 of file Index.h.

CXIdxClientFile(* IndexerCallbacks::ppIncludedFile)(CXClientData client_data, const CXIdxIncludedFileInfo *)

Called when a file gets #included/#imported.

Definition at line 5443 of file Index.h.

CXIdxClientContainer(* IndexerCallbacks::startedTranslationUnit)(CXClientData client_data, void *reserved)

Called at the beginning of indexing a translation unit.

Definition at line 5460 of file Index.h.

---

The documentation for this struct was generated from the following file:

• Index.h