Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class IndexerCallbacks

extends Struct<IndexerCallbacks>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
IndexerCallbacks.Buffer

An array of IndexerCallbacks structs.

Field Summary

Modifier and TypeField and Description
public static final int
ABORTQUERY

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DIAGNOSTIC

The struct member offsets.

public static final int
ENTEREDMAINFILE

The struct member offsets.

public static final int
IMPORTEDASTFILE

The struct member offsets.

public static final int
INDEXDECLARATION

The struct member offsets.

public static final int
INDEXENTITYREFERENCE

The struct member offsets.

public static final int
PPINCLUDEDFILE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STARTEDTRANSLATIONUNIT

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
IndexerCallbacks(long address, ByteBuffer container)

public
IndexerCallbacks(ByteBuffer container)

Creates a IndexerCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public IndexerAbortQuery
abortQuery()

called periodically to check whether indexing should be aborted.

public static IndexerCallbacks
calloc()

Returns a new IndexerCallbacks instance allocated with memCalloc.

public static IndexerCallbacks.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with memCalloc.

public static IndexerCallbacks
calloc(MemoryStack
the stack from which to allocate
stack)

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

public static IndexerCallbacks.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static IndexerCallbacks
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected IndexerCallbacks
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static IndexerCallbacks
create()

Returns a new IndexerCallbacks instance allocated with BufferUtils.

public static IndexerCallbacks
create(long address)

Returns a new IndexerCallbacks instance for the specified memory address.

