Package org.lwjgl.llvm
Class IndexerCallbacks
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.llvm.IndexerCallbacks
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class IndexerCallbacks extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceA group of callbacks used byindexSourceFileandindexTranslationUnit.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 classIndexerCallbacks.BufferAn array ofIndexerCallbacksstructs.
-
Field Summary
Fields Modifier and Type Field Description static intABORTQUERYThe struct member offsets.static intALIGNOFThe struct alignment in bytes.static intDIAGNOSTIC
ENTEREDMAINFILE
IMPORTEDASTFILE
INDEXDECLARATION
INDEXENTITYREFERENCE
PPINCLUDEDFILEThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTARTEDTRANSLATIONUNITThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description IndexerCallbacks(java.nio.ByteBuffer container)Creates aIndexerCallbacksinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IndexerAbortQueryabortQuery()called periodically to check whether indexing should be aborted.static IndexerCallbackscalloc()Returns a newIndexerCallbacksinstance allocated withmemCalloc.static IndexerCallbacks.Buffercalloc(int capacity)Returns a newIndexerCallbacks.Bufferinstance allocated withmemCalloc.static IndexerCallbacks.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newIndexerCallbacks.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static IndexerCallbackscalloc(org.lwjgl.system.MemoryStack stack)Returns a newIndexerCallbacksinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static IndexerCallbackscallocStack()Deprecated.static IndexerCallbacks.BuffercallocStack(int capacity)Deprecated.static IndexerCallbacks.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static IndexerCallbackscallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static IndexerCallbackscreate()Returns a newIndexerCallbacksinstance allocated withBufferUtils.static IndexerCallbacks.Buffercreate(int capacity)Returns a newIndexerCallbacks.Bufferinstance allocated withBufferUtils.static IndexerCallbackscreate(long address)Returns a newIndexerCallbacksinstance for the specified memory address.static IndexerCallbacks.Buffercreate(long address, int capacity)Create aIndexerCallbacks.Bufferinstance at the specified memory.static IndexerCallbackscreateSafe(long address)static IndexerCallbacks.BuffercreateSafe(long address, int capacity)IndexerDiagnosticdiagnostic()called at the end of indexing; passes the complete diagnostic set.IndexerEnteredMainFileenteredMainFile()IndexerImportedASTFileimportedASTFile()Called when a AST file (PCH or module) gets imported.IndexerIndexDeclarationindexDeclaration()IndexerIndexEntityReferenceindexEntityReference()called to index a reference of an entitystatic IndexerCallbacksmalloc()Returns a newIndexerCallbacksinstance allocated withmemAlloc.static IndexerCallbacks.Buffermalloc(int capacity)Returns a newIndexerCallbacks.Bufferinstance allocated withmemAlloc.static IndexerCallbacks.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newIndexerCallbacks.Bufferinstance allocated on the specifiedMemoryStack.static IndexerCallbacksmalloc(org.lwjgl.system.MemoryStack stack)Returns a newIndexerCallbacksinstance allocated on the specifiedMemoryStack.static IndexerCallbacksmallocStack()Deprecated.static IndexerCallbacks.BuffermallocStack(int capacity)Deprecated.static IndexerCallbacks.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static IndexerCallbacksmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static IndexerAbortQuerynabortQuery(long struct)Unsafe version ofabortQuery().static IndexerDiagnosticndiagnostic(long struct)Unsafe version ofdiagnostic().static IndexerEnteredMainFilenenteredMainFile(long struct)Unsafe version ofenteredMainFile().static IndexerImportedASTFilenimportedASTFile(long struct)Unsafe version ofimportedASTFile().static IndexerIndexDeclarationnindexDeclaration(long struct)Unsafe version ofindexDeclaration().static IndexerIndexEntityReferencenindexEntityReference(long struct)Unsafe version ofindexEntityReference().static IndexerIncludedFilenppIncludedFile(long struct)Unsafe version ofppIncludedFile().static IndexerStartedTranslationUnitnstartedTranslationUnit(long struct)Unsafe version ofstartedTranslationUnit().IndexerIncludedFileppIncludedFile()called when a file gets#included/#importedintsizeof()IndexerStartedTranslationUnitstartedTranslationUnit()called at the beginning of indexing a translation unit
-
-
-
Constructor Detail
-
IndexerCallbacks
public IndexerCallbacks(java.nio.ByteBuffer container)
Creates aIndexerCallbacksinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
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
enteredMainFilefield.
-
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
indexDeclarationfield.
-
indexEntityReference
public IndexerIndexEntityReference indexEntityReference()
called to index a reference of an entity
-
malloc
public static IndexerCallbacks malloc()
Returns a newIndexerCallbacksinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static IndexerCallbacks calloc()
Returns a newIndexerCallbacksinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static IndexerCallbacks create()
Returns a newIndexerCallbacksinstance allocated withBufferUtils.
-
create
public static IndexerCallbacks create(long address)
Returns a newIndexerCallbacksinstance for the specified memory address.
-
createSafe
@Nullable public static IndexerCallbacks createSafe(long address)
-
malloc
public static IndexerCallbacks.Buffer malloc(int capacity)
Returns a newIndexerCallbacks.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static IndexerCallbacks.Buffer calloc(int capacity)
Returns a newIndexerCallbacks.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static IndexerCallbacks.Buffer create(int capacity)
Returns a newIndexerCallbacks.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static IndexerCallbacks.Buffer create(long address, int capacity)
Create aIndexerCallbacks.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static IndexerCallbacks.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static IndexerCallbacks mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static IndexerCallbacks callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static IndexerCallbacks mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static IndexerCallbacks callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static IndexerCallbacks.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static IndexerCallbacks.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(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. Usemalloc(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. Usecalloc(int, MemoryStack)instead.
-
malloc
public static IndexerCallbacks malloc(org.lwjgl.system.MemoryStack stack)
Returns a newIndexerCallbacksinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static IndexerCallbacks calloc(org.lwjgl.system.MemoryStack stack)
Returns a newIndexerCallbacksinstance allocated on the specifiedMemoryStackand 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 newIndexerCallbacks.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static IndexerCallbacks.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newIndexerCallbacks.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nabortQuery
public static IndexerAbortQuery nabortQuery(long struct)
Unsafe version ofabortQuery().
-
ndiagnostic
public static IndexerDiagnostic ndiagnostic(long struct)
Unsafe version ofdiagnostic().
-
nenteredMainFile
public static IndexerEnteredMainFile nenteredMainFile(long struct)
Unsafe version ofenteredMainFile().
-
nppIncludedFile
public static IndexerIncludedFile nppIncludedFile(long struct)
Unsafe version ofppIncludedFile().
-
nimportedASTFile
public static IndexerImportedASTFile nimportedASTFile(long struct)
Unsafe version ofimportedASTFile().
-
nstartedTranslationUnit
public static IndexerStartedTranslationUnit nstartedTranslationUnit(long struct)
Unsafe version ofstartedTranslationUnit().
-
nindexDeclaration
public static IndexerIndexDeclaration nindexDeclaration(long struct)
Unsafe version ofindexDeclaration().
-
nindexEntityReference
public static IndexerIndexEntityReference nindexEntityReference(long struct)
Unsafe version ofindexEntityReference().
-
-