Interface IIndexAction

Description

Hierarchy

Fields

Methods

Properties

Unit

Neslib.Clang

Declaration

type IIndexAction = interface(IInterface)

Description

An indexing action/session, to be applied to one or multiple translation units.

Attributes

GUID['{E5988F80-CA12-4EBA-B4E9-2B78EE81A5D9}']

Hierarchy

IInterface
IIndexAction

Overview

Methods

	`function GetHandle: TCXIndexAction;`
	`function IndexSourceFile(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ASourceFilename: String; const AClangCommandLineArgs: array of String; const AUnsavedFiles: TArray<TUnsavedFile> = nil; const ATUOptions: TTranslationUnitFlags = []): TError; overload;`
	`function IndexSourceFile(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ASourceFilename: String; const AClangCommandLineArgs: array of String; const AUnsavedFiles: TArray<TUnsavedFile>; const ATUOptions: TTranslationUnitFlags; out ATranslationUnit: ITranslationUnit): TError; overload;`
	`function IndexTranslationUnit(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ATranslationUnit: ITranslationUnit): TError;`

Properties

property Handle: TCXIndexAction read GetHandle;

Description

Methods

	`function GetHandle: TCXIndexAction;`

function IndexSourceFile(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ASourceFilename: String; const AClangCommandLineArgs: array of String; const AUnsavedFiles: TArray<TUnsavedFile> = nil; const ATUOptions: TTranslationUnitFlags = []): TError; overload;

function IndexSourceFile(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ASourceFilename: String; const AClangCommandLineArgs: array of String; const AUnsavedFiles: TArray<TUnsavedFile>; const ATUOptions: TTranslationUnitFlags; out ATranslationUnit: ITranslationUnit): TError; overload;

Index the given source file and the translation unit corresponding to that file via callbacks implemented through IIndexerListener.

Parameters

AListener: indexing callbacks that the client implements.
AOptions: options that affects how indexing is performed.
ASourceFilename: The name of the source file to load, or an empty string if the source file is included in AClangCommandLineArgs.
AClangCommandLineArgs: (optional) command-line arguments that would be passed to the clang executable if it were being invoked out-of-process. These command-line options will be parsed and will affect how the translation unit is parsed. Note that the following options are
ignored: '-c', '-emit-ast', '-fsyntax-only' (which is the default), and '-o <output file>'.
AUnsavedFiles: (optional) array of files that have not yet been saved to disk but may be required for code completion, including the contents of those files.
ATUOptions: (optional) options that affects how the translation unit is managed but not its compilation.
ATranslationUnit: (optional) is set to a translation unit that can be reused after indexing is finished.

Returns

Error code. If there were errors from which the compiler could recover, then this is not reported as an error. Only if there is a failure from which there is no recovery, will an error be returned.

function IndexTranslationUnit(const AListener: IIndexerListener; const AOptions: TIndexOptions; const ATranslationUnit: ITranslationUnit): TError;

Index the given translation unit via callbacks implemented through IndexerListener.

The order of callback invocations is not guaranteed to be the same as when indexing a source file. The high level order will be:

Preprocessor callbacks invocations
Declaration/reference callbacks invocations
Diagnostic callback invocations

Parameters

AListener: indexing callbacks that the client implements.
AOptions: options that affects how indexing is performed.
ATranslationUnit: the translation unit to index.

Returns

Error code. If there were errors from which the compiler could recover, then this is not reported as an error. Only if there is a failure from which there is no recovery, will an error be returned.

Properties

	`property Handle: TCXIndexAction read GetHandle;`
Internal `handle` to C API

Generated by PasDocEx, based on PasDoc 0.14.0.