IndexerCallbacks (LWJGL 3.2.4 SNAPSHOT

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.NativeResource
```
A group of callbacks used by indexSourceFile and indexTranslationUnit.
Member documentation
- abortQuery – called periodically to check whether indexing should be aborted. Should return 0 to continue, and non-zero to abort.
- diagnostic – called at the end of indexing; passes the complete diagnostic set.
- ppIncludedFile – called when a file gets #included/#imported
- 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 – called at the beginning of indexing a translation unit
- indexEntityReference – called to index a reference of an entity
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 and Description

static class IndexerCallbacks.Buffer
An array of IndexerCallbacks structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABORTQUERY` The struct member offsets.
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DIAGNOSTIC` The struct member offsets.
`static int`	`ENTEREDMAINFILE` The struct member offsets.
`static int`	`IMPORTEDASTFILE` The struct member offsets.
`static int`	`INDEXDECLARATION` The struct member offsets.
`static int`	`INDEXENTITYREFERENCE` The struct member offsets.
`static int`	`PPINCLUDEDFILE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description

IndexerCallbacks(java.nio.ByteBuffer container)
Creates a IndexerCallbacks instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`IndexerCallbacks(java.nio.ByteBuffer container)` Creates a `IndexerCallbacks` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexerAbortQuery`	`abortQuery()` Returns the value of the `abortQuery` field.
`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`	`callocStack()` Returns a new `IndexerCallbacks` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static IndexerCallbacks.Buffer`	`callocStack(int capacity)` Returns a new `IndexerCallbacks.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static IndexerCallbacks.Buffer`	`callocStack(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`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `IndexerCallbacks` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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 IndexerCallbacks`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static IndexerCallbacks.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`IndexerDiagnostic`	`diagnostic()` Returns the value of the `diagnostic` field.
`IndexerEnteredMainFile`	`enteredMainFile()` Returns the value of the `enteredMainFile` field.
`IndexerImportedASTFile`	`importedASTFile()` Returns the value of the `importedASTFile` field.
`IndexerIndexDeclaration`	`indexDeclaration()` Returns the value of the `indexDeclaration` field.
`IndexerIndexEntityReference`	`indexEntityReference()` Returns the value of the `indexEntityReference` field.
`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`	`mallocStack()` Returns a new `IndexerCallbacks` instance allocated on the thread-local `MemoryStack`.
`static IndexerCallbacks.Buffer`	`mallocStack(int capacity)` Returns a new `IndexerCallbacks.Buffer` instance allocated on the thread-local `MemoryStack`.
`static IndexerCallbacks.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `IndexerCallbacks.Buffer` instance allocated on the specified `MemoryStack`.
`static IndexerCallbacks`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `IndexerCallbacks` instance allocated on the specified `MemoryStack`.
`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()` Returns the value of the `ppIncludedFile` field.
`int`	`sizeof()`
`IndexerStartedTranslationUnit`	`startedTranslationUnit()` Returns the value of the `startedTranslationUnit` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - IndexerCallbacks
```
public IndexerCallbacks(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - abortQuery
```
public IndexerAbortQuery abortQuery()
```
    Returns the value of the abortQuery field.
  - diagnostic
```
public IndexerDiagnostic diagnostic()
```
    Returns the value of the diagnostic field.
  - enteredMainFile
```
public IndexerEnteredMainFile enteredMainFile()
```
    Returns the value of the enteredMainFile field.
  - ppIncludedFile
```
public IndexerIncludedFile ppIncludedFile()
```
    Returns the value of the ppIncludedFile field.
  - importedASTFile
```
public IndexerImportedASTFile importedASTFile()
```
    Returns the value of the importedASTFile field.
  - startedTranslationUnit
```
public IndexerStartedTranslationUnit startedTranslationUnit()
```
    Returns the value of the startedTranslationUnit field.
  - indexDeclaration
```
public IndexerIndexDeclaration indexDeclaration()
```
    Returns the value of the indexDeclaration field.
  - indexEntityReference
```
public IndexerIndexEntityReference indexEntityReference()
```
    Returns the value of the indexEntityReference field.
  - 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
```
@Nullable
public static 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
```
@Nullable
public static IndexerCallbacks.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static IndexerCallbacks mallocStack()
```
    Returns a new IndexerCallbacks instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static IndexerCallbacks callocStack()
```
    Returns a new IndexerCallbacks instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static IndexerCallbacks mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new IndexerCallbacks instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static IndexerCallbacks callocStack(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
  - mallocStack
```
public static IndexerCallbacks.Buffer mallocStack(int capacity)
```
    Returns a new IndexerCallbacks.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static IndexerCallbacks.Buffer callocStack(int capacity)
```
    Returns a new IndexerCallbacks.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static IndexerCallbacks.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new IndexerCallbacks.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static IndexerCallbacks.Buffer callocStack(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:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - 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().

Class IndexerCallbacks

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

ABORTQUERY

DIAGNOSTIC

ENTEREDMAINFILE

PPINCLUDEDFILE

IMPORTEDASTFILE

STARTEDTRANSLATIONUNIT

INDEXDECLARATION

INDEXENTITYREFERENCE

Constructor Detail

IndexerCallbacks

Method Detail

sizeof

abortQuery

diagnostic

enteredMainFile

ppIncludedFile

importedASTFile

startedTranslationUnit

indexDeclaration

indexEntityReference

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nabortQuery

ndiagnostic

nenteredMainFile

nppIncludedFile

nimportedASTFile

nstartedTranslationUnit

nindexDeclaration

nindexEntityReference