Neslib.Clang

Neslib.Clang

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

License

Interface IIndexerListener

DescriptionHierarchyFieldsMethodsProperties

Unit

Neslib.Clang

Declaration

type IIndexerListener = interface(IInterface)

Description

A group of callbacks used by IIndexAction.IndexSourceFile and IIndexAction.IndexTranslationUnit. Implement this interface to provide these callbacks.

Attributes
GUID['{D585B3D2-E1AC-4E0D-A7FE-FF21DED1F7DB}']

Hierarchy

  • IInterface
  • IIndexerListener

Overview

Methods

Public function AbortQuery(const AReserved: Pointer): Boolean;
Public procedure Diagnostic(const ADiagnostics: IDiagnosticSet; const AReserved: Pointer);
Public function EnteredMainFile(const AMainFile: TFile; const AReserved: Pointer): TIdxClientFile;
Public function IncludedFile(const AInfo: TIdxIncludedFileInfo): TIdxClientFile;
Public function ImportedAstFile(const AInfo: TIdxImportedAstFileInfo): TIdxClientFile;
Public function StartedTranslationUnit(const AReserved: Pointer): TIdxClientContainer;
Public procedure IndexDeclaration(const AInfo: TIdxDeclInfo);
Public procedure IndexEntityReference(const AInfo: TIdxEntityRefInfo);

Description

Methods

Public function AbortQuery(const AReserved: Pointer): Boolean;

Called periodically to check whether indexing should be aborted. Should return False to continue, and True to abort.

Public procedure Diagnostic(const ADiagnostics: IDiagnosticSet; const AReserved: Pointer);

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

Public function EnteredMainFile(const AMainFile: TFile; const AReserved: Pointer): TIdxClientFile;
 
Public function IncludedFile(const AInfo: TIdxIncludedFileInfo): TIdxClientFile;

Called when a file gets #included/#imported.

Public function ImportedAstFile(const AInfo: TIdxImportedAstFileInfo): TIdxClientFile;

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.

Public function StartedTranslationUnit(const AReserved: Pointer): TIdxClientContainer;

Called at the beginning of indexing a translation unit.

Public procedure IndexDeclaration(const AInfo: TIdxDeclInfo);
 
Public procedure IndexEntityReference(const AInfo: TIdxEntityRefInfo);

Called to index a reference of an entity.

Generated by PasDocEx, based on PasDoc 0.14.0.