Package org.lwjgl.llvm

Class IndexerCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<IndexerCallbacks>

org.lwjgl.llvm.IndexerCallbacks

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class IndexerCallbacks
extends org.lwjgl.system.Struct<IndexerCallbacks>
implements org.lwjgl.system.NativeResource

A group of callbacks used by indexSourceFile and indexTranslationUnit.

Layout

 struct IndexerCallbacks {
     int (*abortQuery) (CXClientData client_data, void *reserved);
     void (*diagnostic) (CXClientData client_data, CXDiagnosticSet diagnosticSet, void *reserved);
     CXIdxClientFile (*enteredMainFile) (CXClientData client_data, CXFile mainFile, void *reserved);
     CXIdxClientFile (*ppIncludedFile) (CXClientData client_data, CXIdxIncludedFileInfo const *info);
     CXIdxClientASTFile (*importedASTFile) (CXClientData client_data, CXIdxImportedASTFileInfo const *info);
     CXIdxClientContainer (*startedTranslationUnit) (CXClientData client_data, void *reserved);
     void (*indexDeclaration) (CXClientData client_data, CXIdxDeclInfo const *info);
     void (*indexEntityReference) (CXClientData client_data, CXIdxEntityRefInfo const *info);
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexerCallbacks.Buffer	An array of IndexerCallbacks structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABORTQUERY	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DIAGNOSTIC	The struct member offsets.
static final int	ENTEREDMAINFILE	The struct member offsets.
static final int	IMPORTEDASTFILE	The struct member offsets.
static final int	INDEXDECLARATION	The struct member offsets.
static final int	INDEXENTITYREFERENCE	The struct member offsets.
static final int	PPINCLUDEDFILE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STARTEDTRANSLATIONUNIT	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
IndexerCallbacks(ByteBuffer container)	Creates a IndexerCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
IndexerAbortQuery	abortQuery()	called periodically to check whether indexing should be aborted.
static IndexerCallbacks	calloc()	Returns a new IndexerCallbacks instance allocated with memCalloc.
static IndexerCallbacks.Buffer	calloc(int capacity)	Returns a new IndexerCallbacks.Buffer instance allocated with memCalloc.
static IndexerCallbacks.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new IndexerCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static IndexerCallbacks	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new IndexerCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
static IndexerCallbacks	callocStack()	Deprecated.
static IndexerCallbacks.Buffer	callocStack(int capacity)	Deprecated.
static IndexerCallbacks.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static IndexerCallbacks	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static IndexerCallbacks	create()	Returns a new IndexerCallbacks instance allocated with BufferUtils.
static IndexerCallbacks.Buffer	create(int capacity)	Returns a new IndexerCallbacks.Buffer instance allocated with BufferUtils.
static IndexerCallbacks	create(long address)	Returns a new IndexerCallbacks instance for the specified memory address.
static IndexerCallbacks.Buffer	create(long address, int capacity)	Create a IndexerCallbacks.Buffer instance at the specified memory.
static @Nullable IndexerCallbacks	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable IndexerCallbacks.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
IndexerDiagnostic	diagnostic()	called at the end of indexing; passes the complete diagnostic set.
IndexerEnteredMainFile	enteredMainFile()
IndexerImportedASTFile	importedASTFile()	Called when a AST file (PCH or module) gets imported.
IndexerIndexDeclaration	indexDeclaration()
IndexerIndexEntityReference	indexEntityReference()	called to index a reference of an entity
static IndexerCallbacks	malloc()	Returns a new IndexerCallbacks instance allocated with memAlloc.
static IndexerCallbacks.Buffer	malloc(int capacity)	Returns a new IndexerCallbacks.Buffer instance allocated with memAlloc.
static IndexerCallbacks.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new IndexerCallbacks.Buffer instance allocated on the specified MemoryStack.
static IndexerCallbacks	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new IndexerCallbacks instance allocated on the specified MemoryStack.
static IndexerCallbacks	mallocStack()	Deprecated.
static IndexerCallbacks.Buffer	mallocStack(int capacity)	Deprecated.
static IndexerCallbacks.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static IndexerCallbacks	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static IndexerAbortQuery	nabortQuery(long struct)	Unsafe version of abortQuery().
static IndexerDiagnostic	ndiagnostic(long struct)	Unsafe version of diagnostic().
static IndexerEnteredMainFile	nenteredMainFile(long struct)	Unsafe version of enteredMainFile().
static IndexerImportedASTFile	nimportedASTFile(long struct)	Unsafe version of importedASTFile().
static IndexerIndexDeclaration	nindexDeclaration(long struct)	Unsafe version of indexDeclaration().
static IndexerIndexEntityReference	nindexEntityReference(long struct)	Unsafe version of indexEntityReference().
static IndexerIncludedFile	nppIncludedFile(long struct)	Unsafe version of ppIncludedFile().
static IndexerStartedTranslationUnit	nstartedTranslationUnit(long struct)	Unsafe version of startedTranslationUnit().
IndexerIncludedFile	ppIncludedFile()	called when a file gets #included/#imported
int	sizeof()
IndexerStartedTranslationUnit	startedTranslationUnit()	called at the beginning of indexing a translation unit

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

ABORTQUERY

public static final int ABORTQUERY

The struct member offsets.

DIAGNOSTIC

public static final int DIAGNOSTIC

The struct member offsets.

ENTEREDMAINFILE

public static final int ENTEREDMAINFILE

The struct member offsets.

PPINCLUDEDFILE

public static final int PPINCLUDEDFILE

The struct member offsets.

IMPORTEDASTFILE

public static final int IMPORTEDASTFILE

The struct member offsets.

STARTEDTRANSLATIONUNIT

public static final int STARTEDTRANSLATIONUNIT

The struct member offsets.

INDEXDECLARATION

public static final int INDEXDECLARATION

The struct member offsets.

INDEXENTITYREFERENCE

public static final int INDEXENTITYREFERENCE

The struct member offsets.

Constructor Details

IndexerCallbacks

public IndexerCallbacks(ByteBuffer container)

Creates a IndexerCallbacks instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<IndexerCallbacks>

abortQuery

public IndexerAbortQuery abortQuery()

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

diagnostic

public IndexerDiagnostic diagnostic()

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

enteredMainFile

public IndexerEnteredMainFile enteredMainFile()

Returns:

the value of the enteredMainFile field.

ppIncludedFile

public IndexerIncludedFile ppIncludedFile()

called when a file gets #included/#imported

importedASTFile

public IndexerImportedASTFile importedASTFile()

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.

startedTranslationUnit

public IndexerStartedTranslationUnit startedTranslationUnit()

called at the beginning of indexing a translation unit

indexDeclaration

public IndexerIndexDeclaration indexDeclaration()

Returns:

the value of the indexDeclaration field.

indexEntityReference

public IndexerIndexEntityReference indexEntityReference()

called to index a reference of an entity

malloc

public static IndexerCallbacks malloc()

Returns a new IndexerCallbacks instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static IndexerCallbacks calloc()

Returns a new IndexerCallbacks instance allocated with memCalloc. The instance must be explicitly freed.

create

public static IndexerCallbacks create()

Returns a new IndexerCallbacks instance allocated with BufferUtils.

create

public static IndexerCallbacks create(long address)

Returns a new IndexerCallbacks instance for the specified memory address.

createSafe

public static @Nullable IndexerCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static IndexerCallbacks.Buffer malloc(int capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static IndexerCallbacks.Buffer calloc(int capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static IndexerCallbacks.Buffer create(int capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static IndexerCallbacks.Buffer create(long address,
 int capacity)

Create a IndexerCallbacks.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable IndexerCallbacks.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static IndexerCallbacks mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static IndexerCallbacks callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static IndexerCallbacks mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static IndexerCallbacks callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static IndexerCallbacks.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static IndexerCallbacks.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static IndexerCallbacks.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static IndexerCallbacks.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static IndexerCallbacks malloc(org.lwjgl.system.MemoryStack stack)

Returns a new IndexerCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static IndexerCallbacks calloc(org.lwjgl.system.MemoryStack stack)

Returns a new IndexerCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static IndexerCallbacks.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new IndexerCallbacks.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static IndexerCallbacks.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new IndexerCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nabortQuery

public static IndexerAbortQuery nabortQuery(long struct)

Unsafe version of abortQuery().

ndiagnostic

public static IndexerDiagnostic ndiagnostic(long struct)

Unsafe version of diagnostic().

nenteredMainFile

public static IndexerEnteredMainFile nenteredMainFile(long struct)

Unsafe version of enteredMainFile().

nppIncludedFile

public static IndexerIncludedFile nppIncludedFile(long struct)

Unsafe version of ppIncludedFile().

nimportedASTFile

public static IndexerImportedASTFile nimportedASTFile(long struct)

Unsafe version of importedASTFile().

nstartedTranslationUnit

public static IndexerStartedTranslationUnit nstartedTranslationUnit(long struct)

Unsafe version of startedTranslationUnit().

nindexDeclaration

public static IndexerIndexDeclaration nindexDeclaration(long struct)

Unsafe version of indexDeclaration().

nindexEntityReference

public static IndexerIndexEntityReference nindexEntityReference(long struct)

Unsafe version of indexEntityReference().