public static IndexerCallbacks.Buffer
create(int
the buffer capacity
capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with BufferUtils.

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

Create a IndexerCallbacks.Buffer instance at the specified memory.

public static IndexerCallbacks
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public IndexerDiagnostic
diagnostic()

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

public IndexerEnteredMainFile

Returns:

the value of the enteredMainFile field.
enteredMainFile()

public IndexerImportedASTFile
importedASTFile()

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

public IndexerIndexDeclaration

Returns:

the value of the indexDeclaration field.
indexDeclaration()

public IndexerIndexEntityReference
indexEntityReference()

called to index a reference of an entity

public static IndexerCallbacks
malloc()

Returns a new IndexerCallbacks instance allocated with memAlloc.

public static IndexerCallbacks.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with memAlloc.

public static IndexerCallbacks
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new IndexerCallbacks instance allocated on the specified MemoryStack.

public static IndexerCallbacks.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

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

public static IndexerCallbacks
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerCallbacks.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static IndexerAbortQuery
nabortQuery(long struct)

Unsafe version of abortQuery.

public static IndexerDiagnostic
ndiagnostic(long struct)

Unsafe version of diagnostic.

public static IndexerEnteredMainFile
nenteredMainFile(long struct)

Unsafe version of enteredMainFile.

public static IndexerImportedASTFile
nimportedASTFile(long struct)

Unsafe version of importedASTFile.

public static IndexerIndexDeclaration
nindexDeclaration(long struct)

Unsafe version of indexDeclaration.

public static IndexerIndexEntityReference
nindexEntityReference(long struct)

Unsafe version of indexEntityReference.

public static IndexerIncludedFile
nppIncludedFile(long struct)

Unsafe version of ppIncludedFile.

public static IndexerStartedTranslationUnit
nstartedTranslationUnit(long struct)

Unsafe version of startedTranslationUnit.

public IndexerIncludedFile
ppIncludedFile()

called when a file gets #included/#imported

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public IndexerStartedTranslationUnit
startedTranslationUnit()

called at the beginning of indexing a translation unit

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ABORTQUERYback to summary
public static final int ABORTQUERY

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DIAGNOSTICback to summary
public static final int DIAGNOSTIC

The struct member offsets.

ENTEREDMAINFILEback to summary
public static final int ENTEREDMAINFILE

The struct member offsets.

IMPORTEDASTFILEback to summary
public static final int IMPORTEDASTFILE

The struct member offsets.

INDEXDECLARATIONback to summary
public static final int INDEXDECLARATION

The struct member offsets.

INDEXENTITYREFERENCEback to summary
public static final int INDEXENTITYREFERENCE

The struct member offsets.

PPINCLUDEDFILEback to summary
public static final int PPINCLUDEDFILE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STARTEDTRANSLATIONUNITback to summary
public static final int STARTEDTRANSLATIONUNIT

The struct member offsets.

Constructor Detail

IndexerCallbacksback to summary
protected IndexerCallbacks(long address, ByteBuffer container)
IndexerCallbacksback to summary
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 Detail

abortQueryback to summary
public IndexerAbortQuery abortQuery()

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

Annotations
@NativeType:int (*) (CXClientData, void *)
callocback to summary
public static IndexerCallbacks calloc()

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

callocback to summary
public static IndexerCallbacks.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static IndexerCallbacks calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static IndexerCallbacks.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static IndexerCallbacks callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static IndexerCallbacks callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static IndexerCallbacks.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static IndexerCallbacks.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected IndexerCallbacks create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static IndexerCallbacks create()

Returns a new IndexerCallbacks instance allocated with BufferUtils.

createback to summary
public static IndexerCallbacks create(long address)

Returns a new IndexerCallbacks instance for the specified memory address.

createback to summary
public static IndexerCallbacks.Buffer create(int capacity)

Returns a new IndexerCallbacks.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a IndexerCallbacks.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static IndexerCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static IndexerCallbacks.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
diagnosticback to summary
public IndexerDiagnostic diagnostic()

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

Annotations
@NativeType:void (*) (CXClientData, CXDiagnosticSet, void *)
enteredMainFileback to summary
public IndexerEnteredMainFile enteredMainFile()
Returns:IndexerEnteredMainFile

the value of the enteredMainFile field.

Annotations
@NativeType:CXIdxClientFile (*) (CXClientData, CXFile, void *)
importedASTFileback to summary
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.

Annotations
@NativeType:CXIdxClientASTFile (*) (CXClientData, CXIdxImportedASTFileInfo const *)
indexDeclarationback to summary
public IndexerIndexDeclaration indexDeclaration()
Returns:IndexerIndexDeclaration

the value of the indexDeclaration field.

Annotations
@NativeType:void (*) (CXClientData, CXIdxDeclInfo const *)
indexEntityReferenceback to summary
public IndexerIndexEntityReference indexEntityReference()

called to index a reference of an entity

Annotations
@NativeType:void (*) (CXClientData, CXIdxEntityRefInfo const *)
mallocback to summary
public static IndexerCallbacks malloc()

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

mallocback to summary
public static IndexerCallbacks.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static IndexerCallbacks malloc(MemoryStack stack)

Returns a new IndexerCallbacks instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static IndexerCallbacks.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static IndexerCallbacks mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static IndexerCallbacks mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static IndexerCallbacks.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static IndexerCallbacks.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nabortQueryback to summary
public static IndexerAbortQuery nabortQuery(long struct)

Unsafe version of abortQuery.

ndiagnosticback to summary
public static IndexerDiagnostic ndiagnostic(long struct)

Unsafe version of diagnostic.

nenteredMainFileback to summary
public static IndexerEnteredMainFile nenteredMainFile(long struct)

Unsafe version of enteredMainFile.

nimportedASTFileback to summary
public static IndexerImportedASTFile nimportedASTFile(long struct)

Unsafe version of importedASTFile.

nindexDeclarationback to summary
public static IndexerIndexDeclaration nindexDeclaration(long struct)

Unsafe version of indexDeclaration.

nindexEntityReferenceback to summary
public static IndexerIndexEntityReference nindexEntityReference(long struct)

Unsafe version of indexEntityReference.

nppIncludedFileback to summary
public static IndexerIncludedFile nppIncludedFile(long struct)

Unsafe version of ppIncludedFile.

nstartedTranslationUnitback to summary
public static IndexerStartedTranslationUnit nstartedTranslationUnit(long struct)

Unsafe version of startedTranslationUnit.

ppIncludedFileback to summary
public IndexerIncludedFile ppIncludedFile()

called when a file gets #included/#imported

Annotations
@NativeType:CXIdxClientFile (*) (CXClientData, CXIdxIncludedFileInfo const *)
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
startedTranslationUnitback to summary
public IndexerStartedTranslationUnit startedTranslationUnit()

called at the beginning of indexing a translation unit

Annotations
@NativeType:CXIdxClientContainer (*) (CXClientData, void *)
org.lwjgl.llvm back to summary

public Class IndexerCallbacks.Buffer

extends StructBuffer<IndexerCallbacks, IndexerCallbacks.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of IndexerCallbacks structs.

Field Summary

Modifier and TypeField and Description
private static final IndexerCallbacks
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new IndexerCallbacks.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public IndexerAbortQuery

Returns:

the value of the IndexerCallbacks#abortQuery field.
abortQuery()

public IndexerDiagnostic

Returns:

the value of the IndexerCallbacks#diagnostic field.
diagnostic()

public IndexerEnteredMainFile

Returns:

the value of the enteredMainFile field.
enteredMainFile()

protected IndexerCallbacks
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public IndexerImportedASTFile

Returns:

the value of the IndexerCallbacks#importedASTFile field.
importedASTFile()

public IndexerIndexDeclaration

Returns:

the value of the indexDeclaration field.
indexDeclaration()

public IndexerIndexEntityReference

Returns:

the value of the IndexerCallbacks#indexEntityReference field.
indexEntityReference()

public IndexerIncludedFile

Returns:

the value of the IndexerCallbacks#ppIncludedFile field.
ppIncludedFile()

protected IndexerCallbacks.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public IndexerStartedTranslationUnit

Returns:

the value of the IndexerCallbacks#startedTranslationUnit field.
startedTranslationUnit()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final IndexerCallbacks ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new IndexerCallbacks.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by IndexerCallbacks#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

abortQueryback to summary
public IndexerAbortQuery abortQuery()
Returns:IndexerAbortQuery

the value of the IndexerCallbacks#abortQuery field.

Annotations
@NativeType:int (*) (CXClientData, void *)
diagnosticback to summary
public IndexerDiagnostic diagnostic()
Returns:IndexerDiagnostic

the value of the IndexerCallbacks#diagnostic field.

Annotations
@NativeType:void (*) (CXClientData, CXDiagnosticSet, void *)
enteredMainFileback to summary
public IndexerEnteredMainFile enteredMainFile()
Returns:IndexerEnteredMainFile

the value of the enteredMainFile field.

Annotations
@NativeType:CXIdxClientFile (*) (CXClientData, CXFile, void *)
getElementFactoryback to summary
protected IndexerCallbacks getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
importedASTFileback to summary
public IndexerImportedASTFile importedASTFile()
Returns:IndexerImportedASTFile

the value of the IndexerCallbacks#importedASTFile field.

Annotations
@NativeType:CXIdxClientASTFile (*) (CXClientData, CXIdxImportedASTFileInfo const *)
indexDeclarationback to summary
public IndexerIndexDeclaration indexDeclaration()
Returns:IndexerIndexDeclaration

the value of the indexDeclaration field.

Annotations
@NativeType:void (*) (CXClientData, CXIdxDeclInfo const *)
indexEntityReferenceback to summary
public IndexerIndexEntityReference indexEntityReference()
Returns:IndexerIndexEntityReference

the value of the IndexerCallbacks#indexEntityReference field.

Annotations
@NativeType:void (*) (CXClientData, CXIdxEntityRefInfo const *)
ppIncludedFileback to summary
public IndexerIncludedFile ppIncludedFile()
Returns:IndexerIncludedFile

the value of the IndexerCallbacks#ppIncludedFile field.

Annotations
@NativeType:CXIdxClientFile (*) (CXClientData, CXIdxIncludedFileInfo const *)
selfback to summary
protected IndexerCallbacks.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
startedTranslationUnitback to summary
public IndexerStartedTranslationUnit startedTranslationUnit()
Returns:IndexerStartedTranslationUnit

the value of the IndexerCallbacks#startedTranslationUnit field.

Annotations
@NativeType:CXIdxClientContainer (*) (CXClientData, void *)